Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Default to "yyyy-MM-dd" for date format #2841

Merged
merged 1 commit into from
Feb 17, 2014
Merged

API Default to "yyyy-MM-dd" for date format #2841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/en/changelogs/3.2.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,15 @@ use `setDisplayFolderName()` with a folder path relative to `assets/`:

UploadField::create('MyField')->setDisplayFolderName('Uploads');

### Removed format detection in i18n::$date_format and i18n::$time_format

Localized dates cause inconsistencies in client-side vs. server-side formatting
and validation, particularly in abbreviated month names. The default date
format has been changed to "yyyy-MM-dd" (e.g. 2014-12-31).
New users will continue to have the option for a localized date
format in their profile (based on their chosen locale).
If you have existing users with `Member.DateFormat` set to a format
including "MMM" or "MMMM", consider deleting those formats to fall back to
the global (and more stable) default.

### Bugfixes
6 changes: 6 additions & 0 deletions docs/en/reference/datefield.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ You can define a custom dateformat for your Datefield based on [Zend_Date consta
// will display a date in the following format: 31-06-2012
DateField::create('MyDate')->setConfig('dateformat', 'dd-MM-yyyy');

Caution: If you're using natural language date formats like abbreviated month names
alongside the "showcalendar" option, you'll need to ensure the formats
between the calendar widget and the SilverStripe validation are consistent.
As an example for the 'de' locale, check `framework/thirdparty/jquery-ui/datepicker/i18n/jquery.ui.datepicker-de.js`
and compare it to `framework/thirdparty/Zend/Locale/Data/de.xml`
(see `<calendar type="gregorian">` in the XML data).

## Min and Max Dates

Expand Down
2 changes: 1 addition & 1 deletion forms/DateField.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public function __construct($name, $title = null, $value = null) {

$this->config = $this->config()->default_config;
if(!$this->getConfig('dateformat')) {
$this->setConfig('dateformat', i18n::get_date_format());
$this->setConfig('dateformat', Config::inst()->get('i18n', 'date_format'));
}

foreach ($this->config()->default_config AS $defaultK => $defaultV) {
Expand Down
2 changes: 1 addition & 1 deletion forms/TimeField.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public function __construct($name, $title = null, $value = ""){
$this->config = $this->config()->default_config;

if(!$this->getConfig('timeformat')) {
$this->setConfig('timeformat', i18n::get_time_format());
$this->setConfig('timeformat', Config::inst()->get('i18n', 'time_format'));
}

parent::__construct($name,$title,$value);
Expand Down
14 changes: 6 additions & 8 deletions i18n/i18n.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,13 @@ class i18n extends Object implements TemplateGlobalProvider {
* @config
* @var string
*/
private static $date_format;
private static $date_format = 'yyyy-MM-dd';

/**
* @config
* @var string
*/
private static $time_format;
private static $time_format = 'H:mm';

/**
* @var array Array of priority keys to instances of Zend_Translate, mapped by name.
Expand Down Expand Up @@ -141,9 +141,8 @@ public static function set_date_format($format) {
* @return string ISO date format
*/
public static function get_date_format() {
require_once 'Zend/Date.php';
$dateFormat = Config::inst()->get('i18n', 'date_format');
return ($dateFormat) ? $dateFormat : Zend_Locale_Format::getDateFormat(self::get_locale());
Deprecation::notice('3.2', 'Use the "i18n.date_format" config setting instead');
return Config::inst()->get('i18n', 'date_format');
}

/**
Expand All @@ -159,9 +158,8 @@ public static function set_time_format($format) {
* @return string ISO time format
*/
public static function get_time_format() {
require_once 'Zend/Date.php';
$timeFormat = Config::inst()->get('i18n', 'time_format');
return ($timeFormat) ? $timeFormat : Zend_Locale_Format::getTimeFormat(self::get_locale());
Deprecation::notice('3.2', 'Use the "i18n.time_format" config setting instead');
return Config::inst()->get('i18n', 'time_format');
}

/**
Expand Down
25 changes: 10 additions & 15 deletions security/Member.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1009,11 +1009,8 @@ public function splitName($name) {
public function getDateFormat() {
if($this->getField('DateFormat')) {
return $this->getField('DateFormat');
} elseif($this->getField('Locale')) {
require_once 'Zend/Date.php';
return Zend_Locale_Format::getDateFormat($this->Locale);
} else {
return i18n::get_date_format();
return Config::inst()->get('i18n', 'date_format');
}
}

Expand All @@ -1027,11 +1024,8 @@ public function getDateFormat() {
public function getTimeFormat() {
if($this->getField('TimeFormat')) {
return $this->getField('TimeFormat');
} elseif($this->getField('Locale')) {
require_once 'Zend/Date.php';
return Zend_Locale_Format::getTimeFormat($this->Locale);
} else {
return i18n::get_time_format();
return Config::inst()->get('i18n', 'time_format');
}
}

Expand Down Expand Up @@ -1265,15 +1259,16 @@ public function getCMSFields() {
$permissionsTab = $fields->fieldByName("Root")->fieldByName('Permissions');
if($permissionsTab) $permissionsTab->addExtraClass('readonly');

$defaultDateFormat = Zend_Locale_Format::getDateFormat(new Zend_Locale($this->Locale));
$localDateFormat = Zend_Locale_Data::getContent(new Zend_Locale($this->Locale), 'date', 'short');
// Ensure short dates always use four digit dates to avoid confusion
$localDateFormat = preg_replace('/(^|[^y])yy($|[^y])/', '$1yyyy$2', $localDateFormat);
$dateFormatMap = array(
'MMM d, yyyy' => Zend_Date::now()->toString('MMM d, yyyy'),
$this->DateFormat => Zend_Date::now()->toString($this->DateFormat),
$localDateFormat => Zend_Date::now()->toString($localDateFormat),
'yyyy/MM/dd' => Zend_Date::now()->toString('yyyy/MM/dd'),
'MM/dd/yyyy' => Zend_Date::now()->toString('MM/dd/yyyy'),
'dd/MM/yyyy' => Zend_Date::now()->toString('dd/MM/yyyy'),
);
$dateFormatMap[$defaultDateFormat] = Zend_Date::now()->toString($defaultDateFormat)
. sprintf(' (%s)', _t('Member.DefaultDateTime', 'default'));
$mainFields->push(
$dateFormatField = new MemberDatetimeOptionsetField(
'DateFormat',
Expand All @@ -1283,13 +1278,13 @@ public function getCMSFields() {
);
$dateFormatField->setValue($this->DateFormat);

$defaultTimeFormat = Zend_Locale_Format::getTimeFormat(new Zend_Locale($this->Locale));
$localTimeFormat = Zend_Locale_Format::getTimeFormat(new Zend_Locale($this->Locale));
$timeFormatMap = array(
$this->TimeFormat => Zend_Date::now()->toString($this->TimeFormat),
$localTimeFormat => Zend_Date::now()->toString($localTimeFormat),
'h:mm a' => Zend_Date::now()->toString('h:mm a'),
'H:mm' => Zend_Date::now()->toString('H:mm'),
);
$timeFormatMap[$defaultTimeFormat] = Zend_Date::now()->toString($defaultTimeFormat)
. sprintf(' (%s)', _t('Member.DefaultDateTime', 'default'));
$mainFields->push(
$timeFormatField = new MemberDatetimeOptionsetField(
'TimeFormat',
Expand Down
6 changes: 4 additions & 2 deletions tests/forms/MemberDatetimeOptionsetFieldTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ protected function createDateFormatFieldForMember($member) {
require_once 'Zend/Date.php';
$defaultDateFormat = Zend_Locale_Format::getDateFormat($member->Locale);
$dateFormatMap = array(
'MMM d, yyyy' => Zend_Date::now()->toString('MMM d, yyyy'),
'yyyy-MM-dd' => Zend_Date::now()->toString('yyyy-MM-dd'),
'yyyy/MM/dd' => Zend_Date::now()->toString('yyyy/MM/dd'),
'MM/dd/yyyy' => Zend_Date::now()->toString('MM/dd/yyyy'),
'dd/MM/yyyy' => Zend_Date::now()->toString('dd/MM/yyyy'),
Expand Down Expand Up @@ -44,15 +44,17 @@ protected function createTimeFormatFieldForMember($member) {
}

public function testDateFormatDefaultCheckedInFormField() {
Config::inst()->update('i18n', 'date_format', 'yyyy-MM-dd');
$field = $this->createDateFormatFieldForMember($this->objFromFixture('Member', 'noformatmember'));
$field->setForm(new Form(new MemberDatetimeOptionsetFieldTest_Controller(), 'Form', new FieldList(),
new FieldList())); // fake form
$parser = new CSSContentParser($field->Field());
$xmlArr = $parser->getBySelector('#Form_Form_DateFormat_MMM_d__y');
$xmlArr = $parser->getBySelector('#Form_Form_DateFormat_yyyy-MM-dd');
$this->assertEquals('checked', (string) $xmlArr[0]['checked']);
}

public function testTimeFormatDefaultCheckedInFormField() {
Config::inst()->update('i18n', 'time_format', 'h:mm:ss a');
$field = $this->createTimeFormatFieldForMember($this->objFromFixture('Member', 'noformatmember'));
$field->setForm(new Form(new MemberDatetimeOptionsetFieldTest_Controller(), 'Form', new FieldList(),
new FieldList())); // fake form
Expand Down
30 changes: 0 additions & 30 deletions tests/i18n/i18nTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,36 +65,6 @@ public function tearDown() {
parent::tearDown();
}

public function testDateFormatFromLocale() {
i18n::set_locale('en_US');
$this->assertEquals('MMM d, y', i18n::get_date_format());
i18n::set_locale('en_NZ');
$this->assertEquals('d/MM/yyyy', i18n::get_date_format());
i18n::set_locale('en_US');
}

public function testTimeFormatFromLocale() {
i18n::set_locale('en_US');
$this->assertEquals('h:mm:ss a', i18n::get_time_format());
i18n::set_locale('de_DE');
$this->assertEquals('HH:mm:ss', i18n::get_time_format());
i18n::set_locale('en_US');
}

public function testDateFormatCustom() {
i18n::set_locale('en_US');
$this->assertEquals('MMM d, y', i18n::get_date_format());
i18n::config()->date_format = 'd/MM/yyyy';
$this->assertEquals('d/MM/yyyy', i18n::get_date_format());
}

public function testTimeFormatCustom() {
i18n::set_locale('en_US');
$this->assertEquals('h:mm:ss a', i18n::get_time_format());
i18n::config()->time_format = 'HH:mm:ss';
$this->assertEquals('HH:mm:ss', i18n::get_time_format());
}

public function testGetExistingTranslations() {
$translations = i18n::get_existing_translations();
$this->assertTrue(isset($translations['en_US']), 'Checking for en translation');
Expand Down
14 changes: 5 additions & 9 deletions tests/security/MemberTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,17 +320,13 @@ public function testIsPasswordExpired() {
}

public function testMemberWithNoDateFormatFallsbackToGlobalLocaleDefaultFormat() {
Config::inst()->update('i18n', 'date_format', 'yyyy-MM-dd');
Config::inst()->update('i18n', 'time_format', 'H:mm');
$member = $this->objFromFixture('Member', 'noformatmember');
$this->assertEquals('MMM d, y', $member->DateFormat);
$this->assertEquals('h:mm:ss a', $member->TimeFormat);
$this->assertEquals('yyyy-MM-dd', $member->DateFormat);
$this->assertEquals('H:mm', $member->TimeFormat);
}

public function testMemberWithNoDateFormatFallsbackToTheirLocaleDefaultFormat() {
$member = $this->objFromFixture('Member', 'delocalemember');
$this->assertEquals('dd.MM.yyyy', $member->DateFormat);
$this->assertEquals('HH:mm:ss', $member->TimeFormat);
}


public function testInGroups() {
$staffmember = $this->objFromFixture('Member', 'staffmember');
$managementmember = $this->objFromFixture('Member', 'managementmember');
Expand Down