Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SetFilterSetting Class Reference
Inheritance diagram for SetFilterSetting:
FilterSetting

Public Member Functions

 getAcceptedValues ()
 
getCheck (&$form)
 
 getLocalizedAcceptedValues ()
 
 setAcceptedValues ($acceptedValues)
 
 SetFilterSetting ($name, $displayName, $validationMessage, $acceptedValues, $required=FORM_VALIDATOR_REQUIRED_VALUE)
 
- Public Member Functions inherited from FilterSetting
 FilterSetting ($name, $displayName, $validationMessage, $required=FORM_VALIDATOR_REQUIRED_VALUE, $isLocalized=false)
 
getCheck (&$form)
 
 getDisplayName ()
 
 getIsLocalized ()
 
 getName ()
 
 getRequired ()
 
 getValidationMessage ()
 
 setDisplayName ($displayName)
 
 setIsLocalized ($isLocalized)
 
 setName ($name)
 
 setRequired ($required)
 
 setValidationMessage ($validationMessage)
 

Additional Inherited Members

- Public Attributes inherited from FilterSetting
 $_displayName
 
 $_name
 

Detailed Description

Class that describes a configurable filter setting which must be one of a given set of values.

Definition at line 20 of file SetFilterSetting.inc.php.

Member Function Documentation

SetFilterSetting::getAcceptedValues ( )

Get the accepted values

Returns
array

Definition at line 56 of file SetFilterSetting.inc.php.

Referenced by getLocalizedAcceptedValues().

& SetFilterSetting::getCheck ( $form)
See Also
FilterSetting::getCheck()

Definition at line 82 of file SetFilterSetting.inc.php.

SetFilterSetting::getLocalizedAcceptedValues ( )

Get a localized array of the accepted values with the key being the accepted value and the value being a localized display name.

NB: The standard implementation displays the accepted values.

Can be overridden by sub-classes.

Returns
array

Definition at line 72 of file SetFilterSetting.inc.php.

References getAcceptedValues(), FilterSetting\getName(), FilterSetting\getRequired(), and FilterSetting\getValidationMessage().

SetFilterSetting::setAcceptedValues (   $acceptedValues)

Set the accepted values

Parameters
$acceptedValuesarray

Definition at line 48 of file SetFilterSetting.inc.php.

SetFilterSetting::SetFilterSetting (   $name,
  $displayName,
  $validationMessage,
  $acceptedValues,
  $required = FORM_VALIDATOR_REQUIRED_VALUE 
)

Constructor

Parameters
$namestring
$displayNamestring
$validationMessagestring
$acceptedValuesarray
$requiredboolean

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


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