Time Helper class for easy use of time data.
Manipulation of time data.
Cake\I18n\Time
format( integer|string|DateTime $date , integer|string|null $format null , boolean|string $invalid false , string|DateTimeZone|null $timezone null )
Returns a formatted date string, given either a Time instance, UNIX timestamp or a valid strtotime() date string.
This method is an alias for TimeHelper::i18nFormat().
$date
$format
optional null $invalid
optional false $timezone
optional null string
Cake\I18n\Time::i18nFormat()
fromString( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
$dateString
$timezone
optional null Cake\I18n\Time
gmt( integer|string|DateTime|null $string null )
Returns gmt as a UNIX timestamp.
$string
optional null integer
i18nFormat( integer|string|DateTime $date , string|null $format null , boolean|string $invalid false , string|DateTimeZone|null $timezone null )
Returns a formatted date string, given either a Datetime instance, UNIX timestamp or a valid strtotime() date string.
$date
$format
optional null $invalid
optional false $timezone
optional null string
Exception
Cake\I18n\Time::i18nFormat()
implementedEvents( )
Event listeners.
array
Cake\View\Helper::implementedEvents()
isFuture( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string is in the future.
$dateString
$timezone
optional null boolean
isPast( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string is in the past.
$dateString
$timezone
optional null boolean
isThisMonth( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string is within this month
$dateString
$timezone
optional null boolean
isThisWeek( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string is within this week.
$dateString
$timezone
optional null boolean
isThisYear( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string is within the current year.
$dateString
$timezone
optional null boolean
isToday( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string is today.
$dateString
$timezone
optional null boolean
isTomorrow( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string is tomorrow.
$dateString
$timezone
optional null boolean
isWithinNext( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if specified datetime is within the interval specified, else false.
$timeInterval
$dateString
$timezone
optional null boolean
Cake\I18n\Time::wasWithinLast()
nice( integer|string|DateTime|null $dateString null , string|DateTimeZone|null $timezone null , string|null $locale null )
Returns a nicely formatted date string for given Datetime string.
$dateString
optional null $timezone
optional null $locale
optional null string
timeAgoInWords( integer|string|DateTime $dateTime , array $options [] )
Formats a date into a phrase expressing the relative time.
element
- The element to wrap the formatted time in. Has a few additional options: - tag
- The tag to use, defaults to 'span'. - class
- The class name to use, defaults to time-ago-in-words
. - title
- Defaults to the $dateTime input.$dateTime
$options
optional [] string
Cake\I18n\Time::timeAgoInWords()
toAtom( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns a date formatted for Atom RSS feeds.
$dateString
$timezone
optional null string
toQuarter( integer|string|DateTime $dateString , boolean $range false )
Returns the quarter
$dateString
$range
optional false integer|array
Cake\I18n\Time::toQuarter()
toRss( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Formats date for RSS feeds
$dateString
$timezone
optional null string
toUnix( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns a UNIX timestamp from a textual datetime description.
$dateString
$timezone
optional null integer
wasWithinLast( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if specified datetime was within the interval specified, else false.
$timeInterval
$dateString
$timezone
optional null boolean
Cake\I18n\Time::wasWithinLast()
wasYesterday( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone null )
Returns true if given datetime string was yesterday.
$dateString
$timezone
optional null boolean
__call( string $method , array $params )
Provide non fatal errors on missing method calls.
$method
$params
__construct( Cake\View\View $View , array $config [] )
Default Constructor
Cake\View\View
$View
$config
optional [] __debugInfo( )
Returns an array that can be used to describe the internal state of this object.
array
__get( string $name )
Lazy loads helpers.
$name
Cake\View\Helper|null
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Returns a string to be used as onclick handler for confirm dialogs.
$message
$okCode
$cancelCode
optional '' $options
optional [] string
addClass( array $options [] , string $class null , string $key 'class' )
Adds the given class to the element options
$options
optional [] $class
optional null $key
optional 'class' array
formatTemplate( string $name , array $data )
Format a template string with $data
$name
$data
string
templater( )
templater
Cake\View\StringTemplate
templates( string|null|array $templates null )
Get/set templates to use.
$templates
optional null mixed
_configDelete( string $key )
Delete a single config key
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Read a config variable
$key
mixed
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
$key
$value
$merge
optional false Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
$key
optional null $value
optional null $merge
optional true mixed
Cake\Core\Exception\Exception
configShallow( string|array $key , mixed|null $value null )
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
$key
$value
optional null mixed
public array
Holds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']
[]
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.View.Helper.TimeHelper.html