Elgg  Version master
Variables
summary.php File Reference

Go to the source code of this file.

Variables

 $relationship = elgg_extract('relationship', $vars)
 Relationship summary Passing an 'icon' with the variables will wrap the listing in an image block. More...
 
if(! $relationship instanceof ElggRelationship$entity_one = get_entity($relationship->guid_one)
 
 $entity_two = get_entity($relationship->guid_two)
 
if(empty($entity_one)||empty($entity_two)) $summary = ''
 
 $icon = elgg_view('relationship/elements/summary/icon', $vars)
 
 $params = (array) elgg_extract('image_block_vars', $vars, [])
 
 $class = elgg_extract_class($params)
 
 $params ['class'] = $class
 
 $params ['data-id'] = $relationship->id
 

Variable Documentation

◆ $class

$class = elgg_extract_class($params)

Definition at line 40 of file summary.php.

◆ $entity_one

if (! $relationship instanceof ElggRelationship) $entity_one = get_entity($relationship->guid_one)

Definition at line 22 of file summary.php.

◆ $entity_two

$entity_two = get_entity($relationship->guid_two)

Definition at line 23 of file summary.php.

◆ $icon

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

Definition at line 36 of file summary.php.

◆ $params [1/3]

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

Definition at line 39 of file summary.php.

◆ $params [2/3]

$params[ 'class'] = $class

Definition at line 42 of file summary.php.

◆ $params [3/3]

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

Definition at line 43 of file summary.php.

◆ $relationship

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

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

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

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

Definition at line 17 of file summary.php.

◆ $summary

$summary = ''

Definition at line 29 of file summary.php.