Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
492 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Contributing | ||
|
||
Any open source product is only as good as the community behind it. You can participate by sharing code, ideas, or simply helping others. No matter what your skill level is, every contribution counts. | ||
|
||
See our [high level overview](http://silverstripe.org/contributing-to-silverstripe) on silverstripe.org on how you can help out. | ||
|
||
Or, for more detailed guidance, read one of the following pages: | ||
|
||
* [Sharing your opinion and raising issues](http://doc.silverstripe.org/framework/en/trunk/misc/contributing/issues) | ||
* [Providing code, whether it's creating a feature or fixing a bug](http://doc.silverstripe.org/framework/en/trunk/misc/contributing/code) | ||
* [Writing and translating documentation](http://doc.silverstripe.org/framework/en/trunk/misc/contributing/documentation) | ||
* [Translating user-interface elements](http://doc.silverstripe.org/framework/en/trunk/misc/contributing/translation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
# DateField | ||
|
||
## Introduction | ||
|
||
This `FormField` subclass lets you display an editable date, either in | ||
a single text input field, or in three separate fields for day, month and year. | ||
It also provides a calendar datepicker. | ||
|
||
## Adding a DateField | ||
|
||
The following example will add a simple DateField to your Page, allowing you to | ||
enter a date manually. | ||
|
||
:::php | ||
class Page extends SiteTree { | ||
static $db = array( | ||
'MyDate' => 'Date', | ||
); | ||
|
||
public function getCMSFields() { | ||
$fields = parent::getCMSFields(); | ||
$fields->addFieldToTab( | ||
'Root.Main', | ||
$myDate = new DateField('MyDate', 'Enter a date') | ||
); | ||
return $fields; | ||
} | ||
} | ||
|
||
## Custom Dateformat | ||
|
||
You can define a custom dateformat for your Datefield based on [Zend_Date constants](http://framework.zend.com/manual/1.12/en/zend.date.constants.html). | ||
|
||
:::php | ||
// will display a date in the following format: 31-06-2012 | ||
DateField::create('MyDate')->setConfig('dateformat', 'dd-MM-yyyy'); | ||
|
||
|
||
## Min and Max Dates | ||
|
||
Set the minimum and maximum allowed datevalues using the `min` and `max` | ||
configuration settings (in ISO format or strtotime() compatible). Example: | ||
|
||
:::php | ||
DateField::create('MyDate') | ||
->setConfig('min', '-7 days') | ||
->setConfig('max', '2012-12-31') | ||
## Separate Day/Month/Year Fields | ||
|
||
The following setting will display your DateField as `three input fields` for | ||
day, month and year separately. Any custom dateformat settings will be ignored. | ||
HTML5 placeholders 'day', 'month' and 'year' are enabled by default. | ||
|
||
:::php | ||
DateField::create('MyDate') | ||
->setConfig('dmyfields', true); | ||
->setConfig('dmyseparator', '/') // set the separator | ||
->setConfig('dmyplaceholders', 'true'); // enable HTML 5 Placeholders | ||
|
||
## Calendar Field | ||
|
||
The following setting will add a Calendar to a single DateField, using the | ||
`jQuery UI DatePicker widget` | ||
|
||
:::php | ||
DateField::create('MyDate')->setConfig('showcalendar', true); | ||
|
||
|
||
### 'Safe' Dateformats to Use with the Calendar | ||
|
||
The jQuery DatePicker doesn't support every constant available for Zend_Date. | ||
If you choose to use the calendar, the following constants should at least be safe: | ||
|
||
Constant | xxxxx | ||
-------- | ----- | ||
d | numeric day of the month (without leading zero) | ||
dd | numeric day of the month (with leading zero) | ||
EEE | dayname, abbreviated | ||
EEEE | dayname | ||
M | numeric month of the year (without leading zero) | ||
MM | numeric month of the year (with leading zero) | ||
MMM | monthname, abbreviated | ||
MMMM | monthname | ||
y | year (4 digits) | ||
yy | year (2 digits) | ||
yyyy | year (4 digits) | ||
|
||
### Calendar localization issues | ||
|
||
Unfortunately the day- and monthname values in Zend Date do not always match | ||
those in the existing jQuery UI locale files, so constants like `EEE` or `MMM`, | ||
for day and monthnames could break validation. To fix this we had to slightly | ||
alter the jQuery locale files, situated in | ||
*/framework/thirdparty/jquery-ui/datepicker/i18n/*, to match Zend_Date. | ||
|
||
At this moment not all locale files may be present. If a locale file is | ||
missing, the DatePicker calendar will fallback to 'yyyy-MM-dd' whenever day- | ||
and/or monthnames are used. After saving, the correct format will be displayed. | ||
|
||
## Contributing jQuery Locale Files | ||
|
||
If you find the jQuery locale file for your chosen locale is missing, the | ||
following section will explain how to create one. If you wish to contribute | ||
your file to the SilverStripe core, please check out the guide on | ||
['contributing code'](http://doc.silverstripe.org/framework/en/trunk/misc/contributing/code). | ||
|
||
### 1. Get the Sourcefile | ||
|
||
You can find a list of locale files for the jQuery UI DatePicker | ||
[in the jQuery source code](https://github.com/jquery/jquery-ui/tree/master/ui/i18n). | ||
|
||
### 2. Find your Zend Locale File | ||
|
||
The Zend locale files are located in */framework/thirdparty/Zend/Locale/Data/*. | ||
Find the one that has the information for your locale. | ||
|
||
### 3. Find the Date Values | ||
|
||
You're looking for the `Gregorian` date values for monthnames and daynames in | ||
the Zend locale file. Edit the DatePicker locale File so your *full day- and | ||
monthnames* and *short monthnames* match. For your *short daynames*, use the | ||
first three characters of the full name. Note that Zend dates are `case | ||
sensitive`! | ||
|
||
### 4. Filename | ||
|
||
Use the original jQuery UI filename 'jquery.ui.datepicker-xx.js', where xx | ||
stands for the locale. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.