Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
FilterForm Class Reference
Inheritance diagram for FilterForm:
Form

Public Member Functions

 execute (&$request)
 
 fetch (&$request)
 
 FilterForm (&$filter, $title, $description, $filterGroupSymbolic)
 
 getDescription ()
 
getFilter ()
 
 getFilterGroupSymbolic ()
 
 getTitle ()
 
 initData (&$alreadyInstantiatedFilters)
 
 readInputData ()
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch (&$request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Additional Inherited Members

- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 

Detailed Description

Form for adding/editing a filter. New filter instances are based on filter templates.

Definition at line 19 of file FilterForm.inc.php.

Member Function Documentation

FilterForm::execute ( $request)

Save filter

Parameters
$requestPKPRequest

Definition at line 224 of file FilterForm.inc.php.

References DAORegistry\getDAO(), Form\getData(), and getFilter().

FilterForm::fetch ( $request)
See Also
Form::fetch()

Definition at line 182 of file FilterForm.inc.php.

References getDescription(), getFilter(), getTitle(), and String\regexp_replace().

FilterForm::FilterForm ( $filter,
  $title,
  $description,
  $filterGroupSymbolic 
)

Constructor.

Parameters
$filterFilter
$filterGroupSymbolicstring
$titlestring
$descriptionstring

Definition at line 39 of file FilterForm.inc.php.

References Form\addCheck(), Form\readUserVars(), and Form\setData().

FilterForm::getDescription ( )

Get the filter form description

Returns
string

Definition at line 93 of file FilterForm.inc.php.

Referenced by fetch().

& FilterForm::getFilter ( )

Get the filter

Returns
Filter

Definition at line 77 of file FilterForm.inc.php.

Referenced by execute(), fetch(), initData(), and readInputData().

FilterForm::getFilterGroupSymbolic ( )

Get the filter group symbol

Returns
mixed

Definition at line 101 of file FilterForm.inc.php.

Referenced by initData().

FilterForm::getTitle ( )

Get the filter form title

Returns
string

Definition at line 85 of file FilterForm.inc.php.

Referenced by fetch().

FilterForm::initData ( $alreadyInstantiatedFilters)

Initialize form data.

Parameters
$alreadyInstantiatedFiltersarray

Definition at line 112 of file FilterForm.inc.php.

References DAORegistry\getDAO(), getFilter(), getFilterGroupSymbolic(), Form\readUserVars(), and Form\setData().

FilterForm::readInputData ( )

Initialize form data from user submitted data.

Definition at line 165 of file FilterForm.inc.php.

References Form\getData(), getFilter(), Form\readUserVars(), and Form\setData().


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