Open Monograph Press  1.1
 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)
 

Public Attributes

 $_description
 
 $_filter
 
 $_filterGroupSymbolic
 
 $_title
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

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 236 of file FilterForm.inc.php.

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

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

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

Constructor.

Parameters
$filterFilter
$filterGroupSymbolicstring
$titlestring
$descriptionstring

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

FilterForm::getDescription ( )

Get the filter form description

Returns
string

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

& FilterForm::getFilter ( )

Get the filter

Returns
Filter

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

FilterForm::getFilterGroupSymbolic ( )

Get the filter group symbol

Returns
mixed

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

FilterForm::getTitle ( )

Get the filter form title

Returns
string

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

FilterForm::initData ( $alreadyInstantiatedFilters)

Initialize form data.

Parameters
$alreadyInstantiatedFiltersarray

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

FilterForm::readInputData ( )

Initialize form data from user submitted data.

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

Member Data Documentation

string FilterForm::$_description

a translation key for the filter form description

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

Filter FilterForm::$_filter

the filter being edited

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

string FilterForm::$_filterGroupSymbolic

the filter group to be configured in this form

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

string FilterForm::$_title

a translation key for the filter form title

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


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