Класс Controller

__constructsource public

__construct( CakeRequest $request null , CakeResponse $response null )

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

Параметры

CakeRequest $request необязательно null

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

CakeResponse $response необязательно null

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

Переопределяет

Object::__construct()

__getsource public

__get( string $name )

Предоставляет обратную совместимость для доступа к свойствам объекта запроса. Также предоставляет псевдоним params.

Параметры

строка $name

Имя запрашиваемого значения

Возвращает

mixed
Запрашиваемое значение для допустимых переменных/псевдонимов, иначе null

__issetsource public

__isset( string $name )

Обеспечивает обратную совместимость, чтобы избежать проблем с пустыми и isset псевдонимами свойств. Лениво загружает модели, используя метод loadModel(), если они объявлены в $uses

Параметры

строка $name

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

Возвращает

boolean
bool

__setsource public

__set( string $name , mixed $value )

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

Параметры

строка $name

Имя свойства для установки.

смешанное $value

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

_afterScaffoldSavesource protected

_afterScaffoldSave( string $method )

Псевдоним к afterScaffoldSave()

Устарело

3.0.0 Будет удалено в 3.0.

Параметры

строка $method

Имя метода.

Возвращает

boolean
bool

См.

Controller::afterScaffoldSave()

_afterScaffoldSaveErrorsource protected

_afterScaffoldSaveError( string $method )

Псевдоним к afterScaffoldSaveError()

Устарело

3.0.0 Будет удалено в 3.0.

Параметры

строка $method

Имя метода.

Возвращает

boolean
bool

См.

Controller::afterScaffoldSaveError()

_beforeScaffoldsource protected

_beforeScaffold( string $method )

Псевдоним к beforeScaffold()

Устарело

3.0.0 Будет удалено в 3.0.

Параметры

строка $method

Имя метода.

Возвращает

boolean
bool

См.

Controller::beforeScaffold()

_getScaffoldsource protected

_getScaffold( CakeRequest $request )

Возвращает объект scaffold для использования в динамически сгенерированных контроллерах.

Параметры

CakeRequest $request

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

Возвращает

Scaffold
Scaffold

_getViewObjectsource protected

_getViewObject( )

Создаёт экземпляр класса представления на основе свойства контроллера

Возвращает

View
View

_isPrivateActionsource protected

_isPrivateAction( ReflectionMethod $method , CakeRequest $request )

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

Параметры

ReflectionMethod $method

Метод, который должен быть вызван.

CakeRequest $request

Запрос для проверки.

Возвращает

boolean
bool

_mergeControllerVarssource protected

_mergeControllerVars( )

Объединяет переменные компонентов, помощников и используемых переменных из Controller::$_mergeParent и PluginAppController.

_mergeUsessource protected

_mergeUses( array $merge )

Вспомогательный метод для объединения свойства $uses.

Объединяет элементы, которые ещё не присутствуют в $this->uses, в $this->uses.

Параметры

массив $merge

Данные для объединения.

_parseBeforeRedirectsource protected

_parseBeforeRedirect( mixed $response , string|array $url , integer $status , boolean $exit )

Обработка ответа перед перенаправлением

Параметры

смешанное $response

Ответ от обратного вызова beforeRedirect

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

То же значение, что и в beforeRedirect

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

То же значение, что и в beforeRedirect

логическое значение $exit

То же значение, что и в beforeRedirect

Возвращает

array
Массив с ключами url, status и exit

_scaffoldErrorsource protected

_scaffoldError( string $method )

Псевдоним к scaffoldError()

Устарело

3.0.0 Будет удалено в 3.0.

Параметры

строка $method

Имя метода.

Возвращает

boolean
bool

См.

Controller::scaffoldError()

afterFiltersource public

afterFilter( )

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

Ссылка

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

afterScaffoldSavesource public

afterScaffoldSave( string $method )

Этот метод следует переопределять в дочерних классах.

Параметры

строка $method

имя метода, вызываемого либо edit, либо update.

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

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#callbacks

afterScaffoldSaveErrorsource public

afterScaffoldSaveError( string $method )

Этот метод следует переопределять в дочерних классах.

Параметры

строка $method

имя метода, вызываемого либо edit, либо update.

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

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#callbacks

beforeFiltersource public

beforeFilter( )

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

Ссылка

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

beforeRedirectsource public

beforeRedirect( string|array $url , integer $status null , boolean $exit true )

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

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

Параметры

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

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

целое число $status необязательно null

Необязательный HTTP-код состояния (например: 404)

