Allows extending classes to decorate an Iterator with reduced boilerplate. More...

Inherits Iterator.

Collaboration diagram for IteratorDecorator:

[legend]

Public Member Functions
	__construct (Iterator $iterator)

	current ()

	key ()

	next ()

	rewind ()

	valid ()

Protected Attributes
Iterator	$iterator

Detailed Description

Allows extending classes to decorate an Iterator with reduced boilerplate.

Note: GPL-2.0-or-later

Stability: stable: to extend

Definition at line 14 of file IteratorDecorator.php.

Constructor & Destructor Documentation

◆ __construct()

IteratorDecorator::__construct ( Iterator $iterator )

Stability: stable: to call

Parameters

Iterator $iterator

Definition at line 22 of file IteratorDecorator.php.

References $iterator.

Member Function Documentation

◆ current()

IteratorDecorator::current ( )

Stability: stable: to override

Definition at line 31 of file IteratorDecorator.php.

◆ key()

IteratorDecorator::key ( )

Stability: stable: to override

Definition at line 40 of file IteratorDecorator.php.

◆ next()

IteratorDecorator::next ( )

Stability: stable: to override

Definition at line 48 of file IteratorDecorator.php.

◆ rewind()

IteratorDecorator::rewind ( )

Stability: stable: to override

Definition at line 56 of file IteratorDecorator.php.

◆ valid()

IteratorDecorator::valid ( )

Stability: stable: to override

Definition at line 64 of file IteratorDecorator.php.

Member Data Documentation

◆ $iterator

Iterator IteratorDecorator::$iterator

protected

Definition at line 15 of file IteratorDecorator.php.

Referenced by __construct().

The documentation for this class was generated from the following file:

includes/libs/Iterators/IteratorDecorator.php

Public Member Functions

Protected Attributes