Класс TimeHelper

__callsource public

__call( string $method , array $params )

Вызов методов из утилиты CakeTime.

Параметры

string $method

Метод для вызова.

array $params

Параметры для передачи методу.

Возвращает

mixed
Значение, возвращаемое вызванным методом, или false при ошибке

Переопределяет

Helper::__call()

__constructsource public

__construct( View $View , array $settings array() )

Конструктор

Настройки:

• engine Имя класса для замены функциональности CakeTime. Класс должен быть размещен в Utility директории.

Параметры

View $View

объект представления, к которому прикреплен помощник.

array $settings необязательно array()

Массив настроек

Исключения

CakeException
Возникает, когда класс движка не найден.

Переопределяет

Helper::__construct()

__getsource public

__get( string $name )

Магический доступ к атрибутам, которые были устаревшими.

Параметры

string $name

Имя атрибута для получения.

Возвращает

mixed
смешанный тип

Переопределяет

Helper::__get()

__issetsource public

__isset( string $name )

Магическая проверка isset для устаревших атрибутов.

Параметры

string $name

Имя атрибута для проверки.

Возвращает

boolean|null
bool|null

__setsource public

__set( string $name , string $value )

Магический доступ для устаревших атрибутов.

Параметры

string $name

Имя атрибута для установки.

string $value

Значение атрибута для установки.

Переопределяет

Helper::__set()

convertsource public

convert( string $serverTime , string|DateTimeZone $timezone )

Преобразует заданное время (в часовом поясе сервера) в локальное время пользователя, учитывая его часовой пояс.

Параметры

string $serverTime

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

string|DateTimeZone $timezone

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См.

CakeTime::convert()

Ссылка

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

convertSpecifierssource public

convertSpecifiers( string $format , string $time null )

Преобразует строку, представляющую формат для функции strftime, и возвращает безопасный для Windows и поддерживающий многоязычие формат.

Параметры

string $format

Формат со спецификаторами для функции strftime. Принимает специальный спецификатор %S, который имитирует модификатор S для date()

string $time необязательно null

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

Возвращает

string
Безопасный для Windows и совместимый с функцией date() формат для strftime

См.

CakeTime::convertSpecifiers()

Ссылка

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

dayAsSqlsource public

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

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

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime

string $fieldName

Имя поля базы данных для сравнения

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string
Частичная строка SQL.

См.

CakeTime::dayAsSql()

Ссылка

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

daysAsSqlsource public

daysAsSql( integer|string|DateTime $begin , integer|string|DateTime $end , string $fieldName , string|DateTimeZone $timezone null )

Возвращает частичную строку SQL для поиска всех записей между двумя датами.

Параметры

integer|string|DateTime $begin

Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime

integer|string|DateTime $end

Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime

string $fieldName

Имя поля базы данных для сравнения

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string
Частичная строка SQL.

См.

CakeTime::daysAsSql()

Ссылка

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

formatsource 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

Параметры

integer|string|DateTime $format

строка формата даты (или маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime)

integer|string|DateTime $date необязательно null

Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime (или строка формата даты)

boolean $invalid необязательно false

флаг для игнорирования результатов fromString == false

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См.

CakeTime::format()

Ссылка

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

fromStringsource public

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

Возвращает маркер времени Unix, заданный либо маркером времени Unix, либо допустимой строкой даты strtotime().

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string
Обработанный маркер времени

См.

CakeTime::fromString()

Ссылка

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

gmtsource public

gmt( integer|string|DateTime $string null )

Возвращает gmt в виде временной метки Unix.

Параметры

целое число|строка|DateTime $string необязательно null

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime

Возвращает

integer
Временная метка Unix

См. также

CakeTime::gmt()

Ссылка

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

i18nFormatsource 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

Возвращает

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

См. также

CakeTime::i18nFormat()

Ссылка

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

isThisMonthsource public

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

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

Параметры

целое число|строка|DateTime $dateString

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime

строка|DateTimeZone $timezone необязательно null

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты находится в текущем месяце

См. также

CakeTime::isThisMonth()

