SearchFormAttributeMappingRules Class Reference

Inheritance diagram for SearchFormAttributeMappingRules:
MixedDateTypesSearchFormAttributeMappingRules OwnedItemsOnlySearchFormAttributeMappingRules MixedDateTimeTypesSearchFormAttributeMappingRules MixedDateTypesTriggerForWorkflowFormAttributeMappingRules

Static Public Member Functions

static resolveValueDataIntoUsableValue ($value)
static resolveAttributesAndRelations ($attributeName, &$attributeAndRelations, $value)
static getIgnoredSavableMetadataRules ()

Detailed Description

Base class for defining rules for search form attributes. Some search form attributes require dynamically determining operatorTypes and values based on either the value specified in the user interface in the search form or some other means. An example is the

See also:
OwnedItemsOnlySearchFormAttributeMappingRules which will dynamically use the current user's userModel id to define the value to filter on.

Definition at line 43 of file SearchFormAttributeMappingRules.php.


Member Function Documentation

static resolveValueDataIntoUsableValue ( value  )  [static]

Override if any massaging is needed on the value.

Parameters:
mixed $value

Reimplemented in MixedDateTypesSearchFormAttributeMappingRules, and OwnedItemsOnlySearchFormAttributeMappingRules.

Definition at line 49 of file SearchFormAttributeMappingRules.php.

static resolveAttributesAndRelations ( attributeName,
&$  attributeAndRelations,
value 
) [static]

Implement if the attributeAndRelations array needs to be dynamically resolved to a new structure at run-time. This could be required if the structure changes depending on the value for example.

Parameters:
string $attributeName
array $attributeAndRelations
mixed $value

Reimplemented in MixedDateTimeTypesSearchFormAttributeMappingRules, and MixedDateTypesSearchFormAttributeMappingRules.

Definition at line 61 of file SearchFormAttributeMappingRules.php.

static getIgnoredSavableMetadataRules (  )  [static]

Override if any rules need to be ignored for attributes using this rule.

Parameters:
mixed $value

Reimplemented in OwnedItemsOnlySearchFormAttributeMappingRules.

Definition at line 70 of file SearchFormAttributeMappingRules.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Aug 17 07:10:30 2017