[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Access/ -> Rule.php (summary)

Joomla! Content Management System

Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 164 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Rule:: (6 methods):
  __construct()
  getData()
  mergeIdentities()
  mergeIdentity()
  allow()
  __toString()


Class: Rule  - X-Ref

Rule class.

__construct($identities)   X-Ref
Constructor.

The input array must be in the form: array(-42 => true, 3 => true, 4 => false)
or an equivalent JSON encoded string.

param: mixed  $identities  A JSON format string (probably from the database) or a named array.

getData()   X-Ref
Get the data for the action.

return: array  A named array

mergeIdentities($identities)   X-Ref
Merges the identities

param: mixed  $identities  An integer or array of integers representing the identities to check.
return: void

mergeIdentity($identity, $allow)   X-Ref
Merges the values for an identity.

param: integer  $identity  The identity.
param: boolean  $allow     The value for the identity (true == allow, false == deny).
return: void

allow($identities)   X-Ref
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.

param: mixed  $identities  An integer or array of integers representing the identities to check.
return: mixed  True if allowed, false for an explicit deny, null for an implicit deny.

__toString()   X-Ref
Convert this object into a JSON encoded string.

return: string  JSON encoded string



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer