Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Rule

Fonctions membres publiques

 __construct ($identities)
 
 getData ()
 
 mergeIdentities ($identities)
 
 mergeIdentity ($identity, $allow)
 
 allow ($identities)
 
 __toString ()
 

Attributs protégés

 $data = array()
 

Description détaillée

Rule class.

Depuis
11.4

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $identities)

Constructor.

The input array must be in the form: array(-42 => true, 3 => true, 4 => false) or an equivalent JSON encoded string.

Paramètres
mixed$identitiesA JSON format string (probably from the database) or a named array.
Depuis
11.1

Références Access\$identities.

Documentation des fonctions membres

◆ __toString()

__toString ( )

Convert this object into a JSON encoded string.

Renvoie
string JSON encoded string
Depuis
11.1

Références json_encode.

◆ allow()

allow (   $identities)

Checks that this 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
mixed$identitiesAn integer or array of integers representing the identities to check.
Renvoie
mixed True if allowed, false for an explicit deny, null for an implicit deny.
Depuis
11.1

Références Access\$identities, et null.

◆ getData()

getData ( )

Get the data for the action.

Renvoie
array A named array
Depuis
11.1

Références $data.

◆ mergeIdentities()

mergeIdentities (   $identities)

Merges the identities

Paramètres
mixed$identitiesAn integer or array of integers representing the identities to check.
Renvoie
void
Depuis
11.1

Références Access\$identities.

◆ mergeIdentity()

mergeIdentity (   $identity,
  $allow 
)

Merges the values for an identity.

Paramètres
integer$identityThe identity.
boolean$allowThe value for the identity (true == allow, false == deny).
Renvoie
void
Depuis
11.1

Documentation des champs

◆ $data

$data = array()
protected

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