Spec-Zone.ru › CakePHP 3.6

Класс 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

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

  • $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 )

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

Параметры

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

__construct()source public 

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

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

Параметры

Cake\View\View $View
Представление, к которому прикрепляется помощник.
массив $config необязательно []
Параметры настройки для помощника.

__debugInfo()source public 

__debugInfo( )

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

Возвращает

массив

__get()source public 

__get( string $name )

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

Параметры

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

Возвращает

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

_confirm()source protected 

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

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

Параметры

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

Возвращает

строка
код onclick JS

addClass()source public 

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

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

Параметры

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

Возвращает

массив
Массив параметров со свойством $key.

getView()source public 

getView( )

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

Возвращает

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

implementedEvents()source public 

implementedEvents( )

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

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

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

Возвращает

массив

Реализация

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
Ключ для записи.
смешанный $value
Значение для записи.
булево|строка $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
Ключ для получения/установки или полный массив конфигураций.
смешанный|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
Ключ для установки или полный массив конфигураций.
смешанный|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 для всей конфигурации.
смешанный $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
Ключ для установки или полный массив конфигураций.
смешанный|null $value необязательно null
Значение для установки.
булево $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–present 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.6/class-Cake.View.Helper.html

Spec-Zone.ru

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