Spec-Zone.ru › CakePHP 2.9

Класс CakeObject

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

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

Прямые подклассы

  • CakeSchema
  • Component
  • Shell
  • View
  • Controller
  • DataSource
  • DbAcl
  • Helper
  • IniAcl
  • Model
  • ModelBehavior
  • PhpAcl

Косвенные подклассы

  • AclBehavior
  • AclComponent
  • FlashComponent
  • JsonView
  • MediaView
  • Mysql
  • PaginatorComponent
  • Postgres
  • RequestHandlerComponent
  • ScaffoldView
  • SecurityComponent
  • SessionComponent
  • AclNode
  • Sqlite
  • Sqlserver
  • TestShell
  • TestsuiteShell
  • ThemeView
  • TranslateBehavior
  • TreeBehavior
  • XmlView
  • Aco
  • Aro
  • AuthComponent
  • ContainableBehavior
  • CookieComponent
  • DboSource
  • EmailComponent
Пакет: Cake\Core
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Core/CakeObject.php

Краткое описание методов

  • __construct() public
    Конструктор, пустое действие
  • _mergeVars() protected

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

  • _set() protected

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

  • _stop() protected

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

  • dispatchMethod() public

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

  • log() public

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

  • requestAction() public

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

  • toString() public

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

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

__construct()source public

__construct( )

Конструктор, пустое действие

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

Вызывает метод этого объекта с заданными параметрами. Обеспечивает OO-обертку для 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. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

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

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

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

Возвращает

смешанный

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


toString()source public

toString( )

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

Возвращает

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

© 2005–2016 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.9/class-CakeObject.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API