Spec-Zone.ru › CakePHP 2.8

Класс Object

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

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

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

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

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

  • AclBehavior
  • AclComponent
  • AppShell
  • Aro
  • AuthComponent
  • BakeShell
  • BakeTask
  • CacheHelper
  • CakeErrorController
  • CommandListShell
  • CommandTask
  • CompletionShell
  • AclNode
  • ConsoleShell
  • ContainableBehavior
  • ControllerTask
  • CookieComponent
  • DbConfigTask
  • DboSource
  • EmailComponent
  • ExtractTask
  • FixtureTask
  • FlashComponent
  • AclShell
  • FlashHelper
  • FormHelper
  • HtmlHelper
  • I18nModel
  • I18nShell
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • JsonView
  • MediaView
  • Aco
  • ModelTask
  • MootoolsEngineHelper
  • Mysql
  • NumberHelper
  • PagesController
  • PaginatorComponent
  • PaginatorHelper
  • Permission
  • PluginTask
  • Postgres
  • AcoAction
  • ProjectTask
  • PrototypeEngineHelper
  • RequestHandlerComponent
  • RssHelper
  • ScaffoldView
  • SchemaShell
  • SecurityComponent
  • ServerShell
  • SessionComponent
  • SessionHelper
  • ApiShell
  • Sqlite
  • Sqlserver
  • TemplateTask
  • TestShell
  • TestsuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • AppController
  • TreeBehavior
  • UpgradeShell
  • ViewTask
  • XmlView
  • AppHelper
  • AppModel
Пакет: Cake\Core
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Core/Object.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

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

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

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

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

Параметры

строка $method
Имя метода для вызова
массив $params необязательно array()
Список параметров для использования при вызове $method

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

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

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. Для данных GET используйте $extra['url']. Для моделирования данных POST используется параметр $extra['data'].

Параметры

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

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

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

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

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

смешанные

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


toString()source public

toString( )

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

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

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

© 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.
http://api.cakephp.org/2.8/class-Object.html

Spec-Zone.ru

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