group.php File Reference

Go to the source code of this file.

Namespaces
	Elgg\Core
	Activate a plugin or plugins.

Functions
	get_group_entity_as_row ($guid)
	Get the group entity. More...
	add_group_tool_option ($name, $label, $default_on=true)
	Adds a group tool option. More...
	remove_group_tool_option ($name)
	Removes a group tool option based on name. More...
	_elgg_groups_container_override ($hook, $type, $result, $params)
	Allow group members to write to the group container. More...
	_elgg_groups_test ($hook, $type, $value)
	Runs unit tests for the group entities. More...
	_elgg_groups_init ()
	init the groups library @access private More...

Variables
return	function (\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks)

Function Documentation

_elgg_groups_container_override()

_elgg_groups_container_override	(		$hook,
			$type,
			$result,
			$params
	)

Allow group members to write to the group container.

Parameters

string	$hook	Hook name
string	$type	Hook type
bool	$result	The value of the hook
array	$params	Parameters related to the hook

Returns

bool @access private

Definition at line 89 of file group.php.

_elgg_groups_init()

_elgg_groups_init

(

)

init the groups library @access private

Definition at line 122 of file group.php.

_elgg_groups_test()

_elgg_groups_test	(		$hook,
			$type,
			$value
	)

Runs unit tests for the group entities.

Parameters

string	$hook	Hook name
string	$type	Hook type
array	$value	Array of unit test locations

Returns

array @access private

Definition at line 112 of file group.php.

add_group_tool_option()

add_group_tool_option	(		$name,
			$label,
			$default_on = true
	)

Adds a group tool option.

See also

remove_group_tool_option().

Parameters

string	$name	Name of the group tool option
string	$label	Used for the group edit form
bool	$default_on	True if this option should be active by default

Returns

void

Since

1.5.0

Definition at line 39 of file group.php.

get_group_entity_as_row()

get_group_entity_as_row

(

$guid

)

Get the group entity.

Parameters

int

$guid

GUID for a group

Returns

array|false @access private

Definition at line 19 of file group.php.

remove_group_tool_option()

remove_group_tool_option

(

$name

)

Removes a group tool option based on name.

See also

add_group_tool_option()

Parameters

string

$name

Name of the group tool option

Returns

void

Since

1.7.5

Definition at line 65 of file group.php.

Variable Documentation

function

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks)	(	\Elgg\EventsService	$events,
		\Elgg\HooksRegistrationService	$hooks
	)

Definition at line 127 of file group.php.