Rule
Rule class.
| since |
2.5.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor.
__construct( identities) :
The input array must be in the form: array(-42 => true, 3 => true, 4 => false) or an equivalent JSON encoded string.
| since |
1.7.0 |
|---|
Arguments
- identities
mixedA JSON format string (probably from the database) or a named array.
Response
mixed
__toString
Convert this object into a JSON encoded string.
__toString() :
| since |
1.7.0 |
|---|
Response
stringJSON encoded string
allow
Checks that this action can be performed by an identity.
allow( identities) :
The identity is an integer where +ve represents a user group, and -ve represents a user.
| since |
1.7.0 |
|---|
Arguments
- identities
mixedAn integer or array of integers representing the identities to check.
Response
mixedTrue if allowed, false for an explicit deny, null for an implicit deny.
getData
Get the data for the action.
getData() : mixed||string|int
| since |
1.7.0 |
|---|
Response
array<string|int, mixed>A named array
mergeIdentities
Merges the identities
mergeIdentities( identities) :
| since |
1.7.0 |
|---|
Arguments
- identities
mixedAn integer or array of integers representing the identities to check.
Response
void
mergeIdentity
Merges the values for an identity.
mergeIdentity( identity, allow) :
| since |
1.7.0 |
|---|
Arguments
- identity
intThe identity.- allow
boolThe value for the identity (true == allow, false == deny).
Response
void
Properties
data
A named array
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>