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.3 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.3
      • 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
  • BakeTask
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeRoute
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbConfigTask
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • FileLog
  • FixtureTask
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • MootoolsEngineHelper
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginShortRoute
  • PluginTask
  • ProjectTask
  • PrototypeEngineHelper
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • Set
  • Shell
  • String
  • TemplateTask
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • 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

Class AclComponent

Access Control List factory class.

Uses a strategy pattern to allow custom ACL implementations to be used with the same component interface. You can define by changing Configure::write('Acl.classname', 'DbAcl'); in your core.php. Concrete ACL implementations should extend AclBase and implement the methods it defines.

Object
Extended by AclComponent
Package: cake\cake\libs\controller\components
Link: http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Access-Control-Lists.html
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: controller/components/acl.php

Properties summary

  • $_Instance public
    object
    Instance of an ACL class

Method Summary

  • __construct() public
    Constructor. Will return an instance of the correct ACL class as defined in Configure::read('Acl.classname')
  • _initACL() public
    Empty class defintion, to be overridden in subclasses.
  • allow() public

    Pass-thru function for ACL allow instance. Allow methods are used to grant an ARO access to an ACO.

  • check() public

    Pass-thru function for ACL check instance. Check methods are used to check whether or not an ARO can access an ACO

  • deny() public

    Pass-thru function for ACL deny instance. Deny methods are used to remove permission from an ARO to access an ACO.

  • grant() public
    Pass-thru function for ACL grant instance. An alias for AclComponent::allow()
  • inherit() public

    Pass-thru function for ACL inherit instance. Inherit methods modify the permission for an ARO to be that of its parent object.

  • revoke() public
    Pass-thru function for ACL grant instance. An alias for AclComponent::deny()
  • startup() public
    Startup is not used

Method Detail

__construct() public ¶

__construct( )

Constructor. Will return an instance of the correct ACL class as defined in Configure::read('Acl.classname')

Overrides
Object::__construct()

_initACL() public ¶

_initACL( )

Empty class defintion, to be overridden in subclasses.

allow() public ¶

allow( string $aro , string $aco , string $action = "*" )

Pass-thru function for ACL allow instance. Allow methods are used to grant an ARO access to an ACO.

Parameters
string $aro
ARO The requesting object identifier.
string $aco
ACO The controlled object identifier.
string $action optional "*"
Action (defaults to *)
Returns
boolean
Success

check() public ¶

check( string $aro , string $aco , string $action = "*" )

Pass-thru function for ACL check instance. Check methods are used to check whether or not an ARO can access an ACO

Parameters
string $aro
ARO The requesting object identifier.
string $aco
ACO The controlled object identifier.
string $action optional "*"
Action (defaults to *)
Returns
boolean
Success

deny() public ¶

deny( string $aro , string $aco , string $action = "*" )

Pass-thru function for ACL deny instance. Deny methods are used to remove permission from an ARO to access an ACO.

Parameters
string $aro
ARO The requesting object identifier.
string $aco
ACO The controlled object identifier.
string $action optional "*"
Action (defaults to *)
Returns
boolean
Success

grant() public ¶

grant( string $aro , string $aco , string $action = "*" )

Pass-thru function for ACL grant instance. An alias for AclComponent::allow()

Parameters
string $aro
ARO The requesting object identifier.
string $aco
ACO The controlled object identifier.
string $action optional "*"
Action (defaults to *)
Returns
boolean
Success

inherit() public ¶

inherit( string $aro , string $aco , string $action = "*" )

Pass-thru function for ACL inherit instance. Inherit methods modify the permission for an ARO to be that of its parent object.

Parameters
string $aro
ARO The requesting object identifier.
string $aco
ACO The controlled object identifier.
string $action optional "*"
Action (defaults to *)
Returns
boolean
Success

revoke() public ¶

revoke( string $aro , string $aco , string $action = "*" )

Pass-thru function for ACL grant instance. An alias for AclComponent::deny()

Parameters
string $aro
ARO The requesting object identifier.
string $aco
ACO The controlled object identifier.
string $action optional "*"
Action (defaults to *)
Returns
boolean
Success

startup() public ¶

startup( object $controller )

Startup is not used

Parameters
object $controller
Controller using this component
Returns
boolean
Proceed with component usage (true), or fail (false)

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

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

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

$_Instance ¶

public object

Instance of an ACL class

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