Elgg\Groups\Tool Class Reference

Inheritance diagram for Elgg\Groups\Tool:

Public Member Functions
	__construct (public string $name, array $options=[])
	Constructor. More...
	__get ($name)
	{} More...
	__set ($name, $value)
	{} More...
	getID ()
	{Get unique item identifier within a collection. Returns string|int } More...
	getPriority ()
	{Get priority (weight) of the item within a collection. Returns int } More...
	getLabel ()
	Get tool label. More...
	getDescription ()
	Get tool description. More...
	isEnabledByDefault ()
	Is the tool enabled by default? More...
	mapMetadataName ()
	Get metadata name for DB storage. More...
	mapMetadataValue ($value=null)
	Get metadata value for DB storage. More...

Protected Attributes
array	$options

Detailed Description

Definition at line 15 of file Tool.php.

Constructor & Destructor Documentation

Elgg\Groups\Tool::__construct	(	public string	$name,
		array	$options = []
	)

Constructor.

Parameters

string	$name	Tool name
array	$options	Tool options

Definition at line 25 of file Tool.php.

Member Function Documentation

Elgg\Groups\Tool::__get

(

$name

)

{}

Definition at line 38 of file Tool.php.

Elgg\Groups\Tool::__set	(		$name,
			$value
	)

{}

Definition at line 53 of file Tool.php.

Elgg\Groups\Tool::getDescription

(

)

Get tool description.

Returns

string|null

Definition at line 90 of file Tool.php.

Elgg\Groups\Tool::getID

(

)

{Get unique item identifier within a collection.

Returns

string|int

}

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 60 of file Tool.php.

Elgg\Groups\Tool::getLabel

(

)

Get tool label.

Returns

string

Definition at line 76 of file Tool.php.

Elgg\Groups\Tool::getPriority

(

)

{Get priority (weight) of the item within a collection.

Returns

int

}

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 67 of file Tool.php.

Elgg\Groups\Tool::isEnabledByDefault

(

)

Is the tool enabled by default?

Returns

bool

Definition at line 104 of file Tool.php.

Elgg\Groups\Tool::mapMetadataName

(

)

Get metadata name for DB storage.

Returns

string

Definition at line 119 of file Tool.php.

Elgg\Groups\Tool::mapMetadataValue

(

$value = null

)

Get metadata value for DB storage.

Parameters

mixed

$value

Input value Defaults to 'default_on' property

Returns

string

Definition at line 131 of file Tool.php.

Member Data Documentation

array Elgg\Groups\Tool::$options

protected

Definition at line 17 of file Tool.php.

---

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

• engine/classes/Elgg/Groups/Tool.php