message.php File Reference

Go to the source code of this file.

Variables
	$type = (string) elgg_extract('type', $vars, false)
	Elgg message element (all unsupported vars will be passed as attributes to the container) More...
	$title = elgg_extract('title', $vars)
	$menu = elgg_extract('menu', $vars)
	$body = elgg_extract('body', $vars, '')
	$link = elgg_extract('link', $vars)
if(empty($title) &&empty($body)) if(!empty($link))	$attrs
if(!empty($type))	$default_icons
	$default_icon_name = elgg_extract($type, $default_icons)
	$icon_name = elgg_extract('icon_name', $vars, $default_icon_name)
if(is_null($title) &&!empty($type) &&elgg_language_key_exists("messages:title:{$type}"))	$header = ''
if(!empty($title) &&!empty($icon_name)) if(!empty($title)) if(!empty($menu)) if(!empty($header)) if(!empty($body))	$contents = elgg_format_element('div', ['class' => 'elgg-inner'], $header . $body)

Variable Documentation

$attrs

$attrs

Initial value:

= [
    'class' => elgg_extract_class($vars, 'elgg-message'),
]

Definition at line 28 of file message.php.

$body

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

Definition at line 17 of file message.php.

$contents

if (!empty( $title) &&!empty( $icon_name)) if (!empty( $title)) if (!empty( $menu)) if (!empty( $header)) if (!empty( $body)) $contents = elgg_format_element('div', ['class' => 'elgg-inner'], $header . $body)

Examples

/root/Elgg/engine/lib/views.php.

Definition at line 73 of file message.php.

$default_icon_name

$default_icon_name = elgg_extract($type, $default_icons)

Definition at line 45 of file message.php.

$default_icons

if (!empty( $type)) $default_icons

Initial value:

= [
    'error' => 'exclamation-circle',
    'help' => 'question-circle',
    'notice' => 'info-circle',
    'info' => 'info-circle',
    'warning' => 'exclamation-triangle',
    'success' => 'check-circle',
]

Definition at line 36 of file message.php.

$header

if (is_null( $title) &&!empty( $type) &&elgg_language_key_exists("messages:title:{$type}")) $header = ''

Definition at line 52 of file message.php.

$icon_name

$icon_name = elgg_extract('icon_name', $vars, $default_icon_name)

Definition at line 46 of file message.php.

$link

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

Definition at line 18 of file message.php.

$menu

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

Definition at line 16 of file message.php.

$title

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

Definition at line 15 of file message.php.

$type

$type = (string) elgg_extract('type', $vars, false)

Elgg message element (all unsupported vars will be passed as attributes to the container)

@uses $vars['type'] The type of message (error, success, warning, help, notice, info) @uses $vars['title'] Optional title text, will default to the type @uses $vars['icon_name'] Optional iconname to override default icon @uses $vars['menu'] Optional menu to show in the title bar @uses $vars['body'] Content of the body @uses $vars['link'] Optional call to action text added to the body @uses $vars['class'] Optional additional class for message

Definition at line 14 of file message.php.