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

Public Attributes

 $_displayName
 
 $_name
 

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 58 of file FilterSetting.inc.php.

& FilterSetting::getCheck ( $form)

Get the form validation check

Returns
FormValidator

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

FilterSetting::getDisplayName ( )

Get the display name

Returns
string

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

FilterSetting::getIsLocalized ( )

Get the localization flag

Returns
boolean

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

FilterSetting::getName ( )

Get the setting name

Returns
string

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

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

FilterSetting::getRequired ( )

Get the required flag

Returns
string

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

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

FilterSetting::getValidationMessage ( )

Get the validation message

Returns
string

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

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

FilterSetting::setDisplayName (   $displayName)

Set the display name

Parameters
$displayNamestring

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

FilterSetting::setIsLocalized (   $isLocalized)

Set the localization flag

Parameters
$isLocalizedboolean

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

References getRequired().

FilterSetting::setName (   $name)

Set the setting name

Parameters
$namestring

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

FilterSetting::setRequired (   $required)

Set the required flag

Parameters
$requiredstring

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

FilterSetting::setValidationMessage (   $validationMessage)

Set the validation message

Parameters
$validationMessagestring

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

Member Data Documentation

string FilterSetting::$_displayName

the supported transformation

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

string FilterSetting::$_name

the (internal) name of the setting

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


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