Elgg  Version 3.0
Namespaces | Functions | Variables
comments.php File Reference

Go to the source code of this file.

Namespaces

 Elgg\Core
 Updates the advanced settings for the primary site object.
 

Functions

 _elgg_comments_init ()
 Comments initialization function. More...
 
 elgg_comments_are_latest_first (ElggEntity $container=null)
 Are comments displayed with latest first? More...
 
 elgg_comments_per_page (ElggEntity $container=null)
 How many comments appear per page. More...
 
 _elgg_comment_redirect ($comment_guid, $fallback_guid)
 Redirect to the comment in context of the containing page. 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_add_content_owner_to_subscriptions ($hook, $type, $returnvalue, $params)
 Add the owner of the content being commented on to the subscribers. More...
 
 _elgg_comments_prepare_content_owner_notification ($hook, $type, $returnvalue, $params)
 Set the notification message for the owner of the content being commented on. More...
 
 _elgg_comments_prepare_notification ($hook, $type, $returnvalue, $params)
 Set the notification message for interested users. More...
 
 _elgg_comments_social_menu_setup (\Elgg\Hook $hook)
 Adds comment menu items to entity menu. 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_guidGUID of the comment
int$fallback_guidGUID of the containing entity
Returns
void

Definition at line 78 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$entityThe updated entity
Returns
bool

Definition at line 233 of file comments.php.

_elgg_comments_add_content_owner_to_subscriptions (   $hook,
  $type,
  $returnvalue,
  $params 
)

Add the owner of the content being commented on to the subscribers.

Parameters
string$hook'get'
string$type'subscribers'
array$returnvaluecurrent subscribers
array$paramssupplied params
Returns
void|array

Definition at line 275 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$returnCan the current user write to this container?
array$paramsArray of parameters (container, user, subtype)
Returns
void|true

Definition at line 154 of file comments.php.

_elgg_comments_init ( )

Comments initialization function.

Returns
void

Definition at line 18 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$returnCan the given user edit the given entity?
array$paramsArray of parameters (entity, user)
Returns
void|boolean Whether the given user is allowed to edit the given comment.

Definition at line 172 of file comments.php.

_elgg_comments_prepare_content_owner_notification (   $hook,
  $type,
  $returnvalue,
  $params 
)

Set the notification message for the owner of the content being commented on.

Parameters
string$hook'prepare'
string$type'notification:create:object:comment'
\Elgg\Notifications\Notification$returnvaluecurrent notification message
array$paramssupplied params
Returns
void|

Definition at line 325 of file comments.php.

_elgg_comments_prepare_notification (   $hook,
  $type,
  $returnvalue,
  $params 
)

Set the notification message for interested users.

Parameters
string$hook'prepare'
string$type'notification:create:object:comment'
\Elgg\Notifications\Notification$returnvaluecurrent notification message
array$paramssupplied params
Returns
void|

Definition at line 370 of file comments.php.

_elgg_comments_social_menu_setup ( \Elgg\Hook  $hook)

Adds comment menu items to entity menu.

Parameters
\Elgg\Hook$hookHook information
Returns
void|[]

Definition at line 415 of file comments.php.

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

Runs unit tests for .

Parameters
string$hookunit_test
string$typesystem
mixed$valueArray of tests
mixed$paramsParams
Returns
array

Definition at line 461 of file comments.php.

elgg_comments_are_latest_first ( ElggEntity  $container = null)

Are comments displayed with latest first?

Parameters
ElggEntity$containerEntity containing comments
Returns
bool False means oldest first.
Since
3.0

Definition at line 48 of file comments.php.

elgg_comments_per_page ( ElggEntity  $container = null)

How many comments appear per page.

Parameters
ElggEntity$containerEntity containing comments
Returns
int
Since
3.0

Definition at line 62 of file comments.php.

Variable Documentation

See also
::loadCore Do not do work here. Just register for events.

Definition at line 469 of file comments.php.