ModelAutoCompleteUtil Class Reference

Inheritance diagram for ModelAutoCompleteUtil:

Static Public Member Functions
static	getByPartialName ($modelClassName, $partialName, $pageSize, $autoCompleteOptions=null)
static	getGlobalSearchResultsByPartialTerm ($partialTerm, $pageSize, User $user, $scopeData=null)
static	getCustomFieldDataByPartialName ($customFieldDataName, $partialName)
Static Protected Member Functions
static	makeNoResultsFoundResultsData ()
static	makeModelResultsData (RedBeanModel $model)
static	makeModelClassNamesAndSearchAttributeData ($partialTerm, User $user, $scopeData)
static	getGenericResults ($modelClassName, $partialName, $pageSize, $autoCompleteOptions)
static	getUserResults ($partialName, $pageSize, $autoCompleteOptions=null)

---

Detailed Description

Helper class to convert a model search into an Jui AutoComplete ready array. There are three types of searches, Generic, User, and Person. Person and User utilize fullName instead of name while User adds the additional usage of username in the resulting label

Definition at line 45 of file ModelAutoCompleteUtil.php.

---

Member Function Documentation

static getByPartialName	(	$	modelClassName,
		$	partialName,
		$	pageSize,
		$	autoCompleteOptions = null
	)			[static]

Parameters:

	$modelClassName
	$partialName
	$pageSize

Returns:

array

Exceptions:

	NotImplementedException
	NotSupportedException

Definition at line 55 of file ModelAutoCompleteUtil.php.

static getGlobalSearchResultsByPartialTerm	(	$	partialTerm,
		$	pageSize,
		User $	user,
		$	scopeData = null
	)			[static]

Given a partial term, search across modules that support global search.

Parameters:

	$partialTerm
	$pageSize
	User	$user
	null	$scopeData

Returns:

array

Definition at line 86 of file ModelAutoCompleteUtil.php.

static getCustomFieldDataByPartialName	(	$	customFieldDataName,
		$	partialName
	)			[static]

Given a name of a customFieldData object and a term to search on return a JSON encoded array of autocomplete search results.

Parameters:

	$customFieldDataName
	$partialName

Returns:

array

Definition at line 119 of file ModelAutoCompleteUtil.php.

---

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

• /home/apizurmo/zurmo/app/protected/modules/zurmo/utils/ModelAutoCompleteUtil.php