FilterForReportForm Class Reference

Inheritance diagram for FilterForReportForm:
ComponentForReportForm OperatorInterface ConfigurableMetadataModel RowKeyInterface

Public Member Functions

 attributeNames ()
 __set ($name, $value)
 setOperator ($value)
 getOperator ()
 rules ()
 validateOperator ()
 validateValue ()
 validateSecondValue ()
 validateValueType ()
 hasAvailableOperatorsType ()
 getOperatorValuesAndLabels ()
 getValueElementType ()
 getCustomFieldDataAndLabels ()
 attributeLabels ()

Static Public Member Functions

static getType ()

Data Fields

 $availableAtRunTime = false
 $currencyIdForValue
 $value
 $secondValue
 $stringifiedModelForValue
 $valueType

Protected Member Functions

 getAvailableOperatorsType ()

Static Protected Member Functions

static getValueTypesWhereValueIsRequired ()
static getValueTypesWhereSecondValueIsRequired ()
static getOperatorsWhereValueIsRequired ()
static getOperatorsWhereSecondValueIsRequired ()

Detailed Description

Component form for filter definitions

Definition at line 40 of file FilterForReportForm.php.


Member Function Documentation

static getType (  )  [static]
Returns:
string component type

Reimplemented from ComponentForReportForm.

Definition at line 92 of file FilterForReportForm.php.

attributeNames (  ) 
Returns:
array

Reimplemented from ComponentForReportForm.

Definition at line 100 of file FilterForReportForm.php.

__set ( name,
value 
)

Reset availableOperatorsType cache whenever a new attribute is set (non-PHPdoc)

See also:
ComponentForReportForm::__set()

Reimplemented from ComponentForReportForm.

Definition at line 110 of file FilterForReportForm.php.

setOperator ( value  ) 
Parameters:
$value 
Exceptions:
NotSupportedException 

Definition at line 123 of file FilterForReportForm.php.

getOperator (  ) 
Returns:
string

Implements OperatorInterface.

Definition at line 135 of file FilterForReportForm.php.

rules (  ) 
Returns:
array

Reimplemented from ComponentForReportForm.

Definition at line 143 of file FilterForReportForm.php.

validateOperator (  ) 
Returns:
bool

Definition at line 163 of file FilterForReportForm.php.

validateValue (  ) 
Returns:
bool

Definition at line 175 of file FilterForReportForm.php.

validateSecondValue (  ) 

When the operator type is Between the secondValue is required. Also if the valueType, which is used by date/datetime attributes is set to Between than the secondValue is required.

Returns:
bool
Exceptions:
NotSupportedException 

Definition at line 223 of file FilterForReportForm.php.

validateValueType (  ) 
Returns:
bool

Definition at line 246 of file FilterForReportForm.php.

hasAvailableOperatorsType (  ) 
Returns:
bool

Definition at line 260 of file FilterForReportForm.php.

getOperatorValuesAndLabels (  ) 
Returns:
array
Exceptions:
NotSupportedException if the attributeIndexOrDerivedType has not been populated yet

Definition at line 273 of file FilterForReportForm.php.

getValueElementType (  ) 
Returns:
null|string
Exceptions:
NotSupportedException if the attributeIndexOrDerivedType has not been populated yet

Definition at line 289 of file FilterForReportForm.php.

getCustomFieldDataAndLabels (  ) 
Returns:
array
Exceptions:
NotSupportedException if the resolved attribute is invalid and not on the resolved model

Definition at line 303 of file FilterForReportForm.php.

getAvailableOperatorsType (  )  [protected]
Returns:
array|null|string
Exceptions:
NotSupportedException if the attributeIndexOrDerivedType has not been populated yet

Definition at line 324 of file FilterForReportForm.php.

static getValueTypesWhereValueIsRequired (  )  [static, protected]
Returns:
array

Definition at line 343 of file FilterForReportForm.php.

static getValueTypesWhereSecondValueIsRequired (  )  [static, protected]
Returns:
array

Definition at line 354 of file FilterForReportForm.php.

static getOperatorsWhereValueIsRequired (  )  [static, protected]
Returns:
array

Definition at line 362 of file FilterForReportForm.php.

static getOperatorsWhereSecondValueIsRequired (  )  [static, protected]
Returns:
array

Definition at line 370 of file FilterForReportForm.php.

attributeLabels (  ) 
Returns:
array

Reimplemented from ComponentForReportForm.

Definition at line 423 of file FilterForReportForm.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Dec 9 07:10:53 2019