логическое значение $exit необязательно true

Если true, вызов exit() будет выполнен после перенаправления

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

mixed
false, чтобы остановить событие перенаправления, строка контроллера для нового URL перенаправления или массив с ключами url, status и exit, которые будут использоваться методом redirect.

Ссылка

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

beforeRendersource public

beforeRender( )

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

Ссылка

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

beforeScaffoldsource public

beforeScaffold( string $method )

Этот метод следует переопределять в дочерних классах.

Параметры

строка $method

имя метода, например, index, edit и т.д.

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

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#callbacks

constructClassessource public

constructClasses( )

Загружает классы модели на основе свойства uses, см. Controller::loadModel(); для получения дополнительной информации. Загружает компоненты и готовит их к инициализации.

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

mixed
true, если модели найдены и создан экземпляр.

Исключения

MissingModelException
MissingModelException

См. также

Controller::loadModel()

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#Controller::constructClasses

disableCachesource public

disableCache( )

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

Устарело

3.0.0 Будет удалено в 3.0. Используйте CakeResponse::disableCache().

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#Controller::disableCache

flashsource public

flash( string $message , string|array $url , integer $pause 1 , string $layout 'flash' )

Отображает сообщение пользователю на $pause секунд, затем перенаправляет на $url. Использует flash.ctp в качестве шаблона по умолчанию для сообщения. Не работает, если текущий уровень отладки выше 0.

Устарело

3.0.0 Будет удалено в 3.0. Используйте Session::setFlash().

Параметры

строка $message

Сообщение для отображения пользователю

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

Относительный строковый или основанный на массиве URL для перенаправления после истечения времени

целое число $pause необязательно 1

Время отображения сообщения

строка $layout необязательно 'flash'

Шаблон, который нужно использовать, по умолчанию 'flash'

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#Controller::flash

getEventManagersource public

getEventManager( )

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

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

CakeEventManager
CakeEventManager

headersource public

header( string $status )

Метод-обертка для удобства и работы с объектом CakeResponse::header().

Устарело

3.0.0 Будет удалено в 3.0. Используйте CakeResponse::header().

Параметры

строка $status

Сообщение заголовка, которое устанавливается.

httpCodessource public

httpCodes( integer|array $code null )

Запрашивает и устанавливает допустимые HTTP-коды ответов и сообщения.

Устарело

3.0.0 С 2.4. Будет удалено в 3.0. Используйте CakeResponse::httpCodes().

Параметры

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

Если $code — целое число, то соответствующий код/сообщение возвращается, если существует, null, если не существует. Если $code — массив, то ключи 'code' и 'message' каждого вложенного массива добавляются к значениям по умолчанию HTTP-кодов. Пример: httpCodes(404); // возвращает массив(404 => 'Не найдено') httpCodes(массив( 701 => 'Единорог переместился', 800 => 'Неожиданный минотавр' )); // устанавливает эти новые значения и возвращает true

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

array
Ассоциативный массив HTTP-кодов в качестве ключей и строк сообщений в качестве значений или null, если заданный $code не существует.

implementedEventssource public

implementedEvents( )

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

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

array
массив

Реализация

CakeEventListener::implementedEvents()

invokeActionsource public

invokeAction( CakeRequest $request )

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

Параметры

CakeRequest $request

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

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

mixed
Результат ответа.

Исключения

PrivateActionException
Если действия не являются общедоступными или имеют префикс _
MissingActionException
Если действия не определены и scaffolding не включен.

loadModelsource public

loadModel( string $modelClass null , integer|string $id null )

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

Параметры

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

Имя класса модели для загрузки

целое число/строка $id необязательно null

Начальный идентификатор, который должна иметь экземпляризованный класс модели

Возвращает

boolean
Истина, если модель найдена

Выбрасывает

MissingModelException
если класс модели не может быть найден.

paginatesource public

paginate( Model|string $object null , string|array $scope array() , array $whitelist array() )

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

Параметры

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

Модель для постраничной навигации (например: экземпляр модели, или 'Модель', или 'Модель.ВложеннаяМодель')

строка|массив $scope необязательно массив()

Условия для использования при постраничной навигации

массив $whitelist необязательно массив()

Список разрешенных опций для постраничной навигации

Возвращает

array
Результаты запроса модели

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#Controller::paginate

postConditionssource public

postConditions( array $data array() , string|array $op null , string $bool 'AND' , boolean $exclusive false )

Преобразует данные формы POST в массив условий модели, пригодный для использования в вызове Model::find().

