This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Library_DatabaseItemList

Concrete5_Library_ItemList
Extended by ItemList
Extended by Concrete5_Library_DatabaseItemList

Direct known subclasses

DatabaseItemList

Methods summary

public
# getTotal( )

Returns the total number of items found by this list

public
# debug( $dbg = true )
protected
# setQuery( $query )
protected
# getQuery( )
public
# addToQuery( $query )
protected
protected
protected
protected
public
# get( $itemsToGet = 0, $offset = 0 )

Returns an array of whatever objects extends this class (e.g. PageList returns a list of pages).

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

Adds a filter to this item list

public
public
# sortBy( string $key, string $dir = 'asc' )

Sets column to sort by. Only supports a single column; for multiple columns us sortByMultiple()

public
# groupBy( $key )
public
# having( $column, $value, $comparison = '=' )
public
# getSortByURL( $column, $dir = 'asc', $baseURL = false, $additionalVars = array() )
protected
public
# filterByAttribute( $column, $value, $comparison = '=' )

Properties summary

protected string $query
# ''
protected string $userQuery
# ''
protected boolean $debug
# false
protected array $filters
# array()
protected string $sortByString
# ''
protected string $groupByString
# ''
protected string $havingString
# ''
protected array $autoSortColumns
# array()
protected string $userPostQuery
# ''