Spec-Zone.ru › CakePHP 3.2

Класс Helper

Абстрактный базовый класс для всех других Helpers в CakePHP. Предоставляет общие методы и функции.

Методы обратного вызова

Helpers поддерживают ряд методов обратного вызова. Эти обратные вызовы позволяют вам подключиться к различным событиям жизненного цикла представления и либо изменить существующее содержимое представления, либо выполнить другую специфичную для приложения логику. События не реализованы в этом базовом классе, так как реализация метода обратного вызова подписывает helper на соответствующее событие. Методы обратного вызова следующие:

  • beforeRender(Event $event, $viewFile) - метод beforeRender вызывается перед рендерингом файла представления.
  • afterRender(Event $event, $viewFile) - метод afterRender вызывается после рендеринга файла представления, но перед рендерингом макета.
  • beforeLayout(Event $event, $layoutFile)` - метод beforeLayout вызывается перед рендерингом макета.
  • afterLayout(Event $event, $layoutFile) - метод afterLayout вызывается после рендеринга макета.
  • beforeRenderFile(Event $event, $viewFile) - Вызывается перед рендерингом любого фрагмента представления.
  • afterRenderFile(Event $event, $viewFile, $content) - Вызывается после рендеринга любого фрагмента представления. Если слушатель возвращает ненулевое значение, вывод рендеренного файла будет установлен на это значение.
Cake\View\Helper реализует Cake\Event\EventListenerInterface использует Cake\Core\InstanceConfigTrait

Прямые подклассы

  • Cake\View\Helper\FlashHelper
  • Cake\View\Helper\FormHelper
  • Cake\View\Helper\HtmlHelper
  • Cake\View\Helper\NumberHelper
  • Cake\View\Helper\PaginatorHelper
  • Cake\View\Helper\RssHelper
  • Cake\View\Helper\SessionHelper
  • Cake\View\Helper\TextHelper
  • Cake\View\Helper\TimeHelper
  • Cake\View\Helper\UrlHelper
Пространство имён: Cake\View
Расположение: View/Helper.php

Резюме свойств

  • $_View protected
    Cake\View\View
    Экземпляр View, к которому прикреплён этот helper
  • $_defaultConfig protected
    array
    Конфигурация по умолчанию для этого helper.
  • $_helperMap protected
    array
    Таблица поиска helper, используемая для ленивой загрузки объектов helper.
  • $fieldset public
    array

    Содержит поля ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey и проверяет ['field_name']

  • $helpers public
    array
    Список helpers, используемых этим helper
  • $plugin public
    string
    Путь к плагину
  • $request public
    Cake\Network\Request
    Объект запроса
  • $tags public
    array
    Содержит шаблоны тегов.
  • $theme public
    string
    Имя текущей темы, если таковое имеется.

Унаследованные свойства

  • _config, _configInitialized

Резюме методов

  • __call() public
    Предоставляет ошибки без критических ошибок при вызовах отсутствующих методов.
  • __construct() public
    Конструктор по умолчанию
  • __debugInfo() public

    Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

  • __get() public
    Лениво загружает helpers.
  • _confirm() protected
    Возвращает строку, которая должна использоваться в качестве обработчика onclick для диалогов подтверждения.
  • addClass() public
    Добавляет указанный класс к параметрам элемента
  • implementedEvents() public
    Получить обратные вызовы View, в которых заинтересован этот helper.
  • initialize() public
    Метод обратной связи конструктора.

Подробное описание методов

__call()source public 

__call( string $method , array $params )

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

Параметры

string $method
Метод для вызова
array $params
Массив параметров для метода.

__construct()source public 

__construct( Cake\View\View $View , array $config [] )

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

Параметры

Cake\View\View $View
Представление, к которому прикрепляется этот helper.
array $config optional []
Параметры конфигурации для helper.

__debugInfo()source public 

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

__get()source public 

__get( string $name )

Лениво загружает helpers.

Параметры

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

Возвращает

Cake\View\Helper|null
Экземпляр helper, если helper с указанным именем существует

_confirm()source protected 

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

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

Параметры

string $message
Сообщение для отображения
string $okCode
Код, который должен быть выполнен после того, как пользователь выбрал «ОК»
string $cancelCode optional ''
Код, который должен быть выполнен после того, как пользователь выбрал «Отмена»
array $options optional []
Массив опций

Возвращает

string
код onclick JS

addClass()source public 

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

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

Параметры

array $options optional []
Массив опций/атрибутов, к которым нужно добавить класс
string|null $class optional null
Имя добавляемого класса.
string $key optional 'class'
Ключ, который нужно использовать для класса.

Возвращает

array
Массив опций со значением $key.

implementedEvents()source public 

implementedEvents( )

Получить обратные вызовы View, в которых заинтересован этот helper.

Определяя один из методов обратного вызова, предполагается, что helper заинтересован в соответствующем событии.

Переопределите этот метод, если вам нужно добавить слушателей событий нестандартного типа. Или если вы хотите, чтобы helpers прослушивали нестандартные события.

Возвращает

array

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public 

initialize( array $config )

Метод обратной связи конструктора.

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

Параметры

array $config
Параметры конфигурации, предоставленные этому helper.

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDelete()source protected 

_configDelete( string $key )

Удалить один ключ конфигурации

Параметры

string $key
Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

_configRead()source protected 

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

string|null $key
Ключ для чтения.

Возвращает

mixed

_configWrite()source protected 

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записать переменную конфигурации

Параметры

string|array $key
Ключ для записи.
mixed $value
Значение для записи.
boolean|string $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Выбрасывает

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

config()source public 

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array|null $key необязательно null
Ключ для получения/установки, или полный массив конфигураций.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

mixed
Значение конфигурации для чтения или сам объект при операциях записи.

Выбрасывает

Cake\Core\Exception\Exception
При попытке установить неверный ключ.

configShallow()source public 

configShallow( string|array $key , mixed|null $value null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config() , которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key
Ключ для установки, или полный массив конфигураций.
mixed|null $value необязательно null
Значение для установки.

Возвращает


$this Сам объект.

Подробное описание свойств

$_Viewsource

protected Cake\View\View

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

$_defaultConfigsource

protected array

Значения конфигурации по умолчанию для данного помощника.

[]

$_helperMapsource

protected array

Таблица поиска помощников, используемая для отложенной загрузки объектов помощников.

[]

$fieldsetsource

public array

Содержит поля ['имя_поля' => ['тип' => 'строка', 'длина' => 100]], первичный ключ и валидацию ['имя_поля']

[]

$helperssource

public array

Список помощников, используемых этим помощником

[]

$pluginsource

public string

Путь к плагину

null

$requestsource

public Cake\Network\Request

Объект запроса

null

$tagssource

public array

Хранит шаблоны тегов.

[]

$themesource

public string

Название текущей темы, если таковая имеется.

null

© 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/3.2/class-Cake.View.Helper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API