UserSearch Class Reference

Inheritance diagram for UserSearch:
BaseModelAutoCompleteUtil

Static Public Member Functions

static getUsersByPartialFullName ($partialName, $pageSize, $autoCompleteOptions=null)
static getUsersByPartialFullNameOrUsername ($partialName, $pageSize=null, $autoCompleteOptions=null)
static getUsersByEmailAddress ($emailAddress, $operatorType=null, $filterOutHideFromSelecting=false, $autoCompleteOptions=null, $pageSize=null)
static getUsersByAnyEmailAddress ($emailAddress, $operatorType=null, $filterOutHideFromSelecting=false, $autoCompleteOptions=null, $pageSize=null)
static getUsersByPartialFullNameOrAnyEmailAddress ($partialNameOrEmailAddress, $pageSize, $stateMetadataAdapterClassName=null, $operatorType=null, $autoCompleteOptions=null)

Static Protected Member Functions

static getWherePartForPartialNameSearchByPartialName ($partialName)
static excludeRootUsers ($exclude, RedBeanModelJoinTablesQueryAdapter &$joinTablesAdapter, &$where)
static excludeCurrentUser ($exclude, RedBeanModelJoinTablesQueryAdapter &$joinTablesAdapter, &$where)
static excludeQueueUsers ($exclude, RedBeanModelJoinTablesQueryAdapter &$joinTablesAdapter, &$where)

Detailed Description

Definition at line 37 of file UserSearch.php.


Member Function Documentation

static getUsersByPartialFullName ( partialName,
pageSize,
autoCompleteOptions = null 
) [static]

For a give User name, run a partial search by full name and retrieve user models.

Parameters:
$partialName 
$pageSize 
$autoCompleteOptions 
Returns:
Array

Definition at line 47 of file UserSearch.php.

static getUsersByPartialFullNameOrUsername ( partialName,
pageSize = null,
autoCompleteOptions = null 
) [static]

For a give User name, run a partial search by full name and retrieve user models.

Parameters:
$partialName 
$pageSize 
$autoCompleteOptions 
Returns:
Array

Definition at line 75 of file UserSearch.php.

static getUsersByEmailAddress ( emailAddress,
operatorType = null,
filterOutHideFromSelecting = false,
autoCompleteOptions = null,
pageSize = null 
) [static]
Parameters:
string $emailAddress
null|string $operatorType
bool $filterOutHideFromSelecting
$autoCompleteOptions 
null|int $pageSize
Returns:
Array

Definition at line 104 of file UserSearch.php.

static getUsersByAnyEmailAddress ( emailAddress,
operatorType = null,
filterOutHideFromSelecting = false,
autoCompleteOptions = null,
pageSize = null 
) [static]
Parameters:
string $emailAddress
null|string $operatorType
bool $filterOutHideFromSelecting
$autoCompleteOptions 
null|int $pageSize
Returns:
Array

Definition at line 156 of file UserSearch.php.

static excludeRootUsers ( exclude,
RedBeanModelJoinTablesQueryAdapter &$  joinTablesAdapter,
&$  where 
) [static, protected]

Updates `where` part of query to exclude rootUsers

Parameters:
$exclude bool
RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter
$where 

Definition at line 278 of file UserSearch.php.

static excludeCurrentUser ( exclude,
RedBeanModelJoinTablesQueryAdapter &$  joinTablesAdapter,
&$  where 
) [static, protected]

Updates `where` part of query to exclude current user

Parameters:
$exclude bool
RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter
$where 

Definition at line 293 of file UserSearch.php.

static excludeQueueUsers ( exclude,
RedBeanModelJoinTablesQueryAdapter &$  joinTablesAdapter,
&$  where 
) [static, protected]

Updates `where` part of query to exclude queueUsers

Parameters:
$exclude bool
RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter
$where 

Definition at line 308 of file UserSearch.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Jul 17 07:11:10 2019