FolderItemList
class FolderItemList extends AttributedItemList implements PagerProviderInterface, PaginationProviderInterface (View source)
Properties
| protected | $sortColumnParameter | from ItemList | |
| protected | $sortDirectionParameter | from ItemList | |
| protected | $paginationPageParameter | from ItemList | |
| protected | $sortBy | from ItemList | |
| protected | $sortByDirection | from ItemList | |
| protected | $sortBySearchColumn | from ItemList | |
| protected bool | $enableAutomaticSorting | Determines whether the list should automatically always sort by a column that's in the automatic sort. |
|
| protected | $autoSortColumns | ||
| protected | $itemsPerPage | from ItemList | |
| protected | $debug | from ItemList | |
| protected Pagination | $pagination | from ItemList | |
| protected QueryBuilder | $query | from ItemList | |
| protected StickyRequest | $searchRequest | from ItemList | |
| protected | $parent | ||
| protected | $searchSubFolders | ||
| protected | $permissionsChecker |
Methods
No description
Returns the total results in this item list.
Allow to modify the auto-pagination parameters and the auto-sorting parameters
No description
No description
No description
No description
Magic method for setting up additional filtering by attributes.
Filters by an attribute.
No description
No description
No description
No description
No description
No description
No description
No description
Returns the standard pagination adapter. This is used for non-permissioned objects and is typically something like DoctrineDbalAdapter
No description
No description
Filters by public date.
No description
Filter the files by their storage location using a storage location id.
Filter the files by their storage location using a storage location object.
Filter the files by their extension.
No description
Filters the file list by file size (in kilobytes).
Filters by "keywords" (which searches everything including filenames, title, folder names, etc.
No description
No description
Details
protected
executeSortBy($column, $direction = 'asc')
No description
protected
executeSanitizedSortBy($column, $direction = 'asc')
No description
executeGetResults()
No description
getResult($queryRow)
No description
debugStart()
No description
debugStop()
No description
array
getAutoSortColumns()
No description
debug()
No description
isDebugged()
No description
sortBy($field, $direction = 'asc')
No description
sortBySearchColumn(Column $column, $direction = null)
No description
getSearchByColumn()
No description
sanitizedSortBy($field, $direction = 'asc')
No description
getResults()
Returns a full array of results.
getActiveSortColumn()
No description
isActiveSortColumn($field)
No description
disableAutomaticSorting()
No description
getSortClassName($column)
No description
getSortURL($column, $dir = 'asc', $url = false)
No description
getActiveSortDirection()
No description
getQuerySortColumnParameter()
No description
getQueryPaginationPageParameter()
No description
protected
loadQueryStringPagingVariable()
Get paging parameter from Concrete configuration
getQuerySortDirectionParameter()
No description
setItemsPerPage($itemsPerPage)
No description
int
getItemsPerPage()
No description
int
getTotalResults()
Returns the total results in this item list.
Pagination
getPagination()
deprecated
deprecated
Deprecated – call the pagination factory directly.
performAutomaticSorting(StickyRequest $request = null)
No description
setupAutomaticSorting(StickyRequest $request = null)
No description
get()
deprecated
deprecated
No description
setNameSpace(mixed $nameSpace)
Allow to modify the auto-pagination parameters and the auto-sorting parameters
createQuery()
No description
QueryBuilder
finalizeQuery(QueryBuilder $query)
No description
__construct()
No description
StickyRequest|null
getSearchRequest()
No description
getQueryObject()
No description
deliverQueryObject()
No description
filter($field, $value, $comparison = '=')
deprecated
deprecated
No description
protected
ensureSelected($field)
No description
__clone()
No description
__call($nm, $a)
Magic method for setting up additional filtering by attributes.
filterByAttribute(mixed $handle, mixed $value, mixed $comparison = '=')
Filters by an attribute.
protected
getAttributeKeyClassName()
No description
enableSubFolderSearch()
No description
enableAutomaticSorting()
No description
getPermissionsChecker()
No description
VariableFactory
getPagerVariableFactory()
No description
PagerManagerInterface
getPagerManager()
No description
setPermissionsChecker(Closure|null $checker = null)
No description
enablePermissions()
No description
ignorePermissions()
No description
mixed
getPaginationAdapter()
Returns the standard pagination adapter. This is used for non-permissioned objects and is typically something like DoctrineDbalAdapter
checkPermissions($mixed)
No description
filterByParentFolder(FileFolder $folder)
No description
filterByType($type)
No description
filterByDateAdded(string $date, string $comparison = '=')
Filters by public date.
filterByOriginalPageID($ocID)
No description
filterByStorageLocationID(int $fslID)
Filter the files by their storage location using a storage location id.
filterByStorageLocation(StorageLocation|int $storageLocation)
Filter the files by their storage location using a storage location object.
filterByExtension(string|string[] $extension)
Filter the files by their extension.
filterBySet($fs)
No description
filterBySize(int|float $from, int|float $to)
Filters the file list by file size (in kilobytes).
filterByKeywords(string $keywords)
Filters by "keywords" (which searches everything including filenames, title, folder names, etc.
...
sortByNodeName()
No description
sortByNodeType()
No description