Class FileList

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

Concrete\Core\Legacy\ItemList
Extended by Concrete\Core\Legacy\DatabaseItemList
Extended by Concrete\Core\Legacy\FileList
Namespace: Concrete\Core\Legacy
Package: Files
Located at src/Legacy/FileList.php

Methods summary

public
# __call( $nm, $a )
public
# filterByExtension( mixed $ext )

Filters by file extension

public
# filterByType( mixed $type )

Filters by type of file

public
# filterByKeywords( $keywords )

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

public
# filterBySet( $fs )
public static
# export( $xml )
public static
# exportArchive( $archive )
protected
public
# filterBySize( $from, $to )

Filters the file list by file size (in kilobytes)

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

Filters by public date

public
public
# filterByApproverUID( integer $uID )

filters a FileList by the uID of the approving User

public
# filterByAuthorUID( integer $uID )

filters a FileList by the uID of the owning User

public
# setPermissionLevel( $plevel )
public
# filterByTag( string $tag = '' )

Filters by tag

protected
protected
public
# get( $itemsToGet = 0, $offset = 0 )

Returns an array of file objects based on current settings

public
# getTotal( )

Returns the total number of items found by this list

protected
public
# sortByAttributeKey( $key, $order = 'asc' )
public

Properties summary

protected array $attributeFilters
# array()
protected array $autoSortColumns
# array('fvFilename', 'fvAuthorName','fvTitle', 'fDateAdded', 'fvDateAdded', 'fvSize')
protected integer $itemsPerPage
# 10
protected string $attributeClass
# 'FileAttributeKey'
protected string $permissionLevel
# 'search_file_set'
protected array $filteredFileSetIDs
# array()