diff --git a/reference/spl/filesystemiterator.xml b/reference/spl/filesystemiterator.xml new file mode 100644 index 0000000000..8dbc3cfc7c --- /dev/null +++ b/reference/spl/filesystemiterator.xml @@ -0,0 +1,88 @@ + + + + + + The FilesystemIterator class + FilesystemIterator + + + + +
+ &reftitle.intro; + + The Filesystem iterator + +
+ + +
+ &reftitle.classsynopsis; + + + + FilesystemIterator + + + + + FilesystemIterator + + + + extends + DirectoryIterator + + + + SeekableIterator + + + + Traversable + + + + Iterator + + + + + Methods + + + Inherited methods + + + + + +
+ +
+ + &reference.spl.entities.filesystemiterator; + +
+ + diff --git a/reference/spl/filesystemiterator/construct.xml b/reference/spl/filesystemiterator/construct.xml new file mode 100644 index 0000000000..fa3b7c7a93 --- /dev/null +++ b/reference/spl/filesystemiterator/construct.xml @@ -0,0 +1,79 @@ + + + + + + FilesystemIterator::__construct + Constructs a new filesystem iterator + + + + &reftitle.description; + + FilesystemIterator::__construct + stringpath + stringflags + + + Constructs a new filesystem iterator from the path. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + path + + + The path. + + + + + flags + + + The desired flags. + + + + + + + + + &reftitle.seealso; + + + FilesystemIterator::setFlags + DirectoryIterator::__construct + + + + + + diff --git a/reference/spl/filesystemiterator/current.xml b/reference/spl/filesystemiterator/current.xml new file mode 100644 index 0000000000..1d2f071abf --- /dev/null +++ b/reference/spl/filesystemiterator/current.xml @@ -0,0 +1,67 @@ + + + + + + FilesystemIterator::current + The current file + + + + &reftitle.description; + + mixed FilesystemIterator::current + + + + Get file information of the current element. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The Filename, File information, or $this depending on the set flags. + + + + + &reftitle.seealso; + + + DirectoryIterator::current + DirectoryIterator::getFileName + + + + + + + diff --git a/reference/spl/filesystemiterator/getflags.xml b/reference/spl/filesystemiterator/getflags.xml new file mode 100644 index 0000000000..e33e48d409 --- /dev/null +++ b/reference/spl/filesystemiterator/getflags.xml @@ -0,0 +1,66 @@ + + + + + + FilesystemIterator::getFlags + Get the handling flags + + + + &reftitle.description; + + public intFilesystemIterator::getFlags + + + + Gets the handling flags, as set in FilesystemIterator::__construct. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The value of the set flags. + + + + + &reftitle.seealso; + + + FilesystemIterator::__construct + + + + + + + diff --git a/reference/spl/filesystemiterator/key.xml b/reference/spl/filesystemiterator/key.xml new file mode 100644 index 0000000000..aec77141e9 --- /dev/null +++ b/reference/spl/filesystemiterator/key.xml @@ -0,0 +1,64 @@ + + + + + + FilesystemIterator::key + Retrieve the file name + + + + &reftitle.description; + + stringFilesystemIterator::key + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the Pathname or Filename depending on the set flags. + + + + + &reftitle.seealso; + + + DirectoryIterator::key + DirectoryIterator::getFilename + DirectoryIterator::getPathname + + + + + + diff --git a/reference/spl/filesystemiterator/next.xml b/reference/spl/filesystemiterator/next.xml new file mode 100644 index 0000000000..331fd71e31 --- /dev/null +++ b/reference/spl/filesystemiterator/next.xml @@ -0,0 +1,66 @@ + + + + + + FilesystemIterator::next + Move to the next entry + + + + &reftitle.description; + + public voidFilesystemIterator::next + + + + Move to the next entry. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + DirectoryIterator::next + + + + + + + diff --git a/reference/spl/filesystemiterator/rewind.xml b/reference/spl/filesystemiterator/rewind.xml new file mode 100644 index 0000000000..2f8043c4cc --- /dev/null +++ b/reference/spl/filesystemiterator/rewind.xml @@ -0,0 +1,66 @@ + + + + + + FilesystemIterator::rewind + Rewinds dir + + + + &reftitle.description; + + public voidFilesystemIterator::rewind + + + + Rewinds the directory back to the start. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + DirectoryIterator::rewind + + + + + + + diff --git a/reference/spl/filesystemiterator/setflags.xml b/reference/spl/filesystemiterator/setflags.xml new file mode 100644 index 0000000000..a04b5d9a91 --- /dev/null +++ b/reference/spl/filesystemiterator/setflags.xml @@ -0,0 +1,78 @@ + + + + + + FilesystemIterator::setFlags + Sets handling flags + + + + &reftitle.description; + + public voidFilesystemIterator::setFlags + stringflags + + + Sets handling flags. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + flags + + + The handling flags to set. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + FilesystemIterator::__construct + FilesystemIterator::getFlags + + + + + + + diff --git a/reference/spl/globiterator.xml b/reference/spl/globiterator.xml new file mode 100644 index 0000000000..d388b5238c --- /dev/null +++ b/reference/spl/globiterator.xml @@ -0,0 +1,93 @@ + + + + + + The GlobIterator class + GlobIterator + + + + +
+ &reftitle.intro; + + Iterates through a file system in a similar fashion to + glob. + +
+ + +
+ &reftitle.classsynopsis; + + + + GlobIterator + + + + + GlobIterator + + + + extends + FilesystemIterator + + + + Iterator + + + + Traversable + + + + SeekableIterator + + + + Countable + + + + + Methods + + + Inherited methods + + + + + +
+ +
+ + &reference.spl.entities.globiterator; + +
+ + diff --git a/reference/spl/globiterator/construct.xml b/reference/spl/globiterator/construct.xml new file mode 100644 index 0000000000..d582060260 --- /dev/null +++ b/reference/spl/globiterator/construct.xml @@ -0,0 +1,80 @@ + + + + + + GlobIterator::__construct + Construct a directory using glob + + + + &reftitle.description; + + GlobIterator::__construct + stringpath + stringflags + + + Constructs a new directory iterator from a glob expression. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + path + + + The path of the directory. + + + + + flags + + + Optional flags. + + + + + + + + + &reftitle.seealso; + + + DirectoryIterator::__construct + glob + + + + + + + diff --git a/reference/spl/globiterator/count.xml b/reference/spl/globiterator/count.xml new file mode 100644 index 0000000000..efff1be1c9 --- /dev/null +++ b/reference/spl/globiterator/count.xml @@ -0,0 +1,59 @@ + + + + + + GlobIterator::count + Get the number of directories and files + + + + &reftitle.description; + + public integerGlobIterator::count + + + + Gets the number of directories and files found by + the glob expression. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The number of returned directories and files, as an + integer. + + + + + + diff --git a/reference/spl/seekableiterator.xml b/reference/spl/seekableiterator.xml new file mode 100644 index 0000000000..020a16e867 --- /dev/null +++ b/reference/spl/seekableiterator.xml @@ -0,0 +1,75 @@ + + + + + + The SeekableIterator class + SeekableIterator + + + + +
+ &reftitle.intro; + + The Seekable iterator. + +
+ + +
+ &reftitle.classsynopsis; + + + + SeekableIterator + + + + + SeekableIterator + + + + Iterator + + + + Traversable + + + + + Methods + + + + +
+ +
+ + &reference.spl.entities.seekableiterator; + +
+ + diff --git a/reference/spl/seekableiterator/seek.xml b/reference/spl/seekableiterator/seek.xml new file mode 100644 index 0000000000..8c8a05fc78 --- /dev/null +++ b/reference/spl/seekableiterator/seek.xml @@ -0,0 +1,68 @@ + + + + + + SeekableIterator::seek + Seeks to a position + + + + &reftitle.description; + + abstract public voidSeekableIterator::seek + stringposition + + + Seeks to a given position in the iterator. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + position + + + The position to seek to. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + +