1
0
mirror of https://github.com/php/php-src.git synced 2026-03-26 01:02:25 +01:00
Files
archived-php-src/ext/spl/internal/recursivecachingiterator.inc
Peter Kokot 60a69daec6 Sync leading and final newlines in source code files
This patch adds missing newlines, trims multiple redundant final
newlines into a single one, and trims redundant leading newlines.

According to POSIX, a line is a sequence of zero or more non-' <newline>'
characters plus a terminating '<newline>' character. [1] Files should
normally have at least one final newline character.

C89 [2] and later standards [3] mention a final newline:
"A source file that is not empty shall end in a new-line character,
which shall not be immediately preceded by a backslash character."

Although it is not mandatory for all files to have a final newline
fixed, a more consistent and homogeneous approach brings less of commit
differences issues and a better development experience in certain text
editors and IDEs.

[1] http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206
[2] https://port70.net/~nsz/c/c89/c89-draft.html#2.1.1.2
[3] https://port70.net/~nsz/c/c99/n1256.html#5.1.1.2
2018-10-14 12:54:08 +02:00

100 lines
2.1 KiB
PHP

<?php
/** @file recursivecachingiterator.inc
* @ingroup SPL
* @brief class RecursiveCachingIterator
* @author Marcus Boerger
* @date 2003 - 2009
*
* SPL - Standard PHP Library
*/
/**
* @brief Cached recursive iteration over another Iterator
* @author Marcus Boerger
* @version 1.2
* @since PHP 5.1
*
* @see CachingIterator
*/
class RecursiveCachingIterator extends CachingIterator implements RecursiveIterator
{
private $hasChildren;
private $getChildren;
/** Construct from another iterator
*
* @param it Iterator to cache
* @param flags Bitmask:
* - CALL_TOSTRING (whether to call __toString() for every element)
* - CATCH_GET_CHILD (whether to catch exceptions when trying to get childs)
*/
function __construct(RecursiveIterator $it, $flags = self::CALL_TOSTRING)
{
parent::__construct($it, $flags);
}
/** Rewind Iterator
*/
function rewind();
{
$this->hasChildren = false;
$this->getChildren = NULL;
parent::rewind();
}
/** Forward to next element if necessary then an Iterator for the Children
* will be created.
*/
function next()
{
if ($this->hasChildren = $this->it->hasChildren())
{
try
{
$child = $this->it->getChildren();
if (!$this->ref)
{
$this->ref = new ReflectionClass($this);
}
$this->getChildren = $ref->newInstance($child, $this->flags);
}
catch(Exception $e)
{
if (!$this->flags & self::CATCH_GET_CHILD)
{
throw $e;
}
$this->hasChildren = false;
$this->getChildren = NULL;
}
} else
{
$this->getChildren = NULL;
}
parent::next();
}
private $ref;
/** @return whether the current element has children
* @note The check whether the Iterator for the children can be created was
* already executed. Hence when flag CATCH_GET_CHILD was given in
* constructor this function returns false so that getChildren does
* not try to access those children.
*/
function hasChildren()
{
return $this->hasChildren;
}
/** @return An Iterator for the children
*/
function getChildren()
{
return $this->getChildren;
}
}
?>