Elgg\EntityCapabilitiesService Class Reference

Entity capabilities service. More...

Public Member Functions
	hasCapability (string $type, string $subtype, string $capability, bool $default=false)
	Checks if a capability is enabled for a specified type/subtype. More...
	setCapability (string $type, string $subtype, string $capability, bool $value)
	Sets the capability value for a specified type/subtype. More...
	getTypesWithCapability (string $capability)
	Returns an array of type/subtypes with the requested capability enabled. More...

Protected Attributes
array	$entities = []

Detailed Description

Entity capabilities service.

Definition at line 11 of file EntityCapabilitiesService.php.

Member Function Documentation

getTypesWithCapability()

Elgg\EntityCapabilitiesService::getTypesWithCapability

(

string

$capability

)

Returns an array of type/subtypes with the requested capability enabled.

Parameters

string

$capability

name of the capability to set

Returns

array

Definition at line 63 of file EntityCapabilitiesService.php.

hasCapability()

Elgg\EntityCapabilitiesService::hasCapability	(	string	$type,
		string	$subtype,
		string	$capability,
		bool	$default = false
	)

Checks if a capability is enabled for a specified type/subtype.

Parameters

string	$type	type of the entity
string	$subtype	subtype of the entity
string	$capability	name of the capability to check
bool	$default	default value to return if it is not explicitly set

Returns

bool

Definition at line 30 of file EntityCapabilitiesService.php.

setCapability()

Elgg\EntityCapabilitiesService::setCapability	(	string	$type,
		string	$subtype,
		string	$capability,
		bool	$value
	)

Sets the capability value for a specified type/subtype.

Parameters

string	$type	type of the entity
string	$subtype	subtype of the entity
string	$capability	name of the capability to set
bool	$value	value to set

Returns

void

Definition at line 44 of file EntityCapabilitiesService.php.

Member Data Documentation

$entities

array Elgg\EntityCapabilitiesService::$entities = []

protected

Definition at line 18 of file EntityCapabilitiesService.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/EntityCapabilitiesService.php