Класс AppHelper

__call()исходный код публичный

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__construct()исходный код публичный

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

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

Параметры

View $View

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

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

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

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

Object::__construct()

__get()исходный код публичный

__get( string $name )

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

Устарело

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

Параметры

строка $name

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

Возвращает

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

__set()исходный код публичный

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

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

смешанный $value

Значение для задания.

_clean()исходный код защищенный

_clean( )

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

_confirm()исходный код защищенный

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив опций

Возвращает

строка
JS код onclick

_encodeUrl()исходный код защищенный

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_formatAttribute()исходный код защищенный

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

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

Устарело

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

Параметры

строка $key

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

строка $value

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

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

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

Возвращает

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

_initInputField()исходный код защищенный

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

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

Параметры

строка $field

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

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

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

Возвращает

массив
Массив опций для поля ввода формы.

_name()исходный код защищенный

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

смешанный

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

_parseAttributes()исходный код защищенный

_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 в список выбранных опций для элемента множественного выбора

Параметры

string|array $data

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

string $key optional 'id'

Имя поля.

Возвращает

array

addClass()source public

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

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

Параметры

array $options optional array()

Массив опций/атрибутов, к которым необходимо добавить класс

string $class optional null

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

string $key optional 'class'

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

Возвращает

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

afterLayout()source public

afterLayout( string $layoutFile )

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

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

Параметры

string $layoutFile

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

afterRender()source public

afterRender( string $viewFile )

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

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

Параметры

string $viewFile

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

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

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

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

Параметры

string $viewFile

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

string $content

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

assetTimestamp()source public

assetTimestamp( string $path )

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

Параметры

string $path

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

Возвращает

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

assetUrl()source public

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

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

Параметры

string|array $path

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

array $options optional array()

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

Возвращает

string
Сгенерированный URL

beforeLayout()source public

beforeLayout( string $layoutFile )

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

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

Параметры

string $layoutFile

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

beforeRender()source public

beforeRender( string $viewFile )

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

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

Параметры

string $viewFile

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

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

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

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

Параметры

string $viewFile

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

clean()source public

clean( string|array $output )

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

Устарело

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

Параметры

string|array $output

Массив строк для очистки или одиночная строка для очистки.

Возвращает

string|array|null
Очищенный контент для вывода

domId()source public

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

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

Параметры

array|string $options optional null

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

string $id optional 'id'

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

Возвращает

mixed

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

Получает поле текущей используемой модели контекста отрисовки. Удаляет постфиксы полей, такие как year, month, day, hour, min, meridian, когда текущая сущность имеет более 2 элементов.

Возвращает

string

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

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

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

Имя поля.

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

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

Возвращает

mixed

Если для $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

Возвращает

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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