PHP-Entwurfsmuster-Iteratormuster

Konzept

Iterator-Modus (Iterator), auch Cursor-Modus (Cursor) genannt. Bietet eine Möglichkeit, nacheinander auf die verschiedenen Elemente in einem Aggregatobjekt zuzugreifen, ohne die interne Darstellung des Objekts offenzulegen.

Wenn Sie auf ein Aggregatobjekt zugreifen und es unabhängig von diesen Objekten durchlaufen müssen, sollten Sie die Verwendung des Iteratormusters in Betracht ziehen. Wenn Sie eine Sammlung auf mehrere Arten durchlaufen müssen, können Sie außerdem die Verwendung des Iteratormusters in Betracht ziehen. Das Iteratormuster bietet eine einheitliche Schnittstelle zum Durchlaufen verschiedener Sammlungsstrukturen, z. B. Start, Nächstes, Ende und aktuelles Element.

Anwendbare Szenarien

Zugriff auf den Inhalt eines Aggregatobjekts, ohne dessen interne Darstellung offenzulegen

Unterstützt mehrere Durchläufe von Aggregatobjekten

Unterschiedlich für die Durchquerung der Aggregatstruktur Bietet eine einheitliche Schnittstelle

UML-Diagramm

Rolle

Iterator: Iterator definiert Zugriff und Durchquerung. Elementschnittstelle

ConcreteIterator (spezifischer Iterator): Ein bestimmter Iterator implementiert die Iterator-Schnittstelle und verfolgt die aktuelle Position beim Durchlaufen des Aggregats

Aggregat (Aggregation): Die Aggregationsdefinition erstellt ein entsprechendes Iteratorobjekt. Die Schnittstelle

ConcreteAggregate (concrete Aggregation): Das konkrete Aggregat implementiert die Schnittstelle, die den entsprechenden Iterator erstellt. Diese Operation gibt eine entsprechende Instanz von ConcreteIterator zurück.

Code

Der Code lautet wie folgt:

PHP SPL Bietet bereits die Iterator-Schnittstelle Iterator und die Container-Schnittstelle IteatorAggragate. Der Quellcode lautet wie folgt:

/**
 * Interface to detect if a class is traversable using &foreach;.
 * @link http://php.net/manual/en/class.traversable.php
 */
interface Traversable {
}

/**
 * Interface to create an external Iterator.
 * @link http://php.net/manual/en/class.iteratoraggregate.php
 */
interface IteratorAggregate extends Traversable {

    /**
     * Retrieve an external iterator
     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
     * @return Traversable An instance of an object implementing <b>Iterator</b> or
     * <b>Traversable</b>
     * @since 5.0.0
     */
    public function getIterator();
}

/**
 * Interface for external iterators or objects that can be iterated
 * themselves internally.
 * @link http://php.net/manual/en/class.iterator.php
 */
interface Iterator extends Traversable {

    /**
     * Return the current element
     * @link http://php.net/manual/en/iterator.current.php
     * @return mixed Can return any type.
     * @since 5.0.0
     */
    public function current();

    /**
     * Move forward to next element
     * @link http://php.net/manual/en/iterator.next.php
     * @return void Any returned value is ignored.
     * @since 5.0.0
     */
    public function next();

    /**
     * Return the key of the current element
     * @link http://php.net/manual/en/iterator.key.php
     * @return mixed scalar on success, or null on failure.
     * @since 5.0.0
     */
    public function key();

    /**
     * Checks if current position is valid
     * @link http://php.net/manual/en/iterator.valid.php
     * @return boolean The return value will be casted to boolean and then evaluated.
     * Returns true on success or false on failure.
     * @since 5.0.0
     */
    public function valid();

    /**
     * Rewind the Iterator to the first element
     * @link http://php.net/manual/en/iterator.rewind.php
     * @return void Any returned value is ignored.
     * @since 5.0.0
     */
    public function rewind();
}

Hier implementieren wir direkt die beiden oben genannten Schnittstellen, siehe folgenden Code:

<?php
header(&#39;Content-type:text/html;charset=utf-8&#39;);
/**
 * 迭代器模式
 */

/**
 * Class ConcreteIterator 具体的迭代器
 */
class ConcreteIterator implements Iterator
{
    private $position = 0;
    private $array = array();

    public function __construct($array) {
        $this->array = $array;
        $this->position = 0;
    }

    function rewind() {
        $this->position = 0;
    }

    function current() {
        return $this->array[$this->position];
    }

    function key() {
        return $this->position;
    }

    function next() {
        ++$this->position;
    }

    function valid() {
        return isset($this->array[$this->position]);
    }
}

/**
 * Class MyAggregate 聚合容器
 */
class ConcreteAggregate implements IteratorAggregate
{
    public $property;

    /**
     * 添加属性
     *
     * @param $property
     */
    public function addProperty($property)
    {
        $this->property[] = $property;
    }

    public function getIterator()
    {
        return new ConcreteIterator($this->property);
    }
}

/**
 * Class Client 客户端测试
 */
class Client
{
    public static function test()
    {
        //创建一个容器
        $concreteAggregate = new ConcreteAggregate();
        // 添加属性
        $concreteAggregate->addProperty(&#39;属性1&#39;);
        // 添加属性
        $concreteAggregate->addProperty(&#39;属性2&#39;);
        //给容器创建迭代器
        $iterator = $concreteAggregate->getIterator();
        //遍历
        while($iterator->valid())
        {
            $key   = $iterator->key();
            $value = $iterator->current();
            echo &#39;键: &#39;.$key.&#39; 值: &#39;.$value.&#39;<hr>&#39;;
            $iterator->next();
        }

    }
}

Client:: test();

Laufergebnis:

Schlüssel: 0 Wert: Attribut 1
Schlüssel: 1 Wert: Attribut 2