/ cake / console / error.php
Defined Classes
ErrorHandler Class Info:
- Class Declaration:
class ErrorHandler extends Object
- File name:
- cake/console/error.php
- Description:
Error Handler for Cake console.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.console
Properties:
-
stderr filehandle
Standard error stream.
-
stdout filehandle
Standard output stream.
Method Summary:
- cakeError( $method, $messages = array ( ) )
- __construct( $method, $messages )
- dispatchMethod( $method, $params = array ( ) )
- error( $params )
- error404( $params )
- log( $msg, $type = 2 )
- missingAction( $params )
- missingComponentClass( $params )
- missingComponentFile( $params )
- missingConnection( $params )
- missingController( $params )
- missingDatabase( $params = array ( ) )
- missingHelperClass( $params )
- missingHelperFile( $params )
- missingLayout( $params )
- missingModel( $params )
- missingTable( $params )
- missingView( $params )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- privateAction( $params )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- stderr( $string )
- stdout( $string, $newline = true )
- _stop( $status = 0 )
- toString( )
cakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__construct
topClass constructor.
- Parameters:
-
-
string $method required
Method dispatching an error
-
array $messages required
Error messages
-
- Method defined in:
- cake/console/error.php on line 51
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
error
topDisplays an error page (e.g. 404 Not found).
- Parameters:
-
-
array $params required
Parameters (code, name, and message)
-
- Method defined in:
- cake/console/error.php on line 63
- Access
public
error404
topConvenience method to display a 404 page.
- Parameters:
-
-
array $params required
Parameters (url, message)
-
- Method defined in:
- cake/console/error.php on line 75
- Access
public
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
missingAction
topRenders the Missing Action web page.
- Parameters:
-
-
array $params required
Parameters (action, className)
-
- Method defined in:
- cake/console/error.php on line 104
- Access
public
missingComponentClass
topRenders the Missing Component class web page.
- Parameters:
-
-
array $params required
Parameters (file, component)
-
- Method defined in:
- cake/console/error.php on line 223
- Access
public
missingComponentFile
topRenders the Missing Component file web page.
- Parameters:
-
-
array $params required
Parameters (file, component)
-
- Method defined in:
- cake/console/error.php on line 211
- Access
public
missingConnection
topRenders the Database Connection web page.
- Parameters:
-
-
array $params required
Parameters
-
- Method defined in:
- cake/console/error.php on line 175
- Access
public
missingController
topRenders the Missing Controller web page.
- Parameters:
-
-
array $params required
Parameters (className)
-
- Method defined in:
- cake/console/error.php on line 91
- Access
public
missingDatabase
topRenders the Missing Database web page.
- Parameters:
-
-
array $params optional array ( )
Parameters
-
- Method defined in:
- cake/console/error.php on line 140
- Access
public
missingHelperClass
topRenders the Missing Helper class web page.
- Parameters:
-
-
array $params required
Parameters (file, helper)
-
- Method defined in:
- cake/console/error.php on line 199
- Access
public
missingHelperFile
topRenders the Missing Helper file web page.
- Parameters:
-
-
array $params required
Parameters (file, helper)
-
- Method defined in:
- cake/console/error.php on line 187
- Access
public
missingLayout
topRenders the Missing Layout web page.
- Parameters:
-
-
array $params required
Parameters (file)
-
- Method defined in:
- cake/console/error.php on line 163
- Access
public
missingModel
topRenders the Missing Model class web page.
- Parameters:
-
-
array $params required
Parameters (className)
-
- Method defined in:
- cake/console/error.php on line 235
- Access
public
missingTable
topRenders the Missing Table web page.
- Parameters:
-
-
array $params required
Parameters (table, className)
-
- Method defined in:
- cake/console/error.php on line 128
- Access
public
missingView
topRenders the Missing View web page.
- Parameters:
-
-
array $params required
Parameters (file, action, className)
-
- Method defined in:
- cake/console/error.php on line 151
- Access
public
Object
topA 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()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
privateAction
topRenders the Private Action web page.
- Parameters:
-
-
array $params required
Parameters (action, className)
-
- Method defined in:
- cake/console/error.php on line 116
- Access
public
requestAction
topCalls 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 required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows 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.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
stderr
topOutputs to the stderr filehandle.
- Parameters:
-
-
string $string required
Error text to output.
-
- Method defined in:
- cake/console/error.php on line 262
- Access
public
stdout
topOutputs to the stdout filehandle.
- Parameters:
-
-
string $string required
String to output.
-
boolean $newline optional true
If true, the outputs gets an added newline.
-
- Method defined in:
- cake/console/error.php on line 248
- Access
public
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
