summaryrefslogtreecommitdiff
path: root/ext/spl/internal/splstack.inc
diff options
context:
space:
mode:
Diffstat (limited to 'ext/spl/internal/splstack.inc')
-rw-r--r--ext/spl/internal/splstack.inc35
1 files changed, 35 insertions, 0 deletions
diff --git a/ext/spl/internal/splstack.inc b/ext/spl/internal/splstack.inc
new file mode 100644
index 0000000000..a83d2c4b8e
--- /dev/null
+++ b/ext/spl/internal/splstack.inc
@@ -0,0 +1,35 @@
+<?php
+
+/** @file splstack.inc
+ * @ingroup SPL
+ * @brief class SplStack
+ * @author Etienne Kneuss
+ * @date 2008
+ *
+ * SPL - Standard PHP Library
+ */
+
+
+/** @ingroup SPL
+ * @brief Implementation of a stack through a DoublyLinkedList. As SplStack
+ * extends SplDoublyLinkedList, shift() and unshift() are still available even
+ * though they don't make much sense for a stack.
+ *
+ * @since PHP 5.3
+ *
+ * The SplStack class provides the main functionnalities of a
+ * stack implemented by a doubly linked list.
+ */
+class SplStack extends SplDoublyLinkedList
+{
+ /** Changes the iteration mode. For stacks, the direction mode
+ * is frozen. Attempting to modify it will result in an RuntimeException.
+ *
+ * @throws RuntimeException
+ * @param $mode new mode of iteration
+ * @see SplDoublyLinkedList::setIteratorMode
+ */
+ function setIteratorMode($mode) {/**/}
+}
+
+?>