Référence de la classe Access

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

Description détaillée

Wrapper class for Access

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Documentation des fonctions membres

check()

check	(		$userId,
			$action,
			$asset = null
	)

Helper wrapper method for check

Paramètres

integer	$userId	Id of the user for which to check authorisation.
string	$action	The name of the action to authorise.
mixed	$asset	Integer asset id or the name of the asset as a string. Defaults to the global asset node.

Renvoie

boolean True if authorised.

Voir également

StaticAccess::check()

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Références $action, $asset, et $userId.

checkGroup()

checkGroup	(		$groupId,
			$action,
			$asset = null
	)

Helper wrapper method for checkGroup

Paramètres

integer	$groupId	The path to the group for which to check authorisation.
string	$action	The name of the action to authorise.
mixed	$asset	Integer asset id or the name of the asset as a string. Defaults to the global asset node.

Renvoie

boolean True if authorised.

Voir également

StaticAccess::checkGroup()

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Références $action, et $asset.

clearStatics()

clearStatics

(

)

Helper wrapper method for addUserToGroup

Renvoie

void

Voir également

StaticAccess::clearStatics

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

getActions()

getActions	(		$component,
			$section = 'component'
	)

Helper wrapper method for getActions

Paramètres

string	$component	The component from which to retrieve the actions.
string	$section	The 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.

Voir également

StaticAccess::getActions()

Depuis

3.4

Obsolète:

4.0 Use StaticAccess::getActionsFromFile or StaticAccess::getActionsFromData instead.

Références $component, et $section.

getActionsFromData()

getActionsFromData	(		$data,
			$xpath = '/access/section[@name=\'component\']/'
	)

Helper wrapper method for getActionsFromData

Paramètres

string | \SimpleXMLElement	$data	The XML string or an XML element.
string	$xpath	An optional xpath to search for the fields.

Renvoie

boolean|array False if case of error or the list of actions available.

Voir également

StaticAccess::getActionsFromData()

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Références $data.

getActionsFromFile()

getActionsFromFile	(		$file,
			$xpath = '/access/section[@name=\'component\']/'
	)

Helper wrapper method for getActionsFromFile

Paramètres

string	$file	The path to the XML file.
string	$xpath	An optional xpath to search for the fields.

Renvoie

boolean|array False if case of error or the list of actions available.

Voir également

StaticAccess::getActionsFromFile()

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Références $file.

getAssetRules()

getAssetRules	(		$asset,
			$recursive = false
	)

Helper wrapper method for getAssetRules

Paramètres

mixed	$asset	Integer asset id or the name of the asset as a string.
boolean	$recursive	True to return the rules object with inherited rules.

Renvoie

AccessRules AccessRules object for the asset.

Voir également

StaticAccess::getAssetRules

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Références $asset.

getAuthorisedViewLevels()

getAuthorisedViewLevels

(

$userId

)

Helper wrapper method for getAuthorisedViewLevels

Paramètres

integer

$userId

Id 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.

Voir également

StaticAccess::getAuthorisedViewLevels()

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Références $userId.

getGroupsByUser()

getGroupsByUser	(		$userId,
			$recursive = true
	)

Helper wrapper method for getGroupsByUser

Paramètres

integer	$userId	Id of the user for which to get the list of groups.
boolean	$recursive	True to include inherited user groups.

Renvoie

array List of user group ids to which the user is mapped.

Voir également

StaticAccess::getGroupsByUser()

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

Références $userId.

getUsersByGroup()

getUsersByGroup	(		$groupId,
			$recursive = false
	)

Helper wrapper method for getUsersByGroup

Paramètres

integer	$groupId	The group Id
boolean	$recursive	Recursively include all child groups (optional)

Renvoie

array

Voir également

StaticAccess::getUsersByGroup()

Depuis

3.4

Obsolète:

4.0 Use Joomla\CMS\Access\Access directly

---

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

• Wrapper/Access.php