Documentation for class generic_acl (inherits from generic):


Properties:

name type default params representant foreign foreign_prop position
id CO_INTEGER SEQUENCE READONLY=1;HIDDEN=1 0 0
version CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
deleted CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
inherits_acl CO_INTEGER 1 HIDDEN=1;READONLY=1 0 50

Methods:


method check_acl
description: This is very important method that checks acl. Whole security system depends on this method!
description: You will want to overwrite this method if you have non-standard ACL checking.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method check_acl_class
description: This is very important method that checks acl. Whole security system depends on this method!
description: You will want to overwrite this method if you have non-standard ACL checking.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING


method testACL
description: this is public version of checkACL, that you can use to check the acl value
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

id_permission
description: Id of permission that you want to check
type CO_INTEGER

id_role
description: Id of role that you want to check
type CO_INTEGER


method testClassACL
description: this is public version of check_acl_class, that you can use to check the acl value for given class
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

id_permission
description: Id of permission that you want to check
type CO_INTEGER

id_role
description: Id of role that you want to check
type CO_INTEGER


method insertChild
description: This method is overloaded of generic::insertChild. In this method we add copying of acl from parent
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

child_class
description: this is the name of class to insert record in
type CO_STRING

child_prop
description: this is the property name in child class that holds id of parent
type CO_STRING

foreign_prop
description: this is the prop in container (this:) class that holds id to copy to child class
type CO_STRING


method insertChildX
description: This method is a version of generic_acl::insertChild. In this method we set properties of the child.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

child_class
description: this is the name of class tu insert record in
type CO_STRING

child_prop
description: this is the property name in child class that holds id of parent
type CO_STRING

foreign_prop
description: this is the prop in container (this:) class that holds id to copy to child class
type CO_STRING

create_params
description: this is array of additional parameters that we can pass to target class to create object; see create
type CO_ARRAY_OF_STRINGS


method cloneACL
description: This method clones all ACLs from given object (used p.e. by catalog)
description: You will want to overwrite this method if you have non-standard ACL checking.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

area_parent
description: this is the name of the area of class that holds the ACLs
type CO_STRING

class_parent
description: this is the name of class that holds the ACLs
type CO_STRING

id_parent
description: this is id of the element that holds the ACLs
type CO_INTEGER


method copyACL
description: This method copies all ACLs from object to the given object.
description: Why not cloneACL? Because only class implementation know how to read ACLs.
description: You will want to overwrite this method if you have non-standard ACL checking.
description: This method is for use in methods only (permission=0; turn security off to use it).
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

area_target
description: this is the name of the area of class to copy ACLs to.
type CO_STRING

class_target
description: this is the name of class to copy ACLs to.
type CO_STRING

id_target
description: this is id of the element to copy ACLs to.
type CO_INTEGER


method permissionOn
description: This method sets one ACL On
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

id_permission
description: this is the id of permission that we wish to set on for current object
type CO_INTEGER

id_role
description: this is the id of the role that we want to grant permission
type CO_INTEGER


method permissionOff
description: This method sets one ACL On
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

id_permission
description: this is the id of permission that we wish to set on for current object
type CO_INTEGER

id_role
description: this is the id of the role that we want to grant permission
type CO_INTEGER


method classPermissionOn
description: This method sets one class ACL On
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

id_permission
description: this is the id of permission that we wish to set on for current object
type CO_INTEGER

id_role
description: this is the id of the role that we want to grant permission
type CO_INTEGER


method classPermissionOff
description: This method sets one class ACL Off
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

id_permission
description: this is the id of permission that we wish to set on for current object
type CO_INTEGER

id_role
description: this is the id of the role that we want to grant permission
type CO_INTEGER


method create
description: this method creates empty object and sets ACL to allow changing of acls to active role
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

create_params
description: this is array of additional parameters that we can pass to target class to create object
type CO_ARRAY_OF_STRINGS

dont_set_acl
description: If this param is set to 1 we do not set ACL for __PERMISSION_CHANGE_ACL for created object
type CO_INTEGER


method createAndSet
description: this method creates empty object and sets ACL to allow changing of acls to active role, also sets props as given in create_params
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

create_params
description: this is array of additional parameters that we can pass to target class to create object
type CO_ARRAY_OF_STRINGS

dont_set_acl
description: If this param is set to 1 we do not set ACL for __PERMISSION_CHANGE_ACL for created object
type CO_INTEGER


method createAndSetWithACL
description: this method creates object and sets ACLs taken from acl_class, also sets props as given in create_params
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

create_params
description: this is array of additional parameters that we can pass to target class to create object
type CO_ARRAY_OF_STRINGS