form.php File Reference

Go to the source code of this file.

Variables
	$defaults
	Create a form for data submission. More...
	$vars = array_merge($defaults, $vars)
	$ignore_empty_body = (bool) elgg_extract('ignore_empty_body', $vars, true)
	$body = elgg_extract('body', $vars)
if(! $ignore_empty_body &&empty($body))	$vars ['class'] = elgg_extract_class($vars, 'elgg-form')
if(elgg_extract('prevent_double_submit', $vars, true))	$vars ['action'] = elgg_normalize_url((string) $vars['action'])
	$vars ['method'] = strtolower((string) $vars['method'])

Variable Documentation

$body

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

Definition at line 27 of file form.php.

$defaults

$defaults

Initial value:

= [
    'method' => 'post',
    'disable_security' => false,
]

Create a form for data submission.

Use this view for forms as it provides protection against CSRF attacks.

@uses $vars['body'] The body of the form (made up of other input/xxx views and html @uses $vars['action'] The action URL of the form @uses $vars['action_name'] The name of the action (for targeting particular forms while extending) @uses $vars['method'] The submit method: post (default) or get @uses $vars['enctype'] Set to 'multipart/form-data' if uploading a file @uses $vars['disable_security'] Turn off CSRF security by setting to true @uses $vars['class'] Additional class for the form @uses $vars['ignore_empty_body'] Boolean (default: true) to determine if an empty body should still draw the form @uses $vars['prevent_double_submit'] Boolean (default: true) disables submit button when form is submitted

Definition at line 17 of file form.php.

$ignore_empty_body

$ignore_empty_body = (bool) elgg_extract('ignore_empty_body', $vars, true)

Definition at line 24 of file form.php.

$vars [1/4]

$vars = array_merge($defaults, $vars)

Definition at line 22 of file form.php.

$vars [2/4]

if (elgg_extract( 'prevent_double_submit', $vars, true)) $vars[ 'action'] = elgg_normalize_url((string) $vars['action'])

Definition at line 40 of file form.php.

$vars [3/4]

if (! $ignore_empty_body &&empty( $body)) $vars[ 'class'] = elgg_extract_class($vars, 'elgg-form')

Definition at line 34 of file form.php.

$vars [4/4]

$vars[ 'method'] = strtolower((string) $vars['method'])

Definition at line 41 of file form.php.