1
0
mirror of https://github.com/php/php-src.git synced 2026-03-28 02:02:32 +01:00
Files
archived-php-src/ext/spl/examples/searchiterator.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

59 lines
1.1 KiB
PHP

<?php
/** @file searchiterator.inc
* @ingroup Examples
* @brief abstract class SearchIterator
* @author Marcus Boerger
* @date 2003 - 2005
*
* SPL - Standard PHP Library
*/
/** @ingroup Examples
* @brief Iterator to search for a specific element
* @author Marcus Boerger
* @version 1.0
*
* This extended FilterIterator stops after finding the first acceptable
* value.
*/
abstract class SearchIterator extends FilterIterator
{
/** @internal whether an entry was found already */
private $done = false;
/** Rewind and reset so that it once again searches.
* @return void
*/
function rewind()
{
parent::rewind();
$this->done = false;
}
/** @return whether the current element is valid
* which can only happen once per iteration.
*/
function valid()
{
return !$this->done && parent::valid();
}
/** Do not move forward but instead mark as finished.
* @return void
*/
function next()
{
$this->done = true;
}
/** Aggregates the inner iterator
*/
function __call($func, $params)
{
return call_user_func_array(array($this->getInnerIterator(), $func), $params);
}
}
?>