Ссылка

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

isThisWeeksource public

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

Возвращает true, если заданная строка даты находится в текущей неделе.

Параметры

целое число|строка|DateTime $dateString

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime

строка|DateTimeZone $timezone необязательно null

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты находится в текущей неделе

См. также

CakeTime::isThisWeek()

Ссылка

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

isThisYearsource public

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

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

Параметры

целое число|строка|DateTime $dateString

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime

строка|DateTimeZone $timezone необязательно null

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты находится в текущем году

См. также

CakeTime::isThisYear()

Ссылка

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

isTodaysource public

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

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

Параметры

целое число|строка|DateTime $dateString

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime

строка|DateTimeZone $timezone необязательно null

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

CakeTime::isToday()

Ссылка

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

isTomorrowsource public

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

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

Параметры

целое число|строка|DateTime $dateString

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime

строка|DateTimeZone $timezone необязательно null

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

CakeTime::isTomorrow()

Ссылка

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

isWithinNextsource public

isWithinNext( 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
bool

См. также

CakeTime::isWithinLast()

Ссылка

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

nicesource public

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

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

Параметры

целое число|строка|DateTime $dateString необязательно null

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime

строка|DateTimeZone $timezone необязательно null

Строковое представление часового пояса пользователя или объект DateTimeZone

строка $format необязательно null

Используемый формат. Если null, используется CakeTime::$niceFormat

Возвращает

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

См. также

CakeTime::nice()

Ссылка

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

niceShortsource public

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

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

Параметры

целое число|строка|DateTime $dateString необязательно null

Временная метка Unix, строка, подходящая для strtotime(), или объект DateTime.

строка|DateTimeZone $timezone необязательно null

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

CakeTime::niceShort()

Ссылка

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

serverOffsetsource public

serverOffset( )

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

Возвращает

integer
Смещение

См. также

CakeTime::serverOffset()

Ссылка

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

timeAgoInWordssource 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 необязательно array()

Формат по умолчанию, если маркер времени используется в $dateString

Возвращает

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

См. также

CakeTime::timeAgoInWords()

Ссылка

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

toAtomsource public

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

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

Параметры

integer|string|DateTime $dateString

Маркер времени UNIX, строка, допустимая для strtotime(), или объект DateTime

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

CakeTime::toAtom()

Ссылка

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

toQuartersource public

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

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

Параметры

integer|string|DateTime $dateString

Маркер времени UNIX, строка, допустимая для strtotime(), или объект DateTime

boolean $range необязательно false

если true, возвращает диапазон в формате ГГГГ-ММ-ДД

Возвращает

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

См. также

CakeTime::toQuarter()

Ссылка

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

toRSSsource public

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

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

Параметры

integer|string|DateTime $dateString

Маркер времени UNIX, строка, допустимая для strtotime(), или объект DateTime

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

CakeTime::toRSS()

Ссылка

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

toUnixsource public

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

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

Параметры

integer|string|DateTime $dateString

Маркер времени UNIX, строка, допустимая для strtotime(), или объект DateTime

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

CakeTime::toUnix()

Ссылка

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

wasWithinLastsource public

wasWithinLast( 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 необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
bool

См. также

CakeTime::wasWithinLast()

Ссылка

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

wasYesterdaysource public

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

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

Параметры

integer|string|DateTime $dateString

Маркер времени UNIX, строка, допустимая для strtotime(), или объект DateTime

string|DateTimeZone $timezone необязательно null

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

CakeTime::wasYesterday()

Ссылка

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

_cleansource protected

_clean( )

Удаляет вредное содержимое из вывода

_confirmsource protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )

Возвращает строку, используемую в качестве обработчика onclick для диалоговых окон подтверждения.

Параметры

string $message

Сообщение для отображения

string $okCode

Код, который выполняется после выбора пользователем «ОК»

string $cancelCode необязательно ''

Код, который выполняется после выбора пользователем «Отмена»

array $options необязательно array()

Массив параметров

Возвращает

string
JS-код onclick

_encodeUrlsource protected

_encodeUrl( string $url )

Кодирует URL для использования в атрибутах HTML.

Параметры

string $url

Кодируемый URL.

Возвращает

string
URL, закодированный как для URL, так и для HTML контекстов.

_formatAttributesource protected

_formatAttribute( string $key , string $value , boolean $escape true )

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с минимализированными атрибутами, значения которых совпадают с их именем, такими как 'disabled' и 'checked'

Устарело

3.0.0 Этот метод будет перемещен в HtmlHelper в 3.0

Параметры

string $key

Имя атрибута для создания

string $value

Значение атрибута для создания.

boolean $escape необязательно true

Определяет, нужно ли экранировать значение

Возвращает

string
Составленный атрибут.

_initInputFieldsource protected

_initInputField( string $field , array $options array() )

Устанавливает значения по умолчанию для тега input. Установит атрибуты name, value и id для массива атрибутов html.

Параметры

string $field

Имя поля для инициализации.

array $options необязательно array()

Массив параметров, используемых при инициализации поля ввода.

Возвращает

array
Массив параметров для поля формы.

_namesource protected

_name( array|string $options array() , string $field null , string $key 'name' )

Получает имя поля ввода для текущего тега. Создаёт атрибуты имени ввода, используя формат CakePHP data[Model][field].

Параметры

массив|строка $options необязательно array()

Если массив, должен быть массивом атрибутов, к которым нужно добавить $key. Если строка или null, будет использоваться как сущность View.

строка $field необязательно null

Имя поля.

строка $key необязательно 'name'

Имя атрибута, который нужно установить, по умолчанию 'name'

Возвращает

mixed
Если для $options был передан массив, возвращается массив с установленным $key. Если была передана строка, возвращается строка.

_parseAttributessource protected

_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )

