class ProgressList extends UserList (View source)

Properties

protected $total from  ItemList
protected $itemsPerPage from  UserList
protected $currentPage from  ItemList
protected $start from  ItemList
protected $sortBy from  ItemList
protected $sortByDirection from  ItemList
protected $queryStringPagingVariable from  ItemList
protected $queryStringSortVariable from  ItemList
protected $queryStringSortDirectionVariable from  ItemList
protected $enableStickySearchRequest from  ItemList
protected $stickySearchRequestNameSpace from  ItemList
protected $items from  ItemList
protected $query from  DatabaseItemList
protected $userQuery from  DatabaseItemList
protected $debug from  DatabaseItemList
protected $filters from  DatabaseItemList
protected $sortByString from  DatabaseItemList
protected $groupByString from  DatabaseItemList
protected $havingString from  DatabaseItemList
protected $autoSortColumns
protected $userPostQuery from  DatabaseItemList
protected $attributeClass from  UserList
protected $attributeFilters from  UserList
$showInactiveUsers from  UserList
$showInvalidatedUsers from  UserList
$searchAgainstEmail from  UserList

Methods

enableStickySearchRequest($namespace = false)

No description

from  ItemList
getQueryStringSortVariable()

No description

from  ItemList
getStickySearchNameSpace($namespace = '')

No description

from  ItemList
resetSearchRequest($namespace = '')

No description

from  ItemList
addToSearchRequest($key, $value)

No description

from  ItemList
getSearchRequest()

No description

from  ItemList
setItemsPerPage($num)

No description

from  ItemList
getItemsPerPage()

No description

from  ItemList
setItems($items)

No description

from  ItemList
from  ItemList
setNameSpace($ns)

No description

from  ItemList
getTotal()

Returns the total number of items found by this list.

from  UserList
getPage($page = false)

Returns an array of object by "page".

from  ItemList
get($itemsToGet = 0, $offset = 0)

Returns an array of userInfo objects based on current filter settings.

setCurrentPage($page = false)

No description

from  ItemList
displaySummary($right_content = '')

Displays summary text about a list.

from  ItemList
getSearchResultsClass($field)

No description

getSortByURL($column, $dir = 'asc', $baseURL = false, $additionalVars = array())

No description

isActiveSortColumn($column)

No description

from  ItemList
getActiveSortColumn()

No description

from  ItemList
getActiveSortDirection()

No description

from  ItemList
requiresPaging()

No description

from  ItemList
getPagination($url = false, $additionalVars = array())

No description

from  ItemList
displayPagingV2($script = false, $return = false, $additionalVars = array()) deprecated

Gets paging that works in our new format

from  ItemList
displayPaging($script = false, $return = false, $additionalVars = array())

Gets standard HTML to display paging

from  ItemList
getSummary()

Returns an object with properties useful for paging.

from  ItemList
sortBy($key, $dir = 'asc')

Sets column to sort by. Only supports a single column; for multiple columns us sortByMultiple().

getSortBy()

No description

from  ItemList
getSortByDirection()

No description

from  ItemList
sortByMultiple()

Sets up a multiple columns to search by. Each argument is taken "as-is" (including asc or desc) and concatenated with commas Note that this is overrides any previous sortByMultiple() call, and all sortBy() calls. Alternatively, you can pass a single array with multiple columns to sort by as its values.

from  ItemList
debug($dbg = true)

No description

setQuery($query)

No description

getQuery()

No description

addToQuery($query)

No description

setupAutoSort()

No description

executeBase()

No description

setupSortByString()

No description

setupAttributeSort()

No description

filter($column, $value, $comparison = '=')

Adds a filter to this item list.

groupBy($key)

No description

having($column, $value, $comparison = '=')

No description

setupAttributeFilters($join)

No description

filterByAttribute($column, $value, $comparison = '=')

No description

filterByUserName($username)

No description

from  UserList
filterByKeywords($keywords)

No description

from  UserList
filterByGroup(Group|string $group = '', bool $inGroup = true)

Filters the user list for only users within the provided group. Accepts an instance of a group object or a string group name.

from  UserList
excludeUsers($uo)

No description

from  UserList
filterByGroupID($gID)

No description

from  UserList
filterByDateAdded($date, $comparison = '=')

No description

from  UserList
array
getUserIDs($itemsToGet = 100, $offset = 0)

Similar to get except it returns an array of userIDs.

from  UserList
filterByIsActive($val)

No description

from  UserList
createQuery()

