Класс FlashHelper

render()исходный код public

render( string $key 'flash' , array $options array() )

Используется для отображения сообщения, установленного в FlashComponent::set()

В вашем представлении: $this->Flash->render('somekey'); По умолчанию используется flash, если параметр не указан

Вы можете передать дополнительную информацию в генерацию сообщения всплывающих уведомлений. Это позволяет объединить все параметры для определенного типа сообщения всплывающих уведомлений в представлении.

echo $this->Flash->render('flash', array('params' => array('name' => $user['User']['name'])));

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

Наконец, вы можете выбрать элемент, используемый для отображения сообщения всплывающих уведомлений. Использование пользовательских элементов позволяет полностью настроить способ генерации сообщений всплывающих уведомлений.

echo $this->Flash->render('flash', array('element' => 'my_custom_element'));

Если вы хотите использовать элемент из плагина для отображения сообщения всплывающих уведомлений, вы можете использовать нотацию точки для имени элемента плагина:

echo $this->Flash->render('flash', array(
  'element' => 'MyPlugin.my_custom_element',
));

Параметры

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

Ключ [Сообщения.] ключа, который вы отображаете в представлении.

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

Дополнительные параметры для создания этого сообщения всплывающих уведомлений. Поддерживает ключи 'params' и 'element', используемые в помощнике.

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

строка|null

Отображаемое сообщение всплывающих уведомлений или null, если ключ всплывающих уведомлений не существует в сессии.

Исключения

UnexpectedValueException
Если значение для ключа параметров настроек всплывающих уведомлений не является массивом.

__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

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

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

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

__set()исходный код public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

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

смешанный $value

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

_clean()исходный код protected

_clean( )

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

_confirm()исходный код protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

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

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

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

_encodeUrl()исходный код protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

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

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

_formatAttribute()исходный код protected

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

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

Устарело

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

Параметры

строка $key

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

строка $value

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

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

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

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

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

_initInputField()исходный код protected

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

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

Параметры

строка $field

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

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

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

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

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

_name()исходный код protected

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

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

Параметры

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

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

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

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

Возвращает

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

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 равен true и 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() для генерации идентификатора атрибута CamelCased.

Параметры

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

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

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

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

Возвращает

смешанный

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

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

Возвращает

строка

model()source public

model( )

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

Возвращает

string

output()source public

output( string $str )

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

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

Устарело

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

Параметры

string $str

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

Возвращает

string

setEntity()source public

setEntity( string $entity , boolean $setScope false )

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

Параметры

string $entity

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

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

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

url()source public

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

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

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

Параметры

string|array $url необязательно null

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

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

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

Возвращает

string
Полный переведённый 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' )

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

mixed

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

webroot()source public

webroot( string $file )

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

Параметры

string $file

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

Возвращает

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

_mergeVars()source protected

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

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

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

Параметры

array $properties

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

string $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status необязательно 0

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

dispatchMethod()source public

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

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

Параметры

string $method

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

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

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

Возвращает

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

log()source public

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

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

Параметры

string $msg

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

integer $type необязательно LOG_ERR

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

null|string|array $scope необязательно null

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

Возвращает

boolean
Успех записи в журнал

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.

Параметры

string|array $url

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

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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