Класс CakeObject
Класс CakeObject предоставляет несколько общих методов, используемых в нескольких подклассах.
Также включает методы для ведения журнала и специальный метод RequestAction для вызова действий других контроллеров из любой точки.
Прямые подклассы
- CakeSchema
- Component
- Shell
- View
- Controller
- DataSource
- DbAcl
- Helper
- IniAcl
- Model
- ModelBehavior
- PhpAcl
Косвенные подклассы
- AclBehavior
- AclComponent
- EmailComponent
- FlashComponent
- InterceptContentHelper
- JsonView
- MediaView
- Mysql
- PaginatorComponent
- Postgres
- RequestHandlerComponent
- ScaffoldView
- AclNode
- SecurityComponent
- SessionComponent
- Sqlite
- Sqlserver
- TestShell
- TestsuiteShell
- ThemeView
- TranslateBehavior
- TreeBehavior
- XmlView
- Aco
- Aro
- AuthComponent
- CakeTestModel
- ContainableBehavior
- CookieComponent
- DboSource
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Core/CakeObject.php
Краткое описание методов
- __construct() publicКонструктор, нет действий
- _mergeVars() protected
Объединяет свойства этого объекта $property со свойством в определении $class. Значение этого класса для свойства будет объединен сверху $class'
- _set() protected
Позволяет установить несколько свойств объекта в одной строке кода. Будут установлены только те свойства, которые являются частью объявления класса.
- _stop() protected
Остановить выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.
- dispatchMethod() public
Вызывает метод этого объекта с заданными параметрами. Предоставляет обертку ОО для
call_user_func_array - log() public
Удобный метод для записи сообщения в CakeLog. См. CakeLog::write() для получения дополнительной информации о записи в журналы.
- requestAction() public
Вызывает метод контроллера из любой точки. Может использоваться для соединения контроллеров или интеграции плагинов в основное приложение. requestAction может быть использован для возврата рендеренд взглядов или извлечения возвращаемого значения из действий контроллера.
- toString() public
Преобразование CakeObject в строку. Каждый класс может переопределить этот метод по мере необходимости.
Подробное описание методов
_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( )
Преобразование CakeObject в строку. Каждый класс может переопределить этот метод по необходимости.
Возвращает
stringИмя этого класса
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-CakeObject.html