summary.php File Reference

Go to the source code of this file.

Variables
	$annotation = elgg_extract('annotation', $vars)
	Annotation summary Passing an 'icon' with the variables will wrap the listing in an image block. More...
if(!$annotation instanceof ElggAnnotation)	$entity = $annotation->getEntity()
if(!$entity instanceof ElggEntity)	$owner = $annotation->getOwnerEntity()
if(!$owner instanceof ElggEntity)	$summary = ''
	$icon = elgg_view('annotation/elements/summary/icon', $vars)
	$params = (array) elgg_extract('image_block_vars', $vars, [])
	$class = elgg_extract_class($params)
	$params ['class'] = $class
	$params ['data-id'] = $annotation->id

Variable Documentation

$annotation = elgg_extract('annotation', $vars)

Annotation summary Passing an 'icon' with the variables will wrap the listing in an image block.

In that case, variables not listed in (e.g. image_alt) will be passed to the image block.

$vars['annotation'] ElggAnnotation $vars['title'] Title link (optional) false = no title, '' = default $vars['metadata'] HTML for annotation menu and metadata (optional) $vars['subtitle'] HTML for the subtitle (optional) $vars['content'] HTML for the annotation content (optional) $vars['icon'] Object icon. If set, the listing will be wrapped with an image block $vars['class'] Class selector for the image block $vars['image_block_vars'] Attributes for the image block wrapper

Definition at line 17 of file summary.php.

$class = elgg_extract_class($params)

Definition at line 44 of file summary.php.

if (!$annotation instanceof ElggAnnotation) $entity = $annotation->getEntity()

Definition at line 22 of file summary.php.

$icon = elgg_view('annotation/elements/summary/icon', $vars)

Definition at line 40 of file summary.php.

if (!$entity instanceof ElggEntity) $owner = $annotation->getOwnerEntity()

Definition at line 27 of file summary.php.

$params = (array) elgg_extract('image_block_vars', $vars, [])

Definition at line 43 of file summary.php.

$params['class'] = $class

Definition at line 46 of file summary.php.

$params['data-id'] = $annotation->id

Definition at line 47 of file summary.php.

$summary = ''

Definition at line 33 of file summary.php.