[ Index ]

PHP Cross Reference of ACL Module

title

Body

[close]

/models/ -> AclObject.php (summary)

AclObject Interface File This is the base interfasce for AclObjects defining the most basic operations

Author: dispy <dispyfree@googlemail.com>
License: LGPLv2
File Size: 361 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 14 functions

  beforeJoin()
  beforeLeave()
  beforeIs()
  getChildObjects()
  getParentObjects()
  loadObjectStatic()
  loadObject()
  loadObjects()
  loadObjectsStatic()
  getNodes()
  afterSave()
  getAssociatedObject()
  assureSaved()
  assureSafety()

Functions
Functions that are not part of a class:

beforeJoin(&$obj)   X-Ref
Callback being executed before every join
Usage of this method allows common behavior for several strategies
with respect to object transformations and a secure environment

param: AclObject $obj

beforeLeave(&$obj)   X-Ref
Callback being executed before every leave
Usage of this method allows common behavior for several strategies
with respect to object transformations and a secure environment

param: AclObject $obj

beforeIs(&$obj)   X-Ref
Callback being executed before every childhood-check
Usage of this method allows common behavior for several strategies
with respect to object transformations and a secure environment

param: AclObject $obj

getChildObjects()   X-Ref
Fetches all child-objects and returns them in an array

return: array[AclObject] the child-objects

getParentObjects()   X-Ref
Fetches all parent-objects and returns them in an array

return: array[AclObject] the parent-objects

loadObjectStatic($identifier, $model)   X-Ref
Just a convenient wrapper to loadObjects

param: mixed $identifier The Identifier denoting the associated row in the ACL-system.
param: string $model - the class-Name of the expected object (Aro or Aco)

loadObject($identifier, $model = NULL)   X-Ref
Just a convenient wrapper to loadObjects

param: mixed $identifier The Identifier denoting the associated row in the ACL-system.
param: string $model - the class-Name of the expected object (Aro or Aco)

loadObjects($identifier, $model = NULL, $onlyFirst = true)   X-Ref
Just a convenient wrapper to loadObjects

param: mixed $identifier The Identifier denoting the associated row in the ACL-system.
param: string $model - the class-Name of the expected object (Aro or Aco)

loadObjectsStatic($identifier, $model = NULL, $onlyFirst = true)   X-Ref
This method is used to load Objects (either Aco or Aro) using convenient identifiers.

param: mixed $identifier The Identifier denoting the associated row in the ACL-system.
param: string $model - the class-Name of the expected object (Aro or Aco)
param: boolean $onlyFirst    Determines whether to fetch only the first matching object, or all of them.
return: type

getNodes()   X-Ref
This method returns all AclNodes being associated with this

param: AclObject object
return: array[AclNode]

afterSave()   X-Ref
Processes post-saving tasks


getAssociatedObject()   X-Ref
Loads the associated object, if possible, and returns it

return: mixed   NULL or a child of CActiveREcord

assureSaved()   X-Ref
Reassures that all passed objects have been saved


assureSafety(&$obj)   X-Ref
Assures that:
- the object is of a proper class
- all involved objects have been saved before they interact

param: AclObject $obj



Generated: Sun Jul 1 19:24:45 2012 Cross-referenced by PHPXref 0.7.1