Référence de la classe Rules

Fonctions membres publiques
	__construct ($input='')
	getData ()
	mergeCollection ($input)
	merge ($actions)
	mergeAction ($action, $identities)
	allow ($action, $identity)
	getAllowed ($identity)
	__toString ()

Attributs protégés
	$data = array()

Description détaillée

Access rules class.

Depuis

2.5.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

$input = ''

)

Constructor.

The input array must be in the form: array('action' => array(-42 => true, 3 => true, 4 => false)) or an equivalent JSON encoded string, or an object where properties are arrays.

Paramètres

mixed

$input

A JSON format string (probably from the database) or a nested array.

Depuis

1.7.0

Références $input, et elseif.

Documentation des fonctions membres

__toString()

__toString

(

)

Magic method to convert the object to JSON string representation.

Renvoie

string JSON representation of the actions array

Depuis

1.7.0

Références $data, $name, et $temp.

allow()

allow	(		$action,
			$identity
	)

Checks that an action can be performed by an identity.

The identity is an integer where +ve represents a user group, and -ve represents a user.

Paramètres

string	$action	The name of the action.
mixed	$identity	An integer representing the identity, or an array of identities

Renvoie

mixed Object or null if there is no information about the action.

Depuis

1.7.0

getAllowed()

getAllowed

(

$identity

)

Get the allowed actions for an identity.

Paramètres

mixed

$identity

An integer representing the identity or an array of identities

Renvoie

CMSObject Allowed actions for the identity or identities

Depuis

1.7.0

Références $name.

getData()

getData

(

)

Get the data for the action.

Renvoie

array A named array of Rule objects.

Depuis

1.7.0

Références $data.

merge()

merge

(

$actions

)

Method to merge actions with this object.

Paramètres

mixed

$actions

Rule object, an array of actions or a JSON string array of actions.

Renvoie

void

Depuis

1.7.0

Références $actions, $data, $name, et elseif.

mergeAction()

mergeAction	(		$action,
			$identities
	)

Merges an array of identities for an action.

Paramètres

string	$action	The name of the action.
array	$identities	An array of identities

Renvoie

void

Depuis

1.7.0

mergeCollection()

mergeCollection

(

$input

)

Method to merge a collection of Rules.

Paramètres

mixed

$input

Rule or array of Rules

Renvoie

void

Depuis

1.7.0

Références $actions, et $input.

Documentation des champs

$data

$data = array()

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• src/Access/Rules.php