Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Static Protected Member Functions
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 ()
 
- Public Member Functions inherited from ComponentForReportForm
 getRowKey ()
 
 attributeNames ()
 
 __set ($name, $value)
 
 rules ()
 
 attributeLabels ()
 
 __construct ($moduleClassName, $modelClassName, $reportType, $rowKey=0)
 
 getModelClassName ()
 
 getModuleClassName ()
 
 getReportType ()
 
 getAttributeIndexOrDerivedType ()
 
 getAttributeAndRelationData ()
 
 hasRelatedData ()
 
 getResolvedAttribute ()
 
 getResolvedAttributeModuleClassName ()
 
 getResolvedAttributeModelClassName ()
 
 getResolvedAttributeRealAttributeName ()
 
 getPenultimateModelClassName ()
 
 getPenultimateRelation ()
 
 getDisplayLabel ()
 
 makeResolvedAttributeModelRelationsAndAttributesToReportAdapter ()
 
 getDisplayElementType ()
 
 isATypeOfCurrencyValue ()
 

Static Public Member Functions

static getType ()
 
- Static Public Member Functions inherited from ComponentForReportForm
static getType ()
 

Data Fields

 $availableAtRunTime = false
 
 $currencyIdForValue
 
 $value
 
 $secondValue
 
 $stringifiedModelForValue
 
 $valueType
 
- Data Fields inherited from ComponentForReportForm
const DISPLAY_LABEL_RELATION_DIVIDER = '>>'
 
const TYPE_FILTERS = 'Filters'
 
const TYPE_DISPLAY_ATTRIBUTES = 'DisplayAttributes'
 
const TYPE_ORDER_BYS = 'OrderBys'
 
const TYPE_GROUP_BYS = 'GroupBys'
 
const TYPE_DRILL_DOWN_DISPLAY_ATTRIBUTES = 'DrillDownDisplayAttributes'
 

Protected Member Functions

 getAvailableOperatorsType ()
 
- Protected Member Functions inherited from ComponentForReportForm
 resolveAttributeOrRelationAndAttributeDataByIndexType ($indexType)
 
 resolveAttributeFromData (Array $attributeAndRelationData)
 
 resolveAttributeModuleClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName)
 
 resolveAttributeModelClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName)
 
 resolvePenultimateModelClassNameFromData (Array $attributeAndRelationData, $modelClassName)
 
 resolvePenultimateRelationFromData (Array $attributeAndRelationData)
 

Static Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from ComponentForReportForm
 $moduleClassName
 
 $modelClassName
 
 $attributeAndRelationData
 
 $reportType
 

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

Definition at line 92 of file FilterForReportForm.php.

attributeNames ( )
Returns
array

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()

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

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
NotSupportedExceptionif the attributeIndexOrDerivedType has not been populated yet

Definition at line 273 of file FilterForReportForm.php.

getValueElementType ( )
Returns
null|string
Exceptions
NotSupportedExceptionif the attributeIndexOrDerivedType has not been populated yet

Definition at line 289 of file FilterForReportForm.php.

getCustomFieldDataAndLabels ( )
Returns
array
Exceptions
NotSupportedExceptionif 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
NotSupportedExceptionif the attributeIndexOrDerivedType has not been populated yet

Definition at line 324 of file FilterForReportForm.php.

static getValueTypesWhereValueIsRequired ( )
staticprotected
Returns
array

Definition at line 343 of file FilterForReportForm.php.

static getValueTypesWhereSecondValueIsRequired ( )
staticprotected
Returns
array

Definition at line 354 of file FilterForReportForm.php.

static getOperatorsWhereValueIsRequired ( )
staticprotected
Returns
array

Definition at line 362 of file FilterForReportForm.php.

static getOperatorsWhereSecondValueIsRequired ( )
staticprotected
Returns
array

Definition at line 370 of file FilterForReportForm.php.


The documentation for this class was generated from the following file:
Generated on Mon Jul 6 2020 07:10:50
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.