Класс Controller

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

Контроллеры должны предоставлять ряд методов «действия». Это публичные методы контроллера, которые не унаследованы от Controller. Каждое действие служит конечной точкой для выполнения определенного действия с ресурсом или набором ресурсов. Например, добавление или редактирование нового объекта, или вывод набора объектов.

Вы можете получить доступ к параметрам запроса, используя $this->getRequest(). Объект запроса содержит все POST, GET и FILES, которые были частью запроса.

После выполнения необходимого действия, контроллеры отвечают за создание ответа. Обычно это происходит в форме сгенерированного View, или, возможно, перенаправления на другой URL. В любом случае $this->getResponse() позволяет вам управлять всеми аспектами ответа.

Контроллеры создаются ActionDispatcher на основе параметров запроса и маршрутизации. По умолчанию контроллеры и действия используют стандартные имена. Например, /posts/index отображается как PostsController::index(). Вы можете перенаправить URL-адреса, используя Router::connect() или RouterBuilder::connect().

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

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

beforeFilter(EventInterface $event) Вызывается перед каждым действием. Это хорошее место для выполнения общей логики, которая применяется ко всем действиям.
beforeRender(EventInterface $event) Вызывается перед отображением представления.
beforeRedirect(EventInterface $event, $url, Response $response) Вызывается перед выполнением перенаправления.
afterFilter(EventInterface $event) Вызывается после завершения каждого действия и после отображения представления.

Пространство имён: Cake\Controller
Ссылка: https://book.cakephp.org/4/en/controllers.html

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

$Auth public @property

Cake\Controller\Component\AuthComponent
$Flash public @property

Cake\Controller\Component\FlashComponent
$FormProtection public @property

Cake\Controller\Component\FormProtectionComponent
$Paginator public @property

Cake\Controller\Component\PaginatorComponent
$RequestHandler public @property

Cake\Controller\Component\RequestHandlerComponent
$Security public @property

Cake\Controller\Component\SecurityComponent
$_components protected

Cake\Controller\ComponentRegistry|null

Экземпляр ComponentRegistry, используемый для создания компонентов
$_eventClass protected

string

Изначальное имя класса для новых объектов событий.
$_eventManager protected

Cake\Event\EventManagerInterface|null

Экземпляр Cake\Event\EventManager, используемый этим объектом для диспетчеризации внутренних событий.
$_modelFactories protected

(callableCake\Datasource\Locator\LocatorInterface)[]

Список переопределённых функций фабрики моделей.
$_modelType protected

string

Тип модели, который следует использовать.
$_responseClass protected

string

Имя класса, который следует использовать для создания объекта ответа.
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Экземпляр локатора таблиц
$_viewBuilder protected

Cake\View\ViewBuilder|null

Используемый экземпляр билдера представлений.
$autoRender protected

bool

Устанавливается в значение true, чтобы автоматически отобразить представление после логики действия.
$modelClass protected

string|null

Основное имя класса модели этого объекта. Должно быть в множественном числе. CakePHP не будет склонять имя.
$name protected

string

Имя этого контроллера. Имена контроллеров — во множественном числе, по аналогии с моделью, которую они обрабатывают.
$paginate public

array

Настройки для пагинации.
$plugin protected

string|null

Автоматически устанавливается в имя плагина.
$request protected

Cake\Http\ServerRequest

Экземпляр объекта \Cake\Http\ServerRequest, содержащий информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.
$response protected

Cake\Http\Response

Экземпляр объекта Response, содержащий информацию о предстоящем ответе

END_OF_DOCUMENT_MARKER

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

__construct() public

Конструктор.
__get() public

Магический метод доступа для автозагрузки моделей.
__set() public

Магический метод установки для удалённых свойств.
_setModelClass() protected

Установить свойство modelClass на основе соглашений.
_templatePath() protected

Получить templatePath на основе имени контроллера и префикса запроса.
afterFilter() public

Вызывается после выполнения и отрисовки действия контроллера.
beforeFilter() public

Вызывается перед действием контроллера. Вы можете использовать этот метод для настройки и кастомизации компонентов или выполнения логики, которая должна выполняться перед каждым действием контроллера.
beforeRedirect() public

