SS_Datetime
class SS_Datetime extends Date 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 SS_Datetime::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 SS_Datetime::set_mock_now()}.
Example definition via {@link DataObject::$db}:
static $db = array(
"Expires" => "SS_Datetime",
);
Config options
| nice_format |
Properties
| string | $class | from SS_Object |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
Return TRUE if a class has a specified extension.
Add an extension to a specific class.
No description
Attemps 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
Determines if the field has a value which is not considered to be 'null' in a database context.
Check if this class is an instance of a specific class, or has that class as one of its parents
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.
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
Clears the cache for the given cacheToFile call
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.
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()}.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
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.
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
Get the class name a field on this object will be casted to
Return the string-format type for the given field.
Save the casting cache for this object (including data from any failovers) into a variable
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.
Return the value of the field without any escaping being applied.
Return the value of a field in an SQL-safe format.
Return the value of a field in a JavaScript-save format.
Return the value of a field escaped suitable to be inserted into an XML node attribute.
Return a single-item iterator so you can iterate over the fields of a single record.
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Return the directory if the current active theme (relative to the site root).
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 on the field.
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 date and time in the format specified by the config value nice_format, or 'd/m/Y g:ia' by default (e.g. '31/01/2014 2:23pm').
Return the date formatted using the given strftime formatting string.
Return a date and time formatted as per a CMS user's settings.
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
Return the nearest date in the past, based on day and month.
Returns the date and time (in 24-hour format) using the format string 'd/m/Y H:i' e.g. '28/02/2014 13:32'.
Returns the date using the format string 'd/m/Y' e.g. '28/02/2014'.
Returns the time in 12-hour format using the format string 'g:ia' e.g. '1:32pm'.
Returns the time in 24-hour format using the format string 'H:i' e.g. '13:32'.
Returns the url encoded date and time in ISO 6801 format using format string 'Y-m-d%20H:i:s' 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 SS_Object at line 60
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in SS_Object at line 132
static SS_Object
create()
An implementation of the factory method, allows you to create an instance of a class
This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use {@link Object::useCustomClass()}
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 SS_Object at line 155
static SS_Object
singleton()
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 SS_Object at line 190
static
create_from_string($classSpec, $firstArg = null)
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.
Object::create_from_string("Versioned('Stage','Live')") will return the result of
Versioned::create('Stage', 'Live);
It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.
If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.
Object::create_from_string("Varchar(50)", "MyField") will return the result of
Vachar::create('MyField', '50');
Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.
in SS_Object at line 215
static
parse_class_spec($classSpec)
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Returns a 2-elemnent array, with classname and arguments
in SS_Object at line 341
static SS_Object
strong_create()
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
in SS_Object at line 361
static
useCustomClass(string $oldClass, string $newClass, bool $strong = false)
This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}
in SS_Object at line 375
static string
getCustomClass(string $class)
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
in SS_Object at line 396
static any
static_lookup($class, $name, null $default = null)
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
in SS_Object at line 436
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 444
static
set_static($class, $name, $value)
deprecated
deprecated
in SS_Object at line 452
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 460
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
in SS_Object at line 470
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
in SS_Object at line 478
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
in SS_Object at line 494
static
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 SS_Object at line 536
static
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 SS_Object at line 594
static
remove_extension(string $extension)
Remove an extension from a class.
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 SS_Object at line 633
static array
get_extensions(string $class, bool $includeArgumentString = false)
in SS_Object at line 655
static
get_extra_config_sources($class = null)
in DBField at line 78
__construct($name = null)
in SS_Object at line 725
mixed
__call(string $method, array $arguments)
Attemps 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 SS_Object at line 792
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 SS_Object at line 802
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in SS_Object at line 963
stat($name, $uncached = false)
in SS_Object at line 970
set_stat($name, $value)
in SS_Object at line 977
uninherited($name)
in DBField at line 162
bool
exists()
Determines if the field has a value which is not considered to be 'null' in a database context.
in SS_Object at line 998
string
parentClass()
in SS_Object at line 1008
bool
is_a(string $class)
Check if this class is an instance of a specific class, or has that class as one of its parents
in DBField at line 351
string
__toString()
in SS_Object at line 1030
mixed
invokeWithExtensions(string $method, mixed $argument = null)
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 SS_Object at line 1058
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
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 SS_Object at line 1097
Extension
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in SS_Object at line 1115
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 SS_Object at line 1126
array
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).
in SS_Object at line 1142
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
in SS_Object at line 1171
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
in ViewableData at line 72
static string
castingObjectCreator(string $fieldSchema)
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
in ViewableData at line 83
static array
castingObjectCreatorPair(string $fieldSchema)
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.
in ViewableData at line 95
bool
__isset(string $property)
Check if a field exists on this object or its failover.
in ViewableData at line 117
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 138
__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 151
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 166
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 176
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 186
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 196
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 206
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 236
unknown
deprecatedCachedCall($method, $args = null, $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
in ViewableData at line 255
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 ViewableData at line 272
ViewableData
getCustomisedObj()
in ViewableData at line 279
setCustomisedObj(ViewableData $object)
in ViewableData at line 296
array
castingHelperPair(string $field)
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).
The returned array contains two keys: - className: the class the field would be casted to (e.g. "Varchar") - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
in ViewableData at line 308
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.
in ViewableData at line 331
string
castingClass(string $field)
Get the class name a field on this object will be casted to
in ViewableData at line 346
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 357
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
in ViewableData at line 394
HTMLText
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 456
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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 503
cachedCall(string $field, array $arguments = null, 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 516
bool
hasValue(string $field, array $arguments = null, 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 538
XML_val($field, $arguments = null, $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 546
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
in ViewableData at line 553
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
in ViewableData at line 560
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
in ViewableData at line 567
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
in ViewableData at line 579
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
in ViewableData at line 599
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 611
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 627
string
ThemeDir(string $subtheme = false)
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 648
string
CSSClasses(string $stopAtClass = 'ViewableData')
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 671
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DBField at line 95
static DBField
create_field(string $className, mixed $value, string $name = null, mixed $object = null)
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 114
DBField
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 130
string
getName()
Returns the name of this field.
in DBField at line 139
mixed
getValue()
Returns the value of this field.
at line 36
setValue(mixed $value, array $record = null)
Set the value on the field.
Optionally takes the whole record as an argument, to pick other values.
in DBField at line 180
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.
The field values could also be in paramaterised format, such as array('MAX(?,?)' => array(42, 69)), allowing the use of raw SQL values such as array('NOW()' => array()).
in DBField at line 200
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 216
addToQuery(SS_Query $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 220
setTable($tableName)
in DBField at line 227
string
forTemplate()
in DBField at line 231
HTMLATT()
in DBField at line 235
URLATT()
in DBField at line 239
RAWURLATT()
in DBField at line 243
ATT()
in DBField at line 247
RAW()
in DBField at line 251
JS()
in DBField at line 259
string
JSON()
Return JSON encoded value
in DBField at line 263
HTML()
in DBField at line 267
XML()
in DBField at line 277
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 284
saveInto($dataObject)
Saves this field to the given data object.
at line 144
FormField
scaffoldFormField(string $title = null, $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 317
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 330
SearchFilter
defaultSearchFilter($name = false)
at line 128
requireField()
Add the field to the underlying database.
in DBField at line 341
debug()
in DBField at line 361
boolean
scalarValueOnly()
Whatever this DBField only accepts scalar values.
Composite DBField to override this method and return false. So they can accept arrays of values.
at line 69
Nice()
Returns the date and time in the format specified by the config value nice_format, or 'd/m/Y g:ia' by default (e.g. '31/01/2014 2:23pm').
in Date at line 79
NiceUS()
Returns the date in US format: “01/18/2006”
in Date at line 86
Year()
Returns the year from the given date
in Date at line 93
Day()
Returns the Full day, of the given date.
in Date at line 100
Month()
Returns a full textual representation of a month, such as January.
in Date at line 107
ShortMonth()
Returns the short version of the month such as Jan
in Date at line 116
string
DayOfMonth($includeOrdinal = false)
Returns the day of the month.
in Date at line 127
Long()
Returns the date in the format 24 December 2006
in Date at line 134
Full()
Returns the date in the format 24 Dec 2006
in Date at line 144
string
Format(string $format)
Return the date using a particular formatting string.
in Date at line 157
FormatI18N($formattingString)
Return the date formatted using the given strftime formatting string.
strftime obeys the current LC_TIME/LC_ALL when printing lexical values like day- and month-names
at line 111
boolean
FormatFromSettings(Member $member = null)
Return a date and time formatted as per a CMS user's settings.
in Date at line 191
RangeString($otherDateObj, $includeOrdinals = false)
in Date at line 204
Rfc822()
in Date at line 208
Rfc2822()
in Date at line 212
Rfc3339()
in Date at line 235
String
Ago(boolean $includeSeconds = true, int $significance = 2)
Returns the number of seconds/minutes/hours/days or months since the timestamp.
in Date at line 261
string
TimeDiff(boolean $includeSeconds = true, int $significance = 2)
in Date at line 290
string
TimeDiffIn(string $format)
Gets the time difference, but always returns it in a certain format
in Date at line 333
boolean
InPast()
Returns true if date is in the past.
in Date at line 341
boolean
InFuture()
Returns true if date is in the future.
in Date at line 349
boolean
IsToday()
Returns true if date is today.
in Date at line 356
URLDate()
Returns a date suitable for insertion into a URL and use by the system.
in Date at line 361
days_between($fyear, $fmonth, $fday, $tyear, $tmonth, $tday)
in Date at line 365
day_before($fyear, $fmonth, $fday)
in Date at line 369
next_day($fyear, $fmonth, $fday)
in Date at line 373
weekday($fyear, $fmonth, $fday)
in Date at line 377
prior_monday($fyear, $fmonth, $fday)
in Date at line 392
static string
past_date($fmonth, $fday = 1, $fyear = null)
Return the nearest date in the past, based on day and month.
Automatically attaches the correct year.
This is useful for determining a financial year start or end date.
at line 77
string
Nice24()
Returns the date and time (in 24-hour format) using the format string 'd/m/Y H:i' e.g. '28/02/2014 13:32'.
at line 85
string
Date()
Returns the date using the format string 'd/m/Y' e.g. '28/02/2014'.
at line 93
string
Time()
Returns the time in 12-hour format using the format string 'g:ia' e.g. '1:32pm'.
at line 101
string
Time24()
Returns the time in 24-hour format using the format string 'H:i' e.g. '13:32'.
at line 140
string
URLDatetime()
Returns the url encoded date and time in ISO 6801 format using format string 'Y-m-d%20H:i:s' e.g. '2014-02-28%2013:32:22'.
at line 175
static SS_Datetime
now()
Returns either the current system date as determined by date(), or a mocked date through {@link set_mock_now()}.
at line 190
static
set_mock_now(SS_Datetime|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 204
static
clear_mock_now()
Clear any mocked date, which causes {@link Now()} to return the current system date.
at line 208
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.