MultipleGroupsAndUsersElement Class Reference

Inheritance diagram for MultipleGroupsAndUsersElement:

Static Public Member Functions
static	getDisplayName ()
Protected Member Functions
	getFormName ()
	getUnqualifiedNameForIdField ()
	getUnqualifiedIdForIdField ()
	assertModelType ()
	getFormattedAttributeLabel ()
	getWidgetSourceUrl ()
	getWidgetHintText ()
	getRelatedRecords ()
	getRelationName ()
	getEditableInputId ($attributeName=null, $relationAttributeName=null)
	getEditableInputName ($attributeName=null, $relationAttributeName=null)

---

Detailed Description

User interface element for selecting multiple groups and users using type ahead element

Definition at line 41 of file MultipleGroupsAndUsersElement.php.

---

Member Function Documentation

getFormName

(

)

[protected]

Returns:

string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 43 of file MultipleGroupsAndUsersElement.php.

getUnqualifiedNameForIdField

(

)

[protected]

Returns:

string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 48 of file MultipleGroupsAndUsersElement.php.

getUnqualifiedIdForIdField

(

)

[protected]

Returns:

string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 53 of file MultipleGroupsAndUsersElement.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 58 of file MultipleGroupsAndUsersElement.php.

getFormattedAttributeLabel

(

)

[protected]

Returns formatted display name

Returns:

string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 63 of file MultipleGroupsAndUsersElement.php.

getWidgetSourceUrl

(

)

[protected]

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

Returns:

mixed

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 73 of file MultipleGroupsAndUsersElement.php.

getWidgetHintText

(

)

[protected]

Returns the hint text display in widget

Returns:

string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 78 of file MultipleGroupsAndUsersElement.php.

getRelatedRecords

(

)

[protected]

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

Returns:

array

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 84 of file MultipleGroupsAndUsersElement.php.

getRelationName

(

)

[protected]

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

Returns:

string

Reimplemented from MultiSelectRelatedModelsAutoCompleteElement.

Definition at line 89 of file MultipleGroupsAndUsersElement.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 94 of file MultipleGroupsAndUsersElement.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 100 of file MultipleGroupsAndUsersElement.php.

---

The documentation for this class was generated from the following file:

• /home/apizurmo/zurmo/app/protected/modules/home/elements/derived/MultipleGroupsAndUsersElement.php