Class \Prado\Data\SqlMap\DataMapper\TSqlMapPagedList

TSqlMapPagedList implements a list with paging functionality that retrieves data from a SqlMap statement.

The maximum number of records fetched is 3 times the page size. It fetches the current, the previous and the next page at a time. This allows the paged list to determine if the page is a the begin, the middle or the end of the list.

The paged list does not need to know about the total number of records.

Class hierarchy

\Prado\Data\SqlMap\DataMapper\TSqlMapPagedList

\Prado\Collections\TPagedList

\Prado\Collections\TList implements IteratorAggregate, ArrayAccess, Countable

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1

Methods summary
`public`	`__construct(IMappedStatement $statement, mixed $parameter, int $pageSize[, null\|mixed $delegate = null ][, int $page = 0 ]) : mixed` Create a new SqlMap paged list.
`public`	`getIsLastPage() : bool`
`public`	`getIsMiddlePage() : bool`
`public`	`getIsNextPageAvailable() : bool`
`public`	`getIsPreviousPageAvailable() : bool`
`public`	`nextPage() : bool\|int` Switches to the next page.
`public`	`previousPage() : bool\|int` Switches to the previous page.
`public`	`setCustomPaging(mixed $value) : mixed`
`protected`	`fetchDataFromStatement(TSqlMapPagedList $sender, TPagedListFetchDataEventParameter $param) : mixed` Fetch data by executing the SqlMap statement.
`protected`	`getOffsetAndLimit(TPagedListFetchDataEventParameter $param) : array<string\|int, mixed>` Calculate the data fetch offsets and limits.
`protected`	`initialize(IMappedStatement $statement, mixed $parameter, int $pageSize, int $page) : mixed` Initialize the paged list.
`protected`	`populateData(TPagedListFetchDataEventParameter $param, array<string\|int, mixed> $data) : mixed` Populate the list with the fetched data.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, add, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clear, clearBehaviors, contains, copyFrom, count, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getCount, getCurrentPageIndex, getCustomPaging, getEventHandlers, getIsFirstPage, getIsLastPage, getIterator, getListeningToGlobalEvents, getPageCount, getPageSize, getReadOnly, getSubProperty, getVirtualCount, gotoPage, hasEvent, hasEventHandler, hasMethod, hasProperty, indexOf, insertAfter, insertAt, insertBefore, isa, itemAt, listen, mergeWith, nextPage, offsetExists, offsetGet, offsetSet, offsetUnset, onFetchData, onPageIndexChanged, previousPage, raiseEvent, remove, removeAt, setCurrentPageIndex, setCustomPaging, setPageSize, setReadOnly, setSubProperty, setVirtualCount, toArray, unlisten, _getZappableSleepProps, collapseReadOnly, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Data\SqlMap\DataMapper\TSqlMapPagedList

Class hierarchy