entitypicker.php File Reference

Go to the source code of this file.

Variables
	$name = elgg_extract('name', $vars, 'entities', false)
	Entity Picker. More...
	$guids = (array) elgg_extract('values', $vars, elgg_extract('value', $vars, []))
	$params = elgg_extract('options', $vars, [])
if(!empty($params))	$params ['view'] = 'json'
	$wrapper_options
	$picker
	$item_view = elgg_extract('item_view', $vars, 'input/autocomplete/item')
	$items = ''

Variable Documentation

$guids

$guids = (array) elgg_extract('values', $vars, elgg_extract('value', $vars, []))

Definition at line 22 of file entitypicker.php.

$item_view

$item_view = elgg_extract('item_view', $vars, 'input/autocomplete/item')

Definition at line 58 of file entitypicker.php.

$items

$items = ''

Definition at line 59 of file entitypicker.php.

$name

$name = elgg_extract('name', $vars, 'entities', false)

Entity Picker.

Sends an array of entity guids.

@uses $vars['values'] Array of user guids for already selected entities or null @uses $vars['limit'] Limit number of entities (default 0 = no limit) @uses $vars['name'] Name of the returned data array (default "entities") @uses $vars['handler'] Name of page handler used to power search (default "livesearch") @uses $vars['options'] Additional options to pass to the handler with the URL query If using custom options, make sure to impose a signed request gatekeeper in the resource view @uses $vars['placeholder'] Optional placeholder text for the input @uses $vars['item_view'] The item view to use for the display of the values (default 'input/autocomplete/item')

Defaults to lazy load entity lists in alphabetical order. User needs to type two characters before seeing the user popup list.

As entities are selected they move down to a "entities" box. When this happens, a hidden input is created to return the GUID in the array with the form

Definition at line 20 of file entitypicker.php.

$params [1/2]

$params = elgg_extract('options', $vars, [])

Definition at line 24 of file entitypicker.php.

$params [2/2]

if (!empty( $params)) $params[ 'view'] = 'json'

Definition at line 35 of file entitypicker.php.

$picker

foreach ( $guids as $guid) $picker

Initial value:

= elgg_format_element('input', [
    'type' => 'text',
    'class' => [
        'elgg-input-entity-picker',
    ],
    'size' => 30,
    'id' => elgg_extract('id', $vars),
    'placeholder' => elgg_extract('placeholder', $vars),
])

Definition at line 45 of file entitypicker.php.

$wrapper_options

$wrapper_options

Initial value:

= [
    'class' => elgg_extract_class($vars, ['elgg-entity-picker']),
    'data-limit' => (int) elgg_extract('limit', $vars, 0),
    'data-name' => $name,
    'data-match-on' => elgg_extract('match_on', $vars, 'entities', false),
    'data-handler' => elgg_http_add_url_query_elements(elgg_extract('handler', $vars, 'livesearch'), $params),
]

Definition at line 37 of file entitypicker.php.