Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Rules - list of methods

Access rules 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/Rules.php
Project: Joomla

Method Summary

public
__construct
(mixed $input = '')

Constructor.
Parameters
  • mixed $input A JSON format string (probably from the database) or a nested 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 of Rule objects.
Since
  • 1.7.0
Show source code of this method: getData Source Code

public void
(mixed $input)

Method to merge a collection of Rules.
Parameters
  • mixed $input Rule or array of Rules
Returns
  • void
Since
  • 1.7.0
Show source code of this method: mergeCollection Source Code

public void
(mixed $actions)

Method to merge actions with this object.
Parameters
  • mixed $actions Rule object, an array of actions or a JSON string array of actions.
Returns
  • void
Since
  • 1.7.0
Show source code of this method: merge Source Code

public void
(mixed $action, mixed $identities)

Merges an array of identities for an action.
Parameters
  • string $action The name of the action.
  • array $identities An array of identities
Returns
  • void
Since
  • 1.7.0
Show source code of this method: mergeAction Source Code

public mixed
(mixed $action, mixed $identity)

Checks that an action can be performed by an identity.
Parameters
  • string $action The name of the action.
  • mixed $identity An integer representing the identity, or an array of identities
Returns
  • mixed Object or null if there is no information about the action.
Since
  • 1.7.0
Show source code of this method: allow Source Code

public \Joomla\CMS\Object\CMSObject
(mixed $identity)

Get the allowed actions for an identity.
Parameters
  • mixed $identity An integer representing the identity or an array of identities
Returns
  • \Joomla\CMS\Object\CMSObject Allowed actions for the identity or identities
Since
  • 1.7.0
Show source code of this method: getAllowed Source Code

public string
__toString
()

Magic method to convert the object to JSON string representation.
Returns
  • string JSON representation of the actions array
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