Класс PagesController

display()source public

display( )

Отображает представление

Возможные исключения

NotFoundException

При невозможности найти файл представления или MissingViewException в режиме отладки.

__construct()source public

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

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

Параметры

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

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

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

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

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

Object::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанное
Запрашиваемое значение для допустимых переменных/псевдонимов, иначе 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 )

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

Параметры

смешанное $response

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

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

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

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

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

булево $exit

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

Возвращает

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

_scaffoldError()source protected

_scaffoldError( string $method )

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

Устарело

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

Параметры

строка $method

Имя метода.

Возвращает

boolean

См. также

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.

Возвращает

boolean
Успех

Ссылка

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

afterScaffoldSaveError()source public

afterScaffoldSaveError( string $method )

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

Параметры

строка $method

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

Возвращает

boolean
Успех

Ссылка

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(); для получения дополнительной информации. Загружает компоненты и подготавливает их к инициализации.

Возвращает

смешанный
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 для перенаправления после истечения срока действия

целое число $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 на данный момент генерирует динамические модели.

Параметры

string $modelClass необязательно null

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

integer|string $id необязательно null

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

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

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

Исключения

MissingModelException
если класс модели не найден.

paginate()source public

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

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

Параметры

Model|string $object необязательно null

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

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

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

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

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

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

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.

Параметры

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

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

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

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

string $bool необязательно 'AND'

Оператор булевых значений SQL: AND, OR, XOR и т.д.

boolean $exclusive необязательно false

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

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

array|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 необязательно null

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

boolean $exit необязательно 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 необязательно null

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

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

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

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

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 необязательно null

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

string $layout необязательно 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 необязательно 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. Если вы хотите отключить её, переопределите этот метод как пустую функцию.

Параметры

массив $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

Параметры

строка $method

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

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

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

Возвращает

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

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() для получения дополнительной информации о журналах.

Возвращает

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.

Параметры

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

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

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

string
Название этого класса

array()