views_handler_field_date.test

<?php


/**
 * @file
 * Definition of ViewsHandlerFieldDateTest.
 */

/**
 * Tests the core views_handler_field_date handler.
 */
class ViewsHandlerFieldDateTest extends ViewsSqlTest {
    
    /**
     *
     */
    public static function getInfo() {
        return array(
            'name' => 'Field: Date',
            'description' => 'Test the core views_handler_field_date handler.',
            'group' => 'Views Handlers',
        );
    }
    
    /**
     *
     */
    public function viewsData() {
        $data = parent::viewsData();
        $data['views_test']['created']['field']['handler'] = 'views_handler_field_date';
        return $data;
    }
    
    /**
     *
     */
    public function testFieldDate() {
        $view = $this->getBasicView();
        $view->display['default']->handler
            ->override_option('fields', array(
            'created' => array(
                'id' => 'created',
                'table' => 'views_test',
                'field' => 'created',
                'relationship' => 'none',
                // Use the ISO-8601 date format.
                // @see http://php.net/manual/en/function.date.php
'custom_date_format' => 'c',
                'second_date_format' => 'custom',
                'second_date_format_custom' => 'c',
            ),
        ));
        $time = gmmktime(0, 0, 0, 1, 1, 2000);
        $this->executeView($view);
        $timezones = array(
            NULL,
            'UTC',
            'America/New_York',
        );
        foreach ($timezones as $timezone) {
            $dates = array(
                'small' => format_date($time, 'small', '', $timezone),
                'medium' => format_date($time, 'medium', '', $timezone),
                'large' => format_date($time, 'large', '', $timezone),
                'custom' => format_date($time, 'custom', 'c', $timezone),
                'today time ago custom' => format_date($time, 'custom', 'c', $timezone),
                'today time ago' => t('%time ago', array(
                    '%time' => format_interval(120, 2),
                )),
            );
            $this->assertRenderedDatesEqual($view, $dates, $timezone);
        }
        $intervals = array(
            'raw time ago' => format_interval(REQUEST_TIME - $time, 2),
            'time ago' => t('%time ago', array(
                '%time' => format_interval(REQUEST_TIME - $time, 2),
            )),
        );
        $this->assertRenderedDatesEqual($view, $intervals);
    }
    
    /**
     *
     */
    protected function assertRenderedDatesEqual($view, $map, $timezone = NULL) {
        foreach ($map as $date_format => $expected_result) {
            $check_result_number = 0;
            // If it's "today time ago" format we have to check the 6th element.
            if ($date_format == 'today time ago') {
                $check_result_number = 5;
            }
            // Correct the date format.
            if ($date_format == 'today time ago custom') {
                $date_format = 'today time ago';
            }
            $view->field['created']->options['date_format'] = $date_format;
            $t_args = array(
                '%value' => $expected_result,
                '%format' => $date_format,
            );
            if (isset($timezone)) {
                $t_args['%timezone'] = $timezone;
                $message = t('Value %value in %format format for timezone %timezone matches.', $t_args);
                $view->field['created']->options['timezone'] = $timezone;
            }
            else {
                $message = t('Value %value in %format format matches.', $t_args);
            }
            $actual_result = $view->field['created']
                ->advanced_render($view->result[$check_result_number]);
            $this->assertEqual($expected_result, $actual_result, $message);
        }
    }
    
    /**
     * Appends dataSet() with a data row for "today time ago" format testing.
     */
    protected function dataSet() {
        $data = parent::dataSet();
        $data[] = array(
            'name' => 'David',
            'age' => 25,
            'job' => 'Singer',
            'created' => REQUEST_TIME - 120,
        );
        return $data;
    }

}