CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 1.2 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.2
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Classes

  • AclBase
  • AclBehavior
  • AclComponent
  • AclNode
  • AclShell
  • Aco
  • AcoAction
  • AjaxHelper
  • ApcEngine
  • ApiShell
  • App
  • AppController
  • AppHelper
  • AppModel
  • Aro
  • AuthComponent
  • BakeShell
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbAclSchema
  • DbConfigTask
  • DboAdodb
  • DboDb2
  • DboFirebird
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOdbc
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • DboSybase
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • Flay
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • i18nSchema
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JsHelper
  • JsHelperObject
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginTask
  • ProjectTask
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • SessionsSchema
  • Set
  • Shell
  • String
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • __enclose
  • make_clean_css
  • mb_encode_mimeheader
  • mb_stripos
  • mb_stristr
  • mb_strlen
  • mb_strpos
  • mb_strrchr
  • mb_strrichr
  • mb_strripos
  • mb_strrpos
  • mb_strstr
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count
  • write_css_cache

Class Debugger

Provide custom logging and error handling.

Debugger overrides PHP's default error handling to provide stack traces and enhanced logging

Object
Extended by Debugger
Package: cake\cake\libs
Link: http://book.cakephp.org/view/460/Using-the-Debugger-Class
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: debugger.php

Properties summary

  • $__data public
    string
    Holds current output data when outputFormat is false.
  • $_outputFormat public
    string
    The current output format.
  • $errors public
    array
    A list of errors generated by the application.
  • $helpPath public
    string
    Contains the base URL for error code documentation.

Inherited Properties

  • _log

Method Summary

  • __construct() public
    Constructor.
  • __object() public
    Handles object to string conversion.
  • _output() public
    Handles object conversion to debug string.
  • checkSessionKey() public
    Verifies that the application's salt value has been changed from the default value.
  • dump() public
    Formats and outputs the contents of the supplied variable.
  • excerpt() public
    Grabs an excerpt from a file and highlights a given line of code
  • exportVar() public
    Converts a variable to a string for debug output.
  • getInstance() public
    Returns a reference to the Debugger singleton object instance.
  • handleError() public
    Overrides PHP's default error handling.
  • invoke() public

    Invokes the given debugger object as the current error handler, taking over control from the previous handler in a stack-like hierarchy.

  • log() public

    Creates a detailed stack trace log at the time of invocation, much like dump() but to debug.log.

  • output() public
    Handles object conversion to debug string.
  • trace() public
    Outputs a stack trace based on the supplied options.
  • trimPath() public

    Shortens file paths by replacing the application base path with 'APP', and the CakePHP core path with 'CORE'.

Method Detail

__construct() public ¶

__construct( )

Constructor.

Overrides
Object::__construct()

__object() public ¶

__object( string $var )

Handles object to string conversion.

Parameters
string $var
Object to convert
Returns
string
See
Debugger:exportVar()

_output() public ¶

_output( string $level , $error , $code , $helpCode , $description , $file , $line , $kontext )

Handles object conversion to debug string.

Parameters
string $level
$var Object to convert
$error
$code
$helpCode
$description
$file
$line
$kontext

checkSessionKey() public ¶

checkSessionKey( )

Verifies that the application's salt value has been changed from the default value.

dump() public ¶

dump( $var )

Formats and outputs the contents of the supplied variable.

Parameters
$var
the variable to dump
See
Debugger::exportVar()
Link
http://book.cakephp.org/view/460/Using-the-Debugger-Class

excerpt() public ¶

excerpt( string $file , integer $line , integer $context = 2 )

Grabs an excerpt from a file and highlights a given line of code

Parameters
string $file
Absolute path to a PHP file
integer $line
Line number to highlight
integer $context optional 2
Number of lines of context to extract above and below $line
Returns
array
Set of lines highlighted
Link
http://book.cakephp.org/view/460/Using-the-Debugger-Class

exportVar() public ¶

exportVar( string $var , $recursion = 0 )

Converts a variable to a string for debug output.

Parameters
string $var
Variable to convert
$recursion optional 0
Returns
string
Variable as a formatted string
Link
http://book.cakephp.org/view/460/Using-the-Debugger-Class

getInstance() public ¶

getInstance( $class = null )

Returns a reference to the Debugger singleton object instance.

Returns
object

handleError() public ¶

handleError( integer $code , string $description , string $file = null , integer $line = null , array $context = null )

Overrides PHP's default error handling.

Parameters
integer $code
Code of error
string $description
Error description
string $file optional null
File on which error occurred
integer $line optional null
Line that triggered the error
array $context optional null
Context
Returns
boolean
true if error was handled

invoke() public ¶

invoke( object $debugger )

Invokes the given debugger object as the current error handler, taking over control from the previous handler in a stack-like hierarchy.

Parameters
object $debugger
A reference to the Debugger object
Link
http://book.cakephp.org/view/460/Using-the-Debugger-Class

log() public ¶

log( $var , $level = LOG_DEBUG )

Creates a detailed stack trace log at the time of invocation, much like dump() but to debug.log.

Parameters
$var
Variable or content to log
$level optional LOG_DEBUG
type of log to use. Defaults to LOG_DEBUG
Link
http://book.cakephp.org/view/460/Using-the-Debugger-Class
Overrides
Object::log()

output() public ¶

output( string $format = 'js' )

Handles object conversion to debug string.

Parameters
string $format optional 'js'
$var Object to convert

trace() public ¶

trace( array $options = array() )

Outputs a stack trace based on the supplied options.

Parameters
array $options optional array()
Format for outputting stack trace
Returns
string
Formatted stack trace
Link
http://book.cakephp.org/view/460/Using-the-Debugger-Class

trimPath() public ¶

trimPath( string $path )

Shortens file paths by replacing the application base path with 'APP', and the CakePHP core path with 'CORE'.

Parameters
string $path
Path to shorten
Returns
string
Normalized path

Methods inherited from Object

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
Object

__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
boolean
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
boolean
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.

Parameters
array $properties optional array()
An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script

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
error
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, and improves performance by using straight method calls in most cases.

Parameters
string $method
Name of the method to call
array $params optional array()
Parameter list to use when calling $method
Returns
mixed
Returns the result of the method call

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location.

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
mixed

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
string
The name of this class

Properties detail

$__data ¶

public string

Holds current output data when outputFormat is false.

array()

$_outputFormat ¶

public string

The current output format.

'js'

$errors ¶

public array

A list of errors generated by the application.

array()

$helpPath ¶

public string

Contains the base URL for error code documentation.

null
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs