class RecursiveDOMIterator in Translation Management Tool 7

Class used to iterate through DOMDocument.

Hierarchy

• class \RecursiveDOMIterator implements \RecursiveIterator

File

translators/file/tmgmt_file.recursive_iterator.inc, line 10

Contains RecursiveDOMIterator.

class RecursiveDOMIterator implements RecursiveIterator {

  /**
   * Current position in DOMNodeList.
   *
   * @var int
   */
  protected $position;

  /**
   * The DOMNodeList with all children to iterate over.
   *
   * @var DOMNodeList
   */
  protected $nodeList;

  /**
   * Constructor.
   *
   * @param DOMNode $domNode
   *   DOMNode to iterate over.
   */
  public function __construct(DOMNode $domNode) {
    $this->position = 0;
    $this->nodeList = $domNode->childNodes;
  }

  /**
   * Returns the current DOMNode.
   *
   * @return DOMNode
   *   Current DOMNode object.
   */
  public function current() {
    return $this->nodeList
      ->item($this->position);
  }

  /**
   * Returns an iterator for the current iterator entry.
   *
   * @return RecursiveDOMIterator
   *   Iterator with children elements.
   */
  public function getChildren() {
    return new self($this
      ->current());
  }

  /**
   * Checks if current element has children.
   *
   * @return bool
   *   Has children.
   */
  public function hasChildren() {
    return $this
      ->current()
      ->hasChildNodes();
  }

  /**
   * Returns the current position.
   *
   * @return int
   *   Current position
   */
  public function key() {
    return $this->position;
  }

  /**
   * Moves the current position to the next element.
   */
  public function next() {
    $this->position++;
  }

  /**
   * Rewind the Iterator to the first element.
   */
  public function rewind() {
    $this->position = 0;
  }

  /**
   * Checks if current position is valid.
   *
   * @return bool
   *   Is valid.
   */
  public function valid() {
    return $this->position < $this->nodeList->length;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RecursiveDOMIterator::$nodeList	protected	property	The DOMNodeList with all children to iterate over.
RecursiveDOMIterator::$position	protected	property	Current position in DOMNodeList.
RecursiveDOMIterator::current	public	function	Returns the current DOMNode.
RecursiveDOMIterator::getChildren	public	function	Returns an iterator for the current iterator entry.
RecursiveDOMIterator::hasChildren	public	function	Checks if current element has children.
RecursiveDOMIterator::key	public	function	Returns the current position.
RecursiveDOMIterator::next	public	function	Moves the current position to the next element.
RecursiveDOMIterator::rewind	public	function	Rewind the Iterator to the first element.
RecursiveDOMIterator::valid	public	function	Checks if current position is valid.
RecursiveDOMIterator::__construct	public	function	Constructor.