trekel / src / php / Trekel / List.php

<?php
/**
 * Copyright 2010 Joey Mazzarelli. All rights reserved.
 *
 * Redistribution and use in source, with or without modification, is
 * permitted provided that the following condition is met:
 *
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY JOEY MAZZARELLI ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL JOEY MAZZARELLI OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation
 * are those of the authors and should not be interpreted as representing
 * official policies, either expressed or implied, of Joey Mazzarelli.
 */

/**
 * Ordered set
 *
 * @package Trekel
 * @author Joey Mazzarelli <joey@mazzarelli.com>
 * @copyright 2011 Joey Mazzarelli
 */
class Trekel_List extends Trekel_Set implements IteratorAggregate {

  /**
   * @var array
   */
  private $list = array();

  /**
   * @var int
   */
  private $idx = 0;

  /**
   * Append an item to the list
   * @param mixed $item Item to append
   * @return void
   */
  public function append ($item) {
    if ($item && !$this->has($item)) {
      $this->add($item);
      $this->list[] = $item;
    }
  }

  /**
   * Append the items to the list
   * @param array $items Items to append
   * @return void
   */
  public function appendAll ($items) {
    foreach ($items as $item) {
      $this->append($item);
    }
  }

  /**
   * Get the iterator
   * @return ArrayIterator
   */
  public function getIterator () {
    return new ArrayIterator($this->getItems());
  }

  /**
   * Get all items
   * @return array
   */
  public function getItems () {
    return $this->list;
  }

  /**
   * Get the next item in the list
   * @return mixed Next item or null
   */
  public function next () {
    if (isset($this->list[$this->idx])) {
      return $this->list[$this->idx++];
    }
    return null;
  }

} // end Trekel_List
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.