Spec-Zone.ru › CakePHP 3.5

Класс 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
JS-код onclick

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
Значение для записи.
логическое значение|строка $merge необязательно false

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

Исключения

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
Значение для установки.
логическое значение $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
Значение для установки.
логическое значение $merge необязательно true
Выполнять ли рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию истинно.

Возвращает


$this

Исключения

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

Подробности свойств

$_Viewsource

protected Cake\View\View

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

$_defaultConfigsource

protected массив

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

[]

$_helperMapsource

protected массив

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

[]

$fieldsetsource

public массив

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

[]

$helperssource

public массив

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

[]

$pluginsource

public строка

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

$requestsource

public Cake\Http\ServerRequest

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

$tagssource

public массив

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

[]

$themesource

public строка

Текущее имя темы, если оно есть.

© 2005–2018 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.5/class-Cake.View.Helper.html

Spec-Zone.ru

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