Метод beforeRedirect вызывается, когда вызывается метод перенаправления контроллера, но перед любыми дальнейшими действиями.
beforeRender() public

Вызывается после выполнения действия контроллера, но перед отрисовкой представления. Вы можете использовать этот метод для выполнения логики или задания переменных представления, которые необходимы для каждого запроса.
components() public

Получить реестр компонентов для этого контроллера.
createView() public

Создаёт экземпляр класса представления на основе текущей конфигурации.
disableAutoRender() public

Отключить автоматическую отрисовку действия.
dispatchEvent() public

Обёртка для создания и отправки событий.
enableAutoRender() public

Включить автоматическую отрисовку действия.
getAction() public

Получить замыкание для действия, которое должно быть вызвано ControllerFactory.
getEventManager() public

Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.
getModelType() public

Получить тип модели, который будет использоваться этим классом
getName() public

Возвращает имя контроллера.
getPlugin() public

Возвращает имя плагина.
getRequest() public

Получает экземпляр запроса.
getResponse() public

Получает экземпляр ответа.
getTableLocator() public

Получает локатор таблиц.
implementedEvents() public

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

Метод инициализации.
invokeAction() public

Диспетчер действия контроллера.
isAction() public

Метод проверки доступности действия из URL.
isAutoRenderEnabled() public

Возвращает true, если действие должно быть автоматически отрисовано.
loadComponent() public

Добавить компонент в реестр контроллера.
loadModel() public

Загружает и создаёт объекты репозитория, необходимые этому объекту.
log() public

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

Переопределить существующую вызываемую функцию для генерации репозиториев заданного типа.
paginate() public

Обрабатывает постраничную навигацию записей в объектах таблиц.
redirect() public

Перенаправляет на заданный $url после отключения $this->autoRender.
referer() public

Возвращает URL ссылки, которая привела к этому запросу.
render() public

Создаёт экземпляр соответствующего класса представления, передаёт ему данные и использует его для отрисовки вывода представления.
set() public

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.
setAction() public deprecated

Внутренне перенаправляет одно действие на другое. Не выполняет другой HTTP-запрос в отличие от Controller::redirect()
setEventManager() public

Возвращает экземпляр Cake\Event\EventManagerInterface для данного объекта.
setModelType() public

Установить тип модели, который будет использоваться этим классом
setName() public

Устанавливает имя контроллера.
setPlugin() public

Устанавливает имя плагина.
setRequest() public

Устанавливает объекты запроса и настраивает ряд свойств контроллера на основе содержимого запроса. Контроллер выступает в качестве прокси для некоторых переменных представления, которые также должны быть обновлены здесь. Свойства, которые устанавливаются:
setResponse() public

Устанавливает экземпляр ответа.
setTableLocator() public

Устанавливает локатор таблиц.
shutdownProcess() public

Выполнить различные процессы завершения работы для этого контроллера. Выполнить обработчики компонентов и контроллера в правильном порядке.
startupProcess() public

Выполнить процесс запуска для этого контроллера. Выполнить обработчики компонентов и контроллера в правильном порядке.
viewBuilder() public

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

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

__construct() public

__construct(Cake\Http\ServerRequest|null $request = null, Cake\Http\Response|null $response = null, string|null $name = null, Cake\Event\EventManagerInterface|null $eventManager = null, Cake\Controller\ComponentRegistry|null $components = null)

Конструктор.

Устанавливает ряд свойств на основе соглашений, если они пусты. Чтобы переопределить используемые CakePHP соглашения, вы можете определить свойства в объявлении вашего класса.

Параметры

Cake\Http\ServerRequest|null $request необязательный: Объект запроса для данного контроллера. Может быть null для тестирования, но ожидайте, что функции, использующие параметры запроса, не будут работать.
Cake\Http\Response|null $response необязательный: Объект ответа для данного контроллера.
string|null $name необязательный: Переопределите имя, полезное при тестировании с использованием подстановочных значений.
Cake\Event\EventManagerInterface|null $eventManager необязательный: Менеджер событий. По умолчанию создаётся новый экземпляр.
Cake\Controller\ComponentRegistry|null $components необязательный: Регистр компонентов. По умолчанию создаётся новый экземпляр.

__get() public

__get(string $name): Cake\Datasource\RepositoryInterface|null

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

Параметры

string $name: Имя свойства

Возвращает

Cake\Datasource\RepositoryInterface|null

__set() public

__set(string $name, mixed $value): void

Магический сеттер для удалённых свойств.

Параметры

string $name: Имя свойства.
mixed $value: Значение для установки.

Возвращает

void

_setModelClass() protected

_setModelClass(string $name): void

Устанавливает свойство modelClass на основе соглашений.

Если свойство уже установлено, оно не будет перезаписано.

Параметры

string $name: Имя класса.

Возвращает

void

_templatePath() protected

_templatePath(): string

Возвращает templatePath на основе имени контроллера и префикса запроса.

Возвращает

string

afterFilter() public

afterFilter(Cake\Event\EventInterface $event): Cake\Http\Response|null|void

Вызывается после выполнения и рендеринга действия контроллера.

Параметры

Cake\Event\EventInterface $event: Экземпляр события

Возвращает

Cake\Http\Response|null|void

Ссылки

https://book.cakephp.org/4/en/controllers.html#request-life-cycle-callbacks

beforeFilter() public

beforeFilter(Cake\Event\EventInterface $event): Cake\Http\Response|null|void

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

Параметры

Cake\Event\EventInterface $event: Экземпляр события

Возвращает

Cake\Http\Response|null|void

Ссылки

https://book.cakephp.org/4/en/controllers.html#request-life-cycle-callbacks

beforeRedirect() public

beforeRedirect(Cake\Event\EventInterface $event, string|array $url, Cake\Http\Response $response): Cake\Http\Response|null|void

Метод beforeRedirect вызывается при вызове метода redirect контроллера, но до дальнейших действий.

Если событие остановлено, контроллер не будет продолжать перенаправлять запрос. Переменные $url и $status имеют то же значение, что и для метода контроллера. Вы можете установить результат события в экземпляр ответа или изменить местоположение перенаправления, используя экземпляр ответа контроллера.

Параметры

Cake\Event\EventInterface $event: Экземпляр события
string|array $url: Строка или массив, определяющий URL, указывающий на другую позицию в приложении или абсолютный URL
Cake\Http\Response $response: Объект ответа.

Возвращает

Cake\Http\Response|null|void

Ссылки

https://book.cakephp.org/4/en/controllers.html#request-life-cycle-callbacks

beforeRender() public

beforeRender(Cake\Event\EventInterface $event): Cake\Http\Response|null|void

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

Параметры

Cake\Event\EventInterface $event: Экземпляр события

Возвращает

Cake\Http\Response|null|void

Ссылки

https://book.cakephp.org/4/en/controllers.html#request-life-cycle-callbacks

components() public

components(Cake\Controller\ComponentRegistry|null $components = null): Cake\Controller\ComponentRegistry

Получение регистра компонентов для данного контроллера.

Если вызывается с первым параметром, он будет установлен как свойство контроллера $this->_components

Параметры

Cake\Controller\ComponentRegistry|null $components необязательный: Регистр компонентов.

Возвращает

Cake\Controller\ComponentRegistry

createView() public

createView(string|null $viewClass = null): Cake\View\View

Создаёт экземпляр класса представления на основе текущей конфигурации.

Параметры

string|null $viewClass необязательный: Необязательное полное имя класса представления для создания экземпляра.

Возвращает

Cake\View\View

Исключения

Cake\View\Exception\MissingViewException
Если класс представления не найден.

disableAutoRender() public

disableAutoRender(): $this

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

Возвращает

$this

dispatchEvent() public

dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface

Обёртка для создания и отправки событий.

Возвращает отправленное событие.

Параметры

string $name: Имя события.
array|null $data необязательный: Любое значение, которое вы хотите передать с этим событием, его могут прочитать слушатели.
object|null $subject необязательный: Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\EventInterface

enableAutoRender() public

enableAutoRender(): $this

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

Возвращает

$this

getAction() public

getAction(): Closure

Получить замыкание для вызова действия ControllerFactory.

Возвращает

Closure

Исключения

Cake\Controller\Exception\MissingActionException

getEventManager() public

getEventManager(): Cake\Event\EventManagerInterface

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

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

Возвращает

Cake\Event\EventManagerInterface

getModelType() public

getModelType(): string

