Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JAccess

Liste de tous les membres

Fonctions membres publiques statiques

static clearStatics ()
static check ($userId, $action, $asset=null)
static checkGroup ($groupId, $action, $asset=null)
static getAssetRules ($asset, $recursive=false)
static getGroupsByUser ($userId, $recursive=true)
static getUsersByGroup ($groupId, $recursive=false)
static getAuthorisedViewLevels ($userId)
static getActions ($component, $section= 'component')
static getActionsFromFile ($file, $xpath="/access/section[@name='component']/")
static getActionsFromData ($data, $xpath="/access/section[@name='component']/")

Fonctions membres protégées statiques

static getGroupPath ($groupId)

Attributs protégés statiques

static $viewLevels = array()
static $assetRules = array()
static $userGroups = array()
static $userGroupPaths = array()
static $groupsByUser = array()

Documentation des fonctions membres

static JAccess::check (   $userId,
  $action,
  $asset = null 
)
static

Method to check if a user is authorised to perform an action, optionally on an asset.

Paramètres:
integer$userIdId of the user for which to check authorisation.
string$actionThe name of the action to authorise.
mixed$assetInteger asset id or the name of the asset as a string. Defaults to the global asset node.
Renvoie:
boolean True if authorised.
Depuis:
11.1

Références $asset, $db, $userId, JFactory\getDbo(), et JTable\getInstance().

Référencé par UsersModelUser\activate(), UsersControllerUser\allowEdit(), JUser\authorise(), UsersModelUser\block(), UsersModelUser\delete(), UsersModelDebugUser\getItems(), et JUser\save().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JAccess::checkGroup (   $groupId,
  $action,
  $asset = null 
)
static

Method to check if a group is authorised to perform an action, optionally on an asset.

Paramètres:
integer$groupIdThe path to the group for which to check authorisation.
string$actionThe name of the action to authorise.
mixed$assetInteger asset id or the name of the asset as a string. Defaults to the global asset node.
Renvoie:
boolean True if authorised.
Depuis:
11.1

Références $asset, $db, JFactory\getDbo(), et JTable\getInstance().

Référencé par UsersControllerGroup\allowEdit(), UsersModelUser\batchUser(), UsersModelGroup\delete(), JFormFieldUserMessages\getGroups(), JFormFieldRules\getInput(), UsersModelDebugGroup\getItems(), JFormFieldGroupParent\getOptions(), JHtmlUser\groups(), UsersModelGroup\save(), UsersModelUser\save(), JUser\save(), et JHtmlAccess\usergroups().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JAccess::clearStatics ( )
static

Method for clearing static caches.

Renvoie:
void
Depuis:
11.3
static JAccess::getActions (   $component,
  $section = 'component' 
)
static

Method to return a list of actions for which permissions can be set given a component and section.

Paramètres:
string$componentThe component from which to retrieve the actions.
string$sectionThe name of the section within the component from which to retrieve the actions.
Renvoie:
array List of actions available for the given component and section.
Depuis:
11.1
Obsolète:
12.3 Use JAccess::getActionsFromFile or JAccess::getActionsFromData instead.

Références JLog\add(), JPATH_ADMINISTRATOR, et JLog\WARNING.

Référencé par JHtmlAccess\actions(), JoomlaupdateHelper\getActions(), SearchHelper\getActions(), ModulesHelper\getActions(), PluginsHelper\getActions(), RedirectHelper\getActions(), TemplatesHelper\getActions(), MessagesHelper\getActions(), WeblinksHelper\getActions(), MenusHelper\getActions(), NewsfeedsHelper\getActions(), LanguagesHelper\getActions(), ContactHelper\getActions(), FinderHelper\getActions(), BannersHelper\getActions(), InstallerHelper\getActions(), CategoriesHelper\getActions(), UsersHelper\getActions(), UsersHelperDebug\getDebugActions(), JFormRuleRules\getFieldActions(), et JFormFieldRules\getInput().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JAccess::getActionsFromData (   $data,
  $xpath = "/access/section[@name='component']/" 
)
static

Method to return a list of actions from a string or from an xml for which permissions can be set.

