AclInterface Interface Reference

Inheritance diagram for AclInterface:

Public Member Functions
	allow ($resourceType, $folderPath, $permission, $role)
	disallow ($resourceType, $folderPath, $permission, $role)
	isAllowed ($resourceType, $folderPath, $permission, $role=null)
	getComputedMask ($resourceType, $folderPath, $role=null)

Detailed Description

The Acl interface.

Member Function Documentation

allow()

allow	(		$resourceType,
			$folderPath,
			$permission,
			$role
	)

Allows a permission in the chosen folder.

Parameters

string	$resourceType	the resource type identifier (also * for all resource types)
string	$folderPath	the folder path
int	$permission	the permission numeric value
string	$role	the user role name (also * for all roles)

Returns

Acl $this

See also

Permission

disallow()

disallow	(		$resourceType,
			$folderPath,
			$permission,
			$role
	)

Disallows a permission in the chosen folder.

Parameters

string	$resourceType	the resource type identifier (also * for all resource types)
string	$folderPath	the folder path
int	$permission	the permission numeric value
string	$role	the user role name (also * for all roles)

Returns

Acl $this

See also

Permission

getComputedMask()

getComputedMask	(		$resourceType,
			$folderPath,
			$role = null
	)

Computes a mask based on the current user role and ACL rules.

Parameters

string	$resourceType	the resource type identifier (also * for all resource types)
string	$folderPath	the folder path
string	$role	the user role name (also * for all roles)

Returns

int computed mask value

See also

MaskBuilder

Implemented in Acl.

isAllowed()

isAllowed	(		$resourceType,
			$folderPath,
			$permission,
			$role = null
	)

Checks if a role has the required permission for a folder.

Parameters

string	$resourceType	the resource type identifier (also * for all resource types)
string	$folderPath	the folder path
int	$permission	the permission numeric value
string	$role	the user role name (also * for all roles)

Returns

bool true if role has required permission

See also

Permission

Implemented in Acl.

---

The documentation for this interface was generated from the following file:

• AclInterface.php