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 BehaviorCollection

Model behavior collection class.

Defines the Behavior interface, and contains common model interaction functionality.

Object
Extended by BehaviorCollection
Package: cake\cake\libs\model
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: model/behavior.php

Properties summary

  • $__mappedMethods public
    array
    Keeps a list of all methods which have been mapped with regular expressions
  • $__methods public
    array
    Keeps a list of all methods of attached behaviors
  • $_attached public
    array
    Lists the currently-attached behavior objects
  • $_disabled public
    array
    Lists the currently-attached behavior objects which are disabled
  • $modelName public
    string
    Stores a reference to the attached name

Inherited Properties

  • _log

Method Summary

  • attach() public
    Attaches a behavior to a model
  • attached() public
    Gets the list of attached behaviors, or, whether the given behavior is attached
  • detach() public
    Detaches a behavior from a model
  • disable() public

    Disables callbacks on a behavior or array of behaviors. Public behavior methods are still callable as normal.

  • dispatchMethod() public
    Dispatches a behavior method
  • enable() public
    Enables callbacks on a behavior or array of behaviors
  • enabled() public
    Gets the list of currently-enabled behaviors, or, the current status of a single behavior
  • init() public
    Attaches a model object and loads a list of behaviors
  • methods() public
    Gets the method list for attached behaviors, i.e. all public, non-callback methods
  • trigger() public
    Dispatches a behavior callback on all attached behavior objects

Method Detail

attach() public ¶

attach( string $behavior , array $config = array() )

Attaches a behavior to a model

Parameters
string $behavior
CamelCased name of the behavior to load
array $config optional array()
Behavior configuration parameters
Returns
boolean
True on success, false on failure

attached() public ¶

attached( string $name = null )

Gets the list of attached behaviors, or, whether the given behavior is attached

Parameters
string $name optional null

Optional. The name of the behavior to check the status of. If omitted, returns an array of currently-attached behaviors

Returns
mixed

If $name is specified, returns the boolean status of the corresponding behavior. Otherwise, returns an array of all attached behaviors.


detach() public ¶

detach( string $name )

Detaches a behavior from a model

Parameters
string $name
CamelCased name of the behavior to unload

disable() public ¶

disable( mixed $name )

Disables callbacks on a behavior or array of behaviors. Public behavior methods are still callable as normal.

Parameters
mixed $name
CamelCased name of the behavior(s) to disable (string or array)

dispatchMethod() public ¶

dispatchMethod( string $model , array $method , $params = array() , $strict = false )

Dispatches a behavior method

Parameters
string $model
$method Name of the method to call
array $method
$params Parameter list to use when calling $method
$params optional array()
$strict optional false
Returns
array
All methods for all behaviors attached to this object
Overrides
Object::dispatchMethod()

enable() public ¶

enable( mixed $name )

Enables callbacks on a behavior or array of behaviors

Parameters
mixed $name
CamelCased name of the behavior(s) to enable (string or array)

enabled() public ¶

enabled( string $name = null )

Gets the list of currently-enabled behaviors, or, the current status of a single behavior

Parameters
string $name optional null

Optional. The name of the behavior to check the status of. If omitted, returns an array of currently-enabled behaviors

Returns
mixed

If $name is specified, returns the boolean status of the corresponding behavior. Otherwise, returns an array of all enabled behaviors.


init() public ¶

init( $modelName , $behaviors = array() )

Attaches a model object and loads a list of behaviors

methods() public ¶

methods( )

Gets the method list for attached behaviors, i.e. all public, non-callback methods

Returns
array
All public methods for all behaviors attached to this collection

trigger() public ¶

trigger( model $model , string $callback , array $params = array() , array $options = array() )

Dispatches a behavior callback on all attached behavior objects

Parameters
model $model
string $callback
array $params optional array()
array $options optional array()
Returns
mixed

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

__construct() public ¶

__construct( )

Class constructor, overridden in descendant classes.

__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

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

API for logging events.

Parameters
string $msg
Log message
integer $type optional LOG_ERROR
Error type constant. Defined in app/config/core.php.
Returns
boolean
Success of log write

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

$__mappedMethods ¶

public array

Keeps a list of all methods which have been mapped with regular expressions

array()

$__methods ¶

public array

Keeps a list of all methods of attached behaviors

array()

$_attached ¶

public array

Lists the currently-attached behavior objects

array()

$_disabled ¶

public array

Lists the currently-attached behavior objects which are disabled

array()

$modelName ¶

public string

Stores a reference to the attached name

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