Получить тип модели, используемой этим классом

Возвращает

string

getName() public

getName(): string

Возвращает имя контроллера.

Возвращает

string

getPlugin() public

getPlugin(): string|null

Возвращает имя плагина.

Возвращает

string|null

getRequest() public

getRequest(): Cake\Http\ServerRequest

Получает экземпляр запроса.

Возвращает

Cake\Http\ServerRequest

getResponse() public

getResponse(): Cake\Http\Response

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

Возвращает

Cake\Http\Response

getTableLocator() public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Получает локатор таблицы.

Возвращает

Cake\ORM\Locator\LocatorInterface

implementedEvents() public

implementedEvents(): array

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

Пример:

public function implementedEvents()
 {
     return [
         'Order.complete' => 'sendEmail',
         'Article.afterBuy' => 'decrementInventory',
         'User.onRegister' => ['callable' => 'logRegistration', 'priority' => 20, 'passParams' => true]
     ];
 }

Возвращает

array

initialize() public

initialize(): void

Метод инициализации.

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

Возвращает

void

invokeAction() public

invokeAction(Closure $action, array $args): void

Выполняет действие контроллера.

Параметры

Closure $action: Закрытие действия.
array $args: Аргументы, которые будут переданы при вызове действия.

Возвращает

void

Исключения

UnexpectedValueException
Если возвращаемое значение действия не равно `null` или экземпляру `ResponseInterface`.

isAction() public

isAction(string $action): bool

Метод для проверки доступности действия из URL.

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

Параметры

string $action: Действие для проверки.

Возвращает

bool

Исключения

ReflectionException

isAutoRenderEnabled() public

isAutoRenderEnabled(): bool

Возвращает true, если действие должно быть отображено автоматически.

Возвращает

bool

loadComponent() public

loadComponent(string $name, array $config = []): Cake\Controller\Component

Добавление компонента в реестр контроллера.

Этот метод также установит компонент в свойство. Например:

$this->loadComponent('Authentication.Authentication');

Приведет к установке свойства Authentication.

Параметры

string $name: Имя компонента для загрузки.
array $config optional: Настройка компонента.

Возвращает

Cake\Controller\Component

Исключения

Exception

loadModel() public

loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface

Загружает и создаёт объекты репозитория, необходимые для этого объекта.

Обычно используется для загрузки объектов ORM Table по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.

Если поставщик репозитория не возвращает объект, будет выброшено MissingModelException.

Параметры

string|null $modelClass optional: Имя класса модели для загрузки. По умолчанию $this->modelClass. Имя может быть псевдонимом, например, 'Post', или полным именем класса, например, App\Model\Table\PostsTable::class.
string|null $modelType optional: Тип репозитория для загрузки. По умолчанию значение getModelType().

Возвращает

Cake\Datasource\RepositoryInterface

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
UnexpectedValueException
Если аргумент $modelClass не указан, а значение свойства ModelAwareTrait::$modelClass пустое.

log() public

log(string $message, int|string $level = LogLevel::ERROR, string|array $context = []): bool

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

Параметры

string $message: Сообщение для журнала.
int|string $level optional: Уровень ошибки.
string|array $context optional: Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

modelFactory() public

modelFactory(string $type, callableCake\Datasource\Locator\LocatorInterface $factory): void

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

Параметры

string $type: Имя типа репозитория, для которого предназначена функция фабрики.
callableCake\Datasource\Locator\LocatorInterface $factory: Функция фабрики, используемая для создания экземпляров.

Возвращает

void

paginate() public

paginate(Cake\ORM\Table|stringCake\ORM\Query|null $object = null, array $settings = []): Cake\ORM\ResultSetCake\Datasource\ResultSetInterface

Обрабатывает постраничную навигацию записей в объектах таблицы.

Загрузит указанный объект таблицы, и PaginatorComponent постранично отобразит запросы, используя данные запроса и настройки, определенные в $this->paginate.

Этот метод также сделает PaginatorHelper доступным в представлении.

Параметры

Cake\ORM\Table|stringCake\ORM\Query|null $object optional: Таблица для постраничной навигации (например: экземпляр таблицы, 'TableName' или объект запроса)
array $settings optional: Настройки/конфигурация, используемые для постраничной навигации.

Возвращает

