summaryrefslogtreecommitdiff
path: root/platform/www/inc/Parsing/Handler/ReWriterInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'platform/www/inc/Parsing/Handler/ReWriterInterface.php')
-rw-r--r--platform/www/inc/Parsing/Handler/ReWriterInterface.php37
1 files changed, 37 insertions, 0 deletions
diff --git a/platform/www/inc/Parsing/Handler/ReWriterInterface.php b/platform/www/inc/Parsing/Handler/ReWriterInterface.php
new file mode 100644
index 0000000..2fa7b25
--- /dev/null
+++ b/platform/www/inc/Parsing/Handler/ReWriterInterface.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace dokuwiki\Parsing\Handler;
+
+/**
+ * A ReWriter takes over from the orignal call writer and handles all new calls itself until
+ * the process method is called and control is given back to the original writer.
+ *
+ * @property array[] $calls The list of current calls
+ */
+interface ReWriterInterface extends CallWriterInterface
+{
+ /**
+ * ReWriterInterface constructor.
+ *
+ * This rewriter will be registered as the new call writer in the Handler.
+ * The original is passed as parameter
+ *
+ * @param CallWriterInterface $callWriter the original callwriter
+ */
+ public function __construct(CallWriterInterface $callWriter);
+
+ /**
+ * Process any calls that have been added and add them to the
+ * original call writer
+ *
+ * @return CallWriterInterface the orignal call writer
+ */
+ public function process();
+
+ /**
+ * Accessor for this rewriter's original CallWriter
+ *
+ * @return CallWriterInterface
+ */
+ public function getCallWriter();
+}