DBDatetime
class DBDatetime extends DBDate implements TemplateGlobalProvider
Represents a date-time field.
The field currently supports New Zealand date format (DD/MM/YYYY), or an ISO 8601 formatted date and time (Y-m-d H:i:s). Alternatively you can set a timestamp that is evaluated through PHP's built-in date() and strtotime() function according to your system locale.
For all computations involving the current date and time, please use {@link DBDatetime::now()} instead of PHP's built-in date() and time() methods. This ensures that all time-based computations are testable with mock dates through {@link DBDatetime::set_mock_now()}.
Example definition via {@link DataObject::$db}:
static $db = array(
"Expires" => "DBDatetime",
);
Traits
Constants
| ISO_DATE |
Standard ISO format string for date in CLDR standard format |
| ISO_LOCALE |
Fixed locale to use for ISO date formatting. This is necessary to prevent locale-specific numeric localisation breaking internal date strings. |
| ISO_DATETIME |
Standard ISO format string for date and time in CLDR standard format, with a whitespace separating date and time (common database representation, e.g. in MySQL). |
| ISO_DATETIME_NORMALISED |
Standard ISO format string for date and time in CLDR standard format, with a "T" separator between date and time (W3C standard, e.g. for HTML5 datetime-local fields). |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
Gets the uninherited value for the given config option
Provide the DBField name and an array of options, e.g. ['index' => true], or ['nullifyEmpty' => false]
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
Set a failover object to attempt to get data from if it is not present on this object.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Determines if the field has a value which is not considered to be 'null' in a database context.
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Get an array of XML-escaped values by field name
Return a single-item iterator so you can iterate over the fields of a single record.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Create a DBField object that's not bound to any particular field.
Set the value of this field in various formats.
Return the desired index type to use. Will return false if the field instance should not be indexed.
Return the transformed value ready to be sent to the database. This value will be escaped automatically by the prepared query processor, so it should not be escaped or quoted at all.
Prepare the current field for usage in a database-manipulation (works on a manipulation reference).
Add custom query parameters for this field, mostly SELECT statements for multi-value fields.
Returns a FormField instance used as a default for form scaffolding.
Returns a FormField instance used as a default for searchform scaffolding.
Add the field to the underlying database.
Returns the index specifications for the field instance, for example:
Get date / time formatter for the current locale
Return formatter in a given locale. Useful if localising in a format other than the current locale.
Get standard ISO date format string
Return the date using a particular formatting string. Use {o} to include an ordinal representation for the day of the month ("1st", "2nd", "3rd" etc)
Return a date and time formatted as per a CMS user's settings.
Return a string in the form "12 - 16 Sept" or "12 Aug - 16 Sept"
Returns the number of seconds/minutes/hours/days or months since the timestamp.
Gets the time difference, but always returns it in a certain format
Adjusts the current instance by the given adjustment, in a PHP strtotime() style date/time modifier.
Returns a date suitable for insertion into a URL and use by the system.
Returns the standard localised date
Returns the standard localised time
Returns the time in 12-hour format using the format string 'h:mm a' e.g. '1:32 pm'.
Returns the time in 24-hour format using the format string 'H:mm' e.g. '13:32'.
Returns the url encoded date and time in ISO 6801 format using format string 'y-MM-dd%20HH:mm:ss' e.g. '2014-02-28%2013:32:22'.
Returns either the current system date as determined by date(), or a mocked date through {@link set_mock_now()}.
Mock the system date temporarily, which is useful for time-based unit testing.
Clear any mocked date, which causes {@link Now()} to return the current system date.
Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template
Details
in CustomMethods at line 50
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 144
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
in CustomMethods at line 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in Extensible at line 224
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in Extensible at line 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
in Extensible at line 395
array
invokeWithExtensions(string $method, mixed $arguments)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 424
array
extend(string $method, mixed $arguments)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
in Extensible at line 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 508
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
in Injectable at line 26
static Injectable
create(array $args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
in Injectable at line 43
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
in Configurable at line 57
$this
set_stat(string $name, mixed $value)
deprecated
deprecated 5.0 Use ->config()->set() instead
Update the config value for a given property
in DBField at line 137
__construct(string $name = null, array $options = [])
Provide the DBField name and an array of options, e.g. ['index' => true], or ['nullifyEmpty' => false]
in ViewableData at line 106
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
in ViewableData at line 129
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 152
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
in ViewableData at line 167
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 194
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 205
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 217
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 232
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
in ViewableData at line 258
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
in DBField at line 328
bool
exists()
Determines if the field has a value which is not considered to be 'null' in a database context.
in DBField at line 610
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(ViewableData $object)
in ViewableData at line 320
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 389
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
in ViewableData at line 471
Object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
in ViewableData at line 516
Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in ViewableData at line 530
bool
hasValue(string $field, array $arguments = [], bool $cache = true)
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
in ViewableData at line 545
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
in ViewableData at line 579
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
in ViewableData at line 592
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
in ViewableData at line 603
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 620
string
ThemeDir()
deprecated
deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
in ViewableData at line 647
string
CSSClasses(string $stopAtClass = self::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DBField at line 164
static DBField
create_field(string $spec, mixed $value, string $name = null, mixed $args)
Create a DBField object that's not bound to any particular field.
Useful for accessing the classes behaviour for other parts of your code.
in DBField at line 192
$this
setName(string $name)
Set the name of this field.
The name should never be altered, but it if was never given a name in the first place you can set a name.
If you try an alter the name a warning will be thrown.
in DBField at line 209
string
getName()
Returns the name of this field.
in DBField at line 219
mixed
getValue()
Returns the value of this field.
in DBDate at line 43
$this
setValue(mixed $value, DataObject|array $record = null, bool $markChanged = true)
Set the value of this field in various formats.
Used by {@link DataObject->getField()}, {@link DataObject->setCastedField()} {@link DataObject->dbObject()} and {@link DataObject->write()}.
As this method is used both for initializing the field after construction, and actually changing its values, it needs a {@link $markChanged} parameter.
in DBField at line 251
mixed
getDefaultValue()
Get default value assigned at the DB level
in DBField at line 262
$this
setDefaultValue(mixed $defaultValue)
Set default value to use at the DB level
in DBField at line 274
$this
setOptions(array $options = [])
Update the optional parameters for this field
in DBField at line 285
array
getOptions()
Get optional parameters for this field
in DBField at line 290
$this
setIndexType($type)
Set the desired index type to use
in DBField at line 304
string|bool
getIndexType()
Return the desired index type to use. Will return false if the field instance should not be indexed.
in DBField at line 341
mixed
prepValueForDB($value)
Return the transformed value ready to be sent to the database. This value will be escaped automatically by the prepared query processor, so it should not be escaped or quoted at all.
in DBField at line 366
writeToManipulation(array $manipulation)
Prepare the current field for usage in a database-manipulation (works on a manipulation reference).
Make value safe for insertion into a SQL SET statement by applying addslashes() - can also be used to apply special SQL-commands to the raw value (e.g. for GIS functionality). {see prepValueForDB}
in DBField at line 383
addToQuery(SQLSelect $query)
Add custom query parameters for this field, mostly SELECT statements for multi-value fields.
By default, the ORM layer does a
SELECT
in DBField at line 393
$this
setTable(string $tableName)
Assign this DBField to a table
in DBField at line 404
string|null
getTable()
Get the table this field belongs to, if assigned
in DBField at line 414
string
forTemplate()
Determine 'default' casting for this field.
in DBField at line 425
string
HTMLATT()
Gets the value appropriate for a HTML attribute string
in DBField at line 435
string
URLATT()
urlencode this string
in DBField at line 445
string
RAWURLATT()
rawurlencode this string
in DBField at line 455
string
ATT()
Gets the value appropriate for a HTML attribute string
in DBField at line 466
mixed
RAW()
Gets the raw value for this field.
Note: Skips processors implemented via forTemplate()
in DBField at line 476
string
JS()
Gets javascript string literal value
in DBField at line 486
string
JSON()
Return JSON encoded value
in DBField at line 496
string
HTML()
Alias for {see XML()}
in DBField at line 506
string
XML()
XML encode this value
in DBField at line 516
string
CDATA()
Safely escape for XML string
in DBField at line 527
mixed
nullValue()
Returns the value to be set in the database to blank this field.
Usually it's a choice between null, 0, and ''
in DBField at line 537
saveInto(DataObject $dataObject)
Saves this field to the given data object.
at line 140
FormField
scaffoldFormField(string $title = null, array $params = null)
Returns a FormField instance used as a default for form scaffolding.
Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}
in DBField at line 572
FormField
scaffoldSearchField(string $title = null)
Returns a FormField instance used as a default for searchform scaffolding.
Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}.
in DBField at line 587
SearchFilter
defaultSearchFilter(string $name = null)
at line 116
requireField()
Add the field to the underlying database.
in DBField at line 599
debug()
in DBField at line 618
array
getArrayValue()
in DBField at line 627
$this
setArrayValue(array $value)
in DBField at line 638
string|array
getSchemaValue()
Get formfield schema value
in DBField at line 643
array
getIndexSpecs()
Returns the index specifications for the field instance, for example:
[
'type' => 'unique',
'columns' => ['FieldName']
]
in DBField at line 661
boolean
scalarValueOnly()
Whether or not this DBField only accepts scalar values.
Composite DBFields can override this method and return false so they can accept arrays of values.
in DBDate at line 95
string
Nice()
Returns the standard localised medium date
in DBDate at line 109
string
Year()
Returns the year from the given date
in DBDate at line 119
string
DayOfWeek()
Returns the day of the week
in DBDate at line 129
string
Month()
Returns a full textual representation of a month, such as January.
in DBDate at line 139
string
ShortMonth()
Returns the short version of the month such as Jan
in DBDate at line 150
string
DayOfMonth(bool $includeOrdinal = false)
Returns the day of the month.
in DBDate at line 165
string
Short()
Returns the date in the localised short format
in DBDate at line 179
string
Long()
Returns the date in the localised long format
in DBDate at line 193
string
Full()
Returns the date in the localised full format
at line 226
IntlDateFormatter
getFormatter(int $dateLength = IntlDateFormatter::MEDIUM, int $timeLength = IntlDateFormatter::SHORT)
Get date / time formatter for the current locale
at line 241
IntlDateFormatter
getCustomFormatter(string|null $locale = null, string|null $pattern = null, int $dateLength = IntlDateFormatter::MEDIUM, int $timeLength = IntlDateFormatter::MEDIUM)
Return formatter in a given locale. Useful if localising in a format other than the current locale.
at line 268
string
getISOFormat()
Get standard ISO date format string
in DBDate at line 268
string
Format($format)
Return the date using a particular formatting string. Use {o} to include an ordinal representation for the day of the month ("1st", "2nd", "3rd" etc)
in DBDate at line 291
int
getTimestamp()
Get unix timestamp for this date
at line 98
boolean
FormatFromSettings(Member $member = null)
Return a date and time formatted as per a CMS user's settings.
in DBDate at line 327
string
RangeString(DBDate $otherDateObj, bool $includeOrdinals = false)
Return a string in the form "12 - 16 Sept" or "12 Aug - 16 Sept"
in DBDate at line 350
string
Rfc822()
Return string in RFC822 format
in DBDate at line 363
string
Rfc2822()
Return date in RFC2822 format
in DBDate at line 375
string
Rfc3339()
Date in RFC3339 format
in DBDate at line 387
string
Ago(boolean $includeSeconds = true, int $significance = 2)
Returns the number of seconds/minutes/hours/days or months since the timestamp.
in DBDate at line 416
string
TimeDiff(boolean $includeSeconds = true, int $significance = 2)
in DBDate at line 449
string
TimeDiffIn(string $format)
Gets the time difference, but always returns it in a certain format
in DBDate at line 523
boolean
InPast()
Returns true if date is in the past.
in DBDate at line 532
boolean
InFuture()
Returns true if date is in the future.
in DBDate at line 541
boolean
IsToday()
Returns true if date is today.
in DBDate at line 558
modify(string $adjustment)
Adjusts the current instance by the given adjustment, in a PHP strtotime() style date/time modifier.
Example:
DBDatetime::now()->modify('+ 3 days')->Format()
DBDatetime::now()->modify('-10 weeks')->Format()
in DBDate at line 569
string
URLDate()
Returns a date suitable for insertion into a URL and use by the system.
at line 55
string
Date()
Returns the standard localised date
at line 66
string
Time()
Returns the standard localised time
at line 77
string
Time12()
Returns the time in 12-hour format using the format string 'h:mm a' e.g. '1:32 pm'.
at line 87
string
Time24()
Returns the time in 24-hour format using the format string 'H:mm' e.g. '13:32'.
at line 135
string
URLDatetime()
Returns the url encoded date and time in ISO 6801 format using format string 'y-MM-dd%20HH:mm:ss' e.g. '2014-02-28%2013:32:22'.
at line 171
static DBDatetime
now()
Returns either the current system date as determined by date(), or a mocked date through {@link set_mock_now()}.
at line 191
static
set_mock_now(DBDatetime|string $datetime)
Mock the system date temporarily, which is useful for time-based unit testing.
Use {@link clear_mock_now()} to revert to the current system date. Caution: This sets a fixed date that doesn't increment with time.
at line 207
static
clear_mock_now()
Clear any mocked date, which causes {@link Now()} to return the current system date.
at line 212
static array
get_template_global_variables()
Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template
If the method to call is not included for a particular template variable, a method named the same as the template variable will be called
If the casting class is not specified for a particular template variable, ViewableData::$default_cast is used
The first letter of the template variable is case-insensitive. However the method name is always case sensitive.