Methods to Implement
Methods to Implement
- abstract protected function didRewind() — Called when @{method:rewind} is invoked. You should reset any internal cursor your implementation holds.
- abstract protected function loadPage() — Called when the iterator needs a page of results. You should load the next result page and update your internal cursor to point past it.
Configuration
Configuration
- final public function getPageSize() — Get the configured page size.
- final public function setPageSize($size) — Configure the page size. Note that implementations may ignore this.
Iterator Implementation
Iterator Implementation
- final public function current()
- public function key() — By default, the iterator assigns a "natural" key (0, 1, 2, ...) to each result. This method is intentionally nonfinal so you can substitute a different behavior by overriding it if you prefer.
- final public function next()
- final public function rewind()
- final public function valid()
Other Methods
Other Methods
- public function __get($name)
- public function __set($name, $value)
- private function throwOnAttemptedIteration()
- public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.