Back to Joomla project (class list)

Class Rule - list of methods

Rule class.
Package: Joomla\CMS\Access
Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Access/Rule.php
Project: Joomla

Method Summary

public
(mixed $identities)

Constructor.
Parameters
  • mixed $identities A JSON format string (probably from the database) or a named array.
Since
  • 1.7.0
Show source code of this method: __construct Source Code

public array
()

Get the data for the action.
Returns
  • array A named array
Since
  • 1.7.0
Show source code of this method: getData Source Code

public void
(mixed $identities)

Merges the identities
Parameters
  • mixed $identities An integer or array of integers representing the identities to check.
Returns
  • void
Since
  • 1.7.0
Show source code of this method: mergeIdentities Source Code

public void
(mixed $identity, mixed $allow)

Merges the values for an identity.
Parameters
  • int $identity The identity.
  • bool $allow The value for the identity (true == allow, false == deny).
Returns
  • void
Since
  • 1.7.0
Show source code of this method: mergeIdentity Source Code

public mixed
(mixed $identities)

Checks that this action can be performed by an identity.
Parameters
  • 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
  • 1.7.0
Show source code of this method: allow Source Code

public string
()

Convert this object into a JSON encoded string.
Returns
  • string JSON encoded string
Since
  • 1.7.0
Show source code of this method: __toString Source Code

Properties Summary

protected array
$data
A named array
Since
  • 1.7.0

Tags Summary

Since
2.5.0