mirror of
https://github.com/php/php-src.git
synced 2026-04-12 18:43:37 +02:00
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
49 lines
1.0 KiB
PHP
49 lines
1.0 KiB
PHP
<?php
|
|
|
|
/** @file seekableiterator.inc
|
|
* @ingroup SPL
|
|
* @brief class SeekableIterator
|
|
* @author Marcus Boerger
|
|
* @date 2003 - 2009
|
|
*
|
|
* SPL - Standard PHP Library
|
|
*/
|
|
|
|
/** @brief seekable iterator
|
|
* @author Marcus Boerger
|
|
* @version 1.0
|
|
* @since PHP 5.0
|
|
*
|
|
* Turns a normal iterator ino a seekable iterator. When there is a way
|
|
* to seek on an iterator LimitIterator can use this to efficiently rewind
|
|
* to offset.
|
|
*/
|
|
interface SeekableIterator extends Iterator
|
|
{
|
|
/** Seek to an absolute position
|
|
*
|
|
* \param $index position to seek to
|
|
* \return void
|
|
*
|
|
* The method should throw an exception if it is not possible to seek to
|
|
* the given position. Typically this exception should be of type
|
|
* OutOfBoundsException.
|
|
\code
|
|
function seek($index);
|
|
$this->rewind();
|
|
$position = 0;
|
|
while($position < $index && $this->valid()) {
|
|
$this->next();
|
|
$position++;
|
|
}
|
|
if (!$this->valid()) {
|
|
throw new OutOfBoundsException('Invalid seek position');
|
|
}
|
|
}
|
|
\endcode
|
|
*/
|
|
function seek($index);
|
|
}
|
|
|
|
?>
|