Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
FilterSetting Class Reference
Inheritance diagram for FilterSetting:
BooleanFilterSetting EmailFilterSetting SetFilterSetting

Public Member Functions

 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)
 

Detailed Description

Class that describes a configurable filter setting.

Definition at line 18 of file FilterSetting.inc.php.

Member Function Documentation

FilterSetting::FilterSetting (   $name,
  $displayName,
  $validationMessage,
  $required = FORM_VALIDATOR_REQUIRED_VALUE,
  $isLocalized = false 
)

Constructor

Parameters
$namestring
$displayNamestring
$validationMessagestring
$requiredstring
$isLocalizedboolean

Definition at line 43 of file FilterSetting.inc.php.

References setDisplayName(), setIsLocalized(), setName(), setRequired(), and setValidationMessage().

& FilterSetting::getCheck ( $form)

Get the form validation check

Returns
FormValidator

Definition at line 142 of file FilterSetting.inc.php.

References getName(), getRequired(), and getValidationMessage().

FilterSetting::getDisplayName ( )

Get the display name

Returns
string

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

FilterSetting::getIsLocalized ( )

Get the localization flag

Returns
boolean

Definition at line 130 of file FilterSetting.inc.php.

FilterSetting::getName ( )

Get the setting name

Returns
string

Definition at line 66 of file FilterSetting.inc.php.

Referenced by BooleanFilterSetting\getCheck(), EmailFilterSetting\getCheck(), SetFilterSetting\getCheck(), and getCheck().

FilterSetting::getRequired ( )

Get the required flag

Returns
string

Definition at line 114 of file FilterSetting.inc.php.

Referenced by EmailFilterSetting\getCheck(), SetFilterSetting\getCheck(), and getCheck().

FilterSetting::getValidationMessage ( )

Get the validation message

Returns
string

Definition at line 98 of file FilterSetting.inc.php.

Referenced by BooleanFilterSetting\getCheck(), EmailFilterSetting\getCheck(), SetFilterSetting\getCheck(), and getCheck().

FilterSetting::setDisplayName (   $displayName)

Set the display name

Parameters
$displayNamestring

Definition at line 74 of file FilterSetting.inc.php.

Referenced by FilterSetting().

FilterSetting::setIsLocalized (   $isLocalized)

Set the localization flag

Parameters
$isLocalizedboolean

Definition at line 122 of file FilterSetting.inc.php.

Referenced by FilterSetting().

FilterSetting::setName (   $name)

Set the setting name

Parameters
$namestring

Definition at line 58 of file FilterSetting.inc.php.

Referenced by FilterSetting().

FilterSetting::setRequired (   $required)

Set the required flag

Parameters
$requiredstring

Definition at line 106 of file FilterSetting.inc.php.

Referenced by FilterSetting().

FilterSetting::setValidationMessage (   $validationMessage)

Set the validation message

Parameters
$validationMessagestring

Definition at line 90 of file FilterSetting.inc.php.

Referenced by FilterSetting().


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