No description

from  UserList
setBaseQuery()

No description

from  UserList
__call($nm, $a)

No description

from  UserList
__construct()

No description

Details

enableStickySearchRequest($namespace = false)

No description

Parameters

$namespace

getQueryStringSortVariable()

No description

getQueryStringSortDirectionVariable()

No description

protected getStickySearchNameSpace($namespace = '')

No description

Parameters

$namespace

resetSearchRequest($namespace = '')

No description

Parameters

$namespace

addToSearchRequest($key, $value)

No description

Parameters

$key
$value

getSearchRequest()

No description

setItemsPerPage($num)

No description

Parameters

$num

getItemsPerPage()

No description

setItems($items)

No description

Parameters

$items

protected loadQueryStringPagingVariable()

No description

setNameSpace($ns)

No description

Parameters

$ns

getTotal()

Returns the total number of items found by this list.

getPage($page = false)

Returns an array of object by "page".

Parameters

$page

get($itemsToGet = 0, $offset = 0)

Returns an array of userInfo objects based on current filter settings.

Parameters

$itemsToGet
$offset

protected setCurrentPage($page = false)

No description

Parameters

$page

displaySummary($right_content = '')

Displays summary text about a list.

Parameters

$right_content

getSearchResultsClass($field)

No description

Parameters

$field

getSortByURL($column, $dir = 'asc', $baseURL = false, $additionalVars = array())

No description

Parameters

$column
$dir
$baseURL
$additionalVars

isActiveSortColumn($column)

No description

Parameters

$column

getActiveSortColumn()

No description

getActiveSortDirection()

No description

requiresPaging()

No description

getPagination($url = false, $additionalVars = array())

No description

Parameters

$url
$additionalVars

displayPagingV2($script = false, $return = false, $additionalVars = array()) deprecated

deprecated - this all has to go.

Gets paging that works in our new format

Parameters

$script
$return
$additionalVars

displayPaging($script = false, $return = false, $additionalVars = array())

Gets standard HTML to display paging

Parameters

$script
$return
$additionalVars

getSummary()

Returns an object with properties useful for paging.

sortBy($key, $dir = 'asc')

Sets column to sort by. Only supports a single column; for multiple columns us sortByMultiple().

Parameters

$key
$dir

getSortBy()

No description

getSortByDirection()

No description

sortByMultiple()

Sets up a multiple columns to search by. Each argument is taken "as-is" (including asc or desc) and concatenated with commas Note that this is overrides any previous sortByMultiple() call, and all sortBy() calls. Alternatively, you can pass a single array with multiple columns to sort by as its values.

e.g. $list->sortByMultiple('columna desc', 'columnb asc'); or $list->sortByMultiple(array('columna desc', 'columnb asc'));.

debug($dbg = true)

No description

Parameters

$dbg

protected setQuery($query)

No description

Parameters

$query

protected getQuery()

No description

addToQuery($query)

No description

Parameters

$query

protected setupAutoSort()

No description

protected executeBase()

No description

protected setupSortByString()

No description

protected setupAttributeSort()

No description

filter($column, $value, $comparison = '=')

Adds a filter to this item list.

Parameters

$column
$value
$comparison

groupBy($key)

No description

Parameters

$key

having($column, $value, $comparison = '=')

No description

Parameters

$column
$value
$comparison

protected setupAttributeFilters($join)

No description

Parameters

$join

filterByAttribute($column, $value, $comparison = '=')

No description

Parameters

$column
$value
$comparison

filterByUserName($username)

No description

Parameters

$username

filterByKeywords($keywords)

No description

Parameters

$keywords

filterByGroup(Group|string $group = '', bool $inGroup = true)

Filters the user list for only users within the provided group. Accepts an instance of a group object or a string group name.

Parameters

Group|string $group
bool $inGroup

excludeUsers($uo)

No description

Parameters

$uo

filterByGroupID($gID)

No description

Parameters

$gID

filterByDateAdded($date, $comparison = '=')

No description

Parameters

$date
$comparison

array getUserIDs($itemsToGet = 100, $offset = 0)

Similar to get except it returns an array of userIDs.

Much faster than getting a UserInfo object for each result if all you need is the user's id.

Parameters

$itemsToGet
$offset

Return Value

array

$userIDs

filterByIsActive($val)

No description

Parameters

$val

protected createQuery()

No description

protected setBaseQuery()

No description

__call($nm, $a)

No description

Parameters

$nm
$a

__construct()

No description