Возвращает строку, разделённую пробелами, с элементами массива $options. Если ключ массива $options совпадает с одним из перечисленных в Helper::$_minimizedAttributes,

И его значение равно:

• '1' (строка)
• 1 (целое число)
• true (логическое)
• 'true' (строка)

Тогда значение будет изменено, чтобы быть идентичным имени ключа. Если значение не соответствует одному из этих 3, параметр не выводится.

'escape' — специальный параметр, контролирующий преобразование атрибутов в их html-сущностные эквиваленты. Установите в значение false, чтобы отключить html-кодирование.

Если значение любого ключа параметра $options установлено в null или false, этот параметр будет исключён из вывода.

Устарело

3.0.0 Этот метод будет перемещён в HtmlHelper в 3.0

Параметры

массив $options

Массив параметров.

массив $exclude необязательно null

Массив параметров, которые будут исключены, эти параметры не будут частью возвращаемого значения.

строка $insertBefore необязательно ' '

Строка, которая будет вставлена перед параметрами.

строка $insertAfter необязательно null

Строка, которая будет вставлена после параметров.

Возвращает

string
Составленные атрибуты.

_resetsource protected

_reset( )

Сбрасывает переменные, используемые Helper::clean(), в null

_selectedArraysource protected

_selectedArray( string|array $data , string $key 'id' )

Преобразует набор записей из ассоциации hasAndBelongsToMany в список выбранных параметров для элемента многократного выбора.

Параметры

строка|массив $data

Массив данных или имя модели.

строка $key необязательно 'id'

Имя поля.

Возвращает

array
массив

addClasssource public

addClass( array $options array() , string $class null , string $key 'class' )

Добавляет указанный класс к параметрам элемента.

Параметры

массив $options необязательно array()

Массив параметров/атрибутов, к которым нужно добавить класс

строка $class необязательно null

Имя добавляемого класса.

строка $key необязательно 'class'

Ключ для использования для класса.

Возвращает

array
Массив параметров с установленным $key.

afterLayoutsource public

afterLayout( string $layoutFile )

Обработчик после макета. afterLayout вызывается после отрисовки макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Файл макета, который был отрисован.

afterRendersource public

afterRender( string $viewFile )

Обработчик после отрисовки. afterRender вызывается после отрисовки файла представления, но перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который был отрисован.

