Класс Controller

__construct()source public

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

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

Параметры

CakeRequest $request optional null

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

CakeResponse $response optional null

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

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

булево значение

__set()source public

__set( string $name , mixed $value )

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

Параметры

строка $name

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

смешанный тип $value

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

_afterScaffoldSave()source protected

_afterScaffoldSave( string $method )

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

Устарело

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

Параметры

строка $method

Имя метода.

Возвращает

булево значение

См. также

Controller::afterScaffoldSave()

_afterScaffoldSaveError()source protected

_afterScaffoldSaveError( string $method )

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

Устарело

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

Параметры

строка $method

Имя метода.

Возвращает

булево значение

См. также

Controller::afterScaffoldSaveError()

_beforeScaffold()source protected

_beforeScaffold( string $method )

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

Устарело

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

Параметры

строка $method

Имя метода.

Возвращает

булево значение

См. также

Controller::beforeScaffold()

_getScaffold()source protected

_getScaffold( CakeRequest $request )

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

Параметры

CakeRequest $request

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

Возвращает

Scaffold

_getViewObject()source protected

_getViewObject( )

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

Возвращает

View

_isPrivateAction()source protected

_isPrivateAction( ReflectionMethod $method , CakeRequest $request )

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

Параметры

ReflectionMethod $method

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

CakeRequest $request

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

Возвращает

булево значение

_mergeControllerVars()source protected

_mergeControllerVars( )

Объединяет переменные компонентов, helpers и uses из Controller::$_mergeParent и PluginAppController.

_mergeUses()source protected

_mergeUses( array $merge )

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

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

Параметры

массив $merge

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

_parseBeforeRedirect()source protected

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

Парсит ответ beforeRedirect

Параметры

смешанный тип $response

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

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

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

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

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

булево значение $exit

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

Возвращает

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

_scaffoldError()source protected

_scaffoldError( string $method )

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

Устарело

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

Параметры

строка $method

Имя метода.

Возвращает

булево значение

См. также

Controller::scaffoldError()

afterFilter()source public

afterFilter( )

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

Ссылка

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

afterScaffoldSave()source public

afterScaffoldSave( string $method )

Этот метод должен быть переопределён в дочерних классах.

Параметры

строка $method

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

Возвращает

булево значение
Успех

Ссылка

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

afterScaffoldSaveError()source public

afterScaffoldSaveError( string $method )

Этот метод должен быть переопределён в дочерних классах.

Параметры

строка $method

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

Возвращает

булево значение
Успех

Ссылка

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

beforeFilter()source public

beforeFilter( )

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

Ссылка

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

beforeRedirect()source 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 optional null

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

булево значение $exit optional true

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

Возвращает

смешанный тип

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

Ссылка

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

beforeRender()source public

beforeRender( )

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

Ссылка

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

beforeScaffold()source public

beforeScaffold( string $method )

Этот метод должен быть переопределён в дочерних классах.

Параметры

строка $method

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

Возвращает

boolean
Успех

Ссылка

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

constructClasses()source public

constructClasses( )

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

Возвращает

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

Выбрасывает

MissingModelException

См. также

Controller::loadModel()

Ссылка

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

disableCache()source public

disableCache( )

Запрещает браузеру кешировать результаты текущего запроса.

Устарело

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

Ссылка

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

flash()source public

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

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

Устарело

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

Параметры

строка $message

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

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

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

целое число $pause опционально 1

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

строка $layout опционально 'flash'

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

Ссылка

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

getEventManager()source public

getEventManager( )

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

Возвращает

CakeEventManager

header()source public

header( string $status )

Удобный и объектный метод-обёртку для CakeResponse::header().

Устарело

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

Параметры

строка $status

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

httpCodes()source 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); // returns array(404 => 'Not Found')

   httpCodes(array(
       701 => 'Unicorn Moved',
       800 => 'Unexpected Minotaur'
   )); // sets these new values, and returns true

Возвращает

массив

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

Реализация

CakeEventListener::implementedEvents()

invokeAction()source public

invokeAction( CakeRequest $request )

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

Параметры

CakeRequest $request

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

Возвращает

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

Выбрасывает

PrivateActionException
При действиях, которые не являются публичными или начинаются с _
MissingActionException

Когда действия не определены и scaffolding не включен.

loadModel()source public

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

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

Параметры

строка $modelClass опционально null

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

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

Изначальный ID, которым должен обладать экземпляр класса модели

Возвращает

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

Выбрасывает

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

paginate()source public

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

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

Параметры

Model/строка $object опционально null

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

строка/массив $scope опционально array()

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

массив $whitelist опционально array()

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

Возвращает

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

Ссылка

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

postConditions()source public

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

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

Устарело

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

Параметры

массив $data опционально array()

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

строка/массив $op опционально null

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

строка $bool опционально 'AND'

Оператор SQL булевой логики: AND, OR, XOR и т.д.

boolean $exclusive опционально false

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

Возвращает

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

redirect()source 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()

Возвращает

CakeResponse|null

Вызывает

Controller.beforeRedirect $this, array($url, $status, $exit)

Ссылка

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

referer()source public

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

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

Параметры

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

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

булево $local необязательно false

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

Возвращает

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

Ссылка

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

render()source public

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

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

Параметры

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

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

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

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

Возвращает

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

Вызывает

Controller.beforeRender $this

Ссылка

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

scaffoldError()source public

scaffoldError( string $method )

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

Параметры

строка $method

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

Возвращает

булево
Успех

Ссылка

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

set()source public

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

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

Параметры

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

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

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

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

Ссылка

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

setAction()source public

setAction( string $action )

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

Примеры:

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

Параметры

строка $action

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

Возвращает

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

setRequest()source 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

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

shutdownProcess()source public

shutdownProcess( )

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

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

Вызывает

Controller.shutdown $this

startupProcess()source public

startupProcess( )

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

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

Вызывает

Controller.initialize $this
Controller.startup $this

validate()source public

validate( )

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

Устаревший

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

Возвращает

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

validateErrors()source public

validateErrors( )

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

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

Устаревший

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

Возвращает

массив
Ошибки проверки или false, если ошибок нет

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

булево $normalize необязательно true

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

_set()source protected

_set( array $properties array() )

Разрешает установку нескольких свойств объекта в одной строке кода. Установит только те свойства, которые являются частью объявления класса.

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

string $method

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

array $params необязательно array()

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

Возвращает

mixed
Результат вызова метода

log()source public

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

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

Параметры

string $msg

Сообщение для лога

integer $type необязательно LOG_ERR

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

null|string|array $scope необязательно null

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

Возвращает

boolean
Успешность записи в лог

requestAction()source 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.

Параметры

string|array $url

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

array $extra необязательно array()

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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()