Spec-Zone.ru › CakePHP 3.7

Класс Component

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

Обратный вызов инициализации

Как и контроллер и таблица, этот класс имеет обратный вызов initialize(), который вы можете использовать для добавления пользовательской логики «конструктора». Важно помнить, что каждый запрос (и подзапрос) будет создавать только один экземпляр любого заданного компонента.

Обратные вызовы жизненного цикла

Компоненты могут предоставлять несколько обратных вызовов, которые вызываются на разных этапах цикла запроса. Доступные обратные вызовы:

  • beforeFilter(Event $event) Вызывается перед методом beforeFilter контроллера по умолчанию.
  • startup(Event $event) Вызывается после метода beforeFilter контроллера и перед вызовом действия контроллера.
  • beforeRender(Event $event) Вызывается перед методом Controller beforeRender и перед загрузкой класса представления.
  • shutdown(Event $event) Вызывается после завершения действия и рендеринга представления, но перед Controller::afterFilter().
  • beforeRedirect(Event $event $url, Response $response) Вызывается перед выполнением перенаправления. Позволяет изменить URL, к которому будет выполнено перенаправление, возвращая экземпляр Response с новым URL, заданным с помощью Response::location(). Перенаправление можно предотвратить, остановив распространение события.

Хотя контроллер не является явным аргументом для методов обратного вызова, он является объектом каждого события и может быть получен с помощью Event::getSubject().

Cake\Controller\Component реализует Cake\Event\EventListenerInterface использует Cake\Core\InstanceConfigTrait , Cake\Log\LogTrait

Непосредственные подклассы

  • Cake\Controller\Component\AuthComponent
  • Cake\Controller\Component\CookieComponent
  • Cake\Controller\Component\CsrfComponent
  • Cake\Controller\Component\FlashComponent
  • Cake\Controller\Component\PaginatorComponent
  • Cake\Controller\Component\RequestHandlerComponent
  • Cake\Controller\Component\SecurityComponent
Пространство имён: Cake\Controller
Ссылка: https://book.cakephp.org/3.0/ru/controllers/components.html
См.: \Cake\Controller\Controller::$components
Расположение: Controller/Component.php

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

  • $_componentMap protected
    array
    Таблица поиска компонентов, используемая для ленивой загрузки объектов компонентов.
  • $_defaultConfig protected
    array
    Конфигурация по умолчанию
  • $_registry protected
    Cake\Controller\ComponentRegistry
    Класс реестра компонентов, используемый для ленивой загрузки компонентов.
  • $components public
    array
    Другие компоненты, используемые этим компонентом.
  • $request public
    Cake\Http\ServerRequest
    Объект запроса
  • $response public
    Cake\Http\Response
    Объект ответа

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

  • _config, _configInitialized

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

  • __construct() public
    Конструктор
  • __debugInfo() public

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

  • __get() public
    Магический метод для ленивой загрузки $components.
  • getController() public
    Получение контроллера, к которому привязан этот компонент.
  • implementedEvents() public
    Получение обратных вызовов контроллера, в которых заинтересован этот компонент.
  • initialize() public
    Метод обратного вызова конструктора.

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

__construct()source public 

__construct( Cake\Controller\ComponentRegistry $registry , array $config = [] )

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry
ComponentRegistry, который может использовать этот компонент для ленивой загрузки своих компонентов
массив $config необязательно []
Массив параметров конфигурации.

__debugInfo()source public 

__debugInfo( )

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

Возвращает

массив

__get()source public 

__get( string $name )

Магический метод для ленивой загрузки $components.

Параметры

строка $name
Имя компонента для получения.

Возвращает

смешанное
Объект компонента или null.

getController()source public 

getController( )

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

Возвращает

Cake\Controller\Controller
Привязанный контроллер.

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
Ключ для чтения.

Возвращает

смешанное

_configWrite()source protected 

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

Запись ключа конфигурации.

Параметры

строка|массив $key
Ключ для записи.
смешанное $value
Значение для записи.
boolean|строка $merge необязательно false

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

Исключения

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

config()source public deprecated 

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() вместо этого.

Параметры

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->configShallow('key', $value);

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

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

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

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

Параметры

string|array $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');

Параметры

string|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']);

Параметры

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

Возвращает


$this

Исключение

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

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

log()source public 

log( mixed $msg , integer|string $level = LogLevel::ERROR , string|array $context = [] )

Удобный метод для записи сообщения в журнал. Смотрите Log::write() для получения дополнительной информации о записи в журналы.

Параметры

mixed $msg
Сообщение журнала.
integer|string $level необязательно LogLevel::ERROR
Уровень ошибки.
string|array $context необязательно []
Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

boolean
Успешность записи в журнал.

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

$_componentMapsource

protected array

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

[]

$_defaultConfigsource

protected array

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

Эти настройки объединяются с предоставленными пользователем настройками при использовании компонента.

[]

$_registrysource

protected Cake\Controller\ComponentRegistry

Класс реестра компонентов, используемый для ленивой загрузки компонентов.

$componentssource

public array

Другие компоненты, используемые этим компонентом.

[]

$requestsource

public Cake\Http\ServerRequest

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

Устаревшее

3.4.0 Хранение ссылок на запрос устарело. Используйте Component::getController() или обращение $event->getSubject() для доступа к контроллеру и запросу вместо этого.


$responsesource

public Cake\Http\Response

Объект ответа

Устаревшее

3.4.0 Хранение ссылок на ответ устарело. Используйте Component::getController() или обращение $event->getSubject() для доступа к контроллеру и ответу вместо этого.


© 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.7/class-Cake.Controller.Component.html

Spec-Zone.ru

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