Cake\ORM\ResultSetCake\Datasource\ResultSetInterface

Исключения

RuntimeException
При отсутствии совместимого объекта таблицы.

Ссылки

https://book.cakephp.org/4/en/controllers.html#paginating-a-model

redirect() public

redirect(string|arrayPsr\Http\Message\UriInterface $url, int $status = 302): Cake\Http\Response|null

Перенаправляет на заданный $url, после отключения $this->autoRender.

Параметры

string|arrayPsr\Http\Message\UriInterface $url: Строка, URL на основе массива или экземпляр UriInterface.
int $status optional: Код HTTP-статуса. По умолчанию 302.

Возвращает

Cake\Http\Response|null

Ссылки

https://book.cakephp.org/4/en/controllers.html#Controller::redirect

referer() public

referer(string|array|null $default = '/', bool $local = true): string

Возвращает URL ссылки, направившей данный запрос.

Параметры

string|array|null $default optional: URL по умолчанию, используемый, если HTTP_REFERER нельзя считать из заголовков
bool $local optional: Если false, не ограничивайте URL ссылок локальным сервером. Будьте осторожны при доверие внешним источникам.

Возвращает

string

render() public

render(string|null $template = null, string|null $layout = null): Cake\Http\Response

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

Параметры

string|null $template optional: Шаблон для рендеринга
string|null $layout optional: Макет для использования

Возвращает

Cake\Http\Response

Ссылки

https://book.cakephp.org/4/en/controllers.html#rendering-a-view

set() public

set(string|array $name, mixed $value = null): $this

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

string|array $name: Строка или массив данных.
mixed $value optional: Значение, если $name - это строка (которая затем работает в качестве ключа). Не используется, если $name - это ассоциативный массив, в противном случае служит значениями для ключей $name.

Возвращает

$this

setAction() public

setAction(string $action, mixed ...$args): mixed

Внутренне перенаправляет одно действие на другое. Не выполняет другой HTTP-запрос, в отличие от Controller::redirect()

Примеры:

setAction('another_action');
setAction('action_with_parameters', $parameter1);

Параметры

string $action: Новое действие, к которому осуществляется «перенаправление». Все другие параметры, переданные в этот метод, будут переданы в качестве параметров новому действию.
mixed ...$args: Аргументы, передаваемые действию

Возвращает

mixed

setEventManager() public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

Возвращает экземпляр Cake\Event\EventManagerInterface для этого объекта.

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

Параметры

Cake\Event\EventManagerInterface $eventManager: устанавливаемый eventManager

Возвращает

$this

setModelType() public

setModelType(string $modelType): $this

Устанавливает тип модели, который будет использоваться этим классом

Параметры

string $modelType: Тип модели

Возвращает

$this

setName() public

setName(string $name): $this

Устанавливает имя контроллера.

Параметры

string $name: Имя контроллера.

Возвращает

$this

setPlugin() public

setPlugin(string|null $name): $this

Устанавливает имя плагина.

Параметры

string|null $name: Имя плагина.

Возвращает

$this

setRequest() public

setRequest(Cake\Http\ServerRequest $request): $this

Устанавливает объекты запроса и настраивает ряд свойств контроллера на основе содержимого запроса. Контроллер действует как прокси для определенных переменных представления, которые также должны быть обновлены здесь. Свойства, которые устанавливаются:

$this->request - в $request параметр

Параметры

Cake\Http\ServerRequest $request: Экземпляр запроса.

Возвращает

$this

setResponse() public

setResponse(Cake\Http\Response $response): $this

Устанавливает экземпляр ответа.

Параметры

Cake\Http\Response $response: Экземпляр ответа.

Возвращает

$this

setTableLocator() public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Устанавливает локатор таблицы.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator: Экземпляр LocatorInterface.

Возвращает

$this

shutdownProcess() public

shutdownProcess(): Psr\Http\Message\ResponseInterface|null

Выполняет различные процессы завершения работы для этого контроллера. Вызывает компоненты и обратные вызовы контроллера в правильном порядке.

вызывает обратный вызов компонента shutdown
вызывает метод контроллера afterFilter

Возвращает

Psr\Http\Message\ResponseInterface|null

startupProcess() public

startupProcess(): Psr\Http\Message\ResponseInterface|null

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

