Spec-Zone.ru › CakePHP 3.4

Класс Helper

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

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

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

  • 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\BreadcrumbsHelper
  • Cake\View\Helper\FlashHelper
  • Cake\View\Helper\UrlHelper
  • 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
Расположение: View/Helper.php

Краткое описание свойств

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

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

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

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

  • _config, _configInitialized

Краткое описание методов

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

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

  • __get() public
    Ленивая загрузка помощников.
  • _confirm() protected
    Возвращает строку, используемую в качестве обработчика onclick для диалоговых окон подтверждения.
  • addClass() public
    Добавляет указанный класс к параметрам элемента
  • getView() public
    Получение экземпляра представления, к которому привязан этот помощник.
  • implementedEvents() public
    Получение обратных вызовов представления, в которых заинтересован этот помощник.
  • 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
Представление, к которому прикрепляется помощник.
array $config optional []
Настройки конфигурации помощника.

__debugInfo()source public 

__debugInfo( )

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

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

array

__get()source public 

__get( string $name )

Ленивая загрузка помощников.

Параметры

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

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

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

_confirm()source protected 

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

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

Параметры

string $message
Сообщение, которое должно быть отображено
string $okCode
Код, который должен быть выполнен после того, как пользователь выбрал 'OK'
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.

getView()source public 

getView( )

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

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

Cake\View\View
Экземпляр привязанного представления.

implementedEvents()source public 

implementedEvents( )

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

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

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

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

array

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public 

initialize( array $config )

Метод подключения конструктора.

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

Параметры

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

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

_configDelete()source protected 

_configDelete( string $key )

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

Параметры

строка $key
Ключ для удаления.

Исключения

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

_configRead()source protected 

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed

_configWrite()source protected 

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

Записывает ключ конфигурации.

Параметры

строка|массив $key
Ключ для записи.
mixed $value
Значение для записи.
boolean|строка $merge по желанию 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']);

Устаревшее

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

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

Возвращает

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

Исключения

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

configShallow()source public 

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

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

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

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

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

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

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

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

Параметры

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

Возвращает


$this

getConfig()source public 

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

строка|null $key по желанию null
Ключ для получения или null для всей конфигурации.
mixed $default по желанию null
Возвращаемое значение, если ключ не существует.

Возвращает

mixed
Значение конфигурации, которое читается.

setConfig()source public 

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

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

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

Возвращает


$this

Исключения

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

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

$_Viewsource

protected Cake\View\View

Экземпляр View, к которому прикреплен этот помощник

$_defaultConfigsource

protected массив

Настройки по умолчанию для этого помощника.

[]

$_helperMapsource

protected массив

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

[]

$fieldsetsource

public массив

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

[]

$helperssource

public массив

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

[]

$pluginsource

public строка

Путь плагина

$requestsource

public Cake\Http\ServerRequest

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

$tagssource

public массив

Содержит шаблоны тегов.

[]

$themesource

public строка

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

© 2005–2017 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.
https://api.cakephp.org/3.4/class-Cake.View.Helper.html

Spec-Zone.ru

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