afterRenderFilesource public

afterRenderFile( string $viewFile , string $content )

Обработчик после отрисовки фрагмента. Вызывается после отрисовки любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который только что был отрисован.

строка $content

Контент, который был отрисован.

assetTimestampsource public

assetTimestamp( string $path )

Добавляет отметку времени к файлу-ресурсу на основе значения Asset.timestamp в Configure. Если Asset.timestamp имеет значение true и debug > 0, или Asset.timestamp === 'force', будет добавлена отметка времени.

Параметры

строка $path

Путь к файлу для добавления отметки времени, путь должен находиться внутри WWW_ROOT

Возвращает

string
Путь с добавленной отметкой времени или без неё.

assetUrlsource public

assetUrl( string|array $path , array $options array() )

Генерирует URL для указанного файла ресурса. В зависимости от переданных параметров, предоставляет полный URL с доменным именем. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

строка|массив $path

Строка пути или массив URL

массив $options необязательно array()

Массив параметров. Возможные ключи: fullBase Возвращает полный URL с доменным именем pathPrefix Префикс пути для относительных URL ext Расширение файла ресурса для добавления plugin Ложное значение предотвратит обработку пути как плагина

Возвращает

string
Сгенерированный URL

beforeLayoutsource public

beforeLayout( string $layoutFile )

Обработчик перед макетом. beforeLayout вызывается перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Макет, который собирается быть отрисованным.

beforeRendersource public

beforeRender( string $viewFile )

Обработчик перед отрисовкой. beforeRender вызывается перед отрисовкой файла представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который будет отрисован

beforeRenderFilesource public

beforeRenderFile( string $viewFile )

Обработчик перед отрисовкой фрагмента. Вызывается перед отрисовкой любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который собирается быть отрисованным.

cleansource public

clean( string|array $output )

Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако, не гарантирует удаление всех возможных вариантов. Использование экранирования содержимого является лучшим способом предотвращения всех возможных атак.

Устарело

3.0.0 Этот метод будет удалён в 3.0

Параметры

строка|массив $output

Либо массив строк для очистки, либо одна строка для очистки.

Возвращает

string|array|null
Очищенное содержимое для вывода

domIdsource public

domId( array|string $options null , string $id 'id' )

Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации идентификатора с использованием CamelCase.

Параметры

массив|строка $options необязательно null

Либо массив HTML-атрибутов, в который добавить $id, либо строка с путем к сущности представления для получения domId.

строка $id необязательно 'id'

Имя атрибута 'id'.

Возвращаемое значение

mixed
Если $options был массивом, возвращается массив с установленным $id. Если была передана строка, возвращается строка.

entitysource public

entity( )

Возвращает ссылку на сущность текущего контекста в виде массива идентификационных частей.

Возвращаемое значение

array
Массив, содержащий идентификационные элементы сущности

fieldsource public

field( )

Получает поле модели, используемое в текущем контексте рендеринга. Удаляет суффиксы полей, такие как year, month, day, hour, min, meridian, если текущая сущность содержит более 2 элементов.

Возвращаемое значение

string
строка

modelsource public

model( )

Получает используемую модель текущего контекста рендеринга.

Возвращаемое значение

string
строка

outputsource public

output( string $str )

Возвращает строку, сгенерированную методом помощника.

Этот метод может быть переопределен в подклассах для выполнения обобщенной обработки вывода после рендеринга.

Устарело

3.0.0 Этот метод будет удален в будущих версиях.

Параметры

строка $str

Строка для вывода.

Возвращаемое значение

string
строка

setEntitysource public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства модели и поля помощника в соответствии со значением в формате "точка" в $entity.

Параметры

строка $entity

Имя поля, например, "ИмяМодели.ИмяПоля" или "ИмяМодели.ID.ИмяПоля"

логическое значение $setScope необязательно false

Устанавливает область видимости представления в указанную модель в $tagValue

urlsource public

url( string|array $url null , boolean $full false )

Находит URL для указанного действия.

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

Параметры

строка|массив $url необязательно null

Либо относительный URL-адрес, например, /products/view/23, либо массив параметров URL. Использование массива для URL позволит использовать функции обратного маршрутизации CakePHP.

логическое значение $full необязательно false

Если true, к результату будет добавлен полный базовый URL

Возвращаемое значение

string
Полный переведенный URL с базовым путем.

Ссылка

http://book.cakephp.org/2.0/ru/views/helpers.html

valuesource public

value( array|string $options array() , string $field null , string $key 'value' )

Получает данные для текущего тега.

Параметры

массив|строка $options необязательно array()

Если массив, должен содержать массив атрибутов, к которым нужно добавить $key. Если строка или null, будет использоваться как сущность представления.

строка $field необязательно null

Имя поля.

строка $key необязательно 'value'

Имя атрибута, который нужно установить, по умолчанию 'value'.

Возвращаемое значение

mixed
Если для $options был передан массив, возвращается массив с установленным $key. Если была передана строка, возвращается строка.

webrootsource public

webroot( string $file )

Проверяет существование файла при использовании темы; если файл не найден, возвращает путь по умолчанию.

Параметры

строка $file

Файл, для которого требуется создать путь в webroot.

Возвращаемое значение

string
Веб-доступный путь к файлу.

_mergeVarssource protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойство $property текущего объекта со свойством в определении $class. Значение свойства этого класса объединяется поверх значения $class'.

Это обеспечивает часть DRY-магии CakePHP. Если вы хотите отключить эту функцию, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства с ним.

логическое значение $normalize необязательно true

Установить в true для применения Hash::normalize() к свойствам перед объединением.

_setsource protected

_set( array $properties array() )

Позволяет устанавливать несколько свойств объекта в одной строке кода. Будут установлены только свойства, являющиеся частью объявления класса.

Параметры

массив $properties необязательно array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stopsource protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число|строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethodsource public

dispatchMethod( string $method , array $params array() )

Вызывает метод данного объекта с заданными параметрами. Предоставляет ОО-обертку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

массив $params необязательно array()

Список параметров, используемых при вызове $method

Возвращаемое значение

mixed
Возвращает результат вызова метода

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения более подробной информации о записи в журналы, см. CakeLog::write().

Параметры

строка $msg

Сообщение журнала

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

null|строка|массив $scope необязательно null

Область(и), в которой создается сообщение журнала. Для получения дополнительной информации о областях ведения журналов, см. CakeLog::config().

Возвращаемое значение

boolean
Успешность записи в журнал

requestActionsource public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любой точки приложения. Может использоваться для соединения контроллеров или подключения плагинов к главному приложению. requestAction можно использовать для возврата рендеренных представлений или получения возвращаемого значения действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Следует использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет смоделировать данные POST.

Параметры

строка|массив $url

Строковый или массивоподобный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

массив $extra необязательно массив()

Если массив содержит ключ "return", он устанавливает AutoRender в значение true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

Возвращаемое значение

mixed
Булево значение true или false при успехе/неудачи или содержимое рендеренного действия, если в $extra установлен ключ 'return'.

toStringsource public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращаемое значение

string
Имя этого класса

null

'%s="%s"'

null

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

array()

'%s="%s"'

array(
    'allowfullscreen',
    'async',
    'autofocus',
    'autoplay',
    'checked',
    'compact',
    'controls',
    'declare',
    'default',
    'defaultchecked',
    'defaultmuted',
    'defaultselected',
    'defer',
    'disabled',
    'enabled',
    'formnovalidate',
    'hidden',
    'indeterminate',
    'inert',
    'ismap',
    'itemscope',
    'loop',
    'multiple',
    'muted',
    'nohref',
    'noresize',
    'noshade',
    'novalidate',
    'nowrap',
    'open',
    'pauseonexit',
    'readonly',
    'required',
    'reversed',
    'scoped',
    'seamless',
    'selected',
    'sortable',
    'spellcheck',
    'truespeed',
    'typemustmatch',
    'visible'
)

null

array()

array()

null

null

array()

array()

null