FileList
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
Returns the total number of items found by this list.
Returns an array of file objects based on current settings.
No description
Gets paging that works in our new format
Gets standard HTML to display paging
Sets column to sort by. Only supports a single column; for multiple columns us 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.
No description
Filters by file extension.
Filters by type of file.
Filters by "keywords" (which searches everything including filenames, title, tags, users who uploaded the file, tags).
No description
No description
No description
No description
Filters the file list by file size (in kilobytes).
Filters by public date.
No description
filters a FileList by the uID of the approving User.
filters a FileList by the uID of the owning User.
No description
Filters by tag.
No description
No description
No description
No description
No description
Details
enableStickySearchRequest($namespace = false)
No description
getQueryStringSortVariable()
No description
getQueryStringSortDirectionVariable()
No description
protected
getStickySearchNameSpace($namespace = '')
No description
resetSearchRequest($namespace = '')
No description
addToSearchRequest($key, $value)
No description
getSearchRequest()
No description
setItemsPerPage($num)
No description
getItemsPerPage()
No description
setItems($items)
No description
protected
loadQueryStringPagingVariable()
No description
setNameSpace($ns)
No description
getTotal()
Returns the total number of items found by this list.
getPage($page = false)
Returns an array of object by "page".
get($itemsToGet = 0, $offset = 0)
Returns an array of file objects based on current settings.
protected
setCurrentPage($page = false)
No description
displaySummary($right_content = '')
Displays summary text about a list.
getSearchResultsClass($field)
No description
getSortByURL($column, $dir = 'asc', $baseURL = false, $additionalVars = array())
No description
isActiveSortColumn($column)
No description
getActiveSortColumn()
No description
getActiveSortDirection()
No description
requiresPaging()
No description
getPagination($url = false, $additionalVars = array())
No description
displayPagingV2($script = false, $return = false, $additionalVars = array())
deprecated
deprecated
Gets paging that works in our new format
displayPaging($script = false, $return = false, $additionalVars = array())
Gets standard HTML to display paging
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().
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
protected
setQuery($query)
No description
protected
getQuery()
No description
addToQuery($query)
No description
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.
groupBy($key)
No description
having($column, $value, $comparison = '=')
No description
protected
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
protected
setupFileSetFilters()
No description
filterBySize($from, $to)
Filters the file list by file size (in kilobytes).
filterByDateAdded(string $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.
protected
setBaseQuery()
No description
protected
setupFilePermissions()
No description
protected
createQuery()
No description
sortByAttributeKey($key, $order = 'asc')
No description
sortByFileSetDisplayOrder()
No description