PHP Класс Pimcore\Model\Document\Listing

Наследование: extends Pimcore\Model\Listing\AbstractListing, implements Zend_Paginator_Adapter_Interface, implements Zend_Paginator_AdapterAggregate, implements Iterator
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$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

Открытые методы

Метод Описание
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.

Описание методов

count() публичный метод

Returns the total items count.
public count ( ) : integer
Результат integer

current() публичный метод

Returns the current listing row.
public current ( ) : Document
Результат Pimcore\Model\Document

getCondition() публичный метод

Returns the SQL condition value.
public getCondition ( ) : string
Результат string

getDocuments() публичный метод

Returns documents, also loads the rows if these aren't loaded.
public getDocuments ( ) : array
Результат array

getItems() публичный метод

Returns the listing based on defined offset and limit as parameters.
public getItems ( integer $offset, integer $itemCountPerPage ) : Listing
$offset integer
$itemCountPerPage integer
Результат Listing

getPaginatorAdapter() публичный метод

public getPaginatorAdapter ( ) : Listing
Результат Listing

getUnpublished() публичный метод

Checks if the document is unpublished.
public getUnpublished ( ) : boolean
Результат boolean

isValidOrderKey() публичный метод

Tests if the given key is an valid order key to sort the results
public isValidOrderKey ( $key ) : boolean
Результат boolean

key() публичный метод

Returns the current listing row key.
public key ( ) : mixed
Результат mixed

next() публичный метод

Returns the next listing row key.
public next ( ) : mixed
Результат mixed

rewind() публичный метод

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

setDocuments() публичный метод

Assign documents to the listing.
public setDocuments ( array $documents ) : Listing
$documents array
Результат Listing

setUnpublished() публичный метод

Set the unpublished flag for the document.
public setUnpublished ( $unpublished ) : boolean
Результат boolean

valid() публичный метод

Checks whether the listing contains more entries.
public valid ( ) : boolean
Результат boolean

Описание свойств

$documents публичное свойство

Contains the results of the list
public array $documents
Результат array

$objectTypeDocument публичное свойство

Return all documents as Type Document. eg. for trees an so on there isn't the whole data required
public bool $objectTypeDocument
Результат boolean

$unpublished публичное свойство

public bool $unpublished
Результат boolean

$validOrderKeys публичное свойство

Valid order keys
public array $validOrderKeys
Результат array