Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Elgg\Forms\StickyForms Class Reference

Public Member Functions

 makeStickyForm ($form_name)
 Save form submission data (all GET and POST vars) into a session cache. More...
 
 clearStickyForm ($form_name)
 Remove form submission data from the session. More...
 
 isStickyForm ($form_name)
 Does form submission data exist for this form? More...
 
 getStickyValue ($form_name, $variable= '', $default=null, $filter_result=true)
 Get a specific value from cached form submission data. More...
 
 getStickyValues ($form_name, $filter_result=true)
 Get all submission data cached for a form. More...
 
 clearStickyValue ($form_name, $variable)
 Remove one value of form submission data from the session. More...
 

Detailed Description

Definition at line 13 of file StickyForms.php.

Member Function Documentation

Elgg\Forms\StickyForms::clearStickyForm (   $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_nameForm namespace
Returns
void

Definition at line 59 of file StickyForms.php.

Elgg\Forms\StickyForms::clearStickyValue (   $form_name,
  $variable 
)

Remove one value of form submission data from the session.

Parameters
string$form_nameThe name of the form
string$variableThe name of the variable to clear
Returns
void

Definition at line 138 of file StickyForms.php.

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

Get a specific value from cached form submission data.

Parameters
string$form_nameThe name of the form
string$variableThe name of the variable
mixed$defaultDefault value if the variable does not exist in sticky cache
boolean$filter_resultFilter for bad input if true
Returns
mixed

Definition at line 91 of file StickyForms.php.

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

Get all submission data cached for a form.

Parameters
string$form_nameThe name of the form
bool$filter_resultFilter for bad input if true
Returns
array

Definition at line 113 of file StickyForms.php.

Elgg\Forms\StickyForms::isStickyForm (   $form_name)

Does form submission data exist for this form?

Parameters
string$form_nameForm namespace
Returns
boolean

Definition at line 73 of file StickyForms.php.

Elgg\Forms\StickyForms::makeStickyForm (   $form_name)

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_nameName of the sticky form
Returns
void

Definition at line 25 of file StickyForms.php.


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