Initial commit

content/inc/Parsing/ParserMode/ModeInterface.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace dokuwiki\Parsing\ParserMode;
+
+/**
+ * Defines a mode (syntax component) in the Parser
+ */
+interface ModeInterface
+{
+    /**
+     * returns a number used to determine in which order modes are added
+     *
+     * @return int;
+     */
+    public function getSort();
+
+    /**
+     * Called before any calls to connectTo
+     *
+     * @return void
+     */
+    public function preConnect();
+
+    /**
+     * Connects the mode
+     *
+     * @param string $mode
+     * @return void
+     */
+    public function connectTo($mode);
+
+    /**
+     * Called after all calls to connectTo
+     *
+     * @return void
+     */
+    public function postConnect();
+
+    /**
+     * Check if given mode is accepted inside this mode
+     *
+     * @param string $mode
+     * @return bool
+     */
+    public function accepts($mode);
+}