Class JAccessRule

JAccessRule class.

Direct known subclasses

JRule

Package: Joomla\Platform\Access
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.4
Located at joomla/access/rule.php

Methods summary

`public`	# `__construct( mixed $identities )` Constructor. Constructor. The input array must be in the form: array(-42 => true, 3 => true, 4 => false) or an equivalent JSON encoded string. Parameters `$identities` `mixed` - $identities A JSON format string (probably from the database) or a named array. Since 11.1
`public array`	# `getData( )` Get the data for the action. Get the data for the action. Returns `array` - A named array Since 11.1
`public`	# `mergeIdentities( mixed $identities )` Merges the identities Merges the identities Parameters `$identities` `mixed` - $identities An integer or array of integers representing the identities to check. Since 11.1
`public`	# `mergeIdentity( integer $identity, boolean $allow )` Merges the values for an identity. Merges the values for an identity. Parameters `$identity` `integer` - $identity The identity. `$allow` `boolean` - $allow The value for the identity (true == allow, false == deny). Since 11.1
`public mixed`	# `allow( mixed $identities )` Checks that this action can be performed by an identity. 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. Parameters `$identities` `mixed` - $identities An integer or array of integers representing the identities to check. Returns `mixed` - True if allowed, false for an explicit deny, null for an implicit deny. Since 11.1
`public string`	# `__toString( )` Convert this object into a JSON encoded string. Convert this object into a JSON encoded string. Returns `string` - JSON encoded string Since 11.1

Magic methods summary

Properties summary

`protected array`	`$data`	# A named array A named array Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JAccessRule

Direct known subclasses

Methods summary

Parameters

Since

Returns

Since

Parameters

Since

Parameters

Since

Parameters

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since