Elgg\Forms\StickyForms Class Reference

Stick forms service. More...

Public Member Functions
	__construct (protected\ElggSession $session)
	Constructor. More...
	makeStickyForm (string $form_name, array $ignored_field_names=[])
	Save form submission data (all GET and POST vars) into a session cache. More...
	clearStickyForm (string $form_name)
	Remove form submission data from the session. More...
	isStickyForm (string $form_name)
	Does form submission data exist for this form? More...
	getStickyValue (string $form_name, string $variable= '', $default=null, bool $filter_result=true)
	Get a specific value from cached form submission data. More...
	getStickyValues (string $form_name, bool $filter_result=true)
	Get all submission data cached for a form. More...

Detailed Description

Stick forms service.

Since

1.10.0

Definition at line 11 of file StickyForms.php.

Constructor & Destructor Documentation

Elgg\Forms\StickyForms::__construct

(

protected\ElggSession

$session

)

Constructor.

Parameters

\ElggSession

$session

Session for storage

Definition at line 18 of file StickyForms.php.

Member Function Documentation

Elgg\Forms\StickyForms::clearStickyForm

(

string

$form_name

)

Remove form submission data from the session.

Call this if validation is successful in the action handler or when they sticky values have been used to repopulate the form after a validation error.

Parameters

string

$form_name

Form namespace

Returns

void

Definition at line 69 of file StickyForms.php.

Elgg\Forms\StickyForms::getStickyValue	(	string	$form_name,
		string	$variable = '',
			$default = null,
		bool	$filter_result = true
	)

Get a specific value from cached form submission data.

Parameters

string	$form_name	The name of the form
string	$variable	The name of the variable
mixed	$default	Default value if the variable does not exist in sticky cache
boolean	$filter_result	Filter for bad input if true

Returns

mixed

Definition at line 98 of file StickyForms.php.

Elgg\Forms\StickyForms::getStickyValues	(	string	$form_name,
		bool	$filter_result = true
	)

Get all submission data cached for a form.

Parameters

string	$form_name	The name of the form
bool	$filter_result	Filter for bad input if true

Returns

array

Definition at line 121 of file StickyForms.php.

Elgg\Forms\StickyForms::isStickyForm

(

string

$form_name

)

Does form submission data exist for this form?

Parameters

string

$form_name

Form namespace

Returns

bool

Definition at line 83 of file StickyForms.php.

Elgg\Forms\StickyForms::makeStickyForm	(	string	$form_name,
		array	$ignored_field_names = []
	)

Save form submission data (all GET and POST vars) into a session cache.

Call this from an action when you want all your submitted variables available if the submission fails validation and is sent back to the form

Parameters

string	$form_name	Name of the sticky form
	string[]	$ignored_field_names Field names which shouldn't be made sticky in this form

Returns

void

Definition at line 32 of file StickyForms.php.

---

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

• engine/classes/Elgg/Forms/StickyForms.php