MultiSelectRelatedModelsAutoCompleteElement Class Reference

Inheritance diagram for MultiSelectRelatedModelsAutoCompleteElement:
Element DerivedElementInterface MultipleAccountsForProjectsElement MultipleContactsForMeetingElement MultipleContactsForProjectsElement MultipleOpportunitiesForProjectsElement MultipleProductCategoriesForProductTemplateElement MultipleRelatedItemModelsAutoCompleteElement OutgoingEmailMessageRecipientBaseElement TagCloudElement

Static Public Member Functions

static getModelAttributeNames ()

Protected Member Functions

 getFormName ()
 getUnqualifiedNameForIdField ()
 getUnqualifiedIdForIdField ()
 assertModelType ()
 getWidgetSourceUrl ()
 getRelationName ()
 getWidgetHintText ()
 getEditableInputId ($attributeName=null, $relationAttributeName=null)
 getEditableInputName ($attributeName=null, $relationAttributeName=null)
 renderControlNonEditable ()
 getClipName ()
 getWidgetPathAlias ()
 getWidgetOptions ()
 getWidgetDefaultHtmlOptions ()
 getJsonEncodedIdsAndLabels ()
 getWidgetPropertyToSearch ()
 getDefaultWidgetOptions ()
 renderControlEditable ()
 getOnAddContent ()
 getOnDeleteContent ()
 renderError ()
 renderLabel ()
 getFormattedAttributeLabel ()
 getDefaultExistingIdsAndLabel ()
 resolveIdAndNameByModel (RedBeanModel $model)
 resolveModelNameForRendering (RedBeanModel $model)
 getRelatedRecords ()
 getExistingIdsAndLabels ()

Detailed Description

Definition at line 37 of file MultiSelectRelatedModelsAutoCompleteElement.php.


Member Function Documentation

static getModelAttributeNames (  )  [static]

Get the attributeNames of attributes used in the derived element. For this element, there are no attributes from the model.

Returns:
array - empty

Implements DerivedElementInterface.

Definition at line 82 of file MultiSelectRelatedModelsAutoCompleteElement.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 Element.

Reimplemented in TagCloudElement.

Definition at line 87 of file MultiSelectRelatedModelsAutoCompleteElement.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 Element.

Reimplemented in TagCloudElement.

Definition at line 92 of file MultiSelectRelatedModelsAutoCompleteElement.php.

renderControlNonEditable (  )  [protected]

Returns rendered content for display as nonEditable.

Returns:
null|string

Reimplemented from Element.

Reimplemented in MultiplePeopleForConversationElement.

Definition at line 101 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getClipName (  )  [protected]

Returns the name for the widget clip

Returns:
string

Definition at line 120 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getWidgetPathAlias (  )  [protected]

Return path alias to the multiselect autocomplete widget

Returns:
string

Definition at line 129 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getWidgetOptions (  )  [protected]

Returns widget options. To set default options in class, override this method

Returns:
array

Definition at line 138 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getWidgetDefaultHtmlOptions (  )  [protected]

Returns an array with 'disabled' populated according to element parameters

Returns:
array

Definition at line 147 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getJsonEncodedIdsAndLabels (  )  [protected]

Returns json encoded string of the existing Ids and Labels bound to model

Returns:
string

Definition at line 156 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getWidgetPropertyToSearch (  )  [protected]

Returns the property widget should search for in response.

Returns:
string

Definition at line 165 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getDefaultWidgetOptions (  )  [final, protected]

Returns default widget options. Do not override this method, override the methods it calls to collect data, or override getWidgetOptions()

Returns:
array

Definition at line 175 of file MultiSelectRelatedModelsAutoCompleteElement.php.

renderControlEditable (  )  [protected]

Returns the rendered content for editable type

Returns:
mixed

Reimplemented from Element.

Definition at line 194 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getOnAddContent (  )  [protected]

Returns the js event handler to fire whenever a new item gets added

Returns:
null

Reimplemented in OnChangeProcessMultiplePeopleForConversationElement.

Definition at line 214 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getOnDeleteContent (  )  [protected]

Returns the js event handler to fire whenever an item gets deleted.

Returns:
null

Reimplemented in OnChangeProcessMultiplePeopleForConversationElement.

Definition at line 223 of file MultiSelectRelatedModelsAutoCompleteElement.php.

renderError (  )  [protected]

Renders Error

Returns:
string|null

Reimplemented from Element.

Reimplemented in OutgoingEmailMessageRecipientBaseElement.

Definition at line 232 of file MultiSelectRelatedModelsAutoCompleteElement.php.

renderLabel (  )  [protected]

Returns label

Returns:
string

Reimplemented from Element.

Reimplemented in OutgoingEmailMessageRecipientBaseElement.

Definition at line 241 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getFormattedAttributeLabel (  )  [protected]
getDefaultExistingIdsAndLabel (  )  [protected]

Returns the default ids and labels that should already be there, probably readonly too.

Returns:
array

Reimplemented in MultiplePeopleForConversationElement.

Definition at line 259 of file MultiSelectRelatedModelsAutoCompleteElement.php.

resolveIdAndNameByModel ( RedBeanModel model  )  [protected]

Resolve an array with id and name using the sent model

Parameters:
$model 
Returns:
array

Reimplemented in TagCloudElement, MultiplePeopleForConversationElement, OutgoingEmailMessageRecipientBaseElement, and MultipleContactsForMeetingElement.

Definition at line 269 of file MultiSelectRelatedModelsAutoCompleteElement.php.

resolveModelNameForRendering ( RedBeanModel model  )  [protected]

Resolves model's name for rendering.

Parameters:
RedBeanModel $model
Returns:
string

Reimplemented in MultipleContactsForProjectsElement.

Definition at line 282 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getRelatedRecords (  )  [protected]

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

Returns:
array

Reimplemented in TagCloudElement.

Definition at line 291 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getExistingIdsAndLabels (  )  [protected]

Returns an array with the Ids and Labels of records already bound to the model attached to element

Returns:
array

Reimplemented in MultipleContactsForMeetingElement.

Definition at line 302 of file MultiSelectRelatedModelsAutoCompleteElement.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Mar 23 07:10:28 2017