Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($name, $displayName, $validationMessage, $acceptedValues, $required=FORM_VALIDATOR_REQUIRED_VALUE) | |
getAcceptedValues () | |
& | getCheck (&$form) |
getLocalizedAcceptedValues () | |
setAcceptedValues ($acceptedValues) | |
Public Member Functions inherited from FilterSetting | |
getDisplayName () | |
getIsLocalized () | |
getName () | |
getRequired () | |
getValidationMessage () | |
setDisplayName ($displayName) | |
setIsLocalized ($isLocalized) | |
setName ($name) | |
setRequired ($required) | |
setValidationMessage ($validationMessage) | |
Data Fields | |
$_acceptedValues | |
Data Fields inherited from FilterSetting | |
$_displayName | |
$_isLocalized | |
$_name | |
$_required | |
$_validationMessage | |
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.
SetFilterSetting::__construct | ( | $name, | |
$displayName, | |||
$validationMessage, | |||
$acceptedValues, | |||
$required = FORM_VALIDATOR_REQUIRED_VALUE |
|||
) |
Constructor
$name | string |
$displayName | string |
$validationMessage | string |
$acceptedValues | array |
$required | boolean |
Reimplemented from FilterSetting.
Definition at line 36 of file SetFilterSetting.inc.php.
SetFilterSetting::getAcceptedValues | ( | ) |
Get the accepted values
Definition at line 56 of file SetFilterSetting.inc.php.
References $_acceptedValues.
Referenced by getCheck(), and getLocalizedAcceptedValues().
& SetFilterSetting::getCheck | ( | & | $form | ) |
Reimplemented from FilterSetting.
Definition at line 82 of file SetFilterSetting.inc.php.
References getAcceptedValues(), FilterSetting\getName(), FilterSetting\getRequired(), and FilterSetting\getValidationMessage().
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.
Definition at line 72 of file SetFilterSetting.inc.php.
References getAcceptedValues().
SetFilterSetting::setAcceptedValues | ( | $acceptedValues | ) |
Set the accepted values
$acceptedValues | array |
Definition at line 48 of file SetFilterSetting.inc.php.
array SetFilterSetting::$_acceptedValues |
Definition at line 25 of file SetFilterSetting.inc.php.
Referenced by getAcceptedValues().