Spec-Zone.ru › CakePHP 4.2

Класс Helper

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

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

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

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

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

  • $_View protected
    Cake\View\View

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

  • $_config protected
    array

    Конфигурация выполнения

  • $_configInitialized protected
    bool

    Указание, была ли конфигурация уже настроена по умолчанию

  • $_defaultConfig protected
    array

    Конфигурация по умолчанию для этого помощника.

  • $_helperMap protected
    array

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

  • $helpers protected
    array

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

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

  • __call() public

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

  • __construct() public

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

  • __debugInfo() public

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

  • __get() public

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

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • _confirm() protected

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

  • addClass() public

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

  • configShallow() public

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

  • getConfig() public

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

  • getConfigOrFail() public

    Возвращает конфигурацию для этого конкретного ключа.

  • getView() public

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

  • implementedEvents() public

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

  • initialize() public

    Метод обратного вызова инициализации.

  • setConfig() public

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

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

__call() public 

__call(string $method, array $params): mixed|void

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

Параметры

string $method

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

array $params

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

Возвращает

mixed|void

__construct() public 

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

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

Параметры

Cake\View\View $view

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

array $config необязательный

Параметры конфигурации помощника.

__debugInfo() public 

__debugInfo(): array

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

Возвращает

array

__get() public 

__get(string $name): Cake\View\Helper|null|void

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

Параметры

string $name

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

Возвращает

Cake\View\Helper|null|void

_configDelete() protected 

_configDelete(string $key): void

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

Параметры

string $key

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

Возвращает

void

Выбрасывает

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

_configRead() protected 

_configRead(string|null $key): mixed

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

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite() protected 

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

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

Параметры

string|array $key

Ключ для записи.

mixed $value

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

bool|string $merge необязательный

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

Возвращает

void

Выбрасывает

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

_confirm() protected 

_confirm(string $okCode, string $cancelCode): string

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

Параметры

string $okCode

Код, который будет выполнен после выбора 'OK'

string $cancelCode

Код, который будет выполнен после выбора 'Отмена'

Возвращает

string

addClass() public 

addClass(array $options, string $class, string $key = 'class'): array

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

Параметры

array $options

Массив параметров/атрибутов для добавления класса.

string $class

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

string $key необязательный

Используемый ключ для класса. По умолчанию 'class'.

Возвращает

array

configShallow() public 

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

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

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

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

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

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

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

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

Параметры

string|array $key

Ключ для установки или весь массив конфигураций.

mixed|null $value необязательный

Значение для установки.

Возвращает

$this

getConfig() public 

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

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

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

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

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

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

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

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

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

Параметры

string|null $key необязательный

Ключ для получения или null для всей конфигурации.

mixed $default необязательный

Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

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

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key

Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getView() public 

getView(): Cake\View\View

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

Возвращает

Cake\View\View

implementedEvents() public 

implementedEvents(): array

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

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

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

Возвращает

array

initialize() public 

initialize(array $config): void

Метод обратного вызова конструктора.

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

Параметры

array $config

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

Возвращает

void

setConfig() public 

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

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

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

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

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

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

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

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

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

Параметры

string|array $key

Ключ для установки или весь массив конфигураций.

mixed|null $value необязательный

Значение для установки.

bool $merge необязательный

Выполнять ли рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Выбрасывает

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

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

$_View protected

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

Тип

Cake\View\View

$_config protected

Конфигурация во время выполнения

Тип

array

$_configInitialized protected

Указатель на то, была ли конфигурация свойства уже настроена по умолчанию

Тип

bool

$_defaultConfig protected

Конфигурация по умолчанию для этого помощника.

Тип

array

$_helperMap protected

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

Тип

array

$helpers protected

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

Тип

array

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

Spec-Zone.ru

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