class FileList extends DatabaseItemList (View source)

An object that allows a filtered list of files to be returned.

\@package Files

Properties

protected $total from ItemList
protected $itemsPerPage
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
protected $attributeFilters
protected $permissionLevel
protected $filteredFileSetIDs

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.

getPage($page = false)

Returns an array of object by "page".

from ItemList
get($itemsToGet, $offset)

Returns an array of file objects based on current 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())

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

__call($nm, $a)

No description

filterByExtension($ext)

Filters by file extension.

filterByType(mixed $type)

Filters by type of file.

filterByKeywords($keywords)

Filters by "keywords" (which searches everything including filenames, title, tags, users who uploaded the file, tags).

filterBySet($fs)

No description

static 
export($xml)

No description

static 
exportArchive($archive)

No description

setupFileSetFilters()

No description

filterBySize($from, $to)

Filters the file list by file size (in kilobytes).

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

Filters by public date.

filterByOriginalPageID($ocID)

No description

filterByApproverUID(int $uID)

filters a FileList by the uID of the approving User.

filterByAuthorUID(int $uID)

filters a FileList by the uID of the owning User.

setPermissionLevel($plevel)

No description

filterByTag(string $tag = '')

Filters by tag.

setBaseQuery()

No description

setupFilePermissions()

No description

createQuery()

No description

sortByAttributeKey($key, $order = 'asc')

No description

sortByFileSetDisplayOrder()

No description

Details

enableStickySearchRequest($namespace = false)

Parameters

$namespace

getQueryStringSortVariable()

getQueryStringSortDirectionVariable()

protected getStickySearchNameSpace($namespace = '')

Parameters

$namespace

resetSearchRequest($namespace = '')

Parameters

$namespace

addToSearchRequest($key, $value)

Parameters

$key
$value

getSearchRequest()

setItemsPerPage($num)

Parameters

$num

getItemsPerPage()

setItems($items)

Parameters

$items

protected loadQueryStringPagingVariable()

setNameSpace($ns)

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, $offset)

Returns an array of file objects based on current settings.

Parameters

$itemsToGet
$offset

protected setCurrentPage($page = false)

Parameters

$page

displaySummary($right_content = '')

Displays summary text about a list.

Parameters

$right_content

getSearchResultsClass($field)

Parameters

$field

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

Parameters

$column
$dir
$baseURL
$additionalVars

isActiveSortColumn($column)

Parameters

$column

getActiveSortColumn()

getActiveSortDirection()

requiresPaging()

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

Parameters

$url
$additionalVars

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

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

getSortByDirection()

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)

Parameters

$dbg

protected setQuery($query)

Parameters

$query

protected getQuery()

addToQuery($query)

Parameters

$query

protected setupAutoSort()

protected executeBase()

protected setupSortByString()

protected setupAttributeSort()

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

Adds a filter to this item list.

Parameters

$column
$value
$comparison

groupBy($key)

Parameters

$key

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

Parameters

$column
$value
$comparison

protected setupAttributeFilters($join)

Parameters

$join

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

Parameters

$column
$value
$comparison

__call($nm, $a)

Parameters

$nm
$a

filterByExtension($ext)

Filters by file extension.

Parameters

$ext

filterByType(mixed $type)

Filters by type of file.

Parameters

mixed $type

filterByKeywords($keywords)

Filters by "keywords" (which searches everything including filenames, title, tags, users who uploaded the file, tags).

Parameters

$keywords

filterBySet($fs)

Parameters

$fs

static export($xml)

Parameters

$xml

static exportArchive($archive)

Parameters

$archive

protected setupFileSetFilters()

filterBySize($from, $to)

Filters the file list by file size (in kilobytes).

Parameters

$from
$to

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

Filters by public date.

Parameters

$date
$comparison

filterByOriginalPageID($ocID)

Parameters

$ocID

filterByApproverUID(int $uID)

filters a FileList by the uID of the approving User.

Parameters

int $uID

filterByAuthorUID(int $uID)

filters a FileList by the uID of the owning User.

Parameters

int $uID

setPermissionLevel($plevel)

Parameters

$plevel

filterByTag(string $tag = '')

Filters by tag.

Parameters

string $tag

protected setBaseQuery()

protected setupFilePermissions()

protected createQuery()

sortByAttributeKey($key, $order = 'asc')

Parameters

$key
$order

sortByFileSetDisplayOrder()