PHP Class Pimcore\Model\Document\Listing

Inheritance: extends Pimcore\Model\Listing\AbstractListing, implements Zend_Paginator_Adapter_Interface, implements Zend_Paginator_AdapterAggregate, implements Iterator
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$documents array Contains the results of the list
$objectTypeDocument boolean Return all documents as Type Document. eg. for trees an so on there isn't the whole data required
$unpublished boolean
$validOrderKeys array Valid order keys

Public Methods

Method Description
count ( ) : integer Returns the total items count.
current ( ) : Document Returns the current listing row.
getCondition ( ) : string Returns the SQL condition value.
getDocuments ( ) : array Returns documents, also loads the rows if these aren't loaded.
getItems ( integer $offset, integer $itemCountPerPage ) : Listing Returns the listing based on defined offset and limit as parameters.
getPaginatorAdapter ( ) : Listing
getUnpublished ( ) : boolean Checks if the document is unpublished.
isValidOrderKey ( $key ) : boolean Tests if the given key is an valid order key to sort the results
key ( ) : mixed Returns the current listing row key.
next ( ) : mixed Returns the next listing row key.
rewind ( ) Rewind the listing back to te start.
setDocuments ( array $documents ) : Listing Assign documents to the listing.
setUnpublished ( $unpublished ) : boolean Set the unpublished flag for the document.
valid ( ) : boolean Checks whether the listing contains more entries.

Method Details

count() public method

Returns the total items count.
public count ( ) : integer
return integer

current() public method

Returns the current listing row.
public current ( ) : Document
return Pimcore\Model\Document

getCondition() public method

Returns the SQL condition value.
public getCondition ( ) : string
return string

getDocuments() public method

Returns documents, also loads the rows if these aren't loaded.
public getDocuments ( ) : array
return array

getItems() public method

Returns the listing based on defined offset and limit as parameters.
public getItems ( integer $offset, integer $itemCountPerPage ) : Listing
$offset integer
$itemCountPerPage integer
return Listing

getPaginatorAdapter() public method

public getPaginatorAdapter ( ) : Listing
return Listing

getUnpublished() public method

Checks if the document is unpublished.
public getUnpublished ( ) : boolean
return boolean

isValidOrderKey() public method

Tests if the given key is an valid order key to sort the results
public isValidOrderKey ( $key ) : boolean
return boolean

key() public method

Returns the current listing row key.
public key ( ) : mixed
return mixed

next() public method

Returns the next listing row key.
public next ( ) : mixed
return mixed

rewind() public method

Rewind the listing back to te start.
public rewind ( )

setDocuments() public method

Assign documents to the listing.
public setDocuments ( array $documents ) : Listing
$documents array
return Listing

setUnpublished() public method

Set the unpublished flag for the document.
public setUnpublished ( $unpublished ) : boolean
return boolean

valid() public method

Checks whether the listing contains more entries.
public valid ( ) : boolean
return boolean

Property Details

$documents public property

Contains the results of the list
public array $documents
return array

$objectTypeDocument public property

Return all documents as Type Document. eg. for trees an so on there isn't the whole data required
public bool $objectTypeDocument
return boolean

$unpublished public property

public bool $unpublished
return boolean

$validOrderKeys public property

Valid order keys
public array $validOrderKeys
return array