* (c) Marcus Boerger, 2003 - 2004
*/
-/** Interface to override array access of objects.
+/** \defgroup SPL Internal classes
+ *
+ * The classes and interfaces in this group are contained in the c-code of
+ * ext/SPL.
+ */
+
+/** \defgroup Examples Example classes
+ *
+ * The classes and interfaces in this group are contained as PHP code in the
+ * examples subdirectory of ext/SPL. Sooner or later they will be moved to
+ * c-code.
+ */
+
+/** \ingroup SPL
+ * \brief Interface to override array access of objects.
*/
interface ArrayAccess
{
function offsetExists($offset);
}
-/** Abstract base interface that cannot be implemented alone. Instead it
+/** \ingroup SPL
+ * \brief Interface to detect a class is traversable using foreach.
+ *
+ * Abstract base interface that cannot be implemented alone. Instead it
* must be implemented by either IteratorAggregate or Iterator.
*
* \note Internal classes that implement this interface can be used in a
{
}
-/** Interface to create an external Iterator.
+/** \ingroup SPL
+ * \brief Interface to create an external Iterator.
*
* \note This is an engine internal interface.
*/
function getIterator();
}
-/** Interface for external iterators or objects that can be iterated
+/** \ingroup SPL
+ * \brief Basic iterator
+ *
+ * Interface for external iterators or objects that can be iterated
* themselves internally.
*
* \note This is an engine internal interface.
function valid();
}
-/** Interface for recursive traversal to be used with
+/** \ingroup SPL
+ * \brief Recursive iterator
+ *
+ * Interface for recursive traversal to be used with
* RecursiveIteratorIterator.
*/
interface RecursiveIterator extends Iterator
function getChildren();
}
-/** \brief Class for recursive traversal.
+/** \ingroup SPL
+ * \brief Class for recursive traversal.
*
* The objects of this class are created by instances of RecursiveIterator.
* Elements of those iterators may be traversable themselves. If so these
* \param $mode one of
* - RIT_LEAVES_ONLY do not return elements that can be recursed.
* - RIT_SELF_FIRST show elements before their sub elements.
- * - RIT_CHILD_FIRST show elements after their sub elements-
+ * - RIT_CHILD_FIRST show elements after their sub elements.
*
* \note If you want to see only those elements which have sub elements then
* use a ParentIterator.
function getSubIterator([$level]);
}
-/** \brief An Array wrapper
+/** \ingroup SPL
+ * \brief An Array wrapper
*
* This array wrapper allows to recursively iterate over Arrays and public
* Object properties.
function count();
}
-/** \brief An Array iterator
+/** \ingroup SPL
+ * \brief An Array iterator
*
* This iterator allows to unset and modify values and keys while iterating
* over Arrays and Objects.
function count();
}
-/** \brief An iterator that filters other iterators
+/** \ingroup SPL
+ * \brief An iterator that filters other iterators
*
* Iterator that wrapps around another iterator and only returns selected
* elements of the inner iterator. The only thing that needs to be done to
function getInnerIterator();
}
-/** This interface is used to optimize LimitIterator functionality. but it
+/** \ingroup SPL
+ * \brief Seekable iterator
+ *
+ * This interface is used to optimize LimitIterator functionality. but it
* may also be used for other situations where seeking a specific offset is
* required and easily possible.
*/
function seek($position);
}
-/** A class that starts iteration at a certain offset and only iterates over
+/** \ingroup SPL
+ * \brief Limiting iterator
+ *
+ * A class that starts iteration at a certain offset and only iterates over
* a specified amount of elements.
*
* This class uses SeekableIterator::seek() if available and rewind() plus
function getPosition();
}
-/** A recursive iterator that only returns elements that themselves can be
+/** \ingroup SPL
+ * \brief Iterator that shows only parents
+ *
+ * A recursive iterator that only returns elements that themselves can be
* trversed.
*/
class ParentIterator extends FilterIterator implements RecursiveIterator
function __construct(RecursiveIterator $iterator);
}
-/** This Iterator allways reads one ahead. That allows it to know whether
+/** \ingroup SPL
+ * \brief Caching iterator
+ *
+ * This Iterator allways reads one ahead. That allows it to know whether
* more elements are available.
*/
class CachingIterator implements Iterator
function getInnerIterator();
}
-/** The recursive version of the CachingIterator.
+/** \ingroup SPL
+ * \brief The recursive version of the CachingIterator.
*/
class CachingRecursiveIterator extends CachingIterator implements RecursiveIterator
{
function __construct(RecursiveIterator $iterator, $getStrVal);
}
-/** \brief Directory iterator
+/** \ingroup SPL
+ * \brief Directory iterator
*/
class DirectoryIterator implements Iterator
{
function __toString();
}
-/** \brief recursive directory iterator
+/** \ingroup SPL
+ * \brief recursive directory iterator
*/
class RecursiveDirectoryIterator extends DirectoryIterator implements RecursiveIterator
{
function getChildren();
}
-/** \brief recursive SimpleXML_Element iterator
+/** \ingroup SPL
+ * \brief recursive SimpleXML_Element iterator
*/
class SimpleXMLIterator extends SimpleXMLElement implements RecursiveIterator
{
projects / php / commitdiff