Класс Controller

__construct()source public

__construct( Cake\Network\Request $request null , Cake\Network\Response $response null , string|null $name null , Cake\Event\EventManager|null $eventManager null , Cake\Controller\ComponentRegistry|null $components null )

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

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

Параметры

Cake\Network\Request $request optional null

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

Cake\Network\Response $response optional null

Объект ответа для этого контроллера.

string|null $name optional null

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

Cake\Event\EventManager|null $eventManager optional null

Менеджер событий. По умолчанию новый экземпляр.

Cake\Controller\ComponentRegistry|null $components optional null

Реестр компонентов. По умолчанию новый экземпляр.

__get()source public

__get( string $name )

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

Параметры

string $name

Имя свойства

Возвращает

boolean|object
Экземпляр модели или false

__set()source public

__set( string $name , mixed $value )

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

Параметры

string $name

Имя свойства.

mixed $value

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

_loadComponents()source protected

_loadComponents( )

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

_mergeControllerVars()source protected

_mergeControllerVars( )

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

_viewPath()source protected

_viewPath( )

Получение пути к представлению на основе имени контроллера и префикса запроса.

Возвращает

string

afterFilter()source public

afterFilter( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

Экземпляр события

Возвращает

boolean|null

Ссылка

http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks

beforeFilter()source public

beforeFilter( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

Экземпляр события

Возвращает

boolean|null

Ссылка

http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks

beforeRedirect()source public

beforeRedirect( Cake\Event\Event $event , string|array $url , Cake\Network\Response $response )

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

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

Параметры

Cake\Event\Event $event

Экземпляр события

строка|массив $url

Строка или массив, представляющие URL, указывающий на другую локацию внутри приложения или абсолютный URL

Cake\Network\Response $response

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

Возвращаемое значение

Cake\Network\Response|null

Ссылка

http://book.cakephp.org/3.0/ru/controllers.html#request-life-cycle-callbacks

beforeRender()source public

beforeRender( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

Экземпляр события

Возвращаемое значение

Cake\Network\Response|null

Ссылка

http://book.cakephp.org/3.0/ru/controllers.html#request-life-cycle-callbacks

components()source public

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

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

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

Параметры

Cake\Controller\ComponentRegistry|null $components optional null

Реестр компонентов.

Возвращаемое значение

Cake\Controller\ComponentRegistry

implementedEvents()source public

implementedEvents( )

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

Возвращаемое значение

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public

initialize( )

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

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

invokeAction()source public

invokeAction( )

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

Возвращаемое значение

смешанный
Результат ответа.

Исключения

LogicException
Если запрос не установлен.
Cake\Controller\Exception\MissingActionException
Если действия не определены или недоступны.

isAction()source public

isAction( string $action )

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

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

Параметры

строка $action

Действие для проверки.

Возвращаемое значение

логическое
Доступно ли действие из URL.

loadComponent()source public

loadComponent( string $name , array $config [] )

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

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

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

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

Параметры

строка $name

Имя компонента для загрузки.

массив $config optional []

Настройки для компонента.

Возвращаемое значение

Cake\Controller\Component

paginate()source public

paginate( Cake\ORM\Table|string|Cake\ORM\Query|null $object null , array $settings [] )

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

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

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

Параметры

Cake\ORM\Table|строка|Cake\ORM\Query|null $object optional null

Таблица для постраничной навигации (например: экземпляр Table, 'TableName' или объект Query)

массив $settings optional []

Настройки/конфигурация, используемые для постраничной навигации.

Возвращаемое значение

Cake\ORM\ResultSet
Результаты запроса

Исключения

RuntimeException
Когда не найден совместимый объект таблицы.

Ссылка

http://book.cakephp.org/3.0/ru/controllers.html#paginating-a-model

redirect()source public

redirect( string|array $url , integer $status 302 )

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

Параметры

строка|массив $url

Строка или массив, представляющие URL, указывающий на другую локацию внутри приложения или абсолютный URL

целое число $status optional 302

Код HTTP-статуса (например: 301)

Возвращаемое значение

Cake\Network\Response|null

Ссылка

http://book.cakephp.org/3.0/ru/controllers.html#Controller::redirect

referer()source public

referer( string|array|null $default null , boolean $local false )

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

Параметры

строка|массив|null $default optional null

Значение по умолчанию для URL, если HTTP_REFERER не может быть прочитан из заголовков

логическое $local optional false

Если true, ограничивает ссылки на исходные URL локальным сервером

Возвращаемое значение

строка
URL ссылки

render()source public

render( string|null $view null , string|null $layout null )

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

Параметры

строка|null $view optional null

Представление для использования при отображении

строка|null $layout optional null

Макет для использования

Возвращаемое значение

Cake\Network\Response
Объект ответа, содержащий отрендеренное представление.

Ссылка

http://book.cakephp.org/3.0/ru/controllers.html#rendering-a-view

setAction()source public

setAction( string $action )

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

Примеры:

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

Параметры

строка $action

Новое действие, на которое производится «перенаправление». Любые другие параметры, переданные в этот метод, будут переданы как параметры новому действию.

Возвращаемое значение

смешанный
Возвращает значение, возвращаемое вызываемым действием

setRequest()source public

setRequest( Cake\Network\Request $request )

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

• $this->request - к параметру $request
• $this->plugin - к $request->params['plugin']
• $this->passedArgs - такие же, как $request->params['pass]
• View::$plugin - $this->plugin

Параметры

Cake\Network\Request $request

Экземпляр запроса.

shutdownProcess()source public

shutdownProcess( )

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

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

Возвращает

Cake\Network\Response|null

startupProcess()source public

startupProcess( )

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

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

Возвращает

Cake\Network\Response|null

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Оборачивает создание и отправку событий.

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

Параметры

строка $name

Имя события.

массив|null $data необязательно null

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

объект|null $subject необязательно null

Объект, к которому относится это событие (по умолчанию $this).

Возвращает

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

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

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

Параметры

Cake\Event\EventManager $eventManager необязательно null

устанавливаемый менеджер событий

Возвращает

Cake\Event\EventManager

tableLocator()source public

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )

Устанавливает локатор таблиц. Если параметры не переданы, возвращает текущий используемый локатор.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null

экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

log()source public

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

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

Параметры

смешанный $msg

Сообщение журнала.

целое число|строка $level необязательно LogLevel::ERROR

Уровень ошибки.

строка|массив $context необязательно []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

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

_mergeProperty()source protected

_mergeProperty( string $property , array $parentClasses , array $options )

Объединить одно свойство со значениями, объявленными во всех родительских классах.

Параметры

строка $property

Имя объединяемого свойства.

массив $parentClasses

Массив классов, которые необходимо объединить.

массив $options

Параметры для объединения свойства, см. _mergeVars()

_mergePropertyData()source protected

_mergePropertyData( array $current , array $parent , boolean $isAssoc )

Объединить все ключи свойства.

Параметры

массив $current

Текущее объединённое значение.

массив $parent

Значение родительского класса.

булево $isAssoc

Выполнять ли объединение в ассоциативном режиме.

Возвращает

смешанный
Обновленное значение.

_mergeVars()source protected

_mergeVars( array $properties , array $options [] )

Объединить список $properties со всеми родительскими классами текущего класса.

Параметры:

• associative - Список свойств, которые должны обрабатываться как ассоциативные массивы. Свойства в этом списке будут переданы в Hash::normalize() перед объединением.

Параметры

массив $properties

Массив свойств и стратегии объединения для них.

массив $options необязательно []

Параметры для объединения свойств.

_setModelClass()source protected

_setModelClass( string $name )

Установить свойства modelClass и modelKey на основе конвенций.

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

Параметры

строка $name

Имя класса.

loadModel()source public

loadModel( string|null $modelClass null , string|null $modelType null )

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

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

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

Параметры

строка|null $modelClass необязательно null

Имя класса модели для загрузки. По умолчанию $this->modelClass

строка|null $modelType необязательно null

Тип хранилища для загрузки. По умолчанию значение modelType().

Возвращает

Cake\Datasource\RepositoryInterface
Созданный экземпляр модели.

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
InvalidArgumentException
При использовании типа, который не зарегистрирован.
UnexpectedValueException
Если тип модели не определен

modelFactory()source public

modelFactory( string $type , callable $factory )

Переопределить существующую функцию для создания хранилищ заданного типа.

Параметры

строка $type

Имя типа хранилища, для которого предназначена функция фабрики.

вызываемый $factory

Функция фабрики, используемая для создания экземпляров.

modelType()source public

modelType( string|null $modelType null )

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

Параметры

строка|null $modelType необязательно null

Тип модели или null для получения текущего

Возвращает

строка|Cake\Datasource\ModelAwareTrait
$this

requestAction()source public

requestAction( string|array $url , array $extra [] )

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

Внутри метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Примеры

Базовый пример получения возвращаемого значения действия контроллера:

$variables = $this->requestAction('/articles/popular');

Базовый пример использования request action для получения отрисованной страницы без макета.

$viewHtml = $this->requestAction('/articles/popular', ['return']);

Вы также можете передать URL в виде массива:

$vars = $this->requestAction(['controller' => 'articles', 'action' => 'popular']);

Передача других данных запроса

Вы можете передать данные POST, GET, COOKIE и другие данные в запрос, используя соответствующие ключи. Куки могут быть переданы с помощью ключа cookies. Параметры GET могут быть установлены с помощью ключа query, а данные POST могут быть отправлены с помощью ключа post.

$vars = $this->requestAction('/articles/popular', [
  'query' => ['page' => 1],
  'cookies' => ['remember_me' => 1],
]);

Отправка значений среды или заголовков

По умолчанию действия, отправленные с помощью этого метода, будут использовать глобальные значения $_SERVER и $_ENV. Если вы хотите переопределить эти значения для действия запроса, вы можете указать значения:

$vars = $this->requestAction('/articles/popular', [
  'environment' => ['CONTENT_TYPE' => 'application/json']
]);

Передача сессии

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

$vars = $this->requestAction('/articles/popular', [
  'session' => new Session($someSessionConfig)
]);

Устаревшее

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

Параметры

строка|массив $url

URL в виде строки или массива. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные аргументы в параметре $url.

массив $extra необязательно []

Если массив содержит ключ "return", он устанавливает autoRender в true. Также может использоваться для отправки данных GET/POST и переданных аргументов.

Возвращаемое значение

смешанный

Булево значение true или false при успехе/неудачи, или содержимое отрисованного действия, если в $extra установлен ключ 'return'.

createView()source public

createView( string|null $viewClass null )

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

Параметры

строка|null $viewClass необязательно null

Необязательное имя класса представления с пространством имён для создания экземпляра.

Возвращаемое значение

Cake\View\View

Исключения

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

set()source public

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

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

Параметры

строка|массив $name

Строка или массив данных.

смешанный $value необязательно null

Значение в случае, если $name является строкой (которая затем работает как ключ). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.

Возвращаемое значение

$this

viewBuilder()source public

viewBuilder( )

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

Возвращаемое значение

Cake\View\ViewBuilder

viewOptions()source public

viewOptions( string|array|null $options null , boolean $merge true )

Получить/установить допустимые параметры представления в свойстве _validViewOptions объекта. Свойство создаётся как пустой массив, если оно не установлено. Если вызывается без параметров, он вернёт текущий список допустимых параметров представления. См. createView().

Параметры

строка|массив|null $options необязательно null

строка или массив строк, которые нужно добавить к _validViewOptions.

boolean $merge необязательно true

Слияние или перезапись существующих допустимых параметров представления. По умолчанию true.

Возвращаемое значение

массив
Обновлённые параметры представления в виде массива.

null

'Cake\Network\Response'

[
    'passedArgs'
]

true

public $components = ['RequestHandler', 'Acl'];

[]

public $helpers = ['Form', 'Html', 'Time'];

[]

null

[]

[]

null