Класс InterceptContentHelper
Класс InterceptContentHelper
- Объект
-
Помощник -
InterceptContentHelper
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение Cake/TestSuite/ControllerTestCase.php
Подробное описание методов
afterRenderисходный код public
afterRender( string $viewFile )
Перехватывает и сохраняет содержимое представления перед отрисовкой макета.
Параметры
- строка
$viewFile - Файл представления
Переопределяет
Helper::afterRender() Методы, унаследованные от Помощника
__callисходный код public
__call( string $method , array $params )
Обеспечивает ошибки, не являющиеся фатальными, при вызовах отсутствующих методов.
Параметры
- строка
$method - Метод для вызова
- массив
$params - Массив параметров для метода.
__constructисходный код public
__construct( View $View , array $settings array() )
Конструктор по умолчанию
Параметры
-
View$View - Представление, к которому прикреплён помощник.
- массив
$settingsнеобязательно array() - Настройки конфигурации помощника.
Переопределяет
Object::__construct() __getисходный код 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 - Значение для установки.
_confirmsource protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )
Возвращает строку, используемую в качестве обработчика onclick для диалогов подтверждения.
Параметры
- строка
$message - Сообщение для отображения
- строка
$okCode - Код, выполняемый после выбора пользователем 'ОК'
- строка
$cancelCodeнеобязательно '' - Код, выполняемый после выбора пользователем 'Отмена'
- массив
$optionsнеобязательно array() - Массив опций
Возвращает
stringJS-код onclick
_encodeUrlsource protected
_encodeUrl( string $url )
Кодирует URL для использования в атрибутах HTML.
Параметры
- строка
$url - URL для кодирования.
Возвращает
stringURL, закодированный для контекстов 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' )
Получает имя поля ввода для текущего тега. Создает атрибуты input name с использованием форматирования CakePHP data[Model][field].
Параметры
- массив|строка
$optionsнеобязательно array() - Если массив, должен быть массивом атрибутов, к которым нужно добавить $key. Если строка или null, будет использоваться как сущность представления.
- строка
$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' (строка)
то значение будет перезаписано, чтобы быть идентичным имени ключа. Если значение не является одним из этих трёх, параметр не выводится.
'escape' — специальная опция, которая управляет преобразованием атрибутов в их закодированные HTML-сущностями эквиваленты. Установите в значение false, чтобы отключить кодирование HTML.
Если значение для любого ключа опции установлено в null или false, эта опция будет исключена из вывода.
Устаревший
3.0.0 Этот метод будет перемещен в HtmlHelper в версии 3.0Параметры
- массив
$options - Массив опций.
- массив
$excludeнеобязательно null - Массив опций, которые необходимо исключить, эти опции не будут частью возвращаемого значения.
- строка
$insertBeforeнеобязательно ' ' - Строка, которая будет вставлена перед опциями.
- строка
$insertAfterнеобязательно null - Строка, которая будет вставлена после опций.
Возвращает
stringСоставленные атрибуты.
_selectedArraysource protected
_selectedArray( string|array $data , string $key 'id' )
Преобразует набор записей из ассоциации hasAndBelongsToMany в список выбранных опций для элемента множественного выбора
Параметры
- string|array
$data - Массив данных или имя модели.
- string
$keyнеобязательно 'id' - Имя поля.
Возвращает
arrayмассив
addClasssource public
addClass( array $options array() , string $class null , string $key 'class' )
Добавляет указанный класс к параметрам элемента
Параметры
- array
$optionsнеобязательно array() - Массив параметров/атрибутов для добавления класса
- string
$classнеобязательно null - Имя добавляемого класса.
- string
$keyнеобязательно 'class' - ключ для использования класса.
Возвращает
arrayМассив параметров с установленным $key.
afterLayoutsource public
afterLayout( string $layoutFile )
Обработка после макета. afterLayout вызывается после отрисовки макета.
Переопределяется в дочерних классах.
Параметры
- string
$layoutFile - Файл макета, который был отрисован.
afterRenderFilesource public
afterRenderFile( string $viewFile , string $content )
Обработка после отрисовки файла. Вызывается после отрисовки любого фрагмента представления.
Переопределяется в дочерних классах.
Параметры
- string
$viewFile - Файл, который только что был отрисован.
- string
$content - Содержимое, которое было отрисовано.
assetTimestampsource public
assetTimestamp( string $path )
Добавляет отметку времени к ресурсу файла на основе значения Asset.timestamp в Configure. Если Asset.timestamp равно true и debug > 0, или Asset.timestamp === 'force', будет добавлена отметка времени.
Параметры
- string
$path - Путь к файлу для добавления отметки времени, путь должен находиться внутри WWW_ROOT
Возвращает
stringПуть с добавленной отметкой времени или без неё.
assetUrlsource public
assetUrl( string|array $path , array $options array() )
Генерирует URL для заданного файла актива. В зависимости от переданных параметров предоставляет полный URL с именем домена. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам
Параметры
- string|array
$path - Строка пути или массив URL
- array
$optionsнеобязательно array() - Массив параметров. Возможные ключи:
fullBaseВозвращает полный URL с именем доменаpathPrefixПрефикс пути для относительных URLextРасширение актива для добавленияpluginЛожное значение предотвратит обработку пути как плагина
Возвращает
stringСгенерированный URL
beforeLayoutsource public
beforeLayout( string $layoutFile )
Обработка перед макетом. beforeLayout вызывается перед отрисовкой макета.
Переопределяется в дочерних классах.
Параметры
- string
$layoutFile - Макет, который будет отрисован.
beforeRendersource public
beforeRender( string $viewFile )
Обработка перед отрисовкой. beforeRender вызывается перед отрисовкой файла представления.
Переопределяется в дочерних классах.
Параметры
- string
$viewFile - Файл представления, который будет отрисован
beforeRenderFilesource public
beforeRenderFile( string $viewFile )
Обработка перед отрисовкой файла. Вызывается перед отрисовкой любого фрагмента представления.
Переопределяется в дочерних классах.
Параметры
- string
$viewFile - Файл, который будет отрисован.
cleansource public
clean( string|array $output )
Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако не гарантируется удаление всех возможностей. Лучший способ предотвращения всех возможных атак — экранирование содержимого.
Устарело
3.0.0 Этот метод будет удален в версии 3.0Параметры
- string|array
$output - Массив строк для очистки или одиночная строка для очистки.
Возвращает
string|array|nullОчищенное содержимое для вывода
domIdsource public
domId( array|string $options null , string $id 'id' )
Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации идентификатора атрибута CamelCased.
Параметры
- array|string
$optionsнеобязательно null - Массив html-атрибутов для добавления $id или строка с путем к сущности представления для получения domId.
- string
$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 Этот метод будет удалён в будущих версиях.Параметры
- string
$str - Строка для вывода.
Возвращает
stringстрока
setEntitysource public
setEntity( string $entity , boolean $setScope false )
Устанавливает свойства модели и поля данного помощника на пару значений, разделённых точкой, в $entity.
Параметры
- string
$entity - Имя поля, например, "ModelName.fieldName" или "ModelName.ID.fieldName"
- boolean
$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.htmlvaluesource 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Веб-доступный путь к файлу.
Наследуемые методы от Object
_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необязательно array() - если массив включает ключ "return", он устанавливает AutoRender в значение true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.
Возвращает
mixedБулевое значение true или false об успехе/неудачи или содержимое рендеренного действия, если в $extra задан ключ 'return'.
toStringsource public
toString( )
Преобразование объекта в строку. Каждый класс может переопределить этот метод по мере необходимости.
Возвращает
stringИмя этого класса
Свойства, унаследованные от Helper
$_associationsource
protected string
Имя текущей модели, сущности ассоциации которой находятся в области видимости.
См.
Helper::setEntity()$_entityPathsource
protected string
Список элементов, разделенных точками, для текущей сущности поля.
См.
Helper::setEntity()$_fieldSuffixessource
protected array
Список строк, которые должны обрабатываться как суффиксы или подвходные данные для родительского входного поля. Используется в основном для полей даты/времени.
array( 'year', 'month', 'day', 'hour', 'min', 'second', 'meridian' )
$_helperMapsource
protected array
Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
array() $_minimizedAttributessource
protected array
Миниатюрные атрибуты
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' )
$_modelScopesource
protected string
Имя текущей модели, сущности которой находятся в области видимости.
См.
Helper::setEntity()$fieldsetsource
public array
Содержит массив полей ('имя_поля' => массив ('тип' => 'строка', 'длина' => 100), первичный ключ и валидирует массив ('имя_поля')
array()
© 2005–2016 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.
http://api.cakephp.org/2.7/class-InterceptContentHelper.html