Referencia de la Clase Acl

Métodos públicos
	add_role (AclRole $roleObject, $access_inherits='')
	add_inherit ($role, $role_to_inherit)
	is_role ($role_name)
	is_resource ($resource_name)
	add_resource (AclResource $resource)
	add_resource_access ($resource, $access_list)
	drop_resource_access ($resource, $access_list)
	allow ($role, $resource, $access)
	deny ($role, $resource, $access)
	is_allowed ($role, $resource, $access_list)

Campos de datos
	$access = array()

Descripción detallada

Definición en la línea 52 del archivo acl.php.

Documentación de las funciones miembro

add_inherit	(		$role,
			$role_to_inherit
	)

Hace que un rol herede los accesos de otro rol

Parámetros

string	$role
string	$role_to_inherit

Definición en la línea 130 del archivo acl.php.

add_resource

(

AclResource

$resource)

Agrega un resource a la Lista ACL

Resource_name puede ser el nombre de un objeto concreto, por ejemplo consulta, buscar, insertar, valida etc o una lista de ellos

Ej: //Agregar un resource a la lista: $acl->add_resource(new AclResource('clientes'), 'consulta');

//Agregar Varios resources a la lista: $acl->add_resource(new AclResource('clientes'), 'consulta', 'buscar', 'insertar');

Parámetros

AclResource

$resource

Devuelve

boolean

Definición en la línea 207 del archivo acl.php.

add_resource_access	(		$resource,
			$access_list
	)

Agrega accesos a un Resource

Parámetros

$resource
$access_list

Definición en la línea 227 del archivo acl.php.

add_role	(	AclRole	$roleObject,
			$access_inherits = ''
	)

Agrega un Rol a la Lista ACL

$roleObject = Objeto de la clase AclRole para agregar a la lista $access_inherits = Nombre del Role del cual hereda permisos ó array del grupo de perfiles del cual hereda permisos

Ej: $acl->add_role(new Acl_Role('administrador'), 'consultor');

Parámetros

string

$roleObject

Devuelve

boolean

Definición en la línea 111 del archivo acl.php.

allow	(		$role,
			$resource,
			$access
	)

Agrega un acceso de la lista de resources a un rol

Utilizar '*' como comodín

Ej: //Acceso para invitados a consultar en clientes $acl->allow('invitados', 'clientes', 'consulta');

//Acceso para invitados a consultar e insertar en clientes $acl->allow('invitados', 'clientes', array('consulta', 'insertar'));

//Acceso para cualquiera a visualizar en productos $acl->allow('*', 'productos', 'visualiza');

//Acceso para cualquiera a visualizar en cualquier resource $acl->allow('*', '*', 'visualiza');

Parámetros

string	$role
string	$resource
mixed	$access

Definición en la línea 296 del archivo acl.php.

deny	(		$role,
			$resource,
			$access
	)

Denegar un acceso de la lista de resources a un rol

Utilizar '*' como comodín

Ej: //Denega acceso para invitados a consultar en clientes $acl->deny('invitados', 'clientes', 'consulta');

//Denega acceso para invitados a consultar e insertar en clientes $acl->deny('invitados', 'clientes', array('consulta', 'insertar'));

//Denega acceso para cualquiera a visualizar en productos $acl->deny('*', 'productos', 'visualiza');

//Denega acceso para cualquiera a visualizar en cualquier resource $acl->deny('*', '*', 'visualiza');

Parámetros

string	$role
string	$resource
mixed	$access

Definición en la línea 350 del archivo acl.php.

drop_resource_access	(		$resource,
			$access_list
	)

Elimina un acceso del resorce

Parámetros

string	$resource
mixed	$access_list

Definición en la línea 248 del archivo acl.php.

is_allowed	(		$role,
			$resource,
			$access_list
	)

Devuelve true si un $role, tiene acceso en un resource

//Andres tiene acceso a insertar en el resource productos $acl->is_allowed('andres', 'productos', 'insertar');

//Invitado tiene acceso a editar en cualquier resource? $acl->is_allowed('invitado', '*', 'editar');

//Invitado tiene acceso a editar en cualquier resource? $acl->is_allowed('invitado', '*', 'editar');

Parámetros

string	$role
string	$resource
mixed	$access

Devuelve

boolean

Definición en la línea 399 del archivo acl.php.

is_resource

(

$resource_name)

Verifica si un resource existe en la lista o no

Parámetros

string

$resource_name

Devuelve

boolean

Definición en la línea 184 del archivo acl.php.

is_role

(

$role_name)

Verifica si un rol existe en la lista o no

Parámetros

string

$role_name

Devuelve

boolean

Definición en la línea 172 del archivo acl.php.

Documentación de los campos

$access = array()

Definición en la línea 78 del archivo acl.php.

---

La documentación para esta clase fue generada a partir del siguiente fichero:

• /home/joan/git/KumbiaPHP/core/libs/acl/acl.php