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

executeSortBy($column, $direction = 'asc')

No description

from  ItemList
executeSanitizedSortBy($column, $direction = 'asc')

No description

from  ItemList
executeGetResults()

No description

from  ItemList
getResult($queryRow)

No description

debugStart()

No description

from  ItemList
debugStop()

No description

from  ItemList
array
getAutoSortColumns()

No description

from  ItemList
debug()

No description

from  ItemList
isDebugged()

No description

from  ItemList
sortBy($field, $direction = 'asc')

No description

from  ItemList
sortBySearchColumn(Column $column, $direction = null)

No description

from  ItemList
getSearchByColumn()

No description

from  ItemList
sanitizedSortBy($field, $direction = 'asc')

No description

from  ItemList
getResults()

Returns a full array of results.

from  ItemList
getActiveSortColumn()

No description

from  ItemList
isActiveSortColumn($field)

No description

from  ItemList
disableAutomaticSorting()

No description

from  ItemList
getSortClassName($column)

No description

from  ItemList
getSortURL($column, $dir = 'asc', $url = false)

No description

from  ItemList
getActiveSortDirection()

No description

from  ItemList
getQuerySortColumnParameter()

No description

from  ItemList
loadQueryStringPagingVariable()

Get paging parameter from Concrete configuration

from  ItemList
from  ItemList
setItemsPerPage($itemsPerPage)

No description

from  ItemList
int
getItemsPerPage()

No description

from  ItemList
int
getTotalResults()

Returns the total results in this item list.

getPagination() deprecated

Deprecated – call the pagination factory directly.

from  ItemList
performAutomaticSorting(StickyRequest $request = null)

No description

from  ItemList
setupAutomaticSorting(StickyRequest $request = null)

No description

get() deprecated

No description

from  ItemList
setNameSpace(mixed $nameSpace)

Allow to modify the auto-pagination parameters and the auto-sorting parameters

from  ItemList
createQuery()

No description

QueryBuilder
finalizeQuery(QueryBuilder $query)

No description

__construct()

No description

getSearchRequest()

No description

from  ItemList
getQueryObject()

No description

from  ItemList
deliverQueryObject()

No description

filter($field, $value, $comparison = '=') deprecated

No description

from  ItemList
ensureSelected($field)

No description

from  ItemList
__clone()

No description

from  ItemList
__call($nm, $a)

Magic method for setting up additional filtering by attributes.

filterByAttribute(mixed $handle, mixed $value, mixed $comparison = '=')

Filters by an attribute.

getAttributeKeyClassName()

No description

enableSubFolderSearch()

No description

enableAutomaticSorting()

No description

getPermissionsChecker()

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.

filterByAddedToPageID($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

Details

protected executeSortBy($column, $direction = 'asc')

No description

Parameters

$column
$direction

protected executeSanitizedSortBy($column, $direction = 'asc')

No description

Parameters

$column
$direction

executeGetResults()

No description

getResult($queryRow)

No description

Parameters

$queryRow

debugStart()

No description

debugStop()

No description

array getAutoSortColumns()

No description

Return Value

array

debug()

No description

isDebugged()

No description

sortBy($field, $direction = 'asc')

No description

Parameters

$field
$direction

sortBySearchColumn(Column $column, $direction = null)

No description

Parameters

Column $column
$direction

getSearchByColumn()

No description

sanitizedSortBy($field, $direction = 'asc')

No description

Parameters

$field
$direction

getResults()

Returns a full array of results.

getActiveSortColumn()

No description

isActiveSortColumn($field)

No description

Parameters

$field

disableAutomaticSorting()

No description

getSortClassName($column)

No description

Parameters

$column

getSortURL($column, $dir = 'asc', $url = false)

No description

Parameters

$column
$dir
$url

getActiveSortDirection()

No description

getQuerySortColumnParameter()

No description

getQueryPaginationPageParameter()

No description

protected loadQueryStringPagingVariable()

Get paging parameter from Concrete configuration

getQuerySortDirectionParameter()

No description

setItemsPerPage($itemsPerPage)

No description

Parameters

$itemsPerPage

int getItemsPerPage()

No description

Return Value

int

int getTotalResults()

Returns the total results in this item list.

Return Value

int

Pagination getPagination() deprecated

deprecated

Deprecated – call the pagination factory directly.

Return Value

Pagination

performAutomaticSorting(StickyRequest $request = null)

No description

Parameters

StickyRequest $request

setupAutomaticSorting(StickyRequest $request = null)

No description

Parameters

StickyRequest $request

get() deprecated

deprecated

No description

setNameSpace(mixed $nameSpace)

Allow to modify the auto-pagination parameters and the auto-sorting parameters

Parameters

mixed $nameSpace

Content that will be added to the parameters

createQuery()

No description

QueryBuilder finalizeQuery(QueryBuilder $query)

No description

Parameters

QueryBuilder $query

Return Value

QueryBuilder

__construct()

No description

StickyRequest|null getSearchRequest()

No description

Return Value

StickyRequest|null

getQueryObject()

No description

deliverQueryObject()

No description

filter($field, $value, $comparison = '=') deprecated

deprecated

No description

Parameters

$field
$value
$comparison

protected ensureSelected($field)

No description

Parameters

$field

__clone()

No description

__call($nm, $a)

Magic method for setting up additional filtering by attributes.

Parameters

$nm
$a

Exceptions

Exception

filterByAttribute(mixed $handle, mixed $value, mixed $comparison = '=')

Filters by an attribute.

Parameters

mixed $handle
mixed $value
mixed $comparison

Exceptions

InvalidAttributeException

protected getAttributeKeyClassName()

No description

enableSubFolderSearch()

No description

enableAutomaticSorting()

No description

getPermissionsChecker()

No description

VariableFactory getPagerVariableFactory()

No description

Return Value

VariableFactory

PagerManagerInterface getPagerManager()

No description

Return Value

PagerManagerInterface

setPermissionsChecker(Closure|null $checker = null)

No description

Parameters

Closure|null $checker

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

Return Value

mixed

checkPermissions($mixed)

No description

Parameters

$mixed

filterByParentFolder(FileFolder $folder)

No description

Parameters

FileFolder $folder

filterByType($type)

No description

Parameters

$type

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

Filters by public date.

Parameters

string $date
string $comparison

filterByAddedToPageID($ocID)

No description

Parameters

$ocID

filterByStorageLocationID(int $fslID)

Filter the files by their storage location using a storage location id.

Parameters

int $fslID

storage location id

filterByStorageLocation(StorageLocation|int $storageLocation)

Filter the files by their storage location using a storage location object.

Parameters

StorageLocation|int $storageLocation

storage location object

filterByExtension(string|string[] $extension)

Filter the files by their extension.

Parameters

string|string[] $extension

one or more file extensions (with or without leading dot)

filterBySet($fs)

No description

Parameters

$fs

filterBySize(int|float $from, int|float $to)

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

Parameters

int|float $from
int|float $to

filterByKeywords(string $keywords)

Filters by "keywords" (which searches everything including filenames, title, folder names, etc.

...

Parameters

string $keywords

sortByNodeName()

No description

sortByNodeType()

No description