Устаревший

3.0.0 Будет удален в версии 3.0.

Параметры

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

Данные POST, организованные по модели и полю

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

Строка, содержащая оператор SQL сравнения, или массив, соответствующий операторам для полей

строка $bool необязательно 'И'

Оператор булевой логики SQL: И, ИЛИ, ИСКЛЮЧАЮЩЕЕ ИЛИ и т.д.

логический $exclusive необязательно false

Если true, и $op является массивом, поля, не включенные в $op, не будут включены в возвращаемые условия

Возвращает

array|null
Массив условий модели

redirectsource public

redirect( string|array $url , integer|array|null $status null , boolean $exit true )

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

Параметры

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

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

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

Код HTTP-статуса (например: 301). По умолчанию 302, когда передается null.

логический $exit необязательно true

Если true, после перенаправления будет вызван exit()

Ссылка

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

Срабатывает

Controller.beforeRedirect $this, массив($url, $status, $exit)

referersource public

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

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

Параметры

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

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

логический $local необязательно false

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

Возвращает

string
Ссылка на предыдущую страницу

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#Controller::referer

rendersource public

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

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

Параметры

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

Представление для рендеринга

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#Controller::render

Срабатывает

Controller.beforeRender $this

scaffoldErrorsource public

scaffoldError( string $method )

Этот метод следует переопределять в дочерних классах. В противном случае он будет рендерить ошибку scaffold. Метод ДОЛЖЕН возвращать true в дочерних классах

Параметры

строка $method

Имя вызываемого метода (например, index, edit и т. д.).

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#callbacks

setsource public

set( string|array $one , string|array $two null )

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

Параметры

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

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

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

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

Ссылка

http://book.cakephp.org/2.0/ru/controllers.html#interacting-with-views

setActionsource public

setAction( string $action )

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

Примеры:

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

Параметры

строка $action

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

Возвращает

mixed
Возвращает значение результата вызываемого действия

setRequestsource public

setRequest( CakeRequest $request )

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

• $this->request - В объект $request
• $this->plugin - В $request->params['plugin']
• $this->view - В $request->params['action']
• $this->autoLayout - В false, если установлен $request->params['bare'];
• $this->autoRender - В false, если $request->params['return'] == 1
• $this->passedArgs - В объединенный результат params['named'] и params['pass]

Параметры

CakeRequest $request

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

shutdownProcesssource public

shutdownProcess( )

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

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

Срабатывает

Controller.shutdown $this

startupProcesssource public

startupProcess( )

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

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

Срабатывает

Controller.initialize $this
Controller.startup $this

validatesource public

validate( )

Возвращает количество ошибок в представленной форме.

Устарело

3.0.0 Этот метод будет удален в версии 3.0

Возвращает

integer
Количество ошибок

validateErrorssource public

validateErrors( )

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

$errors = $this->validateErrors($this->Article, $this->User);

Устарело

3.0.0 Этот метод будет удален в версии 3.0

Возвращает

array
Ошибки валидации или false, если ошибок нет

_mergeVarssource protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства объекта $property со свойством в определении $class. Значение этого свойства для класса будет объединено поверх $class'.

Это обеспечивает некоторые возможности DRY, предоставляемые CakePHP. Если вы хотите отключить эту функцию, переопределите этот метод как пустую функцию.

Параметры

массив $properties

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

строка $class

Класс для объединения свойства с.

логическое значение $normalize необязательно true

Установите в значение true, чтобы выполнить нормализацию свойств с помощью Hash::normalize() перед объединением.

_setsource protected

_set( array $properties array() )

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

Параметры

массив $properties необязательно array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stopsource protected

_stop( integer|string $status 0 )

Остановить выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число или строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethodsource public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет ОО-обёртку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

массив $params необязательно array()

Список параметров для использования при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

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

Параметры

строка $msg

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

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

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

Область(и), в которой создается сообщение журнала. Для получения дополнительной информации о областях ведения журнала см. CakeLog::config().

Возвращает

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

requestActionsource public

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

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

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

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

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

массив $extra необязательно array()

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

Возвращает

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

toStringsource public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

string
Имя этого класса

null

null

'AppController'

'CakeResponse'

true

true

public $cacheAction = array(
        'view/23/' => 21600,
        'recalled/' => 86400
);

false

array('Session', 'Flash')

'.ctp'

array()

'default'

null

array()

null

null

null

array()

null

false

true

null

null

'View'

null

array()