Version 1
[yaffs-website] / vendor / psy / psysh / src / Psy / Readline / Readline.php
diff --git a/vendor/psy/psysh/src/Psy/Readline/Readline.php b/vendor/psy/psysh/src/Psy/Readline/Readline.php
new file mode 100644 (file)
index 0000000..487ac81
--- /dev/null
@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of Psy Shell.
+ *
+ * (c) 2012-2017 Justin Hileman
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Psy\Readline;
+
+/**
+ * An interface abstracting the various readline_* functions.
+ */
+interface Readline
+{
+    /**
+     * Check whether this Readline class is supported by the current system.
+     *
+     * @return bool
+     */
+    public static function isSupported();
+
+    /**
+     * Add a line to the command history.
+     *
+     * @param string $line
+     *
+     * @return bool Success
+     */
+    public function addHistory($line);
+
+    /**
+     * Clear the command history.
+     *
+     * @return bool Success
+     */
+    public function clearHistory();
+
+    /**
+     * List the command history.
+     *
+     * @return array
+     */
+    public function listHistory();
+
+    /**
+     * Read the command history.
+     *
+     * @return bool Success
+     */
+    public function readHistory();
+
+    /**
+     * Read a single line of input from the user.
+     *
+     * @param null|string $prompt
+     *
+     * @return false|string
+     */
+    public function readline($prompt = null);
+
+    /**
+     * Redraw readline to redraw the display.
+     */
+    public function redisplay();
+
+    /**
+     * Write the command history to a file.
+     *
+     * @return bool Success
+     */
+    public function writeHistory();
+}