SearchForm Class Reference

Inheritance diagram for SearchForm:
ModelForm ContactStateSearchForm CurrenciesSearchForm DynamicSearchForm GroupsSearchForm MarketingListMembersSearchForm RolesSearchForm WorkflownQueuesSearchForm AAASearchFormTestModel ApiTestModelItem2SearchForm ApiTestModelItemSearchForm ASearchFormTestModel CCCSearchFormTestModel IIISearchFormTestModel MixedRelationsModelSearchFormTestModel SavedDynamicSearchForm ByTimeWorkflowInQueuesSearchForm WorkflowMessageInQueuesSearchForm

Public Member Functions

 __construct (RedBeanModel $model)
 setAnyMixedAttributesScope ($anyMixedAttributesScope)
 getAnyMixedAttributesScope ()
 rules ()
 attributeLabels ()
 __set ($name, $value)
 __get ($name)
 isAttributeOnForm ($attributeName)
 getSearchableAttributes ()
 getMetadata ()
 isAttribute ($attributeName)
 isAttributeRequired ($attribute)
 attributeNames ()
 setAttributes ($values, $safeOnly=true)
 getAttributesMappedToRealAttributesMetadata ()
 resolveMixedSearchAttributeMappedToRealAttributesMetadata (&$realAttributesMetadata)
 getGlobalSearchAttributeNamesAndLabelsAndAll ()
 setListAttributesSelector (ListAttributesSelector $listAttributesSelector)
 getListAttributesSelector ()
 setKanbanBoard (KanbanBoard $kanbanBoard)
 getKanbanBoard ()

Static Public Member Functions

static isAttributeSearchable ($attributeName)
static getNonSearchableAttributes ()
static isRelation ($attributeName)
static getRelationModelClassName ($relationName)
static getSearchFormAttributeMappingRulesTypeByAttribute ($attributeName)

Data Fields

const ANY_MIXED_ATTRIBUTES_SCOPE_NAME = 'anyMixedAttributesScope'
const SELECTED_LIST_ATTRIBUTES = 'selectedListAttributes'
 $anyMixedAttributes
 $filterByStarred

Protected Member Functions

 getModelModuleClassName ()
 addAttributeNamesThatCanBeSplitUsingDelimiter ($value)
 resolveMixedSearchAttributeElementForMetadata (&$metadata)

Static Protected Member Functions

static doesNameResolveNameForDelimiterSplit ($name)
static getDynamicAttributeTypes ()
static getDynamicAttributeToElementTypes ()
static shouldIgnoreRequiredValidator ()
static getSearchFormAttributeMappingRulesTypes ()

Detailed Description

Base Class for all searchForms that are module specific. This for is to be used if your module form needs to be adapted in the SearchDataProviderMetadataAdapter

Definition at line 41 of file SearchForm.php.


Member Function Documentation

__set ( name,
value 
)

(non-PHPdoc)

See also:
ModelForm::__set()

Reimplemented from ModelForm.

Definition at line 158 of file SearchForm.php.

__get ( name  ) 

(non-PHPdoc)

See also:
ModelForm::__get()

Reimplemented from ModelForm.

Definition at line 171 of file SearchForm.php.

isAttributeOnForm ( attributeName  ) 
Returns:
true if the provided attributeName is in fact an attribute on this form and not the $this->model.

Definition at line 183 of file SearchForm.php.

static isAttributeSearchable ( attributeName  )  [static]
Returns:
true if the provided attribute is searchable and not just a special form property.

Definition at line 199 of file SearchForm.php.

getMetadata (  ) 

(non-PHPdoc)

See also:
ModelForm::getMetadata()

Reimplemented from ModelForm.

Definition at line 234 of file SearchForm.php.

static isRelation ( attributeName  )  [static]

(non-PHPdoc)

See also:
ModelForm::isRelation()

Reimplemented from ModelForm.

Definition at line 261 of file SearchForm.php.

static getRelationModelClassName ( relationName  )  [static]

(non-PHPdoc)

See also:
ModelForm::getRelationModelClassName()

Reimplemented from ModelForm.

Definition at line 274 of file SearchForm.php.

isAttribute ( attributeName  ) 

(non-PHPdoc)

See also:
ModelForm::isAttribute()

Reimplemented from ModelForm.

Definition at line 287 of file SearchForm.php.

isAttributeRequired ( attribute  ) 

(non-PHPdoc)

See also:
ModelForm::isAttributeRequired()

Reimplemented from ModelForm.

Definition at line 302 of file SearchForm.php.

attributeNames (  ) 

(non-PHPdoc)

See also:
ModelForm::attributeNames()

Reimplemented from ModelForm.

Definition at line 315 of file SearchForm.php.

setAttributes ( values,
safeOnly = true 
)

(non-PHPdoc)

See also:
ModelForm::setAttributes()

Reimplemented from ModelForm.

Definition at line 325 of file SearchForm.php.

static doesNameResolveNameForDelimiterSplit ( name  )  [static, protected]

Checks if the supplied name is a normal attribute, or a dynamic attribute which utilizes a delimiter in the string to define two distinct values. If the delimiter is present, but the format is invalid an exception is thrown, otherwise it returns true. If there is no delimiter present then it returns false.

Parameters:
string $name
Exceptions:
NotSupportedException 
Returns:
true/false

Definition at line 366 of file SearchForm.php.

static getDynamicAttributeTypes (  )  [static, protected]
Returns:
array of available dyanamic attribute types. Whatever is used in the name with a delimiter for the second part, example: test__Date, must match a value in this array.

Definition at line 389 of file SearchForm.php.

static getDynamicAttributeToElementTypes (  )  [static, protected]
Returns:
array of dynamic attribute types as the indexes and their corresponding mapping rules as the values.

Definition at line 397 of file SearchForm.php.

getAttributesMappedToRealAttributesMetadata (  ) 
static shouldIgnoreRequiredValidator (  )  [static, protected]

All search forms on validation would ignore required. There are no required attributes on a search form. This is an override.

Reimplemented from ModelForm.

Definition at line 421 of file SearchForm.php.

static getSearchFormAttributeMappingRulesTypeByAttribute ( attributeName  )  [static]

Given an attributeName, return the corresponding rule type.

Parameters:
string $attributeName

Definition at line 438 of file SearchForm.php.

resolveMixedSearchAttributeMappedToRealAttributesMetadata ( &$  realAttributesMetadata  ) 

Resolves a mixed attribute search by filtering out any attributes not part of the scope.

Parameters:
unknown_type $realAttributesMetadata

Reimplemented in WorkflownQueuesSearchForm.

Definition at line 508 of file SearchForm.php.

getGlobalSearchAttributeNamesAndLabelsAndAll (  ) 
Returns:
array of attributeName and label pairings. Based on what attributes are used in a mixed attribute search.

Reimplemented in WorkflownQueuesSearchForm.

Definition at line 559 of file SearchForm.php.

setListAttributesSelector ( ListAttributesSelector listAttributesSelector  ) 
See also:
ListAttributesSelector class

Definition at line 591 of file SearchForm.php.

getListAttributesSelector (  ) 
See also:
ListAttributesSelector class

Definition at line 599 of file SearchForm.php.

setKanbanBoard ( KanbanBoard kanbanBoard  ) 
See also:
KanbanBoard class

Definition at line 607 of file SearchForm.php.

getKanbanBoard (  ) 
Returns:
null|object KanbanBoard

Definition at line 615 of file SearchForm.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Jun 24 07:10:29 2017