Paramètres:
string | SimpleXMLElement$dataThe XML string or an XML element.
string$xpathAn optional xpath to search for the fields.
Renvoie:
boolean|array False if case of error or the list of actions available.
Depuis:
12.1

Références $data, et JFactory\getXML().

+ Voici le graphe d'appel pour cette fonction :

static JAccess::getActionsFromFile (   $file,
  $xpath = "/access/section[@name='component']/" 
)
static

Method to return a list of actions from a file for which permissions can be set.

Paramètres:
string$fileThe path to the XML file.
string$xpathAn optional xpath to search for the fields.
Renvoie:
boolean|array False if case of error or the list of actions available.
Depuis:
12.1

Références $file, et JFactory\getXML().

+ Voici le graphe d'appel pour cette fonction :

static JAccess::getAssetRules (   $asset,
  $recursive = false 
)
static

Method to return the JAccessRules object for an asset. The returned object can optionally hold only the rules explicitly set for the asset or the summation of all inherited rules from parent assets and explicit rules.

Paramètres:
mixed$assetInteger asset id or the name of the asset as a string.
boolean$recursiveTrue to return the rules object with inherited rules.
Renvoie:
JAccessRules JAccessRules object for the asset.
Depuis:
11.1

Références $asset, $db, $query, JFactory\getDbo(), JTable\getInstance(), et JAccessRules\mergeCollection().

Référencé par JHtmlRules\assetFormWidget(), JUser\authorise(), JFormFieldRules\getInput(), et UsersModelGroup\save().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JAccess::getAuthorisedViewLevels (   $userId)
static

Method to return a list of view levels for which the user is authorised.

Paramètres:
integer$userIdId of the user for which to get the list of authorised view levels.
Renvoie:
array List of view levels for which the user is authorised.
Depuis:
11.1

Références $db, $id, $query, $userId, et elseif.

Référencé par JUser\getAuthorisedViewLevels(), modWeblinksHelper\getList(), modArticlesPopularHelper\getList(), modArticlesLatestHelper\getList(), modArticlesNewsHelper\getList(), et modArticlesCategoryHelper\getList().

+ Voici le graphe des appelants de cette fonction :

static JAccess::getGroupPath (   $groupId)
staticprotected

Gets the parent groups that a leaf group belongs to in its branch back to the root of the tree (including the leaf group id).

Paramètres:
mixed$groupIdAn integer or array of integers representing the identities to check.
Renvoie:
mixed True if allowed, false for an explicit deny, null for an implicit deny.
Depuis:
11.1

Références $db, $query, et JFactory\getDbo().

+ Voici le graphe d'appel pour cette fonction :

static JAccess::getGroupsByUser (   $userId,
  $recursive = true 
)
static

Method to return a list of user groups mapped to a user. The returned list can optionally hold only the groups explicitly mapped to the user or all groups both explicitly mapped and inherited by the user.

Paramètres:
integer$userIdId of the user for which to get the list of groups.
boolean$recursiveTrue to include inherited user groups.
Renvoie:
array List of user group ids to which the user is mapped.
Depuis:
11.1

Références $db, $query, $userId, JFactory\getDbo(), JComponentHelper\getParams(), et JArrayHelper\toInteger().

Référencé par UsersModelGroup\delete(), ContentHelper\filterText(), JComponentHelper\filterText(), JUser\getAuthorisedGroups(), ConfigModelApplication\save(), et UsersModelGroup\save().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JAccess::getUsersByGroup (   $groupId,
  $recursive = false 
)
static

Method to return a list of user Ids contained in a Group

Paramètres:
integer$groupIdThe group Id
boolean$recursiveRecursively include all child groups (optional)
Renvoie:
array
Depuis:
11.1

Références $db, $query, JFactory\getDbo(), et JArrayHelper\toInteger().

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JAccess::$assetRules = array()
staticprotected
JAccess::$groupsByUser = array()
staticprotected
JAccess::$userGroupPaths = array()
staticprotected
JAccess::$userGroups = array()
staticprotected
JAccess::$viewLevels = array()
staticprotected

La documentation de cette classe a été générée à partir du fichier suivant :