Класс TimeHelper

__call()source public

__call( string $method , array $params )

Вызов методов из класса утилиты CakeTime

Параметры

строка $method

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

массив $params

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

Возвращает

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

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

Helper::__call()

__construct()source public

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

Конструктор

Настройки:

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

Параметры

View $View

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

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

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

Исключения

CakeException
Когда класс движка не найден.

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

Helper::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанное

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

Helper::__get()

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

булево|null

__set()source public

__set( string $name , string $value )

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

Параметры

строка $name

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

строка $value

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

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

Helper::__set()

convert()source public

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

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

Параметры

строка $serverTime

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

строка|DateTimeZone $timezone

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

Возвращает

целое число
Маркер времени Unix

См. также

CakeTime::convert()

Ссылка

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

convertSpecifiers()source public

convertSpecifiers( string $format , string $time null )

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

Параметры

строка $format

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

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

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

Возвращает

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

См. также

CakeTime::convertSpecifiers()

Ссылка

http://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()

Ссылка

http://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()

Ссылка

http://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()

Ссылка

http://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()

Ссылка

http://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()

Ссылка

http://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()

Ссылка

http://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()

Ссылка

http://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()

Ссылка

http://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, если заданная строка даты и времени находится в текущем году.

Параметры

integer|string|DateTime $dateString

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

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

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

Возвращает

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

См. также

CakeTime::isThisYear()

Ссылка

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

isToday()source public

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

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

Параметры

integer|string|DateTime $dateString

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

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

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

Возвращает

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

См. также

CakeTime::isToday()

Ссылка

http://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 необязательный null

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

Возвращает

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

См. также

CakeTime::isTomorrow()

Ссылка

http://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 необязательный null

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

Возвращает

boolean

См. также

CakeTime::isWithinLast()

Ссылка

http://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 необязательный null

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

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

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

string $format необязательный null

Формат для использования. Если null, используется CakeTime::$niceFormat

Возвращает

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

См. также

CakeTime::nice()

Ссылка

http://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 необязательный null

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

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

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

Возвращает

string
Строка даты с относительным описанием

См. также

CakeTime::niceShort()

Ссылка

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

serverOffset()source public

serverOffset( )

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

Возвращает

integer
Смещение

См. также

CakeTime::serverOffset()

Ссылка

http://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 необязательный array()

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

Возвращает

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

См. также

CakeTime::timeAgoInWords()

Ссылка

http://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 необязательный null

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

Возвращает

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

См. также

CakeTime::toAtom()

Ссылка

http://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 необязательный false

Если true, возвращает диапазон в формате Y-m-d

Возвращает

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

См. также

CakeTime::toQuarter()

Ссылка

http://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 необязательный null

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

Возвращает

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

См. также

CakeTime::toRSS()

Ссылка

http://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().

Параметры

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

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

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

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

Возвращает

целое число
Метка времени Unix

См. также

CakeTime::toUnix()

Ссылка

http://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

Возвращает

булево

См. также

CakeTime::wasWithinLast()

Ссылка

http://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

Возвращает

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

См. также

CakeTime::wasYesterday()

Ссылка

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

_clean()source protected

_clean( )

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

_confirm()source protected

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

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

Параметры

строка $message

Сообщение, отображаемое в диалоге

строка $okCode

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

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

Код, выполняемый после того, как пользователь выбрал 'Отмена', также выполняется, когда okCode не возвращает значение

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

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

Возвращает

строка
JS-код onclick

_encodeUrl()source protected

_encodeUrl( string $url )

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

Параметры

строка $url

URL для кодирования.

Возвращает

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

_formatAttribute()source protected

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

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

Устарело

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

Параметры

строка $key

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

строка $value

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

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

Указывает, необходимо ли экранировать значение

Возвращает

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

_initInputField()source protected

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

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

Параметры

строка $field

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

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

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

Возвращает

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

_name()source protected

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

смешанное

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

_parseAttributes()source 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-кодирование.

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

Устарело

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

Параметры

массив $options

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

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

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

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

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

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

Строка, вставляемая после параметров.

Возвращает

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

_reset()source protected

_reset( )

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

_selectedArray()source protected

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

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

Параметры

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

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

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

Имя поля.

Возвращает

массив

addClass()source public

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

Добавляет заданный класс к опциям элемента.

Параметры

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

Массив опций/атрибутов для добавления класса.

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

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

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

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

Возвращает

массив
Массив опций с установленным ключом.

afterLayout()source public

afterLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

Файл макета, который был рендерен.

afterRender()source public

afterRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

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

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

Параметры

строка $viewFile

Файл, который только что был рендерен.

строка $content

Содержимое, которое было рендерене.

assetTimestamp()source public

assetTimestamp( string $path )

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

Параметры

строка $path

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

Возвращает

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

assetUrl()source public

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

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

Параметры

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

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

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

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

Возвращает

строка
Сгенерированный URL

beforeLayout()source public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

beforeRender()source public

beforeRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

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

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

Параметры

строка $viewFile

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

clean()source public

clean( string|array $output )

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

Устаревший

3.0.0 Этот метод будет удален в версии 3.0

Параметры

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

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

Возвращает

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

domId()source public

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

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

Параметры

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

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

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

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

Возвращает

смешанное

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

Получает текущее поле модели контекста рендеринга. Удаляет суффиксы полей, такие как год, месяц, день, час, мин, меридиан, когда текущая сущность содержит более 2 элементов.

Возвращает

строка

model()source public

model( )

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

Возвращает

строка

output()source public

output( string $str )

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

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

Устаревший

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

Параметры

строка $str

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

Возвращает

строка

setEntity()source public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства модели и поля помощника на пару значений, разделенных точкой в $entity.

Параметры

строка $entity

Имя поля, например "ModelName.fieldName" или "ModelName.ID.fieldName"

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

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

url()source public

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

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

value()source public

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

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

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

webroot()source public

webroot( string $file )

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

Параметры

строка $file

Файл, для которого нужно создать путь webroot.

Возвращает

строка
Путь к файлу, доступный через веб.

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

Список параметров для использования при вызове $method

Возвращает

смешанный тип
Возвращает результат вызова метода

log()source 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().

Возвращает

логическое значение
Успех записи в лог

requestAction()source 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 и именованных/переданных аргументов.

Возвращает

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

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

toString()source public

toString( )

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

Возвращает

строка
Название этого класса

null