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 AclBehavior

Short description for file

Long description for file

Object
Extended by ModelBehavior
Extended by AclBehavior
Package: cake\cake\libs\model\behaviors
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc.
License: The MIT License
Location: model/behaviors/acl.php

Properties summary

  • $__typeMaps public
    array
    Maps ACL type options to ACL models

Inherited Properties

  • mapMethods, settings _log

Method Summary

  • afterDelete() public
    Destroys the ARO/ACO node bound to the deleted record
  • afterSave() public
    Creates a new ARO/ACO node bound to this record
  • node() public
    Retrieves the Aro/Aco node for this model
  • setup() public
    Sets up the configuation for the model, and loads ACL models if they haven't been already

Method Detail

afterDelete() public ¶

afterDelete( object $model )

Destroys the ARO/ACO node bound to the deleted record

Parameters
object $model
Model using this behavior
Overrides
ModelBehavior::afterDelete()

afterSave() public ¶

afterSave( boolean $model , boolean $created )

Creates a new ARO/ACO node bound to this record

Parameters
boolean $model
$created True if this is a new record
boolean $created
True if this save created a new record
Overrides
ModelBehavior::afterSave()

node() public ¶

node( mixed $model , $ref = null )

Retrieves the Aro/Aco node for this model

Parameters
mixed $model
$ref
$ref optional null
Returns
array

setup() public ¶

setup( mixed $model , array $config = array() )

Sets up the configuation for the model, and loads ACL models if they haven't been already

Parameters
mixed $model
$config
array $config optional array()
Configuration settings for $model
Overrides
ModelBehavior::setup()

Methods inherited from ModelBehavior

_addToWhitelist() public ¶

_addToWhitelist( object $model , string $field )

If $model's whitelist property is non-empty, $field will be added to it. Note: this method should only be used in beforeValidate or beforeSave to ensure that it only modifies the whitelist for the current save operation. Also make sure you explicitly set the value of the field which you are allowing.

Parameters
object $model
Model using this behavior
string $field
Field to be added to $model's whitelist

afterFind() public ¶

afterFind( object $model , mixed $results , boolean $primary )

After find callback. Can be used to modify any results returned by find and findAll.

Parameters
object $model
Model using this behavior
mixed $results
The results of the find operation
boolean $primary
Whether this model is being queried directly (vs. being queried as an association)
Returns
mixed
Result of the find operation

beforeDelete() public ¶

beforeDelete( object $model , boolean $cascade = true )

Before delete callback

Parameters
object $model
Model using this behavior
boolean $cascade optional true
If true records that depend on this record will also be deleted
Returns
boolean
True if the operation should continue, false if it should abort

beforeFind() public ¶

beforeFind( object $model , array $query )

Before find callback

Parameters
object $model
Model using this behavior
array $query
$queryData Data used to execute this query, i.e. conditions, order, etc.
Returns
boolean
True if the operation should continue, false if it should abort

beforeSave() public ¶

beforeSave( object $model )

Before save callback

Parameters
object $model
Model using this behavior
Returns
boolean
True if the operation should continue, false if it should abort

beforeValidate() public ¶

beforeValidate( object $model )

Before validate callback

Parameters
object $model
Model using this behavior
Returns
boolean
True if validate operation should continue, false to abort

cleanup() public ¶

cleanup( object $model )

Clean up any initialization this behavior has done on a model. Called when a behavior is dynamically detached from a model using Model::detach().

Parameters
object $model
Model using this behavior
See
BehaviorCollection::detach()

dispatchMethod() public ¶

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

Overrides Object::dispatchMethod to account for PHP4's broken reference support

Parameters
string $model
$method Name of the method to call
array $method
$params Parameter list to use when calling $method
$params optional array()
Returns
mixed
See
Object::dispatchMethod
Overrides
Object::dispatchMethod()

onError() public ¶

onError( object $model , string $error )

DataSource error callback

Parameters
object $model
Model using this behavior
string $error
Error generated in DataSource

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

$__typeMaps ¶

public array

Maps ACL type options to ACL models

array('requester' => 'Aro', 'controlled' => 'Aco')
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