Класс InterceptContentHelper

afterRender()source public

afterRender( string $viewFile )

Перехватывает и сохраняет содержимое представления перед рендерингом макета

Параметры

строка $viewFile

Файл представления

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

Helper::afterRender()

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

Вызываемый метод

массив $params

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

__construct()source public

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

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

Параметры

View $View

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

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

Настройки конфигурации помощника.

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Устарело

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

Параметры

строка $name

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

Возвращает

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

__set()source public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

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

смешанный $value

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

_clean()source protected

_clean( )

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

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

Получает имя поля ввода для текущего тега. Создает атрибуты имени ввода, используя форматирование 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' (строка)

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

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

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

Возвращает

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

afterLayout()source public

afterLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

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 Ложное значение предотвратит обработку пути как плагина

Возвращает

строка
Сгенерированный 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, или строка с путем к сущности представления для получения идентификатора dom.

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

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

Возвращает

смешанное

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

Получает поле модели, используемое в текущем контексте отрисовки. Удаляет постфиксы полей, такие как year, month, day, hour, min, meridian, если текущая сущность содержит более 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 с базовым путём.

Ссылка

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

value()source public

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

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

Параметры

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

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

строка $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 необязательный array()

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

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

Список параметров для использования при вызове $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 необязательный array()

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

Возвращает

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

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

toString()source public

toString( )

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

Возвращает

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