Инициализирует компоненты, вызывая их обратный вызов initialize
Вызывает метод контроллера beforeFilter.
вызывает методы компонента startup

Возвращает

Psr\Http\Message\ResponseInterface|null

viewBuilder() public

viewBuilder(): Cake\View\ViewBuilder

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

Возвращает

Cake\View\ViewBuilder

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

`$Auth` public @property

Тип

Cake\Controller\Component\AuthComponent

`$Flash` public @property

Тип

Cake\Controller\Component\FlashComponent

`$FormProtection` public @property

Тип

Cake\Controller\Component\FormProtectionComponent

`$Paginator` public @property

Тип

Cake\Controller\Component\PaginatorComponent

`$RequestHandler` public @property

Тип

Cake\Controller\Component\RequestHandlerComponent

`$Security` public @property

Тип

Cake\Controller\Component\SecurityComponent

`$_components` protected

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

Тип

Cake\Controller\ComponentRegistry|null

`$_eventClass` protected

Имя по умолчанию класса для новых объектов событий.

Тип

string

`$_eventManager` protected

Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.

Тип

Cake\Event\EventManagerInterface|null

`$_modelFactories` protected

Список переопределенных функций фабрики моделей.

Тип

(callableCake\Datasource\Locator\LocatorInterface)[]

`$_modelType` protected

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

Тип

string

`$_responseClass` protected

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

Тип

string

`$_tableLocator` protected

Экземпляр локатора таблиц

Тип

Cake\ORM\Locator\LocatorInterface|null

`$_viewBuilder` protected

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

Тип

Cake\View\ViewBuilder|null

`$autoRender` protected

Устанавливается в значение true для автоматического рендеринга представления после обработки действий.

Тип

bool

`$modelClass` protected

Основное имя класса модели для этого объекта. Должно быть в форме множественного числа. CakePHP не будет изменять имя.

Пример: Для объекта с именем 'Комментарии', моделью будет 'Комментарии'. Классы плагинов должны использовать имена в формате Plugin.Comments для правильной загрузки моделей из соответствующего плагина.

Используйте пустую строку, чтобы не использовать автоматическую загрузку для этого объекта. Значение Null определяет автообнаружение на основе имени контроллера.

Тип

string|null

`$name` protected

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

Автоматически устанавливается с помощью соглашений в Controller::__construct().

Тип

string

`$paginate` public

Параметры для постраничной навигации.

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

Тип

array

`$plugin` protected

Автоматически устанавливается в имя плагина.

Тип

string|null

`$request` protected

Экземпляр объекта \Cake\Http\ServerRequest, содержащий информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для получения дополнительной информации о запросе.

Тип

Cake\Http\ServerRequest

`$response` protected

Экземпляр объекта Response, содержащий информацию о предстоящем ответе.

Тип

Cake\Http\Response

© 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.Controller.Controller.html

Класс Controller

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

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

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

__construct() public

__get() public

__set() public

_setModelClass() protected

_templatePath() protected

afterFilter() public

beforeFilter() public

beforeRedirect() public

beforeRender() public

components() public

createView() public

disableAutoRender() public

dispatchEvent() public

enableAutoRender() public

getAction() public

getEventManager() public

getModelType() public

getName() public

getPlugin() public

getRequest() public

getResponse() public

getTableLocator() public

implementedEvents() public

initialize() public

invokeAction() public

isAction() public

isAutoRenderEnabled() public

loadComponent() public

loadModel() public

log() public

modelFactory() public

paginate() public

redirect() public

referer() public

render() public

set() public

setAction() public deprecated

setEventManager() public

setModelType() public

setName() public

setPlugin() public

setRequest() public

setResponse() public

setTableLocator() public

shutdownProcess() public

startupProcess() public

viewBuilder() public

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

__construct() public

Параметры

__get() public

Параметры

Возвращает

__set() public

Параметры

Возвращает

_setModelClass() protected

Параметры

Возвращает

_templatePath() protected

Возвращает

afterFilter() public

Параметры

Возвращает

Ссылки

beforeFilter() public

Параметры

Возвращает

Ссылки

beforeRedirect() public

Параметры

Возвращает

Ссылки

beforeRender() public

Параметры

Возвращает