TagCloudElement Class Reference

Inheritance diagram for TagCloudElement:
MultiSelectRelatedModelsAutoCompleteElement Element DerivedElementInterface

Protected Member Functions

 getFormName ()
 assertModelType ()
 getWidgetSourceUrl ()
 getUnqualifiedIdForIdField ()
 getUnqualifiedNameForIdField ()
 getWidgetHintText ()
 getRelationName ()
 getRelatedRecords ()
 resolveIdAndNameByModel (RedBeanModel $customFieldValue)
 getFormattedAttributeLabel ()
 getEditableInputId ($attributeName=null, $relationAttributeName=null)
 getEditableInputName ($attributeName=null, $relationAttributeName=null)

Protected Attributes

 $dataAndLabels = null

Detailed Description

Definition at line 37 of file TagCloudElement.php.


Member Function Documentation

getFormName (  )  [protected]
Returns:
string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 42 of file TagCloudElement.php.

assertModelType (  )  [protected]

Asserts that element is attached to a form with a model type that we are indeed expecting

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 47 of file TagCloudElement.php.

getWidgetSourceUrl (  )  [protected]

Returns the source url widget should hit to request data for autocomplete

Returns:
mixed

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 52 of file TagCloudElement.php.

getUnqualifiedIdForIdField (  )  [protected]
Returns:
string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 58 of file TagCloudElement.php.

getUnqualifiedNameForIdField (  )  [protected]
Returns:
string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 63 of file TagCloudElement.php.

getWidgetHintText (  )  [protected]

Returns the hint text display in widget

Returns:
string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 68 of file TagCloudElement.php.

getRelationName (  )  [protected]

Returns the relation name we would query when generated existing Ids and Labels

Returns:
string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 73 of file TagCloudElement.php.

getRelatedRecords (  )  [protected]

Computes Related records for current model using relationName, returns an array

Returns:
array

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 78 of file TagCloudElement.php.

resolveIdAndNameByModel ( RedBeanModel model  )  [protected]

Resolve an array with id and name using the sent model

Parameters:
$model 
Returns:
array

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 85 of file TagCloudElement.php.

getFormattedAttributeLabel (  )  [protected]

Returns formatted display name

Returns:
string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 100 of file TagCloudElement.php.

getEditableInputId ( attributeName = null,
relationAttributeName = null 
) [protected]

An input Id is typically formed like: modelClassName_attributeName or modelClassName_attributeName_relationAttributeName. This method resolves the input Id string.

Parameters:
string $attributeName
string $relationAttributeName
Returns:
string representing the content of the input id.

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 105 of file TagCloudElement.php.

getEditableInputName ( attributeName = null,
relationAttributeName = null 
) [protected]

An input name is typically formed like: modelClassName[attributeName] or modelClassName[attributeName][relationAttributeName]. This method resolves the input name string. Also handles scenarios where attributeName has something like abc[def]. This method will properly account for that.

Parameters:
string $attributeName
string $relationAttributeName
Returns:
string representing the content of the input name.

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 111 of file TagCloudElement.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Dec 13 07:10:29 2017