正文
PHP 标准库（SPL）是用于解决标准问题（standard problems）的一组接口与类的集合。
SPL 提供了一套标准的数据结构、遍历对象的迭代器、异常，以及一些处理文件的类，
它还提供了一系列的函数，比如 spl_autoload_register()。
此扩展只能在 PHP 5.0 以后使用。
此扩展从 PHP 5.3.0 不再被关闭，会一直有效。成为 PHP 内核组件一部分。
内容一览
数据结构
SplDoublyLinkedList — The SplDoublyLinkedList class
SplStack — SplStack 类
SplQueue — SplQueue 类
SplHeap — The SplHeap class
SplMaxHeap — The SplMaxHeap class
SplMinHeap — The SplMinHeap class
SplPriorityQueue — The SplPriorityQueue class
SplFixedArray — The SplFixedArray class
SplObjectStorage — The SplObjectStorage class
迭代器
AppendIterator — AppendIterator 类
ArrayIterator — ArrayIterator 类
CachingIterator — The CachingIterator class
CallbackFilterIterator — The CallbackFilterIterator class
DirectoryIterator — The DirectoryIterator class
EmptyIterator — The EmptyIterator class
FilesystemIterator — The FilesystemIterator class
FilterIterator — FilterIterator 类
GlobIterator — GlobIterator 类
InfiniteIterator — The InfiniteIterator class
IteratorIterator — The IteratorIterator class
LimitIterator — LimitIterator 类
MultipleIterator — The MultipleIterator class
NoRewindIterator — The NoRewindIterator class
ParentIterator — The ParentIterator class
RecursiveArrayIterator — The RecursiveArrayIterator class
RecursiveCachingIterator — The RecursiveCachingIterator class
RecursiveCallbackFilterIterator — The RecursiveCallbackFilterIterator class
RecursiveDirectoryIterator — The RecursiveDirectoryIterator class
RecursiveFilterIterator — The RecursiveFilterIterator class
RecursiveIteratorIterator — The RecursiveIteratorIterator class
RecursiveRegexIterator — The RecursiveRegexIterator class
RecursiveTreeIterator — The RecursiveTreeIterator class
RegexIterator — The RegexIterator class
接口
Countable — Countable 接口
OuterIterator — The OuterIterator interface
RecursiveIterator — The RecursiveIterator interface
SeekableIterator — The SeekableIterator interface
异常
BadFunctionCallException — The BadFunctionCallException class
BadMethodCallException — BadMethodCallException 类
DomainException — The DomainException class
InvalidArgumentException — The InvalidArgumentException class
LengthException — The LengthException class
LogicException — The LogicException class
OutOfBoundsException — The OutOfBoundsException class
OutOfRangeException — The OutOfRangeException class
OverflowException — The OverflowException class
RangeException — The RangeException class
RuntimeException — The RuntimeException class
UnderflowException — The UnderflowException class
UnexpectedValueException — The UnexpectedValueException class
SPL 函数
class_implements — 返回指定的类实现的所有接口。
class_parents — 返回指定类的父类。
class_uses — Return the traits used by the given class
iterator_apply — 为迭代器中每个元素调用一个用户自定义函数
iterator_count — 计算迭代器中元素的个数
iterator_to_array — 将迭代器中的元素拷贝到数组
spl_autoload_call — 尝试调用所有已注册的 __autoload() 函数来装载请求类
spl_autoload_extensions — 注册并返回 spl_autoload 函数使用的默认文件扩展名
spl_autoload_functions — 返回所有已注册的 __autoload() 函数
spl_autoload_register — 注册给定的函数作为 __autoload 的实现
spl_autoload_unregister — 注销已注册的 __autoload() 函数
spl_autoload — __autoload()函数的默认实现
spl_classes — 返回所有可用的SPL类
spl_object_hash — 返回指定对象的hash id
spl_object_id — Return the integer object handle for given object
文件处理
SplFileInfo — The SplFileInfo class
SplFileObject — SplFileObject 类
SplTempFileObject — The SplTempFileObject class
各种类及接口
ArrayObject — The ArrayObject class
SplObserver — The SplObserver interface
SplSubject — The SplSubject interface
数据结构
迭代器
/**
* Filtered iterator using the callback to determine which items are accepted or rejected.
* @link https://secure.php.net/manual/en/class.callbackfilteriterator.php
* @since 5.4
*/
class CallbackFilterIterator extends FilterIterator {
/**
* Creates a filtered iterator using the callback to determine which items are accepted or rejected.
* @param Iterator $iterator The iterator to be filtered.
* @param callable $callback The callback, which should return TRUE to accept the current item or FALSE otherwise.
* May be any valid callable value.
* The callback should accept up to three arguments: the current item, the current key and the iterator, respectively.
* <code> function my_callback($current, $key, $iterator) </code>
* @link https://secure.php.net/manual/en/callbackfilteriterator.construct.php
*/
function __construct(Iterator $iterator , callable $callback) { }
/**
* This method calls the callback with the current value, current key and the inner iterator.
* The callback is expected to return TRUE if the current item is to be accepted, or FALSE otherwise.
* @link https://secure.php.net/manual/en/callbackfilteriterator.accept.php
* @return bool true if the current element is acceptable, otherwise false.
*/
public function accept() { }
}
/**
* (PHP 5 >= 5.4.0)<br>
* RecursiveCallbackFilterIterator from a RecursiveIterator
* @link https://secure.php.net/manual/en/class.recursivecallbackfilteriterator.php
* @since 5.4
*/
class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements RecursiveIterator {
/**
* Create a RecursiveCallbackFilterIterator from a RecursiveIterator
* @param RecursiveIterator $iterator The recursive iterator to be filtered.
* @param string $callback The callback, which should return TRUE to accept the current item or FALSE otherwise. See Examples.
* May be any valid callable value.
* @link https://secure.php.net/manual/en/recursivecallbackfilteriterator.getchildren.php
*/
function __construct( RecursiveIterator $iterator, $callback ) { }
/**
* Check whether the inner iterator's current element has children
* @link https://php.net/manual/en/recursiveiterator.haschildren.php
* @return bool Returns TRUE if the current element has children, FALSE otherwise.
*/
public function hasChildren() { }
/**
* Returns an iterator for the current entry.
* @link https://secure.php.net/manual/en/recursivecallbackfilteriterator.haschildren.php
* @return RecursiveCallbackFilterIterator containing the children.
*/
public function getChildren() { }
}
/**
* Classes implementing <b>RecursiveIterator</b> can be used to iterate
* over iterators recursively.
* @link https://php.net/manual/en/class.recursiveiterator.php
*/
interface RecursiveIterator extends Iterator {
/**
* Returns if an iterator can be created for the current entry.
* @link https://php.net/manual/en/recursiveiterator.haschildren.php
* @return bool true if the current entry can be iterated over, otherwise returns false.
*/
public function hasChildren();
/**
* Returns an iterator for the current entry.
* @link https://php.net/manual/en/recursiveiterator.getchildren.php
* @return RecursiveIterator An iterator for the current entry.
*/
public function getChildren();
}
/**
* Can be used to iterate through recursive iterators.
* @link https://php.net/manual/en/class.recursiveiteratoriterator.php
*/
class RecursiveIteratorIterator implements OuterIterator {
/**
* The default. Lists only leaves in iteration.
*/
const LEAVES_ONLY = 0;
/**
* Lists leaves and parents in iteration with parents coming first.
*/
const SELF_FIRST = 1;
/**
* Lists leaves and parents in iteration with leaves coming first.
*/
const CHILD_FIRST = 2;
/**
* Special flag: Ignore exceptions thrown in accessing children.
*/
const CATCH_GET_CHILD = 16;
/**
* Construct a RecursiveIteratorIterator
* @link https://php.net/manual/en/recursiveiteratoriterator.construct.php
* @param Traversable $iterator
* @param int $mode [optional] The operation mode. See class constants for details.
* @param int $flags [optional] A bitmask of special flags. See class constants for details.
* @since 5.1.3
*/
public function __construct(Traversable $iterator, $mode = self::LEAVES_ONLY, $flags = 0) { }
/**
* Rewind the iterator to the first element of the top level inner iterator
* @link https://php.net/manual/en/recursiveiteratoriterator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Check whether the current position is valid
* @link https://php.net/manual/en/recursiveiteratoriterator.valid.php
* @return bool true if the current position is valid, otherwise false
*/
public function valid() { }
/**
* Access the current key
* @link https://php.net/manual/en/recursiveiteratoriterator.key.php
* @return string|float|int|bool|null The current key.
*/
public function key() { }
/**
* Access the current element value
* @link https://php.net/manual/en/recursiveiteratoriterator.current.php
* @return mixed The current elements value.
*/
public function current() { }
/**
* Move forward to the next element
* @link https://php.net/manual/en/recursiveiteratoriterator.next.php
* @return void
*/
public function next() { }
/**
* Get the current depth of the recursive iteration
* @link https://php.net/manual/en/recursiveiteratoriterator.getdepth.php
* @return int The current depth of the recursive iteration.
*/
public function getDepth() { }
/**
* The current active sub iterator
* @link https://php.net/manual/en/recursiveiteratoriterator.getsubiterator.php
* @param int $level [optional]
* @return RecursiveIterator The current active sub iterator.
*/
public function getSubIterator($level) { }
/**
* Get inner iterator
* @link https://php.net/manual/en/recursiveiteratoriterator.getinneriterator.php
* @return Iterator The current active sub iterator.
*/
public function getInnerIterator() { }
/**
* Begin Iteration
* @link https://php.net/manual/en/recursiveiteratoriterator.beginiteration.php
* @return void
*/
public function beginIteration() { }
/**
* End Iteration
* @link https://php.net/manual/en/recursiveiteratoriterator.enditeration.php
* @return void
*/
public function endIteration() { }
/**
* Has children
* @link https://php.net/manual/en/recursiveiteratoriterator.callhaschildren.php
* @return bool true if the element has children, otherwise false
*/
public function callHasChildren() { }
/**
* Get children
* @link https://php.net/manual/en/recursiveiteratoriterator.callgetchildren.php
* @return RecursiveIterator A <b>RecursiveIterator</b>.
*/
public function callGetChildren() { }
/**
* Begin children
* @link https://php.net/manual/en/recursiveiteratoriterator.beginchildren.php
* @return void
*/
public function beginChildren() { }
/**
* End children
* @link https://php.net/manual/en/recursiveiteratoriterator.endchildren.php
* @return void
*/
public function endChildren() { }
/**
* Next element
* @link https://php.net/manual/en/recursiveiteratoriterator.nextelement.php
* @return void
*/
public function nextElement() { }
/**
* Set max depth
* @link https://php.net/manual/en/recursiveiteratoriterator.setmaxdepth.php
* @param int $maxDepth [optional] <p>
* The maximum allowed depth. Default -1 is used
* for any depth.
* </p>
* @return void
*/
public function setMaxDepth($maxDepth) { }
/**
* Get max depth
* @link https://php.net/manual/en/recursiveiteratoriterator.getmaxdepth.php
* @return int|false The maximum accepted depth, or false if any depth is allowed.
*/
public function getMaxDepth() { }
}
/**
* 实现<b>OuterIterator</b>的类可用于在迭代器上进行迭代
* Classes implementing <b>OuterIterator</b> can be used to iterate
* over iterators.
* @link https://php.net/manual/en/class.outeriterator.php
*/
interface OuterIterator extends Iterator {
/**
* Returns the inner iterator for the current entry.
* @link https://php.net/manual/en/outeriterator.getinneriterator.php
* @return Iterator The inner iterator for the current entry.
*/
public function getInnerIterator();
}
/**
* 这个迭代器包装器允许将任何可遍历的内容转换为迭代器。
* 重要的是要理解，大多数不实现迭代器的类都有其原因，因为它们很可能不允许完整的迭代器特性集。
* 如果是这样，应该提供技术来防止误用，否则会出现异常或致命错误。
* This iterator wrapper allows the conversion of anything that is
* Traversable into an Iterator.
* It is important to understand that most classes that do not implement
* Iterators have reasons as most likely they do not allow the full
* Iterator feature set. If so, techniques should be provided to prevent
* misuse, otherwise expect exceptions or fatal errors.
* @link https://php.net/manual/en/class.iteratoriterator.php
*/
class IteratorIterator implements OuterIterator {
/**
* Create an iterator from anything that is traversable
* @link https://php.net/manual/en/iteratoriterator.construct.php
* @param Traversable $iterator
* @param string $class [optional]
*/
public function __construct(Traversable $iterator, $class = '') { }
/**
* Get the inner iterator
* @link https://php.net/manual/en/iteratoriterator.getinneriterator.php
* @return Iterator The inner iterator as passed to IteratorIterator::__construct.
*/
public function getInnerIterator() { }
/**
* Rewind to the first element
* @link https://php.net/manual/en/iteratoriterator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Checks if the iterator is valid
* @link https://php.net/manual/en/iteratoriterator.valid.php
* @return bool true if the iterator is valid, otherwise false
*/
public function valid() { }
/**
* Get the key of the current element
* @link https://php.net/manual/en/iteratoriterator.key.php
* @return string|float|int|bool|null The key of the current element.
*/
public function key() { }
/**
* Get the current value
* @link https://php.net/manual/en/iteratoriterator.current.php
* @return mixed The value of the current element.
*/
public function current() { }
/**
* Forward to the next element
* @link https://php.net/manual/en/iteratoriterator.next.php
* @return void
*/
public function next() { }
}
/**
* This abstract iterator filters out unwanted values. This class should be extended to
* implement custom iterator filters. The <b>FilterIterator::accept</b>
* must be implemented in the subclass.
* @link https://php.net/manual/en/class.filteriterator.php
*/
abstract class FilterIterator extends IteratorIterator {
/**
* Check whether the current element of the iterator is acceptable
* @link https://php.net/manual/en/filteriterator.accept.php
* @return bool true if the current element is acceptable, otherwise false.
*/
abstract public function accept();
/**
* Construct a filterIterator
* @link https://php.net/manual/en/filteriterator.construct.php
* @param Iterator $iterator
*/
public function __construct(Iterator $iterator) { }
/**
* Rewind the iterator
* @link https://php.net/manual/en/filteriterator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Check whether the current element is valid
* @link https://php.net/manual/en/filteriterator.valid.php
* @return bool true if the current element is valid, otherwise false
*/
public function valid() { }
/**
* Get the current key
* @link https://php.net/manual/en/filteriterator.key.php
* @return string|float|int|bool|null The current key.
*/
public function key() { }
/**
* Get the current element value
* @link https://php.net/manual/en/filteriterator.current.php
* @return mixed The current element value.
*/
public function current() { }
/**
* Move the iterator forward
* @link https://php.net/manual/en/filteriterator.next.php
* @return void
*/
public function next() { }
/**
* Get the inner iterator
* @link https://php.net/manual/en/filteriterator.getinneriterator.php
* @return Iterator The inner iterator.
*/
public function getInnerIterator() { }
}
/**
* This abstract iterator filters out unwanted values for a <b>RecursiveIterator</b>.
* This class should be extended to implement custom filters.
* The <b>RecursiveFilterIterator::accept</b> must be implemented in the subclass.
* @link https://php.net/manual/en/class.recursivefilteriterator.php
*/
abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator {
/**
* Create a RecursiveFilterIterator from a RecursiveIterator
* @link https://php.net/manual/en/recursivefilteriterator.construct.php
* @param RecursiveIterator $iterator
*/
public function __construct(RecursiveIterator $iterator) { }
/**
* Check whether the inner iterator's current element has children
* @link https://php.net/manual/en/recursivefilteriterator.haschildren.php
* @return bool true if the inner iterator has children, otherwise false
*/
public function hasChildren() { }
/**
* Return the inner iterator's children contained in a RecursiveFilterIterator
* @link https://php.net/manual/en/recursivefilteriterator.getchildren.php
* @return RecursiveFilterIterator containing the inner iterator's children.
*/
public function getChildren() { }
}
/**
* This extended FilterIterator allows a recursive iteration using RecursiveIteratorIterator that only shows those elements which have children.
* @link https://php.net/manual/en/class.parentiterator.php
*/
class ParentIterator extends RecursiveFilterIterator {
/**
* Determines acceptability
* @link https://php.net/manual/en/parentiterator.accept.php
* @return bool true if the current element is acceptable, otherwise false.
*/
public function accept() { }
/**
* Constructs a ParentIterator
* @link https://php.net/manual/en/parentiterator.construct.php
* @param RecursiveIterator $iterator
*/
public function __construct(RecursiveIterator $iterator) { }
/**
* Check whether the inner iterator's current element has children
* @link https://php.net/manual/en/recursivefilteriterator.haschildren.php
* @return bool true if the inner iterator has children, otherwise false
*/
public function hasChildren() { }
/**
* Return the inner iterator's children contained in a RecursiveFilterIterator
* @link https://php.net/manual/en/recursivefilteriterator.getchildren.php
* @return ParentIterator containing the inner iterator's children.
*/
public function getChildren() { }
}
/**
* The Seekable iterator.
* @link https://php.net/manual/en/class.seekableiterator.php
*/
interface SeekableIterator extends Iterator {
/**
* Seeks to a position
* @link https://php.net/manual/en/seekableiterator.seek.php
* @param int $position <p>
* The position to seek to.
* </p>
* @return void
*/
public function seek($position);
}
/**
* The <b>LimitIterator</b> class allows iteration over
* a limited subset of items in an <b>Iterator</b>.
* @link https://php.net/manual/en/class.limititerator.php
*/
class LimitIterator extends IteratorIterator {
/**
* Construct a LimitIterator
* @link https://php.net/manual/en/limititerator.construct.php
* @param Iterator $iterator The iterator to limit.
* @param int $offset [optional] The offset to start at. Must be zero or greater.
* @param int $limit [optional] The number of items to iterate. Must be -1 or greater. -1, the default, means no limit.
*/
public function __construct(Iterator $iterator, $offset = 0, $limit = -1) { }
/**
* Rewind the iterator to the specified starting offset
* @link https://php.net/manual/en/limititerator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Check whether the current element is valid
* @link https://php.net/manual/en/limititerator.valid.php
* @return bool true on success or false on failure.
*/
public function valid() { }
/**
* Get current key
* @link https://php.net/manual/en/limititerator.key.php
* @return string|float|int|bool|null the key for the current item.
*/
public function key() { }
/**
* Get current element
* @link https://php.net/manual/en/limititerator.current.php
* @return mixed the current element or null if there is none.
*/
public function current() { }
/**
* Move the iterator forward
* @link https://php.net/manual/en/limititerator.next.php
* @return void
*/
public function next() { }
/**
* Seek to the given position
* @link https://php.net/manual/en/limititerator.seek.php
* @param int $offset <p>
* The position to seek to.
* </p>
* @return int the offset position after seeking.
*/
public function seek($offset) { }
/**
* Return the current position
* @link https://php.net/manual/en/limititerator.getposition.php
* @return int The current position.
*/
public function getPosition() { }
/**
* Get inner iterator
* @link https://php.net/manual/en/limititerator.getinneriterator.php
* @return Iterator The inner iterator passed to <b>LimitIterator::__construct</b>.
*/
public function getInnerIterator() { }
}
/**
* This object supports cached iteration over another iterator.
* @link https://php.net/manual/en/class.cachingiterator.php
*/
class CachingIterator extends IteratorIterator implements ArrayAccess, Countable, Stringable {
/**
* String conversion flag (mutually exclusive): Uses the current element for the iterator's string conversion.
* This converts the current element to a string only once, regardless of whether it is needed or not.
*/
const CALL_TOSTRING = 1;
/**
* String conversion flag (mutually exclusive). Uses the current key for the iterator's string conversion.
*/
const TOSTRING_USE_KEY = 2;
/**
* String conversion flag (mutually exclusive). Uses the current element for the iterator's string conversion.
* This converts the current element to a string only when (and every time) it is needed.
*/
const TOSTRING_USE_CURRENT = 4;
/**
* String conversion flag (mutually exclusive). Forwards the string conversion to the inner iterator.
* This converts the inner iterator to a string only once, regardless of whether it is needed or not.
*/
const TOSTRING_USE_INNER = 8;
/**
* Ignore exceptions thrown in accessing children. Only used with {@see RecursiveCachingIterator}.
*/
const CATCH_GET_CHILD = 16;
/**
* Cache all read data. This is needed to use {@see CachingIterator::getCache}, and ArrayAccess and Countable methods.
*/
const FULL_CACHE = 256;
/**
* Constructs a new CachingIterator.
* @link https://php.net/manual/en/cachingiterator.construct.php
* @param Iterator $iterator The iterator to cache.
* @param int $flags [optional] A bitmask of flags. See CachingIterator class constants for details.
*/
public function __construct(Iterator $iterator, $flags = self::CALL_TOSTRING) { }
/**
* Rewind the iterator
* @link https://php.net/manual/en/cachingiterator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Check whether the current element is valid
* @link https://php.net/manual/en/cachingiterator.valid.php
* @return bool true on success or false on failure.
*/
public function valid() { }
/**
* Return the key for the current element
* @link https://php.net/manual/en/cachingiterator.key.php
* @return string|float|int|bool|null
*/
public function key() { }
/**
* Return the current element
* @link https://php.net/manual/en/cachingiterator.current.php
* @return mixed
*/
public function current() { }
/**
* Move the iterator forward
* @link https://php.net/manual/en/cachingiterator.next.php
* @return void
*/
public function next() { }
/**
* Check whether the inner iterator has a valid next element
* @link https://php.net/manual/en/cachingiterator.hasnext.php
* @return bool true on success or false on failure.
*/
public function hasNext() { }
/**
* Return the string representation of the current iteration based on the flag being used.
* @link https://php.net/manual/en/cachingiterator.tostring.php
* @return string The string representation of the current iteration based on the flag being used.
*/
public function __toString() { }
/**
* Returns the inner iterator
* @link https://php.net/manual/en/cachingiterator.getinneriterator.php
* @return Iterator an object implementing the Iterator interface.
*/
public function getInnerIterator() { }
/**
* Get flags used
* @link https://php.net/manual/en/cachingiterator.getflags.php
* @return int Bitmask of the flags
*/
public function getFlags() { }
/**
* The setFlags purpose
* @link https://php.net/manual/en/cachingiterator.setflags.php
* @param int $flags Bitmask of the flags to set.
* @return void
*/
public function setFlags($flags) { }
/**
* Internal cache array index to retrieve.
* @link https://php.net/manual/en/cachingiterator.offsetget.php
* @param string $key The index of the element to retrieve.
* @return mixed
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
public function offsetGet($key) { }
/**
* Set an element on the internal cache array.
* @link https://php.net/manual/en/cachingiterator.offsetset.php
* @param string $key The index of the element to be set.
* @param string $value The new value for the <i>index</i>.
* @return void
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
public function offsetSet($key, $value) { }
/**
* Remove an element from the internal cache array.
* @link https://php.net/manual/en/cachingiterator.offsetunset.php
* @param string $key The index of the element to be unset.
* @return void
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
public function offsetUnset($key) { }
/**
* Return whether an element at the index exists on the internal cache array.
* @link https://php.net/manual/en/cachingiterator.offsetexists.php
* @param string $key The index being checked.
* @return bool true if an entry referenced by the offset exists, false otherwise.
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
public function offsetExists($key) { }
/**
* Retrieve the contents of the cache
* @link https://php.net/manual/en/cachingiterator.getcache.php
* @return array An array containing the cache items.
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
public function getCache() { }
/**
* The number of elements in the iterator
* @link https://php.net/manual/en/cachingiterator.count.php
* @return int The count of the elements iterated over.
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
* @since 5.2.2
*/
public function count() { }
}
/**
* ...
* @link https://php.net/manual/en/class.recursivecachingiterator.php
*/
class RecursiveCachingIterator extends CachingIterator implements RecursiveIterator {
/**
* Constructs a new RecursiveCachingIterator.
* @link https://php.net/manual/en/recursivecachingiterator.construct.php
* @param Iterator $iterator The iterator to cache.
* @param int $flags [optional] A bitmask of flags. See CachingIterator class constants for details.
*/
public function __construct(Iterator $iterator, $flags = self::CALL_TOSTRING) { }
/**
* Check whether the current element of the inner iterator has children
* @link https://php.net/manual/en/recursivecachingiterator.haschildren.php
* @return bool true if the inner iterator has children, otherwise false
*/
public function hasChildren() { }
/**
* Return the inner iterator's children as a RecursiveCachingIterator
* @link https://php.net/manual/en/recursivecachingiterator.getchildren.php
* @return RecursiveCachingIterator The inner iterator's children, as a RecursiveCachingIterator.
*/
public function getChildren() { }
}
/**
* This iterator cannot be rewinded.
* @link https://php.net/manual/en/class.norewinditerator.php
*/
class NoRewindIterator extends IteratorIterator {
/**
* Construct a NoRewindIterator
* @link https://php.net/manual/en/norewinditerator.construct.php
* @param Iterator $iterator
*/
public function __construct(Iterator $iterator) { }
/**
* Prevents the rewind operation on the inner iterator.
* @link https://php.net/manual/en/norewinditerator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Validates the iterator
* @link https://php.net/manual/en/norewinditerator.valid.php
* @return bool true on success or false on failure.
*/
public function valid() { }
/**
* Get the current key
* @link https://php.net/manual/en/norewinditerator.key.php
* @return string|float|int|bool|null The current key.
*/
public function key() { }
/**
* Get the current value
* @link https://php.net/manual/en/norewinditerator.current.php
* @return mixed The current value.
*/
public function current() { }
/**
* Forward to the next element
* @link https://php.net/manual/en/norewinditerator.next.php
* @return void
*/
public function next() { }
/**
* Get the inner iterator
* @link https://php.net/manual/en/norewinditerator.getinneriterator.php
* @return Iterator The inner iterator, as passed to <b>NoRewindIterator::__construct</b>.
*/
public function getInnerIterator() { }
}
/**
* An Iterator that iterates over several iterators one after the other.
* @link https://php.net/manual/en/class.appenditerator.php
*/
class AppendIterator extends IteratorIterator {
/**
* Constructs an AppendIterator
* @link https://php.net/manual/en/appenditerator.construct.php
*/
public function __construct() { }
/**
* Appends an iterator
* @link https://php.net/manual/en/appenditerator.append.php
* @param Iterator $iterator <p>
* The iterator to append.
* </p>
* @return void
*/
public function append(Iterator $iterator) { }
/**
* Rewinds the Iterator
* @link https://php.net/manual/en/appenditerator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Checks validity of the current element
* @link https://php.net/manual/en/appenditerator.valid.php
* @return bool true on success or false on failure.
*/
public function valid() { }
/**
* Gets the current key
* @link https://php.net/manual/en/appenditerator.key.php
* @return string|float|int|bool|null The current key if it is valid or null otherwise.
*/
public function key() { }
/**
* Gets the current value
* @link https://php.net/manual/en/appenditerator.current.php
* @return mixed The current value if it is valid or null otherwise.
*/
public function current() { }
/**
* Moves to the next element
* @link https://php.net/manual/en/appenditerator.next.php
* @return void
*/
public function next() { }
/**
* Gets an inner iterator
* @link https://php.net/manual/en/appenditerator.getinneriterator.php
* @return Iterator the current inner Iterator.
*/
public function getInnerIterator() { }
/**
* Gets an index of iterators
* @link https://php.net/manual/en/appenditerator.getiteratorindex.php
* @return int The index of iterators.
*/
public function getIteratorIndex() { }
/**
* The getArrayIterator method
* @link https://php.net/manual/en/appenditerator.getarrayiterator.php
* @return ArrayIterator containing the appended iterators.
*/
public function getArrayIterator() { }
}
/**
* The <b>InfiniteIterator</b> allows one to
* infinitely iterate over an iterator without having to manually
* rewind the iterator upon reaching its end.
* @link https://php.net/manual/en/class.infiniteiterator.php
*/
class InfiniteIterator extends IteratorIterator {
/**
* Constructs an InfiniteIterator
* @link https://php.net/manual/en/infiniteiterator.construct.php
* @param Iterator $iterator
*/
public function __construct(Iterator $iterator) { }
/**
* Moves the inner Iterator forward or rewinds it
* @link https://php.net/manual/en/infiniteiterator.next.php
* @return void
*/
public function next() { }
}
/**
* This iterator can be used to filter another iterator based on a regular expression.
* @link https://php.net/manual/en/class.regexiterator.php
*/
class RegexIterator extends FilterIterator {
/**
* Return all matches for the current entry @see preg_match_all
*/
const ALL_MATCHES = 2;
/**
* Return the first match for the current entry @see preg_match
*/
const GET_MATCH = 1;
/**
* Only execute match (filter) for the current entry @see preg_match
*/
const MATCH = 0;
/**
* Replace the current entry (Not fully implemented yet) @see preg_replace
*/
const REPLACE = 4;
/**
* Returns the split values for the current entry @see preg_split
*/
const SPLIT = 3;
/**
* Special flag: Match the entry key instead of the entry value.
*/
const USE_KEY = 1;
const INVERT_MATCH = 2;
public $replacement;
/**
* Create a new RegexIterator
* @link https://php.net/manual/en/regexiterator.construct.php
* @param Iterator $iterator The iterator to apply this regex filter to.
* @param string $regex The regular expression to match.
* @param int $pattern [optional] Operation mode, see RegexIterator::setMode() for a list of modes.
* @param int $flags [optional] Special flags, see RegexIterator::setFlags() for a list of available flags.
* @param int $pregFlags [optional] The regular expression flags. These flags depend on the operation mode parameter
*/
public function __construct(Iterator $iterator, $pattern, $mode = self::MATCH, $flags = 0, $pregFlags = 0) { }
/**
* Get accept status
* @link https://php.net/manual/en/regexiterator.accept.php
* @return bool true if a match, false otherwise.
*/
public function accept() { }
/**
* Returns operation mode.
* @link https://php.net/manual/en/regexiterator.getmode.php
* @return int the operation mode.
*/
public function getMode() { }
/**
* Sets the operation mode.
* @link https://php.net/manual/en/regexiterator.setmode.php
* @param int $mode <p>
* The operation mode.
* </p>
* <p>
* The available modes are listed below. The actual
* meanings of these modes are described in the
* predefined constants.
* <table>
* <b>RegexIterator</b> modes
* <tr valign="top">
* <td>value</td>
* <td>constant</td>
* </tr>
* <tr valign="top">
* <td>0</td>
* <td>
* RegexIterator::MATCH
* </td>
* </tr>
* <tr valign="top">
* <td>1</td>
* <td>
* RegexIterator::GET_MATCH
* </td>
* </tr>
* <tr valign="top">
* <td>2</td>
* <td>
* RegexIterator::ALL_MATCHES
* </td>
* </tr>
* <tr valign="top">
* <td>3</td>
* <td>
* RegexIterator::SPLIT
* </td>
* </tr>
* <tr valign="top">
* <td>4</td>
* <td>
* RegexIterator::REPLACE
* </td>
* </tr>
* </table>
* </p>
* @return void
*/
public function setMode($mode) { }
/**
* Get flags
* @link https://php.net/manual/en/regexiterator.getflags.php
* @return int the set flags.
*/
public function getFlags() { }
/**
* Sets the flags.
* @link https://php.net/manual/en/regexiterator.setflags.php
* @param int $flags <p>
* The flags to set, a bitmask of class constants.
* </p>
* <p>
* The available flags are listed below. The actual
* meanings of these flags are described in the
* predefined constants.
* <table>
* <b>RegexIterator</b> flags
* <tr valign="top">
* <td>value</td>
* <td>constant</td>
* </tr>
* <tr valign="top">
* <td>1</td>
* <td>
* RegexIterator::USE_KEY
* </td>
* </tr>
* </table>
* </p>
* @return void
*/
public function setFlags($flags) { }
/**
* Returns current regular expression
* @link https://secure.php.net/manual/en/regexiterator.getregex.php
* @return string
* @since 5.4
*/
public function getRegex() {}
/**
* Returns the regular expression flags.
* @link https://php.net/manual/en/regexiterator.getpregflags.php
* @return int a bitmask of the regular expression flags.
*/
public function getPregFlags() { }
/**
* Sets the regular expression flags.
* @link https://php.net/manual/en/regexiterator.setpregflags.php
* @param int $pregFlags <p>
* The regular expression flags. See <b>RegexIterator::__construct</b>
* for an overview of available flags.
* </p>
* @return void
*/
public function setPregFlags($pregFlags) { }
}
/**
* This recursive iterator can filter another recursive iterator via a regular expression.
* @link https://php.net/manual/en/class.recursiveregexiterator.php
*/
class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator {
/**
* Creates a new RecursiveRegexIterator.
* @link https://php.net/manual/en/recursiveregexiterator.construct.php
* @param RecursiveIterator $iterator The iterator to apply this regex filter to.
* @param string $pattern The regular expression to match.
* @param int $mode [optional] Operation mode, see RegexIterator::setMode() for a list of modes.
* @param int $flags [optional] Special flags, see RegexIterator::setFlags() for a list of available flags.
* @param int $pregFlags [optional] The regular expression flags. These flags depend on the operation mode parameter
*/
public function __construct(RecursiveIterator $iterator, $pattern, $mode = self::MATCH, $flags = 0, $pregFlags = 0) { }
/**
* Returns whether an iterator can be obtained for the current entry.
* @link https://php.net/manual/en/recursiveregexiterator.haschildren.php
* @return bool true if an iterator can be obtained for the current entry, otherwise returns false.
*/
public function hasChildren() { }
/**
* Returns an iterator for the current entry.
* @link https://php.net/manual/en/recursiveregexiterator.getchildren.php
* @return RecursiveRegexIterator An iterator for the current entry, if it can be iterated over by the inner iterator.
*/
public function getChildren() { }
}
/**
* Allows iterating over a <b>RecursiveIterator</b> to generate an ASCII graphic tree.
* @link https://php.net/manual/en/class.recursivetreeiterator.php
*/
class RecursiveTreeIterator extends RecursiveIteratorIterator {
const BYPASS_CURRENT = 4;
const BYPASS_KEY = 8;
const PREFIX_LEFT = 0;
const PREFIX_MID_HAS_NEXT = 1;
const PREFIX_MID_LAST = 2;
const PREFIX_END_HAS_NEXT = 3;
const PREFIX_END_LAST = 4;
const PREFIX_RIGHT = 5;
/**
* Construct a RecursiveTreeIterator
* @link https://php.net/manual/en/recursivetreeiterator.construct.php
* @param RecursiveIterator|IteratorAggregate $iterator
* @param int $flags [optional] Flags to control the behavior of the RecursiveTreeIterator object.
* @param int $cachingIteratorFlags [optional] Flags to affect the behavior of the {@see RecursiveCachingIterator} used internally.
* @param int $mode [optional] Flags to affect the behavior of the {@see RecursiveIteratorIterator} used internally.
*/
public function __construct($iterator, $flags = self::BYPASS_KEY, $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD,
$mode = self::SELF_FIRST) { }
/**
* Rewind iterator
* @link https://php.net/manual/en/recursivetreeiterator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Check validity
* @link https://php.net/manual/en/recursivetreeiterator.valid.php
* @return bool true if the current position is valid, otherwise false
*/
public function valid() { }
/**
* Get the key of the current element
* @link https://php.net/manual/en/recursivetreeiterator.key.php
* @return string the current key prefixed and postfixed.
*/
public function key() { }
/**
* Get current element
* @link https://php.net/manual/en/recursivetreeiterator.current.php
* @return string the current element prefixed and postfixed.
*/
public function current() { }
/**
* Move to next element
* @link https://php.net/manual/en/recursivetreeiterator.next.php
* @return void
*/
public function next() { }
/**
* Begin iteration
* @link https://php.net/manual/en/recursivetreeiterator.beginiteration.php
* @return RecursiveIterator A <b>RecursiveIterator</b>.
*/
public function beginIteration() { }
/**
* End iteration
* @link https://php.net/manual/en/recursivetreeiterator.enditeration.php
* @return void
*/
public function endIteration() { }
/**
* Has children
* @link https://php.net/manual/en/recursivetreeiterator.callhaschildren.php
* @return bool true if there are children, otherwise false
*/
public function callHasChildren() { }
/**
* Get children
* @link https://php.net/manual/en/recursivetreeiterator.callgetchildren.php
* @return RecursiveIterator A <b>RecursiveIterator</b>.
*/
public function callGetChildren() { }
/**
* Begin children
* @link https://php.net/manual/en/recursivetreeiterator.beginchildren.php
* @return void
*/
public function beginChildren() { }
/**
* End children
* @link https://php.net/manual/en/recursivetreeiterator.endchildren.php
* @return void
*/
public function endChildren() { }
/**
* Next element
* @link https://php.net/manual/en/recursivetreeiterator.nextelement.php
* @return void
*/
public function nextElement() { }
/**
* Get the prefix
* @link https://php.net/manual/en/recursivetreeiterator.getprefix.php
* @return string the string to place in front of current element
*/
public function getPrefix() { }
/**
* @param string $postfix
*/
public function setPostfix($postfix) {}
/**
* Set a part of the prefix
* @link https://php.net/manual/en/recursivetreeiterator.setprefixpart.php
* @param int $part <p>
* One of the RecursiveTreeIterator::PREFIX_* constants.
* </p>
* @param string $value <p>
* The value to assign to the part of the prefix specified in <i>part</i>.
* </p>
* @return void
*/
public function setPrefixPart($part, $value) { }
/**
* Get current entry
* @link https://php.net/manual/en/recursivetreeiterator.getentry.php
* @return string the part of the tree built for the current element.
*/
public function getEntry() { }
/**
* Get the postfix
* @link https://php.net/manual/en/recursivetreeiterator.getpostfix.php
* @return string to place after the current element.
*/
public function getPostfix() { }
}
ArrayIterator
/**
* This iterator allows to unset and modify values and keys while iterating
* over Arrays and Objects.
* @link https://php.net/manual/en/class.arrayiterator.php
*/
class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {
const STD_PROP_LIST = 1;
const ARRAY_AS_PROPS = 2;
/**
* Construct an ArrayIterator
* @link https://php.net/manual/en/arrayiterator.construct.php
* @param array $array The array or object to be iterated on.
* @param int $flags Flags to control the behaviour of the ArrayObject object.
* @see ArrayObject::setFlags()
*/
public function __construct($array = array(), $flags = 0) { }
/**
* Check if offset exists
* @link https://php.net/manual/en/arrayiterator.offsetexists.php
* @param string $key <p>
* The offset being checked.
* </p>
* @return bool true if the offset exists, otherwise false
*/
public function offsetExists($key) { }
/**
* Get value for an offset
* @link https://php.net/manual/en/arrayiterator.offsetget.php
* @param string $key <p>
* The offset to get the value from.
* </p>
* @return mixed The value at offset <i>index</i>.
*/
public function offsetGet($key) { }
/**
* Set value for an offset
* @link https://php.net/manual/en/arrayiterator.offsetset.php
* @param string $key <p>
* The index to set for.
* </p>
* @param string $value <p>
* The new value to store at the index.
* </p>
* @return void
*/
public function offsetSet($key, $value) { }
/**
* Unset value for an offset
* @link https://php.net/manual/en/arrayiterator.offsetunset.php
* @param string $key <p>
* The offset to unset.
* </p>
* @return void
*/
public function offsetUnset($key) { }
/**
* Append an element
* @link https://php.net/manual/en/arrayiterator.append.php
* @param mixed $value <p>
* The value to append.
* </p>
* @return void
*/
public function append($value) { }
/**
* Get array copy
* @link https://php.net/manual/en/arrayiterator.getarraycopy.php
* @return array A copy of the array, or array of public properties
* if ArrayIterator refers to an object.
*/
public function getArrayCopy() { }
/**
* Count elements
* @link https://php.net/manual/en/arrayiterator.count.php
* @return int The number of elements or public properties in the associated
* array or object, respectively.
*/
public function count() { }
/**
* Get flags
* @link https://php.net/manual/en/arrayiterator.getflags.php
* @return string The current flags.
*/
public function getFlags() { }
/**
* Set behaviour flags
* @link https://php.net/manual/en/arrayiterator.setflags.php
* @param string $flags <p>
* A bitmask as follows:
* 0 = Properties of the object have their normal functionality
* when accessed as list (var_dump, foreach, etc.).
* 1 = Array indices can be accessed as properties in read/write.
* </p>
* @return void
*/
public function setFlags($flags) { }
/**
* Sort array by values
* @link https://php.net/manual/en/arrayiterator.asort.php
* @param int $flags [optional]
* @return void
*/
public function asort($flags = SORT_REGULAR) { }
/**
* Sort array by keys
* @link https://php.net/manual/en/arrayiterator.ksort.php
* @param int $flags [optional]
* @return void
*/
public function ksort($flags = SORT_REGULAR) { }
/**
* User defined sort
* @link https://php.net/manual/en/arrayiterator.uasort.php
* @param callable $callback <p>
* The compare function used for the sort.
* </p>
* @return void
*/
public function uasort($callback) { }
/**
* User defined sort
* @link https://php.net/manual/en/arrayiterator.uksort.php
* @param callable $callback <p>
* The compare function used for the sort.
* </p>
* @return void
*/
public function uksort($callback) { }
/**
* Sort an array naturally
* @link https://php.net/manual/en/arrayiterator.natsort.php
* @return void
*/
public function natsort() { }
/**
* Sort an array naturally, case insensitive
* @link https://php.net/manual/en/arrayiterator.natcasesort.php
* @return void
*/
public function natcasesort() { }
/**
* Unserialize
* @link https://php.net/manual/en/arrayiterator.unserialize.php
* @param string $data <p>
* The serialized ArrayIterator object to be unserialized.
* </p>
* @return string The <b>ArrayIterator</b>.
*/
public function unserialize($data) { }
/**
* Serialize
* @link https://php.net/manual/en/arrayiterator.serialize.php
* @return string The serialized <b>ArrayIterator</b>.
*/
public function serialize() { }
/**
* Rewind array back to the start
* @link https://php.net/manual/en/arrayiterator.rewind.php
* @return void
*/
public function rewind() { }
/**
* Return current array entry
* @link https://php.net/manual/en/arrayiterator.current.php
* @return mixed The current array entry.
*/
public function current() { }
/**
* Return current array key
* @link https://php.net/manual/en/arrayiterator.key.php
* @return string|float|int|bool|null The current array key.
*/
public function key() { }
/**
* Move to next entry
* @link https://php.net/manual/en/arrayiterator.next.php
* @return void
*/
public function next() { }
/**
* Check whether array contains more entries
* @link https://php.net/manual/en/arrayiterator.valid.php
* @return bool
*/
public function valid() { }
/**
* Seek to position
* @link https://php.net/manual/en/arrayiterator.seek.php
* @param int $offset <p>
* The position to seek to.
* </p>
* @return void
*/
public function seek($offset) { }
/**
* @return array
* @since 7.4
*/
public function __debugInfo(){}
/**
* @return array
* @since 7.4
*/
public function __serialize(): array {}
/**
* @param array $data
* @since 7.4
*/
public function __unserialize(array $data): void {}
}
RecursiveArrayIterator
/**
* This iterator allows to unset and modify values and keys while iterating over Arrays and Objects
* in the same way as the ArrayIterator. Additionally it is possible to iterate
* over the current iterator entry.
* @link https://php.net/manual/en/class.recursivearrayiterator.php
*/
class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
const CHILD_ARRAYS_ONLY = 4;
/**
* Returns whether current entry is an array or an object.
* @link https://php.net/manual/en/recursivearrayiterator.haschildren.php
* @return bool true if the current entry is an array or an object,
* otherwise false is returned.
*/
public function hasChildren() { }
/**
* Returns an iterator for the current entry if it is an array or an object.
* @link https://php.net/manual/en/recursivearrayiterator.getchildren.php
* @return RecursiveArrayIterator An iterator for the current entry, if it is an array or object.
*/
public function getChildren() { }
}
EmptyIterator
/**
* The EmptyIterator class for an empty iterator.
* @link https://secure.php.net/manual/en/class.emptyiterator.php
*/
class EmptyIterator implements Iterator {
/**
* Return the current element
* @link https://php.net/manual/en/iterator.current.php
* @return mixed Can return any type.
*/
public function current() { }
/**
* Move forward to next element
* @link https://php.net/manual/en/iterator.next.php
* @return void Any returned value is ignored.
*/
public function next() { }
/**
* Return the key of the current element
* @link https://php.net/manual/en/iterator.key.php
* @return string|float|int|bool|null scalar on success, or null on failure.
*/
public function key() { }
/**
* Checks if current position is valid
* @link https://php.net/manual/en/iterator.valid.php
* @return bool The return value will be casted to boolean and then evaluated.
* Returns true on success or false on failure.
*/
public function valid() { }
/**
* Rewind the Iterator to the first element
* @link https://php.net/manual/en/iterator.rewind.php
* @return void Any returned value is ignored.
*/
public function rewind() { }
}
接口
异常
/**
* Exception that represents error in the program logic. This kind of
* exceptions should directly lead to a fix in your code.
* @link https://php.net/manual/en/class.logicexception.php
*/
class LogicException extends Exception {
}
/**
* Exception thrown if a callback refers to an undefined function or if some
* arguments are missing.
* @link https://php.net/manual/en/class.badfunctioncallexception.php
*/
class BadFunctionCallException extends LogicException {
}
/**
* Exception thrown if a callback refers to an undefined method or if some
* arguments are missing.
* @link https://php.net/manual/en/class.badmethodcallexception.php
*/
class BadMethodCallException extends BadFunctionCallException {
}
/**
* Exception thrown if a value does not adhere to a defined valid data domain.
* @link https://php.net/manual/en/class.domainexception.php
*/
class DomainException extends LogicException {
}
/**
* Exception thrown if an argument does not match with the expected value.
* @link https://php.net/manual/en/class.invalidargumentexception.php
*/
class InvalidArgumentException extends LogicException {
}
/**
* Exception thrown if a length is invalid.
* @link https://php.net/manual/en/class.lengthexception.php
*/
class LengthException extends LogicException {
}
/**
* Exception thrown when an illegal index was requested. This represents
* errors that should be detected at compile time.
* @link https://php.net/manual/en/class.outofrangeexception.php
*/
class OutOfRangeException extends LogicException {
}
/**
* Exception thrown if an error which can only be found on runtime occurs.
* @link https://php.net/manual/en/class.runtimeexception.php
*/
class RuntimeException extends Exception {
}
/**
* Exception thrown if a value is not a valid key. This represents errors
* that cannot be detected at compile time.
* @link https://php.net/manual/en/class.outofboundsexception.php
*/
class OutOfBoundsException extends RuntimeException {
}
/**
* Exception thrown when you add an element into a full container.
* @link https://php.net/manual/en/class.overflowexception.php
*/
class OverflowException extends RuntimeException {
}
/**
* Exception thrown to indicate range errors during program execution.
* Normally this means there was an arithmetic error other than
* under/overflow. This is the runtime version of
* <b>DomainException</b>.
* @link https://php.net/manual/en/class.rangeexception.php
*/
class RangeException extends RuntimeException {
}
/**
* Exception thrown when you try to remove an element of an empty container.
* @link https://php.net/manual/en/class.underflowexception.php
*/
class UnderflowException extends RuntimeException {
}
/**
* Exception thrown if a value does not match with a set of values. Typically
* this happens when a function calls another function and expects the return
* value to be of a certain type or value not including arithmetic or buffer
* related errors.
* @link https://php.net/manual/en/class.unexpectedvalueexception.php
*/
class UnexpectedValueException extends RuntimeException {
}
SPL 函数
文件处理
SplFileInfo 类：
class SplFileInfo implements Stringable {
/* 方法 */
public __construct(string $file_name)
public getATime(): int|false
public getBasename(string $suffix = ""): string
public getCTime(): int
public getExtension(): string
public getFileInfo(?string $class = null): SplFileInfo
public getFilename(): string
public getGroup(): int|false
public getInode(): int|false
public getLinkTarget(): string|false
public getMTime(): int|false
public getOwner(): int|false
public getPath(): string
public getPathInfo(?string $class = null): ?SplFileInfo
public getPathname(): string
public getPerms(): int|false
public getRealPath(): string|false
public getSize(): int|false
public getType(): string|false
public isDir(): bool
public isExecutable(): bool
public isFile(): bool
public isLink(): bool
public isReadable(): bool
public isWritable(): bool
public openFile(string $mode = "r", bool $useIncludePath = false, ?resource $context = null): SplFileObject
public setFileClass(string $class = SplFileObject::class): void
public setInfoClass(string $class = SplFileInfo::class): void
public __toString(): string
}
SplFileObject 类：
class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator {
/* 常量 */
const int DROP_NEW_LINE = 1;
const int READ_AHEAD = 2;
const int SKIP_EMPTY = 4;
const int READ_CSV = 8;
/* 方法 */
public __construct(
string $filename,
string $mode = "r",
bool $useIncludePath = false,
?resource $context = null
)
public current(): string|array|false
public eof(): bool
public fflush(): bool
public fgetc(): string|false
public fgetcsv(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): array|false
public fgets(): string
public fgetss(string $allowable_tags = ?): string
public flock(int $operation, int &$wouldBlock = null): bool
public fpassthru(): int
public fputcsv(
array $fields,
string $separator = ",",
string $enclosure = "\"",
string $escape = "\\",
string $eol = "\n"
): int|false
public fread(int $length): string|false
public fscanf(string $format, mixed &...$vars): array|int|null
public fseek(int $offset, int $whence = SEEK_SET): int
public fstat(): array
public ftell(): int|false
public ftruncate(int $size): bool
public fwrite(string $data, int $length = 0): int|false
public getChildren(): ?RecursiveIterator
public getCsvControl(): array
public getFlags(): int
public getMaxLineLen(): int
public hasChildren(): bool
public key(): int
public next(): void
public rewind(): void
public seek(int $line): void
public setCsvControl(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): void
public setFlags(int $flags): void
public setMaxLineLen(int $maxLength): void
public valid(): bool
/* 继承的方法 */
public SplFileInfo::getATime(): int|false
public SplFileInfo::getBasename(string $suffix = ""): string
public SplFileInfo::getCTime(): int
public SplFileInfo::getExtension(): string
public SplFileInfo::getFileInfo(?string $class = null): SplFileInfo
public SplFileInfo::getFilename(): string
public SplFileInfo::getGroup(): int|false
public SplFileInfo::getInode(): int|false
public SplFileInfo::getLinkTarget(): string|false
public SplFileInfo::getMTime(): int|false
public SplFileInfo::getOwner(): int|false
public SplFileInfo::getPath(): string
public SplFileInfo::getPathInfo(?string $class = null): ?SplFileInfo
public SplFileInfo::getPathname(): string
public SplFileInfo::getPerms(): int|false
public SplFileInfo::getRealPath(): string|false
public SplFileInfo::getSize(): int|false
public SplFileInfo::getType(): string|false
public SplFileInfo::isDir(): bool
public SplFileInfo::isExecutable(): bool
public SplFileInfo::isFile(): bool
public SplFileInfo::isLink(): bool
public SplFileInfo::isReadable(): bool
public SplFileInfo::isWritable(): bool
public SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = false, ?resource $context = null): SplFileObject
public SplFileInfo::setFileClass(string $class = SplFileObject::class): void
public SplFileInfo::setInfoClass(string $class = SplFileInfo::class): void
public SplFileInfo::__toString(): string
}
SplTempFileObject 类：
class SplTempFileObject extends SplFileObject {
/* 继承的常量 */
const int SplFileObject::DROP_NEW_LINE = 1;
const int SplFileObject::READ_AHEAD = 2;
const int SplFileObject::SKIP_EMPTY = 4;
const int SplFileObject::READ_CSV = 8;
/* 方法 */
public __construct(int $maxMemory = 2 * 1024 * 1024)
/* 继承的方法 */
public SplFileObject::current(): string|array|false
public SplFileObject::eof(): bool
public SplFileObject::fflush(): bool
public SplFileObject::fgetc(): string|false
public SplFileObject::fgetcsv(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): array|false
public SplFileObject::fgets(): string
public SplFileObject::fgetss(string $allowable_tags = ?): string
public SplFileObject::flock(int $operation, int &$wouldBlock = null): bool
public SplFileObject::fpassthru(): int
public SplFileObject::fputcsv(
array $fields,
string $separator = ",",
string $enclosure = "\"",
string $escape = "\\",
string $eol = "\n"
): int|false
public SplFileObject::fread(int $length): string|false
public SplFileObject::fscanf(string $format, mixed &...$vars): array|int|null
public SplFileObject::fseek(int $offset, int $whence = SEEK_SET): int
public SplFileObject::fstat(): array
public SplFileObject::ftell(): int|false
public SplFileObject::ftruncate(int $size): bool
public SplFileObject::fwrite(string $data, int $length = 0): int|false
public SplFileObject::getChildren(): ?RecursiveIterator
public SplFileObject::getCsvControl(): array
public SplFileObject::getFlags(): int
public SplFileObject::getMaxLineLen(): int
public SplFileObject::hasChildren(): bool
public SplFileObject::key(): int
public SplFileObject::next(): void
public SplFileObject::rewind(): void
public SplFileObject::seek(int $line): void
public SplFileObject::setCsvControl(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): void
public SplFileObject::setFlags(int $flags): void
public SplFileObject::setMaxLineLen(int $maxLength): void
public SplFileObject::valid(): bool
public SplFileInfo::getATime(): int|false
public SplFileInfo::getBasename(string $suffix = ""): string
public SplFileInfo::getCTime(): int
public SplFileInfo::getExtension(): string
public SplFileInfo::getFileInfo(?string $class = null): SplFileInfo
public SplFileInfo::getFilename(): string
public SplFileInfo::getGroup(): int|false
public SplFileInfo::getInode(): int|false
public SplFileInfo::getLinkTarget(): string|false
public SplFileInfo::getMTime(): int|false
public SplFileInfo::getOwner(): int|false
public SplFileInfo::getPath(): string
public SplFileInfo::getPathInfo(?string $class = null): ?SplFileInfo
public SplFileInfo::getPathname(): string
public SplFileInfo::getPerms(): int|false
public SplFileInfo::getRealPath(): string|false
public SplFileInfo::getSize(): int|false
public SplFileInfo::getType(): string|false
public SplFileInfo::isDir(): bool
public SplFileInfo::isExecutable(): bool
public SplFileInfo::isFile(): bool
public SplFileInfo::isLink(): bool
public SplFileInfo::isReadable(): bool
public SplFileInfo::isWritable(): bool
public SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = false, ?resource $context = null): SplFileObject
public SplFileInfo::setFileClass(string $class = SplFileObject::class): void
public SplFileInfo::setInfoClass(string $class = SplFileInfo::class): void
public SplFileInfo::__toString(): string
}
ThinkPHP5 的实现
think/File 类：
<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2018 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <liu21st@gmail.com>
// +----------------------------------------------------------------------
namespace think;
use SplFileObject;
class File extends SplFileObject
{
/**
* @var string 错误信息
*/
private $error = '';
/**
* @var string 当前完整文件名
*/
protected $filename;
/**
* @var string 上传文件名
*/
protected $saveName;
/**
* @var string 文件上传命名规则
*/
protected $rule = 'date';
/**
* @var array 文件上传验证规则
*/
protected $validate = [];
/**
* @var bool 单元测试
*/
protected $isTest;
/**
* @var array 上传文件信息
*/
protected $info;
/**
* @var array 文件 hash 信息
*/
protected $hash = [];
/**
* File constructor.
* @access public
* @param string $filename 文件名称
* @param string $mode 访问模式
*/
public function __construct($filename, $mode = 'r')
{
parent::__construct($filename, $mode);
$this->filename = $this->getRealPath() ?: $this->getPathname();
}
/**
* 设置是否是单元测试
* @access public
* @param bool $test 是否是测试
* @return $this
*/
public function isTest($test = false)
{
$this->isTest = $test;
return $this;
}
/**
* 设置上传信息
* @access public
* @param array $info 上传文件信息
* @return $this
*/
public function setUploadInfo($info)
{
$this->info = $info;
return $this;
}
/**
* 获取上传文件的信息
* @access public
* @param string $name 信息名称
* @return array|string
*/
public function getInfo($name = '')
{
return isset($this->info[$name]) ? $this->info[$name] : $this->info;
}
/**
* 获取上传文件的文件名
* @access public
* @return string
*/
public function getSaveName()
{
return $this->saveName;
}
/**
* 设置上传文件的保存文件名
* @access public
* @param string $saveName 保存名称
* @return $this
*/
public function setSaveName($saveName)
{
$this->saveName = $saveName;
return $this;
}
/**
* 获取文件的哈希散列值
* @access public
* @param string $type 类型
* @return string
*/
public function hash($type = 'sha1')
{
if (!isset($this->hash[$type])) {
$this->hash[$type] = hash_file($type, $this->filename);
}
return $this->hash[$type];
}
/**
* 检查目录是否可写
* @access protected
* @param string $path 目录
* @return boolean
*/
protected function checkPath($path)
{
if (is_dir($path) || mkdir($path, 0755, true)) {
return true;
}
$this->error = ['directory {:path} creation failed', ['path' => $path]];
return false;
}
/**
* 获取文件类型信息
* @access public
* @return string
*/
public function getMime()
{
$finfo = finfo_open(FILEINFO_MIME_TYPE);
return finfo_file($finfo, $this->filename);
}
/**
* 设置文件的命名规则
* @access public
* @param string $rule 文件命名规则
* @return $this
*/
public function rule($rule)
{
$this->rule = $rule;
return $this;
}
/**
* 设置上传文件的验证规则
* @access public
* @param array $rule 验证规则
* @return $this
*/
public function validate(array $rule = [])
{
$this->validate = $rule;
return $this;
}
/**
* 检测是否合法的上传文件
* @access public
* @return bool
*/
public function isValid()
{
return $this->isTest ? is_file($this->filename) : is_uploaded_file($this->filename);
}
/**
* 检测上传文件
* @access public
* @param array $rule 验证规则
* @return bool
*/
public function check($rule = [])
{
$rule = $rule ?: $this->validate;
/* 检查文件大小 */
if (isset($rule['size']) && !$this->checkSize($rule['size'])) {
$this->error = 'filesize not match';
return false;
}
/* 检查文件 Mime 类型 */
if (isset($rule['type']) && !$this->checkMime($rule['type'])) {
$this->error = 'mimetype to upload is not allowed';
return false;
}
/* 检查文件后缀 */
if (isset($rule['ext']) && !$this->checkExt($rule['ext'])) {
$this->error = 'extensions to upload is not allowed';
return false;
}
/* 检查图像文件 */
if (!$this->checkImg()) {
$this->error = 'illegal image files';
return false;
}
return true;
}
/**
* 检测上传文件后缀
* @access public
* @param array|string $ext 允许后缀
* @return bool
*/
public function checkExt($ext)
{
if (is_string($ext)) {
$ext = explode(',', $ext);
}
$extension = strtolower(pathinfo($this->getInfo('name'), PATHINFO_EXTENSION));
return in_array($extension, $ext);
}
/**
* 检测图像文件
* @access public
* @return bool
*/
public function checkImg()
{
$extension = strtolower(pathinfo($this->getInfo('name'), PATHINFO_EXTENSION));
// 如果上传的不是图片，或者是图片而且后缀确实符合图片类型则返回 true
return !in_array($extension, ['gif', 'jpg', 'jpeg', 'bmp', 'png', 'swf']) || in_array($this->getImageType($this->filename), [1, 2, 3, 4, 6, 13]);
}
/**
* 判断图像类型
* @access protected
* @param string $image 图片名称
* @return bool|int
*/
protected function getImageType($image)
{
if (function_exists('exif_imagetype')) {
return exif_imagetype($image);
}
try {
$info = getimagesize($image);
return $info ? $info[2] : false;
} catch (\Exception $e) {
return false;
}
}
/**
* 检测上传文件大小
* @access public
* @param integer $size 最大大小
* @return bool
*/
public function checkSize($size)
{
return $this->getSize() <= $size;
}
/**
* 检测上传文件类型
* @access public
* @param array|string $mime 允许类型
* @return bool
*/
public function checkMime($mime)
{
$mime = is_string($mime) ? explode(',', $mime) : $mime;
return in_array(strtolower($this->getMime()), $mime);
}
/**
* 移动文件
* @access public
* @param string $path 保存路径
* @param string|bool $savename 保存的文件名 默认自动生成
* @param boolean $replace 同名文件是否覆盖
* @return false|File
*/
public function move($path, $savename = true, $replace = true)
{
// 文件上传失败，捕获错误代码
if (!empty($this->info['error'])) {
$this->error($this->info['error']);
return false;
}
// 检测合法性
if (!$this->isValid()) {
$this->error = 'upload illegal files';
return false;
}
// 验证上传
if (!$this->check()) {
return false;
}
$path = rtrim($path, DS) . DS;
// 文件保存命名规则
$saveName = $this->buildSaveName($savename);
$filename = $path . $saveName;
// 检测目录
if (false === $this->checkPath(dirname($filename))) {
return false;
}
// 不覆盖同名文件
if (!$replace && is_file($filename)) {
$this->error = ['has the same filename: {:filename}', ['filename' => $filename]];
return false;
}
/* 移动文件 */
if ($this->isTest) {
rename($this->filename, $filename);
} elseif (!move_uploaded_file($this->filename, $filename)) {
$this->error = 'upload write error';
return false;
}
// 返回 File 对象实例
$file = new self($filename);
$file->setSaveName($saveName)->setUploadInfo($this->info);
return $file;
}
/**
* 获取保存文件名
* @access protected
* @param string|bool $savename 保存的文件名 默认自动生成
* @return string
*/
protected function buildSaveName($savename)
{
// 自动生成文件名
if (true === $savename) {
if ($this->rule instanceof \Closure) {
$savename = call_user_func_array($this->rule, [$this]);
} else {
switch ($this->rule) {
case 'date':
$savename = date('Ymd') . DS . md5(microtime(true));
break;
default:
if (in_array($this->rule, hash_algos())) {
$hash = $this->hash($this->rule);
$savename = substr($hash, 0, 2) . DS . substr($hash, 2);
} elseif (is_callable($this->rule)) {
$savename = call_user_func($this->rule);
} else {
$savename = date('Ymd') . DS . md5(microtime(true));
}
}
}
} elseif ('' === $savename || false === $savename) {
$savename = $this->getInfo('name');
}
if (!strpos($savename, '.')) {
$savename .= '.' . pathinfo($this->getInfo('name'), PATHINFO_EXTENSION);
}
return $savename;
}
/**
* 获取错误代码信息
* @access private
* @param int $errorNo 错误号
* @return $this
*/
private function error($errorNo)
{
switch ($errorNo) {
case 1:
case 2:
$this->error = 'upload File size exceeds the maximum value';
break;
case 3:
$this->error = 'only the portion of file is uploaded';
break;
case 4:
$this->error = 'no file to uploaded';
break;
case 6:
$this->error = 'upload temp dir not found';
break;
case 7:
$this->error = 'file write error';
break;
default:
$this->error = 'unknown upload error';
}
return $this;
}
/**
* 获取错误信息（支持多语言）
* @access public
* @return string
*/
public function getError()
{
if (is_array($this->error)) {
list($msg, $vars) = $this->error;
} else {
$msg = $this->error;
$vars = [];
}
return Lang::has($msg) ? Lang::get($msg, $vars) : $msg;
}
/**
* 魔法方法，获取文件的 hash 值
* @access public
* @param string $method 方法名
* @param mixed $args 调用参数
* @return string
*/
public function __call($method, $args)
{
return $this->hash($method);
}
}
think/Request 类中 file() 方法部分：
<?php
namespace think;
class Request
{
/**
* @var object 对象实例
*/
protected static $instance;
protected $method;
/**
* @var string 域名（含协议和端口）
*/
protected $domain;
/**
* @var string URL地址
*/
protected $url;
/**
* @var string 基础URL
*/
protected $baseUrl;
/**
* @var string 当前执行的文件
*/
protected $baseFile;
/**
* @var string 访问的ROOT地址
*/
protected $root;
/**
* @var string pathinfo
*/
protected $pathinfo;
/**
* @var string pathinfo（不含后缀）
*/
protected $path;
/**
* @var array 当前路由信息
*/
protected $routeInfo = [];
/**
* @var array 环境变量
*/
protected $env;
/**
* @var array 当前调度信息
*/
protected $dispatch = [];
protected $module;
protected $controller;
protected $action;
// 当前语言集
protected $langset;
/**
* @var array 请求参数
*/
protected $param = [];
protected $get = [];
protected $post = [];
protected $request = [];
protected $route = [];
protected $put;
protected $session = [];
protected $file = [];
protected $cookie = [];
protected $server = [];
protected $header = [];
/* 省略若干 */
/**
* 获取上传的文件信息
* @access public
* @param string|array $name 名称
* @return null|array|\think\File
*/
public function file($name = '')
{
if (empty($this->file)) {
$this->file = isset($_FILES) ? $_FILES : [];
}
if (is_array($name)) {
return $this->file = array_merge($this->file, $name);
}
$files = $this->file;
if (!empty($files)) {
// 处理上传文件
$array = [];
foreach ($files as $key => $file) {
if (is_array($file['name'])) {
$item = [];
$keys = array_keys($file);
$count = count($file['name']);
for ($i = 0; $i < $count; $i++) {
if (empty($file['tmp_name'][$i]) || !is_file($file['tmp_name'][$i])) {
continue;
}
$temp['key'] = $key;
foreach ($keys as $_key) {
$temp[$_key] = $file[$_key][$i];
}
$item[] = (new File($temp['tmp_name']))->setUploadInfo($temp);
}
$array[$key] = $item;
} else {
if ($file instanceof File) {
$array[$key] = $file;
} else {
if (empty($file['tmp_name']) || !is_file($file['tmp_name'])) {
continue;
}
$array[$key] = (new File($file['tmp_name']))->setUploadInfo($file);
}
}
}
if (strpos($name, '.')) {
list($name, $sub) = explode('.', $name);
}
if ('' === $name) {
// 获取全部文件
return $array;
} elseif (isset($sub) && isset($array[$name][$sub])) {
return $array[$name][$sub];
} elseif (isset($array[$name])) {
return $array[$name];
}
}
return;
}
}
各种类及接口
ArrayObject
/**
* This class allows objects to work as arrays.
* @link https://php.net/manual/en/class.arrayobject.php
*/
class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Countable {
/**
* Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.).
*/
const STD_PROP_LIST = 1;
/**
* Entries can be accessed as properties (read and write).
*/
const ARRAY_AS_PROPS = 2;
/**
* Construct a new array object
* @link https://php.net/manual/en/arrayobject.construct.php
* @param array|object $array The input parameter accepts an array or an Object.
* @param int $flags Flags to control the behaviour of the ArrayObject object.
* @param string $iteratorClass Specify the class that will be used for iteration of the ArrayObject object. ArrayIterator is the default class used.
*
*/
public function __construct($array = array(), $flags = 0, $iteratorClass = "ArrayIterator") { }
/**
* Returns whether the requested index exists
* @link https://php.net/manual/en/arrayobject.offsetexists.php
* @param mixed $key <p>
* The index being checked.
* </p>
* @return bool true if the requested index exists, otherwise false
*/
public function offsetExists($key) { }
/**
* Returns the value at the specified index
* @link https://php.net/manual/en/arrayobject.offsetget.php
* @param mixed $key <p>
* The index with the value.
* </p>
* @return mixed|false The value at the specified index or false.
*/
public function offsetGet($key) { }
/**
* Sets the value at the specified index to newval
* @link https://php.net/manual/en/arrayobject.offsetset.php
* @param mixed $key <p>
* The index being set.
* </p>
* @param mixed $value <p>
* The new value for the <i>index</i>.
* </p>
* @return void
*/
public function offsetSet($key, $value) { }
/**
* Unsets the value at the specified index
* @link https://php.net/manual/en/arrayobject.offsetunset.php
* @param mixed $key <p>
* The index being unset.
* </p>
* @return void
*/
public function offsetUnset($key) { }
/**
* Appends the value
* @link https://php.net/manual/en/arrayobject.append.php
* @param mixed $value <p>
* The value being appended.
* </p>
* @return void
*/
public function append($value) { }
/**
* Creates a copy of the ArrayObject.
* @link https://php.net/manual/en/arrayobject.getarraycopy.php
* @return array a copy of the array. When the <b>ArrayObject</b> refers to an object
* an array of the public properties of that object will be returned.
*/
public function getArrayCopy() { }
/**
* Get the number of public properties in the ArrayObject
* When the <b>ArrayObject</b> is constructed from an array all properties are public.
* @link https://php.net/manual/en/arrayobject.count.php
* @return int The number of public properties in the ArrayObject.
*/
public function count() { }
/**
* Gets the behavior flags.
* @link https://php.net/manual/en/arrayobject.getflags.php
* @return int the behavior flags of the ArrayObject.
*/
public function getFlags() { }
/**
* Sets the behavior flags.
* @link https://php.net/manual/en/arrayobject.setflags.php
* @param int $flags <p>
* The new ArrayObject behavior.
* It takes on either a bitmask, or named constants. Using named
* constants is strongly encouraged to ensure compatibility for future
* versions.
* </p>
* <p>
* The available behavior flags are listed below. The actual
* meanings of these flags are described in the
* predefined constants.
* <table>
* ArrayObject behavior flags
* <tr valign="top">
* <td>value</td>
* <td>constant</td>
* </tr>
* <tr valign="top">
* <td>1</td>
* <td>
* ArrayObject::STD_PROP_LIST
* </td>
* </tr>
* <tr valign="top">
* <td>2</td>
* <td>
* ArrayObject::ARRAY_AS_PROPS
* </td>
* </tr>
* </table>
* </p>
* @return void
*/
public function setFlags($flags) { }
/**
* Sort the entries by value
* @link https://php.net/manual/en/arrayobject.asort.php
* @param int $flags [optional]
* @return void
*/
public function asort($flags = SORT_REGULAR) { }
/**
* Sort the entries by key
* @link https://php.net/manual/en/arrayobject.ksort.php
* @param int $flags [optional]
* @return void
*/
public function ksort($flags = SORT_REGULAR) { }
/**
* Sort the entries with a user-defined comparison function and maintain key association
* @link https://php.net/manual/en/arrayobject.uasort.php
* @param callback $callback <p>
* Function <i>cmp_function</i> should accept two
* parameters which will be filled by pairs of entries.
* The comparison function must return an integer less than, equal
* to, or greater than zero if the first argument is considered to
* be respectively less than, equal to, or greater than the
* second.
* </p>
* @return void
*/
public function uasort($callback) { }
/**
* Sort the entries by keys using a user-defined comparison function
* @link https://php.net/manual/en/arrayobject.uksort.php
* @param callback $callback <p>
* The callback comparison function.
* </p>
* <p>
* Function <i>cmp_function</i> should accept two
* parameters which will be filled by pairs of entry keys.
* The comparison function must return an integer less than, equal
* to, or greater than zero if the first argument is considered to
* be respectively less than, equal to, or greater than the
* second.
* </p>
* @return void
*/
public function uksort($callback) { }
/**
* Sort entries using a "natural order" algorithm
* @link https://php.net/manual/en/arrayobject.natsort.php
* @return void
*/
public function natsort() { }
/**
* Sort an array using a case insensitive "natural order" algorithm
* @link https://php.net/manual/en/arrayobject.natcasesort.php
* @return void
*/
public function natcasesort() { }
/**
* Unserialize an ArrayObject
* @link https://php.net/manual/en/arrayobject.unserialize.php
* @param string $data <p>
* The serialized <b>ArrayObject</b>.
* </p>
* @return void The unserialized <b>ArrayObject</b>.
*/
public function unserialize($data) { }
/**
* Serialize an ArrayObject
* @link https://php.net/manual/en/arrayobject.serialize.php
* @return string The serialized representation of the <b>ArrayObject</b>.
*/
public function serialize() { }
/**
* @return array
* @since 7.4
*/
public function __debugInfo(){}
/**
* @return array
* @since 7.4
*/
public function __serialize(): array {}
/**
* @param array $data
* @since 7.4
*/
public function __unserialize(array $data): void {}
/**
* Create a new iterator from an ArrayObject instance
* @link https://php.net/manual/en/arrayobject.getiterator.php
* @return ArrayIterator An iterator from an <b>ArrayObject</b>.
*/
public function getIterator() { }
/**
* Exchange the array for another one.
* @link https://php.net/manual/en/arrayobject.exchangearray.php
* @param mixed $array <p>
* The new array or object to exchange with the current array.
* </p>
* @return array the old array.
*/
public function exchangeArray($array) { }
/**
* Sets the iterator classname for the ArrayObject.
* @link https://php.net/manual/en/arrayobject.setiteratorclass.php
* @param string $iteratorClass <p>
* The classname of the array iterator to use when iterating over this object.
* </p>
* @return void
*/
public function setIteratorClass($iteratorClass) { }
/**
* Gets the iterator classname for the ArrayObject.
* @link https://php.net/manual/en/arrayobject.getiteratorclass.php
* @return string the iterator class name that is used to iterate over this object.
*/
public function getIteratorClass() { }
}
附图
参考资料
PHP 手册 函数参考 其它基本扩展 PHP标准库 (SPL) https://www.php.net/manual/zh/book.spl.php
PHP 手册 语言参考 预定义接口 https://www.php.net/manual/zh/reserved.interfaces.php
视频 php入门到不放弃34-标准库SPL介绍 https://haokan.baidu.com/v?pd=wisenatural&vid=336462461276701203