Класс Controller

__construct()source public

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

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

Параметры

CakeRequest $request optional null

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

CakeResponse $response optional null

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

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

Object::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $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 )

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

Параметры

CakeRequest $request

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

Возвращает

Scaffold

_getViewObject()source protected

_getViewObject( )

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

Возвращает

View

_isPrivateAction()source protected

_isPrivateAction( ReflectionMethod $method , CakeRequest $request )

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

Параметры

ReflectionMethod $method

Метод, который необходимо вызвать.

CakeRequest $request

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

Возвращает

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

_mergeControllerVars()source protected

_mergeControllerVars( )

Объединяет переменные компонентов, хелперов и используемых классов из 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( )

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

Ссылка

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

afterScaffoldSave()source public

afterScaffoldSave( string $method )

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

Параметры

строка $method

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

Возвращает

логическое значение
Успех

Ссылка

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

afterScaffoldSaveError()source public

afterScaffoldSaveError( string $method )

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

Параметры

строка $method

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

Возвращает

логическое значение
Успех

Ссылка

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

beforeFilter()source public

beforeFilter( )

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

Ссылка

http://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 необязательный null

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

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

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

Возвращает

смешанный

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

Ссылка

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

beforeRender()source public

beforeRender( )

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

Ссылка

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

beforeScaffold()source public

beforeScaffold( string $method )

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

Параметры

строка $method

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

Возвращает

boolean
Успех

Ссылка

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

constructClasses()source public

constructClasses( )

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

Возвращает

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

Выбрасывает

MissingModelException

См. также

Controller::loadModel()

Ссылка

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

disableCache()source public

disableCache( )

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

Устарело

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

Ссылка

http://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-адрес или URL-адрес в формате массива для перенаправления после истечения времени

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

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

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

Используемый шаблон, по умолчанию 'flash'

Ссылка

http://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

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

Возвращает

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

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

Возвращает

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

Ссылка

http://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 в массив условий модели, подходящий для использования в вызове Model::find().

Устарело

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

Параметры

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

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

строка|массив $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. Выполнение скрипта приостанавливается после перенаправления.

Параметры

string|array $url

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

integer|array|null $status optional null

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

boolean $exit optional true

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

Возвращает

Cake\Network\Response|null

Триггеры

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

Ссылка

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

referer()source public

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

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

Параметры

string $default optional null

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

boolean $local optional false

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

Возвращает

string
URL ссылки-источника

Ссылка

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

render()source public

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

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

Параметры

string $view optional null

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

string $layout optional null

Шаблон макета

Возвращает

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

Триггеры

Controller.beforeRender $this

Ссылка

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

scaffoldError()source public

scaffoldError( string $method )

Этот метод следует переопределять в дочерних классах. В противном случае будет рендериться ошибка scaffold. Метод ОБЯЗАТЕЛЬНО должен возвращать true в дочерних классах.

Параметры

string $method

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

Возвращает

boolean
Успех

Ссылка

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

set()source public

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

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

Параметры

string|array $one

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

string|array $two optional null

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

Ссылка

http://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);

Параметры

string $action

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

Возвращает

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

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

Возвращает

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

validateErrors()source public

validateErrors( )

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

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

Устарело

3.0.0 Этот метод будет удалён в 3.0

Возвращает

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

_mergeVars()source protected

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

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

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

Параметры

array $properties

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

string $class

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

boolean $normalize optional true

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

_set()source protected

_set( array $properties array() )

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

Параметры

array $properties optional array()

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status optional 0

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

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

смешанный
Возвращает результат вызова метода

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

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

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

requestAction()source public

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

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

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

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

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

Параметры

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

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

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

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

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

смешанный

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

toString()source public

toString( )

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

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

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

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