Rule

Rule class.

since

2.5.0

package

Application

Methods

__construct

Constructor.

__construct(mixed identities) : mixed

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() : string
since

1.7.0

Response

stringJSON encoded string

allow

Checks that this action can be performed by an identity.

allow(mixed identities) : mixed

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() : array
since

1.7.0

Response

arrayA named array

mergeIdentities

Merges the identities

mergeIdentities(mixed identities) : void
since

1.7.0

Arguments

identities

mixedAn integer or array of integers representing the identities to check.

mergeIdentity

Merges the values for an identity.

mergeIdentity(int identity, bool allow) : void
since

1.7.0

Arguments

identity

intThe identity.

allow

boolThe value for the identity (true == allow, false == deny).

Properties

data

A named array

since

1.7.0

Type(s)

array