Класс AppHelper

__callsource public

__call( string $method , array $params )

Предоставление ошибок, не являющихся фатальными, при вызовах отсутствующих методов.

Параметры

строка $method

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

массив $params

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

__constructsource public

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

Конструктор по умолчанию

Параметры

View $View

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

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

Параметры настройки для помощника.

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

Object::__construct()

__getsource public

__get( string $name )

Ленично загружает помощников. Предоставляет доступ к устаревшим свойствам запроса.

Устарело

3.0.0 Доступ к свойствам запроса через этот метод устарел и будет удален в версии 3.0.

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

Возвращает

mixed
Помощник или свойство, найденное по имени $name

__setsource public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

смешанное $value

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

_cleansource protected

_clean( )

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

_confirmsource protected

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

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

Параметры

строка $message

Сообщение, которое должно быть отображено

строка $okCode

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

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

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

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

Массив опций

Возвращает

string
JS-код onclick

_encodeUrlsource protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_formatAttributesource protected

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

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

Устарело

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

Параметры

строка $key

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

строка $value

Значение создаваемого атрибута.

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

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

Возвращает

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

_initInputFieldsource protected

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

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

Параметры

строка $field

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

массив $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.

Если значение любого ключа опции установлено в 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 Значение False предотвратит обработку пути как плагина

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

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

Получает поле модели, используемое в текущем контексте рендеринга. Удаляет суффиксы полей, такие как год, месяц, день, час, мин, меридиан, когда текущая сущность имеет более 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/en/views/helpers.html

valuesource public

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

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

Параметры

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

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

строка $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() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет OO-обёртку для 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 необязательно array()

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

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

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

toStringsource public

toString( )

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

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

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

'%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