Класс TimeHelper
Класс Time Helper для удобной работы с данными времени.
Обработка данных времени.
- AppHelper
-
TimeHelper
Ссылка: https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html
См.:
CakeTimeАвторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/TimeHelper.php
Краткое описание свойств
- Экземпляр CakeTime
$_engineprotected
Краткое описание методов
- __call() publicВызов методов из утилиты CakeTime
- __construct() publicКонструктор
- __get() publicМагический аксессор для устаревших атрибутов.
- __isset() publicМагическая проверка isset для устаревших атрибутов.
- __set() publicМагический аксессор для устаревших атрибутов.
- convert() publicПреобразует заданное время (в часовом поясе сервера) в локальное время пользователя, учитывая его часовой пояс.
- convertSpecifiers() public
Преобразует строку, представляющую формат для функции strftime, и возвращает формат, совместимый с Windows и учитывающий i18n.
- dayAsSql() public
Возвращает частичную SQL-строку для поиска всех записей между двумя моментами времени, которые происходят в один и тот же день.
- daysAsSql() publicВозвращает частичную SQL-строку для поиска всех записей между двумя датами.
- format() public
Возвращает отформатированную строку даты, используя либо временную метку Unix, либо допустимую строку даты для strtotime(). Эта функция также принимает строку времени и строку формата в качестве первого и второго параметров. В этом случае эта функция работает как обёртка для TimeHelper::i18nFormat()
- fromString() publicВозвращает временную метку Unix, используя либо временную метку Unix, либо допустимую строку даты для strtotime().
- gmt() publicВозвращает GMT в виде временной метки Unix.
- i18nFormat() public
Возвращает отформатированную строку даты, используя либо временную метку Unix, либо допустимую строку даты для strtotime(). Она учитывает формат даты по умолчанию для текущего языка, если используется файл LC_TIME.
- isThisMonth() publicВозвращает true, если заданная строка даты находится в этом месяце
- isThisWeek() publicВозвращает true, если заданная строка даты находится на этой неделе.
- isThisYear() publicВозвращает true, если заданная строка даты находится в текущем году.
- isToday() publicВозвращает true, если заданная строка даты — сегодня.
- isTomorrow() publicВозвращает true, если заданная строка даты — завтра.
- isWithinNext() publicВозвращает true, если заданная дата находится в указанном интервале, иначе false.
- nice() publicВозвращает отформатированную строку даты для заданной строки Datetime.
- niceShort() publicВозвращает отформатированную описательную строку даты для заданной строки даты и времени.
- serverOffset() publicВозвращает смещение сервера
- timeAgoInWords() publicФорматирует дату в фразу, выражающую относительное время.
- toAtom() publicВозвращает дату, отформатированную для лент Atom RSS.
- toQuarter() publicВозвращает квартал
- toRSS() publicФорматирует дату для лент RSS
- toUnix() publicВозвращает временную метку Unix из текстового описания даты и времени. Обёртка для функции PHP strtotime().
- wasWithinLast() publicВозвращает true, если заданная дата была в указанном интервале, иначе false.
- wasYesterday() publicВозвращает true, если заданная строка даты — вчера.
Подробное описание методов
__call()source public
__call( string $method , array $params )
Вызов методов из утилиты CakeTime
Параметры
- строка
$method - Метод для вызова.
- массив
$params - Параметры для передачи методу.
Возвращаемое значение
смешанноеРезультат вызываемого метода или false при ошибке
__construct()source public
__construct( View $View , array $settings array() )
Конструктор
Настройки:
-
engineИмя класса, используемого для замены функциональности CakeTime. Класс должен быть размещён в каталогеUtility.
Параметры
-
View$View - объект представления, к которому прикреплён помощник.
- массив
$settingsнеобязательно array() - Массив настроек
Исключения
CakeExceptionКогда класс движка не может быть найден.
__get()source public
__get( string $name )
Магический аксессор для устаревших атрибутов.
Параметры
- строка
$name - Имя атрибута для получения.
Возвращаемое значение
смешанное__isset()source public
__isset( string $name )
Магическая проверка isset для устаревших атрибутов.
Параметры
- строка
$name - Имя атрибута для проверки.
Возвращаемое значение
boolean|null__set()source public
__set( string $name , string $value )
Магический аксессор для устаревших атрибутов.
Параметры
- строка
$name - Имя атрибута для задания.
- строка
$value - Значение атрибута для задания.
convert()source public
convert( string $serverTime , string|DateTimeZone $timezone )
Преобразует заданное время (в часовом поясе сервера) в локальное время пользователя, учитывая его часовой пояс.
Параметры
- строка
$serverTime - Временная метка Unix
- строка|DateTimeZone
$timezone - Строка часового пояса пользователя или объект DateTimeZone
Возвращаемое значение
целое числоВременная метка Unix
См.
CakeTime::convert()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingconvertSpecifiers()source public
convertSpecifiers( string $format , string $time null )
Преобразует строку, представляющую формат для функции strftime, и возвращает формат, совместимый с Windows и учитывающий локализацию.
Параметры
- строка
$format Формат со спецификаторами для функции strftime. Принимает специальный спецификатор %S, который имитирует модификатор S для date()
- строка
$timeнеобязательно null - Маркер времени Unix
Возвращает
строкаФормат, совместимый с функцией strftime, безопасный для Windows и совместимый с функцией date()
См. также
CakeTime::convertSpecifiers()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingdayAsSql()source public
dayAsSql( integer|string|DateTime $dateString , string $fieldName , string|DateTimeZone $timezone null )
Возвращает частичную строку SQL для поиска всех записей между двумя моментами времени, которые происходят в один и тот же день.
Параметры
- целое число/строка/DateTime
$dateString - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- строка
$fieldName - Имя поля базы данных для сравнения
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
строкаЧастичная строка SQL.
См. также
CakeTime::dayAsSql()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingdaysAsSql()source public
daysAsSql( integer|string|DateTime $begin , integer|string|DateTime $end , string $fieldName , string|DateTimeZone $timezone null )
Возвращает частичную строку SQL для поиска всех записей между двумя датами.
Параметры
- целое число/строка/DateTime
$begin - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- целое число/строка/DateTime
$end - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- строка
$fieldName - Имя поля базы данных для сравнения
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
строкаЧастичная строка SQL.
См. также
CakeTime::daysAsSql()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingformat()source public
format( integer|string|DateTime $format , integer|string|DateTime $date null , boolean $invalid false , string|DateTimeZone $timezone null )
Возвращает отформатированную строку даты, заданную либо маркером времени Unix, либо допустимой строкой даты для strtotime(). Эта функция также принимает строку времени и строку формата в качестве первых двух параметров. В этом случае функция ведет себя как обертка для TimeHelper::i18nFormat()
Примеры
Создание локализованного и отформатированного времени:
$this->Time->format('2012-02-15', '%m-%d-%Y'); // returns 02-15-2012
$this->Time->format('2012-02-15 23:01:01', '%c'); // returns preferred date and time based on configured locale
$this->Time->format('0000-00-00', '%d-%m-%Y', 'N/A'); // return N/A because an invalid date was passed
$this->Time->format('2012-02-15 23:01:01', '%c', 'N/A', 'America/New_York'); // converts passed date to timezone Параметры
- целое число/строка/DateTime
$format - строка формата даты (или маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime)
- целое число/строка/DateTime
$dateнеобязательно null - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime (или строка формата даты)
- логическое значение
$invalidнеобязательно false - флаг для игнорирования результатов fromString == false
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
строкаОтформатированная строка даты
См. также
CakeTime::format()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingfromString()source public
fromString( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает маркер времени Unix, заданный либо маркером времени Unix, либо допустимой строкой даты для strtotime().
Параметры
- целое число/строка/DateTime
$dateString - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
строкаРаспарсенный маркер времени
См. также
CakeTime::fromString()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattinggmt()source public
gmt( integer|string|DateTime $string null )
Возвращает GMT в виде маркера времени Unix.
Параметры
- целое число/строка/DateTime
$stringнеобязательно null - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
Возвращает
целое числоМаркер времени Unix
См. также
CakeTime::gmt()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingi18nFormat()source public
i18nFormat( integer|string|DateTime $date , string $format null , boolean $invalid false , string|DateTimeZone $timezone null )
Возвращает отформатированную строку даты, заданную либо маркером времени Unix, либо допустимой строкой даты для strtotime(). Учитывает формат даты по умолчанию для текущего языка, если используется файл LC_TIME.
Параметры
- целое число/строка/DateTime
$date - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- строка
$formatнеобязательно null - Строка формата strftime.
- логическое значение
$invalidнеобязательно false - Флаг для игнорирования результатов fromString == false
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
строкаОтформатированная и переведенная строка даты
См. также
CakeTime::i18nFormat()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingisThisMonth()source public
isThisMonth( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если заданная строка datetime находится в текущем месяце
Параметры
- целое число/строка/DateTime
$dateString - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
логическое значениеTrue, если строка datetime находится в текущем месяце
См. также
CakeTime::isThisMonth()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timeisThisWeek()source public
isThisWeek( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если заданная строка datetime находится в текущей неделе.
Параметры
- целое число/строка/DateTime
$dateString - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
логическое значениеTrue, если строка datetime находится в текущей неделе
См. также
CakeTime::isThisWeek()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timeisThisYear()source public
isThisYear( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если заданная строка datetime находится в текущем году.
Параметры
- целое число/строка/DateTime
$dateString - Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
- строка/DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
логическое значениеTrue, если строка datetime находится в текущем году
См. также
CakeTime::isThisYear()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timeisToday()source public
isToday( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если заданная строка даты и времени — это сегодня.
Параметры
- integer|string|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
booleanTrue, если строка даты и времени — это сегодня
См. также
CakeTime::isToday()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timeisTomorrow()source public
isTomorrow( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если заданная строка даты и времени — это завтра.
Параметры
- integer|string|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
booleanTrue, если строка даты и времени — это завтра
См. также
CakeTime::isTomorrow()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timeisWithinNext()source public
isWithinNext( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если указанная дата и время находится в указанном интервале, иначе false.
Параметры
- string|integer
$timeInterval Числовое значение со временем. Примеры допустимых значений: 6 часов, 2 дня, 1 минута.
- integer|string|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
booleanСм. также
CakeTime::isWithinLast()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timenice()source public
nice( integer|string|DateTime $dateString null , string|DateTimeZone $timezone null , string $format null )
Возвращает отформатированную строку даты для заданной строки даты и времени.
Параметры
- integer|string|DateTime
$dateStringoptional null - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
- string
$formatoptional null - Формат. Если null, используется
CakeTime::$niceFormat
Возвращает
stringОтформатированная строка даты
См. также
CakeTime::nice()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingniceShort()source public
niceShort( integer|string|DateTime $dateString null , string|DateTimeZone $timezone null )
Возвращает отформатированную описательную строку даты для заданной строки даты и времени.
Параметры
- integer|string|DateTime
$dateStringoptional null - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime.
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
stringОписательная строка относительной даты
См. также
CakeTime::niceShort()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingserverOffset()source public
serverOffset( )
Возвращает смещение сервера
Возвращает
integerСмещение
См. также
CakeTime::serverOffset()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingtimeAgoInWords()source public
timeAgoInWords( integer|string|DateTime $dateTime , array $options array() )
Форматирует дату в фразу, выражающую относительное время.
Дополнительные параметры
-
element- Элемент, в который нужно обернуть отформатированное время. Имеет несколько дополнительных параметров:-
tag- Имя тега, по умолчанию 'span'. -
class- Имя класса, по умолчаниюtime-ago-in-words. -
title- По умолчанию значение $dateTime.
-
Параметры
- integer|string|DateTime
$dateTime - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- array
$optionsoptional array() - Формат по умолчанию, если в $dateString используется маркер времени
Возвращает
stringСтрока относительного времени.
См. также
CakeTime::timeAgoInWords()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingtoAtom()source public
toAtom( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает дату, отформатированную для лент Atom RSS.
Параметры
- integer|string|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
stringОтформатированная строка даты
См. также
CakeTime::toAtom()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingtoQuarter()source public
toQuarter( integer|string|DateTime $dateString , boolean $range false )
Возвращает квартал.
Параметры
- integer|string|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- boolean
$rangeoptional false - Если true, возвращает диапазон в формате ГГГГ-ММ-ДД
Возвращает
integer|array1, 2, 3 или 4 квартал года или массив, если $range true
См. также
CakeTime::toQuarter()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingtoRSS()source public
toRSS( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Форматирует дату для лент RSS.
Параметры
- integer|string|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
stringОтформатированная строка даты
См. также
CakeTime::toRSS()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingtoUnix()source public
toUnix( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает маркер времени Unix из текстового описания даты и времени. Оборачивает функцию PHP strtotime().
Параметры
- integer|string|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- string|DateTimeZone
$timezoneoptional null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
integerМаркер времени Unix
См. также
CakeTime::toUnix()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formattingwasWithinLast()source public
wasWithinLast( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если указанная дата и время находились в указанном интервале, иначе false.
Параметры
- строка|целое число
$timeInterval числовое значение с типом времени. Примеры допустимых типов: 6 часов, 2 дня, 1 минута.
- целое число|строка|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- строка|DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
booleanСм. также
CakeTime::wasWithinLast()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timewasYesterday()source public
wasYesterday( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )
Возвращает true, если заданная строка даты и времени была вчера.
Параметры
- целое число|строка|DateTime
$dateString - Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
- строка|DateTimeZone
$timezoneнеобязательно null - Строка часового пояса пользователя или объект DateTimeZone
Возвращает
booleanTrue, если строка даты и времени была вчера
См. также
CakeTime::wasYesterday()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-timeПодробное описание свойств
© 2005–2017 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.
https://api.cakephp.org/2.10/class-TimeHelper.html