Class Object
Object class, allowing __construct and __destruct in PHP4.
Also includes methods for logging and the special method RequestAction, to call other Controllers' Actions from anywhere.
Direct Subclasses
- AclBase
- AclComponent
- ConnectionManager
- Controller
- CookieComponent
- DataSource
- Debugger
- EmailComponent
- ErrorHandler
- File
- Folder
- I18n
- App
- L10n
- MagicDb
- MagicFileResource
- ModelBehavior
- Multibyte
- Overloadable
- Overloadable2
- RequestHandlerComponent
- Scaffold
- Security
- AuthComponent
- SecurityComponent
- Shell
- Validation
- View
- XmlNode
- BehaviorCollection
- CakeSchema
- CakeSession
- CakeSocket
- Component
- Configure
Indirect Subclasses
- AclBehavior
- AclNode
- Aro
- BakeShell
- BakeTask
- CacheHelper
- CakeErrorController
- ConsoleShell
- ContainableBehavior
- ControllerTask
- DbAcl
- DbConfigTask
- AclShell
- DboMssql
- DboMysql
- DboMysqlBase
- DboMysqli
- DboOracle
- DboPostgres
- DboSource
- DboSqlite
- ExtractTask
- FixtureTask
- Aco
- FormHelper
- Helper
- HtmlHelper
- HttpSocket
- I18nModel
- I18nShell
- IniAcl
- JavascriptHelper
- JqueryEngineHelper
- JsBaseEngineHelper
- AcoAction
- JsHelper
- MediaView
- Model
- ModelTask
- MootoolsEngineHelper
- NumberHelper
- PagesController
- PaginatorHelper
- Permission
- PluginTask
- AjaxHelper
- ProjectTask
- PrototypeEngineHelper
- RssHelper
- ScaffoldView
- SchemaShell
- SessionComponent
- SessionHelper
- TemplateTask
- TestSuiteShell
- TestTask
- ApiShell
- TextHelper
- ThemeView
- TimeHelper
- TranslateBehavior
- TreeBehavior
- ViewTask
- Xml
- XmlElement
- XmlHelper
- XmlTextNode
- AppController
- AppHelper
- AppModel
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: object.php
Method Summary
-
Object() public
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
-
__construct() public
Class constructor, overridden in descendant classes. -
__openPersistent() public
Open the persistent class file for reading Used by Object::_persist()
-
_persist() public
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
-
_savePersistent() public
You should choose a unique name for the persistent file -
_set() public
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
-
_stop() public
Stop execution of the current script. Wraps exit() making testing easier.
-
cakeError() public
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
-
dispatchMethod() public
Calls a method on this object with the given parameters. Provides an OO wrapper for
call_user_func_array -
log() public
Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
-
requestAction() public
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
-
toString() public
Object-to-string conversion. Each class can override this method as necessary.
Method Detail
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
dispatchMethod() public ¶
dispatchMethod( string $method , array $params = array() )
Calls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class