Elgg  Version master
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Elgg\Groups\Tool Class Reference
Inheritance diagram for Elgg\Groups\Tool:
Elgg\Collections\CollectionItemInterface

Public Member Functions

 __construct ($name, array $options=[])
 Constructor. More...
 
 __get ($name)
 {} More...
 
 __set ($name, $value)
 
 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...
 

Public Attributes

 $name
 

Protected Attributes

 $options
 

Detailed Description

Definition at line 15 of file Tool.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
string$nameTool name
array$optionsTool options

Definition at line 33 of file Tool.php.

Member Function Documentation

Elgg\Groups\Tool::__get (   $name)

{}

Definition at line 48 of file Tool.php.

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

Definition at line 63 of file Tool.php.

Elgg\Groups\Tool::getDescription ( )

Get tool description.

Returns
string|null

Definition at line 100 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 70 of file Tool.php.

Elgg\Groups\Tool::getLabel ( )

Get tool label.

Returns
string

Definition at line 86 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 77 of file Tool.php.

Elgg\Groups\Tool::isEnabledByDefault ( )

Is the tool enabled by default?

Returns
bool

Definition at line 113 of file Tool.php.

Elgg\Groups\Tool::mapMetadataName ( )

Get metadata name for DB storage.

Returns
string

Definition at line 127 of file Tool.php.

Elgg\Groups\Tool::mapMetadataValue (   $value = null)

Get metadata value for DB storage.

Parameters
mixed$valueInput value Defaults to 'default_on' property
Returns
string

Definition at line 139 of file Tool.php.

Member Data Documentation

Elgg\Groups\Tool::$name

Definition at line 20 of file Tool.php.

Elgg\Groups\Tool::$options
protected

Definition at line 25 of file Tool.php.


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