2242 lines
74 KiB
PHP
2242 lines
74 KiB
PHP
<?php
|
|
|
|
// Start of SPL v.0.2
|
|
|
|
/**
|
|
* The SplFileInfo class offers a high-level object oriented interface to
|
|
* information for an individual file.
|
|
* @link https://php.net/manual/en/class.splfileinfo.php
|
|
*/
|
|
class SplFileInfo {
|
|
|
|
/**
|
|
* Construct a new SplFileInfo object
|
|
* @link https://php.net/manual/en/splfileinfo.construct.php
|
|
* @param $file_name
|
|
* @since 5.1.2
|
|
*/
|
|
public function __construct ($file_name) {}
|
|
|
|
/**
|
|
* Gets the path without filename
|
|
* @link https://php.net/manual/en/splfileinfo.getpath.php
|
|
* @return string the path to the file.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getPath () {}
|
|
|
|
/**
|
|
* Gets the filename
|
|
* @link https://php.net/manual/en/splfileinfo.getfilename.php
|
|
* @return string The filename.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getFilename () {}
|
|
|
|
/**
|
|
* Gets the file extension
|
|
* @link https://php.net/manual/en/splfileinfo.getextension.php
|
|
* @return string a string containing the file extension, or an
|
|
* empty string if the file has no extension.
|
|
* @since 5.3.6
|
|
*/
|
|
public function getExtension () {}
|
|
|
|
/**
|
|
* Gets the base name of the file
|
|
* @link https://php.net/manual/en/splfileinfo.getbasename.php
|
|
* @param string $suffix [optional] <p>
|
|
* Optional suffix to omit from the base name returned.
|
|
* </p>
|
|
* @return string the base name without path information.
|
|
* @since 5.2.2
|
|
*/
|
|
public function getBasename ($suffix = null) {}
|
|
|
|
/**
|
|
* Gets the path to the file
|
|
* @link https://php.net/manual/en/splfileinfo.getpathname.php
|
|
* @return string The path to the file.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getPathname () {}
|
|
|
|
/**
|
|
* Gets file permissions
|
|
* @link https://php.net/manual/en/splfileinfo.getperms.php
|
|
* @return int the file permissions.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getPerms () {}
|
|
|
|
/**
|
|
* Gets the inode for the file
|
|
* @link https://php.net/manual/en/splfileinfo.getinode.php
|
|
* @return int the inode number for the filesystem object.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getInode () {}
|
|
|
|
/**
|
|
* Gets file size
|
|
* @link https://php.net/manual/en/splfileinfo.getsize.php
|
|
* @return int The filesize in bytes.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getSize () {}
|
|
|
|
/**
|
|
* Gets the owner of the file
|
|
* @link https://php.net/manual/en/splfileinfo.getowner.php
|
|
* @return int The owner id in numerical format.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getOwner () {}
|
|
|
|
/**
|
|
* Gets the file group
|
|
* @link https://php.net/manual/en/splfileinfo.getgroup.php
|
|
* @return int The group id in numerical format.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getGroup () {}
|
|
|
|
/**
|
|
* Gets last access time of the file
|
|
* @link https://php.net/manual/en/splfileinfo.getatime.php
|
|
* @return int the time the file was last accessed.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getATime () {}
|
|
|
|
/**
|
|
* Gets the last modified time
|
|
* @link https://php.net/manual/en/splfileinfo.getmtime.php
|
|
* @return int the last modified time for the file, in a Unix timestamp.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getMTime () {}
|
|
|
|
/**
|
|
* Gets the inode change time
|
|
* @link https://php.net/manual/en/splfileinfo.getctime.php
|
|
* @return int The last change time, in a Unix timestamp.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getCTime () {}
|
|
|
|
/**
|
|
* Gets file type
|
|
* @link https://php.net/manual/en/splfileinfo.gettype.php
|
|
* @return string A string representing the type of the entry.
|
|
* May be one of file, link,
|
|
* or dir
|
|
* @since 5.1.2
|
|
*/
|
|
public function getType () {}
|
|
|
|
/**
|
|
* Tells if the entry is writable
|
|
* @link https://php.net/manual/en/splfileinfo.iswritable.php
|
|
* @return bool true if writable, false otherwise;
|
|
* @since 5.1.2
|
|
*/
|
|
public function isWritable () {}
|
|
|
|
/**
|
|
* Tells if file is readable
|
|
* @link https://php.net/manual/en/splfileinfo.isreadable.php
|
|
* @return bool true if readable, false otherwise.
|
|
* @since 5.1.2
|
|
*/
|
|
public function isReadable () {}
|
|
|
|
/**
|
|
* Tells if the file is executable
|
|
* @link https://php.net/manual/en/splfileinfo.isexecutable.php
|
|
* @return bool true if executable, false otherwise.
|
|
* @since 5.1.2
|
|
*/
|
|
public function isExecutable () {}
|
|
|
|
/**
|
|
* Tells if the object references a regular file
|
|
* @link https://php.net/manual/en/splfileinfo.isfile.php
|
|
* @return bool true if the file exists and is a regular file (not a link), false otherwise.
|
|
* @since 5.1.2
|
|
*/
|
|
public function isFile () {}
|
|
|
|
/**
|
|
* Tells if the file is a directory
|
|
* @link https://php.net/manual/en/splfileinfo.isdir.php
|
|
* @return bool true if a directory, false otherwise.
|
|
* @since 5.1.2
|
|
*/
|
|
public function isDir () {}
|
|
|
|
/**
|
|
* Tells if the file is a link
|
|
* @link https://php.net/manual/en/splfileinfo.islink.php
|
|
* @return bool true if the file is a link, false otherwise.
|
|
* @since 5.1.2
|
|
*/
|
|
public function isLink () {}
|
|
|
|
/**
|
|
* Gets the target of a link
|
|
* @link https://php.net/manual/en/splfileinfo.getlinktarget.php
|
|
* @return string the target of the filesystem link.
|
|
* @since 5.2.2
|
|
*/
|
|
public function getLinkTarget () {}
|
|
|
|
/**
|
|
* Gets absolute path to file
|
|
* @link https://php.net/manual/en/splfileinfo.getrealpath.php
|
|
* @return string|false the path to the file, or <b>FALSE</b> if the file does not exist.
|
|
* @since 5.2.2
|
|
*/
|
|
public function getRealPath () {}
|
|
|
|
/**
|
|
* Gets an SplFileInfo object for the file
|
|
* @link https://php.net/manual/en/splfileinfo.getfileinfo.php
|
|
* @param string $class_name [optional] <p>
|
|
* Name of an <b>SplFileInfo</b> derived class to use.
|
|
* </p>
|
|
* @return SplFileInfo An <b>SplFileInfo</b> object created for the file.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getFileInfo ($class_name = null) {}
|
|
|
|
/**
|
|
* Gets an SplFileInfo object for the path
|
|
* @link https://php.net/manual/en/splfileinfo.getpathinfo.php
|
|
* @param string $class_name [optional] <p>
|
|
* Name of an <b>SplFileInfo</b> derived class to use.
|
|
* </p>
|
|
* @return SplFileInfo an <b>SplFileInfo</b> object for the parent path of the file.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getPathInfo ($class_name = null) {}
|
|
|
|
/**
|
|
* Gets an SplFileObject object for the file
|
|
* @link https://php.net/manual/en/splfileinfo.openfile.php
|
|
* @param string $open_mode [optional] <p>
|
|
* The mode for opening the file. See the <b>fopen</b>
|
|
* documentation for descriptions of possible modes. The default
|
|
* is read only.
|
|
* </p>
|
|
* @param bool $use_include_path [optional] <p>
|
|
* ¶meter.use_include_path;
|
|
* </p>
|
|
* @param resource $context [optional] <p>
|
|
* ¶meter.context;
|
|
* </p>
|
|
* @return SplFileObject The opened file as an <b>SplFileObject</b> object.
|
|
* @since 5.1.2
|
|
*/
|
|
public function openFile ($open_mode = 'r', $use_include_path = false, $context = null) {}
|
|
|
|
/**
|
|
* Sets the class name used with <b>SplFileInfo::openFile</b>
|
|
* @link https://php.net/manual/en/splfileinfo.setfileclass.php
|
|
* @param string $class_name [optional] <p>
|
|
* The class name to use when openFile() is called.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.2
|
|
*/
|
|
public function setFileClass ($class_name = null) {}
|
|
|
|
/**
|
|
* Sets the class used with getFileInfo and getPathInfo
|
|
* @link https://php.net/manual/en/splfileinfo.setinfoclass.php
|
|
* @param string $class_name [optional] <p>
|
|
* The class name to use.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.2
|
|
*/
|
|
public function setInfoClass ($class_name = null) {}
|
|
|
|
/**
|
|
* Returns the path to the file as a string
|
|
* @link https://php.net/manual/en/splfileinfo.tostring.php
|
|
* @return string the path to the file.
|
|
* @since 5.1.2
|
|
*/
|
|
public function __toString () {}
|
|
|
|
public final function _bad_state_ex (){}
|
|
|
|
public function __wakeup() {}
|
|
}
|
|
|
|
/**
|
|
* The DirectoryIterator class provides a simple interface for viewing
|
|
* the contents of filesystem directories.
|
|
* @link https://php.net/manual/en/class.directoryiterator.php
|
|
*/
|
|
class DirectoryIterator extends SplFileInfo implements SeekableIterator {
|
|
|
|
/**
|
|
* Constructs a new directory iterator from a path
|
|
* @link https://php.net/manual/en/directoryiterator.construct.php
|
|
* @param $path
|
|
* @throws UnexpectedValueException if the path cannot be opened.
|
|
* @throws RuntimeException if the path is an empty string.
|
|
* @since 5.0
|
|
*/
|
|
public function __construct ($path) {}
|
|
|
|
|
|
/**
|
|
* Determine if current DirectoryIterator item is '.' or '..'
|
|
* @link https://php.net/manual/en/directoryiterator.isdot.php
|
|
* @return bool true if the entry is . or ..,
|
|
* otherwise false
|
|
* @since 5.0
|
|
*/
|
|
public function isDot () {}
|
|
|
|
/**
|
|
* Rewind the DirectoryIterator back to the start
|
|
* @link https://php.net/manual/en/directoryiterator.rewind.php
|
|
* @return void
|
|
* @since 5.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Check whether current DirectoryIterator position is a valid file
|
|
* @link https://php.net/manual/en/directoryiterator.valid.php
|
|
* @return bool true if the position is valid, otherwise false
|
|
* @since 5.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Return the key for the current DirectoryIterator item
|
|
* @link https://php.net/manual/en/directoryiterator.key.php
|
|
* @return string The key for the current <b>DirectoryIterator</b> item.
|
|
* @since 5.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Return the current DirectoryIterator item.
|
|
* @link https://php.net/manual/en/directoryiterator.current.php
|
|
* @return DirectoryIterator The current <b>DirectoryIterator</b> item.
|
|
* @since 5.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Move forward to next DirectoryIterator item
|
|
* @link https://php.net/manual/en/directoryiterator.next.php
|
|
* @return void
|
|
* @since 5.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Seek to a DirectoryIterator item
|
|
* @link https://php.net/manual/en/directoryiterator.seek.php
|
|
* @param int $position <p>
|
|
* The zero-based numeric position to seek to.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function seek ($position) {}
|
|
}
|
|
|
|
/**
|
|
* The Filesystem iterator
|
|
* @link https://php.net/manual/en/class.filesystemiterator.php
|
|
*/
|
|
class FilesystemIterator extends DirectoryIterator {
|
|
const CURRENT_MODE_MASK = 240;
|
|
const CURRENT_AS_PATHNAME = 32;
|
|
const CURRENT_AS_FILEINFO = 0;
|
|
const CURRENT_AS_SELF = 16;
|
|
const KEY_MODE_MASK = 3840;
|
|
const KEY_AS_PATHNAME = 0;
|
|
const FOLLOW_SYMLINKS = 512;
|
|
const KEY_AS_FILENAME = 256;
|
|
const NEW_CURRENT_AND_KEY = 256;
|
|
const SKIP_DOTS = 4096;
|
|
const UNIX_PATHS = 8192;
|
|
const OTHER_MODE_MASK = 12288;
|
|
|
|
/**
|
|
* Constructs a new filesystem iterator
|
|
* @link https://php.net/manual/en/filesystemiterator.construct.php
|
|
* @param $path
|
|
* @param $flags [optional]
|
|
* @throws UnexpectedValueException if the path cannot be found.
|
|
* @since 5.3.0
|
|
*/
|
|
public function __construct ($path, $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS) {}
|
|
|
|
/**
|
|
* Rewinds back to the beginning
|
|
* @link https://php.net/manual/en/filesystemiterator.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Move to the next file
|
|
* @link https://php.net/manual/en/filesystemiterator.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Retrieve the key for the current file
|
|
* @link https://php.net/manual/en/filesystemiterator.key.php
|
|
* @return string the pathname or filename depending on the set flags.
|
|
* See the FilesystemIterator constants.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* The current file
|
|
* @link https://php.net/manual/en/filesystemiterator.current.php
|
|
* @return mixed The filename, file information, or $this depending on the set flags.
|
|
* See the FilesystemIterator constants.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Get the handling flags
|
|
* @link https://php.net/manual/en/filesystemiterator.getflags.php
|
|
* @return int The integer value of the set flags.
|
|
* @since 5.3.0
|
|
*/
|
|
public function getFlags () {}
|
|
|
|
/**
|
|
* Sets handling flags
|
|
* @link https://php.net/manual/en/filesystemiterator.setflags.php
|
|
* @param int $flags [optional] <p>
|
|
* The handling flags to set.
|
|
* See the FilesystemIterator constants.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function setFlags ($flags = null) {}
|
|
}
|
|
|
|
/**
|
|
* The <b>RecursiveDirectoryIterator</b> provides
|
|
* an interface for iterating recursively over filesystem directories.
|
|
* @link https://php.net/manual/en/class.recursivedirectoryiterator.php
|
|
*/
|
|
class RecursiveDirectoryIterator extends FilesystemIterator implements RecursiveIterator {
|
|
|
|
|
|
/**
|
|
* Constructs a RecursiveDirectoryIterator
|
|
* @link https://php.net/manual/en/recursivedirectoryiterator.construct.php
|
|
* @param $path
|
|
* @param $flags [optional]
|
|
* @throws UnexpectedValueException if the path cannot be found or is not a directory.
|
|
* @since 5.1.2
|
|
*/
|
|
public function __construct ($path, $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO) {}
|
|
|
|
/**
|
|
* Returns whether current entry is a directory and not '.' or '..'
|
|
* @link https://php.net/manual/en/recursivedirectoryiterator.haschildren.php
|
|
* @param bool $allow_links [optional] <p>
|
|
* </p>
|
|
* @return bool whether the current entry is a directory, but not '.' or '..'
|
|
* @since 5.0
|
|
*/
|
|
public function hasChildren ($allow_links = null) {}
|
|
|
|
/**
|
|
* Returns an iterator for the current entry if it is a directory
|
|
* @link https://php.net/manual/en/recursivedirectoryiterator.getchildren.php
|
|
* @return object An iterator for the current entry, if it is a directory.
|
|
* @since 5.1.0
|
|
*/
|
|
public function getChildren () {}
|
|
|
|
/**
|
|
* Get sub path
|
|
* @link https://php.net/manual/en/recursivedirectoryiterator.getsubpath.php
|
|
* @return string The sub path (sub directory).
|
|
* @since 5.1.0
|
|
*/
|
|
public function getSubPath () {}
|
|
|
|
/**
|
|
* Get sub path and name
|
|
* @link https://php.net/manual/en/recursivedirectoryiterator.getsubpathname.php
|
|
* @return string The sub path (sub directory) and filename.
|
|
* @since 5.1.0
|
|
*/
|
|
public function getSubPathname () {}
|
|
|
|
/**
|
|
* Rewinds back to the beginning
|
|
* @link https://php.net/manual/en/filesystemiterator.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Move to the next file
|
|
* @link https://php.net/manual/en/filesystemiterator.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Retrieve the key for the current file
|
|
* @link https://php.net/manual/en/filesystemiterator.key.php
|
|
* @return string the pathname or filename depending on the set flags.
|
|
* See the FilesystemIterator constants.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* The current file
|
|
* @link https://php.net/manual/en/filesystemiterator.current.php
|
|
* @return mixed The filename, file information, or $this depending on the set flags.
|
|
* See the FilesystemIterator constants.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
}
|
|
|
|
/**
|
|
* Iterates through a file system in a similar fashion to
|
|
* <b>glob</b>.
|
|
* @link https://php.net/manual/en/class.globiterator.php
|
|
*/
|
|
class GlobIterator extends FilesystemIterator implements Countable {
|
|
|
|
/**
|
|
* Construct a directory using glob
|
|
* @link https://php.net/manual/en/globiterator.construct.php
|
|
* @param $path
|
|
* @param $flags [optional]
|
|
* @since 5.3.0
|
|
*/
|
|
public function __construct ($path, $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO) {}
|
|
|
|
/**
|
|
* Get the number of directories and files
|
|
* @link https://php.net/manual/en/globiterator.count.php
|
|
* @return int The number of returned directories and files, as an
|
|
* integer.
|
|
* @since 5.3.0
|
|
*/
|
|
public function count () {}
|
|
}
|
|
|
|
/**
|
|
* The SplFileObject class offers an object oriented interface for a file.
|
|
* @link https://php.net/manual/en/class.splfileobject.php
|
|
*/
|
|
class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator {
|
|
/**
|
|
* Drop newlines at the end of a line.
|
|
*/
|
|
const DROP_NEW_LINE = 1;
|
|
/**
|
|
* Read on rewind/next.
|
|
*/
|
|
const READ_AHEAD = 2;
|
|
/**
|
|
* Skip empty lines in the file. This requires the {@see READ_AHEAD} flag to work as expected.
|
|
*/
|
|
const SKIP_EMPTY = 4;
|
|
/**
|
|
* Read lines as CSV rows.
|
|
*/
|
|
const READ_CSV = 8;
|
|
|
|
|
|
/**
|
|
* Construct a new file object.
|
|
*
|
|
* @link https://php.net/manual/en/splfileobject.construct.php
|
|
*
|
|
* @param string $file_name The file to open
|
|
* @param string $open_mode [optional] The mode in which to open the file. See {@see fopen} for a list of allowed modes.
|
|
* @param bool $use_include_path [optional] Whether to search in the include_path for filename
|
|
* @param resource $context [optional] A valid context resource created with {@see stream_context_create}
|
|
*
|
|
* @throws RuntimeException When the filename cannot be opened
|
|
* @throws LogicException When the filename is a directory
|
|
*
|
|
* @since 5.1.0
|
|
*/
|
|
public function __construct ($file_name, $open_mode = 'r', $use_include_path = false, $context = null) {}
|
|
|
|
/**
|
|
* Rewind the file to the first line
|
|
* @link https://php.net/manual/en/splfileobject.rewind.php
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Reached end of file
|
|
* @link https://php.net/manual/en/splfileobject.eof.php
|
|
* @return bool true if file is at EOF, false otherwise.
|
|
* @since 5.1.0
|
|
*/
|
|
public function eof () {}
|
|
|
|
/**
|
|
* Not at EOF
|
|
* @link https://php.net/manual/en/splfileobject.valid.php
|
|
* @return bool true if not reached EOF, false otherwise.
|
|
* @since 5.1.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Gets line from file
|
|
* @link https://php.net/manual/en/splfileobject.fgets.php
|
|
* @return string|false a string containing the next line from the file, or false on error.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fgets () {}
|
|
|
|
/**
|
|
* Read from file
|
|
* @link https://php.net/manual/en/splfileobject.fread.php
|
|
* @param int $length <p>
|
|
* The number of bytes to read.
|
|
* </p>
|
|
* @return string|false returns the string read from the file or FALSE on failure.
|
|
* @since 5.5.11
|
|
*/
|
|
public function fread ($length) {}
|
|
|
|
/**
|
|
* Gets line from file and parse as CSV fields
|
|
* @link https://php.net/manual/en/splfileobject.fgetcsv.php
|
|
* @param string $delimiter [optional] <p>
|
|
* The field delimiter (one character only). Defaults as a comma or the value set using <b>SplFileObject::setCsvControl</b>.
|
|
* </p>
|
|
* @param string $enclosure [optional] <p>
|
|
* The field enclosure character (one character only). Defaults as a double quotation mark or the value set using <b>SplFileObject::setCsvControl</b>.
|
|
* </p>
|
|
* @param string $escape [optional] <p>
|
|
* The escape character (one character only). Defaults as a backslash (\) or the value set using <b>SplFileObject::setCsvControl</b>.
|
|
* </p>
|
|
* @return array an indexed array containing the fields read, or false on error.
|
|
* </p>
|
|
* <p>
|
|
* A blank line in a CSV file will be returned as an array
|
|
* comprising a single null field unless using <b>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</b>,
|
|
* in which case empty lines are skipped.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fgetcsv ($delimiter = ",", $enclosure = "\"", $escape = "\\") {}
|
|
|
|
/**
|
|
* Write a field array as a CSV line
|
|
* @link https://php.net/manual/en/splfileobject.fputcsv.php
|
|
* @param array $fields <p>
|
|
* An array of values
|
|
* @param string $delimiter [optional] <p>
|
|
* The field delimiter (one character only). Defaults as a comma or the value set using <b>SplFileObject::setCsvControl</b>.
|
|
* </p>
|
|
* @param string $enclosure [optional] <p>
|
|
* The field enclosure character (one character only). Defaults as a double quotation mark or the value set using <b>SplFileObject::setCsvControl</b>.
|
|
* </p>
|
|
* @param string $escape The optional escape parameter sets the escape character (one character only).
|
|
* @return int|false Returns the length of the written string or FALSE on failure.
|
|
* @since 5.4.0
|
|
*</p>
|
|
*/
|
|
public function fputcsv (array $fields, $delimiter = ',' , $enclosure = '"', $escape = "\\") {}
|
|
|
|
/**
|
|
* Set the delimiter and enclosure character for CSV
|
|
* @link https://php.net/manual/en/splfileobject.setcsvcontrol.php
|
|
* @param string $delimiter [optional] <p>
|
|
* The field delimiter (one character only).
|
|
* </p>
|
|
* @param string $enclosure [optional] <p>
|
|
* The field enclosure character (one character only).
|
|
* </p>
|
|
* @param string $escape [optional] <p>
|
|
* The field escape character (one character only).
|
|
* </p>
|
|
* @return void
|
|
* @since 5.2.0
|
|
*/
|
|
public function setCsvControl ($delimiter = ",", $enclosure = "\"", $escape = "\\") {}
|
|
|
|
/**
|
|
* Get the delimiter and enclosure character for CSV
|
|
* @link https://php.net/manual/en/splfileobject.getcsvcontrol.php
|
|
* @return array an indexed array containing the delimiter and enclosure character.
|
|
* @since 5.2.0
|
|
*/
|
|
public function getCsvControl () {}
|
|
|
|
/**
|
|
* Portable file locking
|
|
* @link https://php.net/manual/en/splfileobject.flock.php
|
|
* @param int $operation <p>
|
|
* <i>operation</i> is one of the following:
|
|
* <b>LOCK_SH</b> to acquire a shared lock (reader).
|
|
* @param int $wouldblock [optional] <p>
|
|
* Set to true if the lock would block (EWOULDBLOCK errno condition).
|
|
* </p>
|
|
* @return bool true on success or false on failure.
|
|
* @since 5.1.0
|
|
*/
|
|
public function flock ($operation, &$wouldblock = null) {}
|
|
|
|
/**
|
|
* Flushes the output to the file
|
|
* @link https://php.net/manual/en/splfileobject.fflush.php
|
|
* @return bool true on success or false on failure.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fflush () {}
|
|
|
|
/**
|
|
* Return current file position
|
|
* @link https://php.net/manual/en/splfileobject.ftell.php
|
|
* @return int|false the position of the file pointer as an integer, or false on error.
|
|
* @since 5.1.0
|
|
*/
|
|
public function ftell () {}
|
|
|
|
/**
|
|
* Seek to a position
|
|
* @link https://php.net/manual/en/splfileobject.fseek.php
|
|
* @param int $offset <p>
|
|
* The offset. A negative value can be used to move backwards through the file which
|
|
* is useful when SEEK_END is used as the <i>whence</i> value.
|
|
* </p>
|
|
* @param int $whence [optional] <p>
|
|
* <i>whence</i> values are:
|
|
* <b>SEEK_SET</b> - Set position equal to <i>offset</i> bytes.
|
|
* <b>SEEK_CUR</b> - Set position to current location plus <i>offset</i>.
|
|
* <b>SEEK_END</b> - Set position to end-of-file plus <i>offset</i>.
|
|
* </p>
|
|
* <p>
|
|
* If <i>whence</i> is not specified, it is assumed to be <b>SEEK_SET</b>.
|
|
* </p>
|
|
* @return int 0 if the seek was successful, -1 otherwise. Note that seeking
|
|
* past EOF is not considered an error.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fseek ($offset, $whence = SEEK_SET) {}
|
|
|
|
/**
|
|
* Gets character from file
|
|
* @link https://php.net/manual/en/splfileobject.fgetc.php
|
|
* @return string|false a string containing a single character read from the file or false on EOF.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fgetc () {}
|
|
|
|
/**
|
|
* Output all remaining data on a file pointer
|
|
* @link https://php.net/manual/en/splfileobject.fpassthru.php
|
|
* @return int|false the number of characters read from <i>handle</i>
|
|
* and passed through to the output.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fpassthru () {}
|
|
|
|
/**
|
|
* Gets line from file and strip HTML tags
|
|
* @link https://php.net/manual/en/splfileobject.fgetss.php
|
|
* @param string $allowable_tags [optional] <p>
|
|
* You can use the optional third parameter to specify tags which should
|
|
* not be stripped.
|
|
* </p>
|
|
* @return string|false a string containing the next line of the file with HTML and PHP
|
|
* code stripped, or false on error.
|
|
* @since 5.1.0
|
|
* @deprecated 7.3
|
|
*/
|
|
public function fgetss ($allowable_tags = null) {}
|
|
|
|
/**
|
|
* Parses input from file according to a format
|
|
* @link https://php.net/manual/en/splfileobject.fscanf.php
|
|
* @param string $format <p>
|
|
* The specified format as described in the <b>sprintf</b> documentation.
|
|
* </p>
|
|
* @param mixed $_ [optional] <p>
|
|
* The optional assigned values.
|
|
* </p>
|
|
* @return mixed If only one parameter is passed to this method, the values parsed will be
|
|
* returned as an array. Otherwise, if optional parameters are passed, the
|
|
* function will return the number of assigned values. The optional
|
|
* parameters must be passed by reference.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fscanf ($format, &$_ = null) {}
|
|
|
|
/**
|
|
* Write to file
|
|
* @link https://php.net/manual/en/splfileobject.fwrite.php
|
|
* @param string $str <p>
|
|
* The string to be written to the file.
|
|
* </p>
|
|
* @param int $length [optional] <p>
|
|
* If the <i>length</i> argument is given, writing will
|
|
* stop after <i>length</i> bytes have been written or
|
|
* the end of <i>string</i> is reached, whichever comes
|
|
* first.
|
|
* </p>
|
|
* @return int the number of bytes written, or null on error.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fwrite ($str, $length = null) {}
|
|
|
|
/**
|
|
* Gets information about the file
|
|
* @link https://php.net/manual/en/splfileobject.fstat.php
|
|
* @return array an array with the statistics of the file; the format of the array
|
|
* is described in detail on the <b>stat</b> manual page.
|
|
* @since 5.1.0
|
|
*/
|
|
public function fstat () {}
|
|
|
|
/**
|
|
* Truncates the file to a given length
|
|
* @link https://php.net/manual/en/splfileobject.ftruncate.php
|
|
* @param int $size <p>
|
|
* The size to truncate to.
|
|
* </p>
|
|
* <p>
|
|
* If <i>size</i> is larger than the file it is extended with null bytes.
|
|
* </p>
|
|
* <p>
|
|
* If <i>size</i> is smaller than the file, the extra data will be lost.
|
|
* </p>
|
|
* @return bool true on success or false on failure.
|
|
* @since 5.1.0
|
|
*/
|
|
public function ftruncate ($size) {}
|
|
|
|
/**
|
|
* Retrieve current line of file
|
|
* @link https://php.net/manual/en/splfileobject.current.php
|
|
* @return string|array|false Retrieves the current line of the file. If the <b>SplFileObject::READ_CSV</b> flag is set, this method returns an array containing the current line parsed as CSV data.
|
|
* @since 5.1.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Get line number
|
|
* @link https://php.net/manual/en/splfileobject.key.php
|
|
* @return int the current line number.
|
|
* @since 5.1.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Read next line
|
|
* @link https://php.net/manual/en/splfileobject.next.php
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Sets flags for the SplFileObject
|
|
* @link https://php.net/manual/en/splfileobject.setflags.php
|
|
* @param int $flags <p>
|
|
* Bit mask of the flags to set. See
|
|
* SplFileObject constants
|
|
* for the available flags.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function setFlags ($flags) {}
|
|
|
|
/**
|
|
* Gets flags for the SplFileObject
|
|
* @link https://php.net/manual/en/splfileobject.getflags.php
|
|
* @return int an integer representing the flags.
|
|
* @since 5.1.0
|
|
*/
|
|
public function getFlags () {}
|
|
|
|
/**
|
|
* Set maximum line length
|
|
* @link https://php.net/manual/en/splfileobject.setmaxlinelen.php
|
|
* @param int $max_len <p>
|
|
* The maximum length of a line.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function setMaxLineLen ($max_len) {}
|
|
|
|
/**
|
|
* Get maximum line length
|
|
* @link https://php.net/manual/en/splfileobject.getmaxlinelen.php
|
|
* @return int the maximum line length if one has been set with
|
|
* <b>SplFileObject::setMaxLineLen</b>, default is 0.
|
|
* @since 5.1.0
|
|
*/
|
|
public function getMaxLineLen () {}
|
|
|
|
/**
|
|
* SplFileObject does not have children
|
|
* @link https://php.net/manual/en/splfileobject.haschildren.php
|
|
* @return bool false
|
|
* @since 5.1.2
|
|
*/
|
|
public function hasChildren () {}
|
|
|
|
/**
|
|
* No purpose
|
|
* @link https://php.net/manual/en/splfileobject.getchildren.php
|
|
* @return null An SplFileObject does not have children so this method returns NULL.
|
|
* @since 5.1.0
|
|
*/
|
|
public function getChildren () {}
|
|
|
|
/**
|
|
* Seek to specified line
|
|
* @link https://php.net/manual/en/splfileobject.seek.php
|
|
* @param int $line_pos <p>
|
|
* The zero-based line number to seek to.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function seek ($line_pos) {}
|
|
|
|
/**
|
|
* Alias of <b>SplFileObject::fgets</b>
|
|
* @link https://php.net/manual/en/splfileobject.getcurrentline.php
|
|
* @return string|false Returns a string containing the next line from the file, or FALSE on error.
|
|
* @since 5.1.2
|
|
*/
|
|
public function getCurrentLine () {}
|
|
|
|
/**
|
|
* Alias of <b>SplFileObject::current</b>
|
|
* @link https://php.net/manual/en/splfileobject.tostring.php
|
|
* @since 5.1.0
|
|
*/
|
|
public function __toString () {}
|
|
|
|
}
|
|
|
|
/**
|
|
* The SplTempFileObject class offers an object oriented interface for a temporary file.
|
|
* @link https://php.net/manual/en/class.spltempfileobject.php
|
|
*/
|
|
class SplTempFileObject extends SplFileObject {
|
|
|
|
|
|
/**
|
|
* Construct a new temporary file object
|
|
* @link https://php.net/manual/en/spltempfileobject.construct.php
|
|
* @param $max_memory [optional]
|
|
* @throws RuntimeException if an error occurs.
|
|
* @since 5.1.2
|
|
*/
|
|
public function __construct ($max_memory) {}
|
|
}
|
|
|
|
/**
|
|
* The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.
|
|
* @link https://php.net/manual/en/class.spldoublylinkedlist.php
|
|
*/
|
|
class SplDoublyLinkedList implements Iterator, Countable, ArrayAccess, Serializable
|
|
{
|
|
const IT_MODE_LIFO = 2;
|
|
const IT_MODE_FIFO = 0;
|
|
const IT_MODE_DELETE = 1;
|
|
const IT_MODE_KEEP = 0;
|
|
|
|
|
|
/**
|
|
* Add/insert a new value at the specified index
|
|
* @param mixed $index The index where the new value is to be inserted.
|
|
* @param mixed $newval The new value for the index.
|
|
* @link https://php.net/spldoublylinkedlist.add
|
|
* @return void
|
|
* @since 5.5.0
|
|
*/
|
|
public function add($index, $newval) {}
|
|
|
|
/**
|
|
* Pops a node from the end of the doubly linked list
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.pop.php
|
|
* @return mixed The value of the popped node.
|
|
* @since 5.3.0
|
|
*/
|
|
public function pop () {}
|
|
|
|
/**
|
|
* Shifts a node from the beginning of the doubly linked list
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.shift.php
|
|
* @return mixed The value of the shifted node.
|
|
* @since 5.3.0
|
|
*/
|
|
public function shift () {}
|
|
|
|
/**
|
|
* Pushes an element at the end of the doubly linked list
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.push.php
|
|
* @param mixed $value <p>
|
|
* The value to push.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function push ($value) {}
|
|
|
|
/**
|
|
* Prepends the doubly linked list with an element
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.unshift.php
|
|
* @param mixed $value <p>
|
|
* The value to unshift.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function unshift ($value) {}
|
|
|
|
/**
|
|
* Peeks at the node from the end of the doubly linked list
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.top.php
|
|
* @return mixed The value of the last node.
|
|
* @since 5.3.0
|
|
*/
|
|
public function top () {}
|
|
|
|
/**
|
|
* Peeks at the node from the beginning of the doubly linked list
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.bottom.php
|
|
* @return mixed The value of the first node.
|
|
* @since 5.3.0
|
|
*/
|
|
public function bottom () {}
|
|
|
|
/**
|
|
* Counts the number of elements in the doubly linked list.
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.count.php
|
|
* @return int the number of elements in the doubly linked list.
|
|
* @since 5.3.0
|
|
*/
|
|
public function count () {}
|
|
|
|
/**
|
|
* Checks whether the doubly linked list is empty.
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.isempty.php
|
|
* @return bool whether the doubly linked list is empty.
|
|
* @since 5.3.0
|
|
*/
|
|
public function isEmpty () {}
|
|
|
|
/**
|
|
* Sets the mode of iteration
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.setiteratormode.php
|
|
* @param int $mode <p>
|
|
* There are two orthogonal sets of modes that can be set:
|
|
* </p>
|
|
* The direction of the iteration (either one or the other):
|
|
* <b>SplDoublyLinkedList::IT_MODE_LIFO</b> (Stack style)
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function setIteratorMode ($mode) {}
|
|
|
|
/**
|
|
* Returns the mode of iteration
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.getiteratormode.php
|
|
* @return int the different modes and flags that affect the iteration.
|
|
* @since 5.3.0
|
|
*/
|
|
public function getIteratorMode () {}
|
|
|
|
/**
|
|
* Returns whether the requested $index exists
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.offsetexists.php
|
|
* @param mixed $index <p>
|
|
* The index being checked.
|
|
* </p>
|
|
* @return bool true if the requested <i>index</i> exists, otherwise false
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetExists ($index) {}
|
|
|
|
/**
|
|
* Returns the value at the specified $index
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.offsetget.php
|
|
* @param mixed $index <p>
|
|
* The index with the value.
|
|
* </p>
|
|
* @return mixed The value at the specified <i>index</i>.
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetGet ($index) {}
|
|
|
|
/**
|
|
* Sets the value at the specified $index to $newval
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.offsetset.php
|
|
* @param mixed $index <p>
|
|
* The index being set.
|
|
* </p>
|
|
* @param mixed $newval <p>
|
|
* The new value for the <i>index</i>.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetSet ($index, $newval) {}
|
|
|
|
/**
|
|
* Unsets the value at the specified $index
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.offsetunset.php
|
|
* @param mixed $index <p>
|
|
* The index being unset.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetUnset ($index) {}
|
|
|
|
/**
|
|
* Rewind iterator back to the start
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Return current array entry
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.current.php
|
|
* @return mixed The current node value.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Return current node index
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.key.php
|
|
* @return mixed The current node index.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Move to next entry
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Move to previous entry
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.prev.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function prev () {}
|
|
|
|
/**
|
|
* Check whether the doubly linked list contains more nodes
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.valid.php
|
|
* @return bool true if the doubly linked list contains any more nodes, false otherwise.
|
|
* @since 5.3.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Unserializes the storage
|
|
* @link https://php.net/manual/ru/spldoublylinkedlist.serialize.php
|
|
* @param string $serialized The serialized string.
|
|
* @return void
|
|
* @since 5.4.0
|
|
*/
|
|
public function unserialize($serialized) {}
|
|
|
|
/**
|
|
* Serializes the storage
|
|
* @link https://php.net/manual/ru/spldoublylinkedlist.unserialize.php
|
|
* @return string The serialized string.
|
|
* @since 5.4.0
|
|
*/
|
|
public function serialize () {}
|
|
|
|
}
|
|
|
|
/**
|
|
* The SplQueue class provides the main functionalities of a queue implemented using a doubly linked list.
|
|
* @link https://php.net/manual/en/class.splqueue.php
|
|
*/
|
|
class SplQueue extends SplDoublyLinkedList {
|
|
|
|
|
|
/**
|
|
* Adds an element to the queue.
|
|
* @link https://php.net/manual/en/splqueue.enqueue.php
|
|
* @param mixed $value <p>
|
|
* The value to enqueue.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function enqueue ($value) {}
|
|
|
|
/**
|
|
* Dequeues a node from the queue
|
|
* @link https://php.net/manual/en/splqueue.dequeue.php
|
|
* @return mixed The value of the dequeued node.
|
|
* @since 5.3.0
|
|
*/
|
|
public function dequeue () {}
|
|
|
|
/**
|
|
* Sets the mode of iteration
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.setiteratormode.php
|
|
* @param int $mode <p>
|
|
* There are two orthogonal sets of modes that can be set:
|
|
* </p>
|
|
* The direction of the iteration (either one or the other):
|
|
* @since 5.3.0
|
|
* <b>SplDoublyLinkedList::IT_MODE_LIFO</b> (Stack style)
|
|
* @return void
|
|
*/
|
|
public function setIteratorMode ($mode) {}
|
|
|
|
}
|
|
/**
|
|
* The SplStack class provides the main functionalities of a stack implemented using a doubly linked list.
|
|
* @link https://php.net/manual/en/class.splstack.php
|
|
*/
|
|
class SplStack extends SplDoublyLinkedList {
|
|
|
|
/**
|
|
* Sets the mode of iteration
|
|
* @link https://php.net/manual/en/spldoublylinkedlist.setiteratormode.php
|
|
* @param int $mode <p>
|
|
* There are two orthogonal sets of modes that can be set:
|
|
* </p>
|
|
* The direction of the iteration (either one or the other):
|
|
* <b>SplDoublyLinkedList::IT_MODE_LIFO</b> (Stack style)
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function setIteratorMode ($mode) {}
|
|
}
|
|
|
|
/**
|
|
* The SplHeap class provides the main functionalities of an Heap.
|
|
* @link https://php.net/manual/en/class.splheap.php
|
|
*/
|
|
abstract class SplHeap implements Iterator, Countable {
|
|
|
|
/**
|
|
* Extracts a node from top of the heap and sift up.
|
|
* @link https://php.net/manual/en/splheap.extract.php
|
|
* @return mixed The value of the extracted node.
|
|
* @since 5.3.0
|
|
*/
|
|
public function extract () {}
|
|
|
|
/**
|
|
* Inserts an element in the heap by sifting it up.
|
|
* @link https://php.net/manual/en/splheap.insert.php
|
|
* @param mixed $value <p>
|
|
* The value to insert.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function insert ($value) {}
|
|
|
|
/**
|
|
* Peeks at the node from the top of the heap
|
|
* @link https://php.net/manual/en/splheap.top.php
|
|
* @return mixed The value of the node on the top.
|
|
* @since 5.3.0
|
|
*/
|
|
public function top () {}
|
|
|
|
/**
|
|
* Counts the number of elements in the heap.
|
|
* @link https://php.net/manual/en/splheap.count.php
|
|
* @return int the number of elements in the heap.
|
|
* @since 5.3.0
|
|
*/
|
|
public function count () {}
|
|
|
|
/**
|
|
* Checks whether the heap is empty.
|
|
* @link https://php.net/manual/en/splheap.isempty.php
|
|
* @return bool whether the heap is empty.
|
|
* @since 5.3.0
|
|
*/
|
|
public function isEmpty () {}
|
|
|
|
/**
|
|
* Rewind iterator back to the start (no-op)
|
|
* @link https://php.net/manual/en/splheap.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Return current node pointed by the iterator
|
|
* @link https://php.net/manual/en/splheap.current.php
|
|
* @return mixed The current node value.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Return current node index
|
|
* @link https://php.net/manual/en/splheap.key.php
|
|
* @return mixed The current node index.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Move to the next node
|
|
* @link https://php.net/manual/en/splheap.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Check whether the heap contains more nodes
|
|
* @link https://php.net/manual/en/splheap.valid.php
|
|
* @return bool true if the heap contains any more nodes, false otherwise.
|
|
* @since 5.3.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Recover from the corrupted state and allow further actions on the heap.
|
|
* @link https://php.net/manual/en/splheap.recoverfromcorruption.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function recoverFromCorruption () {}
|
|
|
|
/**
|
|
* Compare elements in order to place them correctly in the heap while sifting up.
|
|
* @link https://php.net/manual/en/splheap.compare.php
|
|
* @param mixed $value1 <p>
|
|
* The value of the first node being compared.
|
|
* </p>
|
|
* @param mixed $value2 <p>
|
|
* The value of the second node being compared.
|
|
* </p>
|
|
* @return int Result of the comparison, positive integer if <i>value1</i> is greater than <i>value2</i>, 0 if they are equal, negative integer otherwise.
|
|
* </p>
|
|
* <p>
|
|
* Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
|
|
* @since 5.3.0
|
|
*/
|
|
abstract protected function compare ($value1, $value2);
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isCorrupted(){}
|
|
|
|
}
|
|
|
|
/**
|
|
* The SplMinHeap class provides the main functionalities of a heap, keeping the minimum on the top.
|
|
* @link https://php.net/manual/en/class.splminheap.php
|
|
*/
|
|
class SplMinHeap extends SplHeap {
|
|
|
|
/**
|
|
* Compare elements in order to place them correctly in the heap while sifting up.
|
|
* @link https://php.net/manual/en/splminheap.compare.php
|
|
* @param mixed $value1 <p>
|
|
* The value of the first node being compared.
|
|
* </p>
|
|
* @param mixed $value2 <p>
|
|
* The value of the second node being compared.
|
|
* </p>
|
|
* @return void Result of the comparison, positive integer if <i>value1</i> is lower than <i>value2</i>, 0 if they are equal, negative integer otherwise.
|
|
* </p>
|
|
* <p>
|
|
* Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
|
|
* @since 5.3.0
|
|
*/
|
|
protected function compare ($value1, $value2) {}
|
|
|
|
/**
|
|
* Extracts a node from top of the heap and sift up.
|
|
* @link https://php.net/manual/en/splheap.extract.php
|
|
* @return mixed The value of the extracted node.
|
|
* @since 5.3.0
|
|
*/
|
|
public function extract () {}
|
|
|
|
/**
|
|
* Inserts an element in the heap by sifting it up.
|
|
* @link https://php.net/manual/en/splheap.insert.php
|
|
* @param mixed $value <p>
|
|
* The value to insert.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function insert ($value) {}
|
|
|
|
/**
|
|
* Peeks at the node from the top of the heap
|
|
* @link https://php.net/manual/en/splheap.top.php
|
|
* @return mixed The value of the node on the top.
|
|
* @since 5.3.0
|
|
*/
|
|
public function top () {}
|
|
|
|
/**
|
|
* Counts the number of elements in the heap.
|
|
* @link https://php.net/manual/en/splheap.count.php
|
|
* @return int the number of elements in the heap.
|
|
* @since 5.3.0
|
|
*/
|
|
public function count () {}
|
|
|
|
/**
|
|
* Checks whether the heap is empty.
|
|
* @link https://php.net/manual/en/splheap.isempty.php
|
|
* @return bool whether the heap is empty.
|
|
* @since 5.3.0
|
|
*/
|
|
public function isEmpty () {}
|
|
|
|
/**
|
|
* Rewind iterator back to the start (no-op)
|
|
* @link https://php.net/manual/en/splheap.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Return current node pointed by the iterator
|
|
* @link https://php.net/manual/en/splheap.current.php
|
|
* @return mixed The current node value.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Return current node index
|
|
* @link https://php.net/manual/en/splheap.key.php
|
|
* @return mixed The current node index.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Move to the next node
|
|
* @link https://php.net/manual/en/splheap.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Check whether the heap contains more nodes
|
|
* @link https://php.net/manual/en/splheap.valid.php
|
|
* @return bool true if the heap contains any more nodes, false otherwise.
|
|
* @since 5.3.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Recover from the corrupted state and allow further actions on the heap.
|
|
* @link https://php.net/manual/en/splheap.recoverfromcorruption.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function recoverFromCorruption () {}
|
|
|
|
}
|
|
|
|
/**
|
|
* The SplMaxHeap class provides the main functionalities of a heap, keeping the maximum on the top.
|
|
* @link https://php.net/manual/en/class.splmaxheap.php
|
|
*/
|
|
class SplMaxHeap extends SplHeap {
|
|
|
|
/**
|
|
* Compare elements in order to place them correctly in the heap while sifting up.
|
|
* @link https://php.net/manual/en/splmaxheap.compare.php
|
|
* @param mixed $value1 <p>
|
|
* The value of the first node being compared.
|
|
* </p>
|
|
* @param mixed $value2 <p>
|
|
* The value of the second node being compared.
|
|
* </p>
|
|
* @return void Result of the comparison, positive integer if <i>value1</i> is greater than <i>value2</i>, 0 if they are equal, negative integer otherwise.
|
|
* </p>
|
|
* <p>
|
|
* Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
|
|
* @since 5.3.0
|
|
*/
|
|
protected function compare ($value1, $value2) {}
|
|
|
|
}
|
|
/**
|
|
* The SplPriorityQueue class provides the main functionalities of an
|
|
* prioritized queue, implemented using a heap.
|
|
* @link https://php.net/manual/en/class.splpriorityqueue.php
|
|
*/
|
|
class SplPriorityQueue implements Iterator, Countable {
|
|
const EXTR_BOTH = 3;
|
|
const EXTR_PRIORITY = 2;
|
|
const EXTR_DATA = 1;
|
|
|
|
|
|
/**
|
|
* Compare priorities in order to place elements correctly in the heap while sifting up.
|
|
* @link https://php.net/manual/en/splpriorityqueue.compare.php
|
|
* @param mixed $priority1 <p>
|
|
* The priority of the first node being compared.
|
|
* </p>
|
|
* @param mixed $priority2 <p>
|
|
* The priority of the second node being compared.
|
|
* </p>
|
|
* @return int Result of the comparison, positive integer if <i>priority1</i> is greater than <i>priority2</i>, 0 if they are equal, negative integer otherwise.
|
|
* </p>
|
|
* <p>
|
|
* Multiple elements with the same priority will get dequeued in no particular order.
|
|
* @since 5.3.0
|
|
*/
|
|
public function compare ($priority1, $priority2) {}
|
|
|
|
/**
|
|
* Inserts an element in the queue by sifting it up.
|
|
* @link https://php.net/manual/en/splpriorityqueue.insert.php
|
|
* @param mixed $value <p>
|
|
* The value to insert.
|
|
* </p>
|
|
* @param mixed $priority <p>
|
|
* The associated priority.
|
|
* </p>
|
|
* @return true
|
|
* @since 5.3.0
|
|
*/
|
|
public function insert ($value, $priority) {}
|
|
|
|
/**
|
|
* Sets the mode of extraction
|
|
* @link https://php.net/manual/en/splpriorityqueue.setextractflags.php
|
|
* @param int $flags <p>
|
|
* Defines what is extracted by <b>SplPriorityQueue::current</b>,
|
|
* <b>SplPriorityQueue::top</b> and
|
|
* <b>SplPriorityQueue::extract</b>.
|
|
* </p>
|
|
* <b>SplPriorityQueue::EXTR_DATA</b> (0x00000001): Extract the data
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function setExtractFlags ($flags) {}
|
|
|
|
/**
|
|
* Peeks at the node from the top of the queue
|
|
* @link https://php.net/manual/en/splpriorityqueue.top.php
|
|
* @return mixed The value or priority (or both) of the top node, depending on the extract flag.
|
|
* @since 5.3.0
|
|
*/
|
|
public function top () {}
|
|
|
|
/**
|
|
* Extracts a node from top of the heap and sift up.
|
|
* @link https://php.net/manual/en/splpriorityqueue.extract.php
|
|
* @return mixed The value or priority (or both) of the extracted node, depending on the extract flag.
|
|
* @since 5.3.0
|
|
*/
|
|
public function extract () {}
|
|
|
|
/**
|
|
* Counts the number of elements in the queue.
|
|
* @link https://php.net/manual/en/splpriorityqueue.count.php
|
|
* @return int the number of elements in the queue.
|
|
* @since 5.3.0
|
|
*/
|
|
public function count () {}
|
|
|
|
/**
|
|
* Checks whether the queue is empty.
|
|
* @link https://php.net/manual/en/splpriorityqueue.isempty.php
|
|
* @return bool whether the queue is empty.
|
|
* @since 5.3.0
|
|
*/
|
|
public function isEmpty () {}
|
|
|
|
/**
|
|
* Rewind iterator back to the start (no-op)
|
|
* @link https://php.net/manual/en/splpriorityqueue.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Return current node pointed by the iterator
|
|
* @link https://php.net/manual/en/splpriorityqueue.current.php
|
|
* @return mixed The value or priority (or both) of the current node, depending on the extract flag.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Return current node index
|
|
* @link https://php.net/manual/en/splpriorityqueue.key.php
|
|
* @return mixed The current node index.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Move to the next node
|
|
* @link https://php.net/manual/en/splpriorityqueue.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Check whether the queue contains more nodes
|
|
* @link https://php.net/manual/en/splpriorityqueue.valid.php
|
|
* @return bool true if the queue contains any more nodes, false otherwise.
|
|
* @since 5.3.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Recover from the corrupted state and allow further actions on the queue.
|
|
* @link https://php.net/manual/en/splpriorityqueue.recoverfromcorruption.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function recoverFromCorruption () {}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isCorrupted() {}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getExtractFlags() {}
|
|
|
|
}
|
|
|
|
/**
|
|
* The SplFixedArray class provides the main functionalities of array. The
|
|
* main differences between a SplFixedArray and a normal PHP array is that
|
|
* the SplFixedArray is of fixed length and allows only integers within
|
|
* the range as indexes. The advantage is that it allows a faster array
|
|
* implementation.
|
|
* @link https://php.net/manual/en/class.splfixedarray.php
|
|
*/
|
|
class SplFixedArray implements Iterator, ArrayAccess, Countable {
|
|
|
|
/**
|
|
* Constructs a new fixed array
|
|
* @link https://php.net/manual/en/splfixedarray.construct.php
|
|
* @param int $size [optional]
|
|
* @since 5.3.0
|
|
*/
|
|
public function __construct ($size = 0) {}
|
|
|
|
/**
|
|
* Returns the size of the array
|
|
* @link https://php.net/manual/en/splfixedarray.count.php
|
|
* @return int the size of the array.
|
|
* @since 5.3.0
|
|
*/
|
|
public function count () {}
|
|
|
|
/**
|
|
* Returns a PHP array from the fixed array
|
|
* @link https://php.net/manual/en/splfixedarray.toarray.php
|
|
* @return array a PHP array, similar to the fixed array.
|
|
* @since 5.3.0
|
|
*/
|
|
public function toArray () {}
|
|
|
|
/**
|
|
* Import a PHP array in a <b>SplFixedArray</b> instance
|
|
* @link https://php.net/manual/en/splfixedarray.fromarray.php
|
|
* @param array $array <p>
|
|
* The array to import.
|
|
* </p>
|
|
* @param bool $save_indexes [optional] <p>
|
|
* Try to save the numeric indexes used in the original array.
|
|
* </p>
|
|
* @return SplFixedArray an instance of <b>SplFixedArray</b>
|
|
* containing the array content.
|
|
* @since 5.3.0
|
|
*/
|
|
public static function fromArray (array $array, $save_indexes = true) {}
|
|
|
|
/**
|
|
* Gets the size of the array
|
|
* @link https://php.net/manual/en/splfixedarray.getsize.php
|
|
* @return int the size of the array, as an integer.
|
|
* @since 5.3.0
|
|
*/
|
|
public function getSize () {}
|
|
|
|
/**
|
|
* Change the size of an array
|
|
* @link https://php.net/manual/en/splfixedarray.setsize.php
|
|
* @param int $size <p>
|
|
* The new array size.
|
|
* </p>
|
|
* @return bool
|
|
* @since 5.3.0
|
|
*/
|
|
public function setSize ($size) {}
|
|
|
|
/**
|
|
* Returns whether the requested index exists
|
|
* @link https://php.net/manual/en/splfixedarray.offsetexists.php
|
|
* @param int $index <p>
|
|
* The index being checked.
|
|
* </p>
|
|
* @return bool true if the requested <i>index</i> exists, otherwise false
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetExists ($index) {}
|
|
|
|
/**
|
|
* Returns the value at the specified index
|
|
* @link https://php.net/manual/en/splfixedarray.offsetget.php
|
|
* @param int $index <p>
|
|
* The index with the value.
|
|
* </p>
|
|
* @return mixed The value at the specified <i>index</i>.
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetGet ($index) {}
|
|
|
|
/**
|
|
* Sets a new value at a specified index
|
|
* @link https://php.net/manual/en/splfixedarray.offsetset.php
|
|
* @param int $index <p>
|
|
* The index being set.
|
|
* </p>
|
|
* @param mixed $newval <p>
|
|
* The new value for the <i>index</i>.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetSet ($index, $newval) {}
|
|
|
|
/**
|
|
* Unsets the value at the specified $index
|
|
* @link https://php.net/manual/en/splfixedarray.offsetunset.php
|
|
* @param int $index <p>
|
|
* The index being unset.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetUnset ($index) {}
|
|
|
|
/**
|
|
* Rewind iterator back to the start
|
|
* @link https://php.net/manual/en/splfixedarray.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Return current array entry
|
|
* @link https://php.net/manual/en/splfixedarray.current.php
|
|
* @return mixed The current element value.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Return current array index
|
|
* @link https://php.net/manual/en/splfixedarray.key.php
|
|
* @return int The current array index.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Move to next entry
|
|
* @link https://php.net/manual/en/splfixedarray.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Check whether the array contains more elements
|
|
* @link https://php.net/manual/en/splfixedarray.valid.php
|
|
* @return bool true if the array contains any more elements, false otherwise.
|
|
* @since 5.3.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
public function __wakeup()
|
|
{
|
|
}
|
|
|
|
|
|
}
|
|
|
|
/**
|
|
* The <b>SplObserver</b> interface is used alongside
|
|
* <b>SplSubject</b> to implement the Observer Design Pattern.
|
|
* @link https://php.net/manual/en/class.splobserver.php
|
|
*/
|
|
interface SplObserver {
|
|
|
|
/**
|
|
* Receive update from subject
|
|
* @link https://php.net/manual/en/splobserver.update.php
|
|
* @param SplSubject $subject <p>
|
|
* The <b>SplSubject</b> notifying the observer of an update.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function update (SplSubject $subject);
|
|
|
|
}
|
|
|
|
/**
|
|
* The <b>SplSubject</b> interface is used alongside
|
|
* <b>SplObserver</b> to implement the Observer Design Pattern.
|
|
* @link https://php.net/manual/en/class.splsubject.php
|
|
*/
|
|
interface SplSubject {
|
|
|
|
/**
|
|
* Attach an SplObserver
|
|
* @link https://php.net/manual/en/splsubject.attach.php
|
|
* @param SplObserver $observer <p>
|
|
* The <b>SplObserver</b> to attach.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function attach (SplObserver $observer);
|
|
|
|
/**
|
|
* Detach an observer
|
|
* @link https://php.net/manual/en/splsubject.detach.php
|
|
* @param SplObserver $observer <p>
|
|
* The <b>SplObserver</b> to detach.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function detach (SplObserver $observer);
|
|
|
|
/**
|
|
* Notify an observer
|
|
* @link https://php.net/manual/en/splsubject.notify.php
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function notify ();
|
|
|
|
}
|
|
|
|
/**
|
|
* The SplObjectStorage class provides a map from objects to data or, by
|
|
* ignoring data, an object set. This dual purpose can be useful in many
|
|
* cases involving the need to uniquely identify objects.
|
|
* @link https://php.net/manual/en/class.splobjectstorage.php
|
|
*/
|
|
class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess {
|
|
|
|
/**
|
|
* Adds an object in the storage
|
|
* @link https://php.net/manual/en/splobjectstorage.attach.php
|
|
* @param object $object <p>
|
|
* The object to add.
|
|
* </p>
|
|
* @param mixed $data [optional] <p>
|
|
* The data to associate with the object.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function attach ($object, $data = null) {}
|
|
|
|
/**
|
|
* Removes an object from the storage
|
|
* @link https://php.net/manual/en/splobjectstorage.detach.php
|
|
* @param object $object <p>
|
|
* The object to remove.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function detach ($object) {}
|
|
|
|
/**
|
|
* Checks if the storage contains a specific object
|
|
* @link https://php.net/manual/en/splobjectstorage.contains.php
|
|
* @param object $object <p>
|
|
* The object to look for.
|
|
* </p>
|
|
* @return bool true if the object is in the storage, false otherwise.
|
|
* @since 5.1.0
|
|
*/
|
|
public function contains ($object) {}
|
|
|
|
/**
|
|
* Adds all objects from another storage
|
|
* @link https://php.net/manual/en/splobjectstorage.addall.php
|
|
* @param SplObjectStorage $storage <p>
|
|
* The storage you want to import.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function addAll ($storage) {}
|
|
|
|
/**
|
|
* Removes objects contained in another storage from the current storage
|
|
* @link https://php.net/manual/en/splobjectstorage.removeall.php
|
|
* @param SplObjectStorage $storage <p>
|
|
* The storage containing the elements to remove.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function removeAll ($storage) {}
|
|
|
|
/**
|
|
* Removes all objects except for those contained in another storage from the current storage
|
|
* @link https://php.net/manual/en/splobjectstorage.removeallexcept.php
|
|
* @param SplObjectStorage $storage <p>
|
|
* The storage containing the elements to retain in the current storage.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.6
|
|
*/
|
|
public function removeAllExcept ($storage) {}
|
|
|
|
/**
|
|
* Returns the data associated with the current iterator entry
|
|
* @link https://php.net/manual/en/splobjectstorage.getinfo.php
|
|
* @return mixed The data associated with the current iterator position.
|
|
* @since 5.3.0
|
|
*/
|
|
public function getInfo () {}
|
|
|
|
/**
|
|
* Sets the data associated with the current iterator entry
|
|
* @link https://php.net/manual/en/splobjectstorage.setinfo.php
|
|
* @param mixed $data <p>
|
|
* The data to associate with the current iterator entry.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function setInfo ($data) {}
|
|
|
|
/**
|
|
* Returns the number of objects in the storage
|
|
* @link https://php.net/manual/en/splobjectstorage.count.php
|
|
* @return int The number of objects in the storage.
|
|
* @since 5.1.0
|
|
*/
|
|
public function count () {}
|
|
|
|
/**
|
|
* Rewind the iterator to the first storage element
|
|
* @link https://php.net/manual/en/splobjectstorage.rewind.php
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Returns if the current iterator entry is valid
|
|
* @link https://php.net/manual/en/splobjectstorage.valid.php
|
|
* @return bool true if the iterator entry is valid, false otherwise.
|
|
* @since 5.1.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Returns the index at which the iterator currently is
|
|
* @link https://php.net/manual/en/splobjectstorage.key.php
|
|
* @return int The index corresponding to the position of the iterator.
|
|
* @since 5.1.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Returns the current storage entry
|
|
* @link https://php.net/manual/en/splobjectstorage.current.php
|
|
* @return object The object at the current iterator position.
|
|
* @since 5.1.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Move to the next entry
|
|
* @link https://php.net/manual/en/splobjectstorage.next.php
|
|
* @return void
|
|
* @since 5.1.0
|
|
*/
|
|
public function next () {}
|
|
|
|
/**
|
|
* Unserializes a storage from its string representation
|
|
* @link https://php.net/manual/en/splobjectstorage.unserialize.php
|
|
* @param string $serialized <p>
|
|
* The serialized representation of a storage.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.2.2
|
|
*/
|
|
public function unserialize ($serialized) {}
|
|
|
|
/**
|
|
* Serializes the storage
|
|
* @link https://php.net/manual/en/splobjectstorage.serialize.php
|
|
* @return string A string representing the storage.
|
|
* @since 5.2.2
|
|
*/
|
|
public function serialize () {}
|
|
|
|
/**
|
|
* Checks whether an object exists in the storage
|
|
* @link https://php.net/manual/en/splobjectstorage.offsetexists.php
|
|
* @param object $object <p>
|
|
* The object to look for.
|
|
* </p>
|
|
* @return bool true if the object exists in the storage,
|
|
* and false otherwise.
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetExists ($object) {}
|
|
|
|
/**
|
|
* Associates data to an object in the storage
|
|
* @link https://php.net/manual/en/splobjectstorage.offsetset.php
|
|
* @param object $object <p>
|
|
* The object to associate data with.
|
|
* </p>
|
|
* @param mixed $data [optional] <p>
|
|
* The data to associate with the object.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetSet ($object, $data = null) {}
|
|
|
|
/**
|
|
* Removes an object from the storage
|
|
* @link https://php.net/manual/en/splobjectstorage.offsetunset.php
|
|
* @param object $object <p>
|
|
* The object to remove.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetUnset ($object) {}
|
|
|
|
/**
|
|
* Returns the data associated with an <type>object</type>
|
|
* @link https://php.net/manual/en/splobjectstorage.offsetget.php
|
|
* @param object $object <p>
|
|
* The object to look for.
|
|
* </p>
|
|
* @return mixed The data previously associated with the object in the storage.
|
|
* @since 5.3.0
|
|
*/
|
|
public function offsetGet ($object) {}
|
|
|
|
/**
|
|
* Calculate a unique identifier for the contained objects
|
|
* @link https://php.net/manual/en/splobjectstorage.gethash.php
|
|
* @param $object <p>
|
|
* object whose identifier is to be calculated.
|
|
* @return string A string with the calculated identifier.
|
|
* @since 5.4.0
|
|
*/
|
|
public function getHash($object) {}
|
|
|
|
}
|
|
|
|
/**
|
|
* An Iterator that sequentially iterates over all attached iterators
|
|
* @link https://php.net/manual/en/class.multipleiterator.php
|
|
*/
|
|
class MultipleIterator implements Iterator {
|
|
const MIT_NEED_ANY = 0;
|
|
const MIT_NEED_ALL = 1;
|
|
const MIT_KEYS_NUMERIC = 0;
|
|
const MIT_KEYS_ASSOC = 2;
|
|
|
|
|
|
/**
|
|
* Constructs a new MultipleIterator
|
|
* @link https://php.net/manual/en/multipleiterator.construct.php
|
|
* @param $flags [optional] Defaults to MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC
|
|
* @since 5.3.0
|
|
*/
|
|
public function __construct ($flags = MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC) {}
|
|
|
|
/**
|
|
* Gets the flag information
|
|
* @link https://php.net/manual/en/multipleiterator.getflags.php
|
|
* @return int Information about the flags, as an integer.
|
|
* @since 5.3.0
|
|
*/
|
|
public function getFlags () {}
|
|
|
|
/**
|
|
* Sets flags
|
|
* @link https://php.net/manual/en/multipleiterator.setflags.php
|
|
* @param int $flags <p>
|
|
* The flags to set, according to the
|
|
* Flag Constants
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function setFlags ($flags) {}
|
|
|
|
/**
|
|
* Attaches iterator information
|
|
* @link https://php.net/manual/en/multipleiterator.attachiterator.php
|
|
* @param Iterator $iterator <p>
|
|
* The new iterator to attach.
|
|
* </p>
|
|
* @param int|string|null $infos [optional] <p>
|
|
* The associative information for the Iterator, which must be an
|
|
* integer, a string, or null.
|
|
* </p>
|
|
* @return void Description...
|
|
* @since 5.3.0
|
|
*/
|
|
public function attachIterator (Iterator $iterator, $infos = null) {}
|
|
|
|
/**
|
|
* Detaches an iterator
|
|
* @link https://php.net/manual/en/multipleiterator.detachiterator.php
|
|
* @param Iterator $iterator <p>
|
|
* The iterator to detach.
|
|
* </p>
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function detachIterator (Iterator $iterator) {}
|
|
|
|
/**
|
|
* Checks if an iterator is attached
|
|
* @link https://php.net/manual/en/multipleiterator.containsiterator.php
|
|
* @param Iterator $iterator <p>
|
|
* The iterator to check.
|
|
* </p>
|
|
* @return bool true on success or false on failure.
|
|
* @since 5.3.0
|
|
*/
|
|
public function containsIterator (Iterator $iterator) {}
|
|
|
|
/**
|
|
* Gets the number of attached iterator instances
|
|
* @link https://php.net/manual/en/multipleiterator.countiterators.php
|
|
* @return int The number of attached iterator instances (as an integer).
|
|
* @since 5.3.0
|
|
*/
|
|
public function countIterators () {}
|
|
|
|
/**
|
|
* Rewinds all attached iterator instances
|
|
* @link https://php.net/manual/en/multipleiterator.rewind.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function rewind () {}
|
|
|
|
/**
|
|
* Checks the validity of sub iterators
|
|
* @link https://php.net/manual/en/multipleiterator.valid.php
|
|
* @return bool true if one or all sub iterators are valid depending on flags,
|
|
* otherwise false
|
|
* @since 5.3.0
|
|
*/
|
|
public function valid () {}
|
|
|
|
/**
|
|
* Gets the registered iterator instances
|
|
* @link https://php.net/manual/en/multipleiterator.key.php
|
|
* @return array An array of all registered iterator instances,
|
|
* or false if no sub iterator is attached.
|
|
* @since 5.3.0
|
|
*/
|
|
public function key () {}
|
|
|
|
/**
|
|
* Gets the registered iterator instances
|
|
* @link https://php.net/manual/en/multipleiterator.current.php
|
|
* @return array|false An array containing the current values of each attached iterator,
|
|
* or false if no iterators are attached.
|
|
* @throws \RuntimeException if mode MIT_NEED_ALL is set and at least one attached iterator is not valid.
|
|
* @throws \InvalidArgumentException if a key is NULL and MIT_KEYS_ASSOC is set.
|
|
* @since 5.3.0
|
|
*/
|
|
public function current () {}
|
|
|
|
/**
|
|
* Moves all attached iterator instances forward
|
|
* @link https://php.net/manual/en/multipleiterator.next.php
|
|
* @return void
|
|
* @since 5.3.0
|
|
*/
|
|
public function next () {}
|
|
|
|
}
|
|
|