comments.php File Reference

Go to the source code of this file.

Namespaces
	Elgg\Core
	Activate a plugin or plugins.

Functions
	_elgg_comments_init ()
	Comments initialization function. More...
	_elgg_comments_page_handler ($segments)
	Page handler for generic comments manipulation. More...
	_elgg_comment_redirect ($comment_guid, $fallback_guid)
	Redirect to the comment in context of the containing page. More...
	_elgg_comment_setup_entity_menu ($hook, $type, $return, $params)
	Setup the menu shown with a comment. More...
	_elgg_comment_url_handler ($hook, $type, $return, $params)
	Format and return the URL for a comment. More...
	_elgg_comments_container_permissions_override ($hook, $type, $return, $params)
	Allow users to comment on entities not owned by them. More...
	_elgg_comments_permissions_override ($hook, $type, $return, $params)
	By default, only authors can edit their comments. More...
	_elgg_comments_access_sync ($event, $type, $entity)
	Update comment access to match that of the container. More...
	_elgg_comments_test ($hook, $type, $value, $params)
	Runs unit tests for . More...

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

Function Documentation

_elgg_comment_redirect	(		$comment_guid,
			$fallback_guid
	)

Redirect to the comment in context of the containing page.

Parameters

int	$comment_guid	GUID of the comment
int	$fallback_guid	GUID of the containing entity

Returns

void private

Definition at line 71 of file comments.php.

_elgg_comment_setup_entity_menu	(		$hook,
			$type,
			$return,
			$params
	)

Setup the menu shown with a comment.

Parameters

string	$hook	'register'
string	$type	'menu:entity'
	\ElggMenuItem[]	$return Array of objects
array	$params	Array of view vars

Returns

array private

Definition at line 133 of file comments.php.

_elgg_comment_url_handler	(		$hook,
			$type,
			$return,
			$params
	)

Format and return the URL for a comment.

This is the container's URL because comments don't have their own page.

Parameters

string	$hook	'entity:url'
string	$type	'object'
string	$return	URL for entity
array	$params	Array with the elgg entity passed in as 'entity'

Returns

string private

Definition at line 166 of file comments.php.

_elgg_comments_access_sync	(		$event,
			$type,
			$entity
	)

Update comment access to match that of the container.

Parameters

string	$event	'update:after'
string	$type	'all'
ElggEntity	$entity	The updated entity

Returns

bool

private

Definition at line 284 of file comments.php.

_elgg_comments_container_permissions_override	(		$hook,
			$type,
			$return,
			$params
	)

Allow users to comment on entities not owned by them.

Object being commented on is used as the container of the comment so permission check must be overridden if user isn't the owner of the object.

Parameters

string	$hook	'container_permissions_check'
string	$type	'object'
boolean	$return	Can the current user write to this container?
array	$params	Array of parameters (container, user, subtype)

Returns

array private

Definition at line 200 of file comments.php.

_elgg_comments_init

(

)

Comments initialization function.

Returns

void private

Definition at line 16 of file comments.php.

_elgg_comments_page_handler

(

$segments

)

Page handler for generic comments manipulation.

Parameters

array

$segments

Returns

bool private

Definition at line 40 of file comments.php.

_elgg_comments_permissions_override	(		$hook,
			$type,
			$return,
			$params
	)

By default, only authors can edit their comments.

Parameters

string	$hook	'permissions_check'
string	$type	'object'
boolean	$return	Can the given user edit the given entity?
array	$params	Array of parameters (entity, user)

Returns

boolean Whether the given user is allowed to edit the given comment. private

Definition at line 221 of file comments.php.

_elgg_comments_test	(		$hook,
			$type,
			$value,
			$params
	)

Runs unit tests for .

Parameters

string	$hook	unit_test
string	$type	system
mixed	$value	Array of tests
mixed	$params	Params

Returns

array private

Definition at line 325 of file comments.php.

Variable Documentation

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

Definition at line 331 of file comments.php.