Elgg\FormsService Class Reference

WARNING: API IN FLUX. More...

Public Member Functions
	__construct (ViewsService $views, Logger $logger)
	Constructor. More...
	render ($action, $form_vars=array(), $body_vars=array())
	setFooter ($footer= '')
	Sets form footer and defers its rendering until the form view and extensions have been rendered. More...
	getFooter ()
	Returns currently set footer, or false if not in the form rendering stack. More...

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Use the elgg_* versions instead.

private

Since

2.3

Definition at line 13 of file FormsService.php.

Constructor & Destructor Documentation

Elgg\FormsService::__construct	(	ViewsService	$views,
		Logger	$logger
	)

Constructor.

Parameters

ViewsService	$views	Views service
Logger	$logger	Logger service

Definition at line 41 of file FormsService.php.

Member Function Documentation

Elgg\FormsService::getFooter

(

)

Returns currently set footer, or false if not in the form rendering stack.

Returns

string|false

Definition at line 142 of file FormsService.php.

Elgg\FormsService::render	(		$action,
			$form_vars = array(),
			$body_vars = array()
	)

Definition at line 80 of file FormsService.php.

Elgg\FormsService::setFooter

(

$footer = ''

)

Sets form footer and defers its rendering until the form view and extensions have been rendered.

Deferring footer rendering allows plugins to extend the form view while maintaining logical DOM structure. Footer will be rendered using 'elements/forms/footer' view after form body has finished rendering

Parameters

string

$footer

Footer

Returns

bool

Definition at line 126 of file FormsService.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/FormsService.php