Spec-Zone.ru › CakePHP 2.10

Класс TimeHelper

Класс Time Helper для удобной работы с данными времени.

Обработка данных времени.

AppHelper
Extended by TimeHelper
Пакет: Cake\View\Helper
Ссылка: 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

Краткое описание свойств

  • $_engine protected
    CakeTime
    Экземпляр CakeTime

Краткое описание методов

  • __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#formatting
END_OF_DOCUMENT_MARKER

convertSpecifiers()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#formatting

dayAsSql()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#formatting

daysAsSql()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#formatting

format()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#formatting

fromString()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#formatting

gmt()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#formatting

i18nFormat()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#formatting

isThisMonth()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-time

isThisWeek()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-time

isThisYear()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-time
END_OF_DOCUMENT_MARKER

isToday()source public

isToday( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Возвращает true, если заданная строка даты и времени — это сегодня.

Параметры

integer|string|DateTime $dateString
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
string|DateTimeZone $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени — это сегодня

См. также

CakeTime::isToday()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-time

isTomorrow()source public

isTomorrow( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Возвращает true, если заданная строка даты и времени — это завтра.

Параметры

integer|string|DateTime $dateString
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
string|DateTimeZone $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени — это завтра

См. также

CakeTime::isTomorrow()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-time

isWithinNext()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 $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean

См. также

CakeTime::isWithinLast()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-time

nice()source public

nice( integer|string|DateTime $dateString null , string|DateTimeZone $timezone null , string $format null )

Возвращает отформатированную строку даты для заданной строки даты и времени.

Параметры

integer|string|DateTime $dateString optional null
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
string|DateTimeZone $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone
string $format optional null
Формат. Если null, используется CakeTime::$niceFormat

Возвращает

string
Отформатированная строка даты

См. также

CakeTime::nice()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

niceShort()source public

niceShort( integer|string|DateTime $dateString null , string|DateTimeZone $timezone null )

Возвращает отформатированную описательную строку даты для заданной строки даты и времени.

Параметры

integer|string|DateTime $dateString optional null
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime.
string|DateTimeZone $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string
Описательная строка относительной даты

См. также

CakeTime::niceShort()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

serverOffset()source public

serverOffset( )

Возвращает смещение сервера

Возвращает

integer
Смещение

См. также

CakeTime::serverOffset()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

timeAgoInWords()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 $options optional array()
Формат по умолчанию, если в $dateString используется маркер времени

Возвращает

string
Строка относительного времени.

См. также

CakeTime::timeAgoInWords()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

toAtom()source public

toAtom( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Возвращает дату, отформатированную для лент Atom RSS.

Параметры

integer|string|DateTime $dateString
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
string|DateTimeZone $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string
Отформатированная строка даты

См. также

CakeTime::toAtom()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

toQuarter()source public

toQuarter( integer|string|DateTime $dateString , boolean $range false )

Возвращает квартал.

Параметры

integer|string|DateTime $dateString
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
boolean $range optional false
Если true, возвращает диапазон в формате ГГГГ-ММ-ДД

Возвращает

integer|array
1, 2, 3 или 4 квартал года или массив, если $range true

См. также

CakeTime::toQuarter()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

toRSS()source public

toRSS( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Форматирует дату для лент RSS.

Параметры

integer|string|DateTime $dateString
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
string|DateTimeZone $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string
Отформатированная строка даты

См. также

CakeTime::toRSS()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

toUnix()source public

toUnix( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Возвращает маркер времени Unix из текстового описания даты и времени. Оборачивает функцию PHP strtotime().

Параметры

integer|string|DateTime $dateString
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
string|DateTimeZone $timezone optional null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

integer
Маркер времени Unix

См. также

CakeTime::toUnix()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#formatting

wasWithinLast()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-time

wasYesterday()source public

wasYesterday( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Возвращает true, если заданная строка даты и времени была вчера.

Параметры

целое число|строка|DateTime $dateString
Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
строка|DateTimeZone $timezone необязательно null
Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени была вчера

См. также

CakeTime::wasYesterday()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/time.html#testing-time

Подробное описание свойств

$_enginesource

protected CakeTime

Экземпляр CakeTime

null

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API