All Data Structures Functions Variables Pages
Static Public Member Functions | Protected Member Functions
MultiSelectRelatedModelsAutoCompleteElement Class Reference
Inheritance diagram for MultiSelectRelatedModelsAutoCompleteElement:
Element DerivedElementInterface MultipleAccountsForProjectsElement MultipleContactsForMeetingElement MultipleContactsForProjectsElement MultipleGroupsAndUsersElement MultipleOpportunitiesForProjectsElement MultipleProductCategoriesForProductTemplateElement MultipleRelatedItemModelsAutoCompleteElement OutgoingEmailMessageRecipientBaseElement TagCloudElement

Static Public Member Functions

static getModelAttributeNames ()
 
- Static Public Member Functions inherited from Element
static getDisplayName ()
 
static isReadOnly ()
 
static resolveInputNameForEditableInput ($attributeName)
 
static resolveInputNamePrefixIntoString ($inputNamePrefix)
 
static resolveInputIdPrefixIntoString ($inputIdPrefix)
 

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 ()
 
- Protected Member Functions inherited from Element
 renderLabel ()
 
 resolveIdForLabel ()
 
 getFormattedAttributeLabel ()
 
 resolveNonActiveFormFormattedLabel ($label)
 
 renderError ()
 
 renderScopedErrorId ($inputNameIdPrefix, $attribute)
 
 renderEditable ()
 
 renderNonEditable ()
 
 renderControlEditable ()
 
 renderControlNonEditable ()
 
 getColumnSpan ()
 
 getDisabledValue ()
 
 getHtmlOptions ()
 
 resolveContentTemplate ($template, $data)
 
 getEditableInputId ($attributeName=null, $relationAttributeName=null)
 
 getEditableInputName ($attributeName=null, $relationAttributeName=null)
 
 resolveInputPrefix ()
 
 resolveInputIdPrefix ()
 
 resolveInputNamePrefix ()
 
 getListViewGridId ()
 

Additional Inherited Members

- Public Member Functions inherited from Element
 __construct ($model, $attribute, $form=null, array $params=array())
 
 render ()
 
 getEditableNameIds ()
 
 getAttribute ()
 
 renderAsControlNonEditable ()
 
- Data Fields inherited from Element
 $params
 
 $editableTemplate = '<th>{label}</th><td colspan="{colspan}">{content}{error}</td>'
 
 $nonEditableTemplate = '<th>{label}</th><td colspan="{colspan}">{content}</td>'
 
- Protected Attributes inherited from Element
 $model
 
 $attribute
 
 $form
 

Detailed Description

Definition at line 37 of file MultiSelectRelatedModelsAutoCompleteElement.php.

Member Function Documentation

getFormName ( )
abstractprotected
Returns
string
getUnqualifiedNameForIdField ( )
abstractprotected
Returns
string
getUnqualifiedIdForIdField ( )
abstractprotected
Returns
string
assertModelType ( )
abstractprotected

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

getWidgetSourceUrl ( )
abstractprotected

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

Returns
mixed
getRelationName ( )
abstractprotected

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

Returns
string
getWidgetHintText ( )
abstractprotected

Returns the hint text display in widget

Returns
string
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.

renderControlNonEditable ( )
protected

Returns rendered content for display as nonEditable.

Returns
null|string

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

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

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

Definition at line 214 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getOnDeleteContent ( )
protected

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

Returns
null

Definition at line 223 of file MultiSelectRelatedModelsAutoCompleteElement.php.

renderError ( )
protected

Renders Error

Returns
string|null

Definition at line 232 of file MultiSelectRelatedModelsAutoCompleteElement.php.

renderLabel ( )
protected

Returns label

Returns
string

Definition at line 241 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getFormattedAttributeLabel ( )
protected

Returns formatted display name

Returns
string

Definition at line 250 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getDefaultExistingIdsAndLabel ( )
protected

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

Returns
array

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

Definition at line 269 of file MultiSelectRelatedModelsAutoCompleteElement.php.

resolveModelNameForRendering ( RedBeanModel  $model)
protected

Resolves model's name for rendering.

Parameters
RedBeanModel$model
Returns
string

Definition at line 282 of file MultiSelectRelatedModelsAutoCompleteElement.php.

getRelatedRecords ( )
protected

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

Returns
array

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

Definition at line 302 of file MultiSelectRelatedModelsAutoCompleteElement.php.


The documentation for this class was generated from the following file:
Generated on Tue Mar 31 2020 07:11:13