Debian Codegraph @

codelitephp/resources/cc/readline.php

raw
1 <?php
2
3 // Start of readline v.5.6.0
4
5 /**
6 * Reads a line
7 * @link http://www.php.net/manual/en/function.readline.php
8 * @param prompt string[optional] <p>
9 * You may specify a string with which to prompt the user.
10 * </p>
11 * @return string a single string from the user. The line returned has the ending
12 * newline removed.
13 */
14 function readline ($prompt = null) {}
15
16 /**
17 * Gets/sets various internal readline variables
18 * @link http://www.php.net/manual/en/function.readline-info.php
19 * @param varname string[optional] <p>
20 * A variable name.
21 * </p>
22 * @param newvalue string[optional] <p>
23 * If provided, this will be the new value of the setting.
24 * </p>
25 * @return mixed If called with no parameters, this function returns an array of
26 * values for all the setting readline uses. The elements will
27 * be indexed by the following values: done, end, erase_empty_line,
28 * library_version, line_buffer, mark, pending_input, point, prompt,
29 * readline_name, and terminal_name.
30 * </p>
31 * <p>
32 * If called with one or two parameters, the old value is returned.
33 */
34 function readline_info ($varname = null, $newvalue = null) {}
35
36 /**
37 * Adds a line to the history
38 * @link http://www.php.net/manual/en/function.readline-add-history.php
39 * @param line string <p>
40 * The line to be added in the history.
41 * </p>
42 * @return bool Returns true on success, false on failure.
43 */
44 function readline_add_history ($line) {}
45
46 /**
47 * Clears the history
48 * @link http://www.php.net/manual/en/function.readline-clear-history.php
49 * @return bool Returns true on success, false on failure.
50 */
51 function readline_clear_history () {}
52
53 /**
54 * Lists the history
55 * @link http://www.php.net/manual/en/function.readline-list-history.php
56 * @return array an array of the entire command line history. The elements are
57 * indexed by integers starting at zero.
58 */
59 function readline_list_history () {}
60
61 /**
62 * Reads the history
63 * @link http://www.php.net/manual/en/function.readline-read-history.php
64 * @param filename string[optional] <p>
65 * Path to the filename containing the command history.
66 * </p>
67 * @return bool Returns true on success, false on failure.
68 */
69 function readline_read_history ($filename = null) {}
70
71 /**
72 * Writes the history
73 * @link http://www.php.net/manual/en/function.readline-write-history.php
74 * @param filename string[optional] <p>
75 * Path to the saved file.
76 * </p>
77 * @return bool Returns true on success, false on failure.
78 */
79 function readline_write_history ($filename = null) {}
80
81 /**
82 * Registers a completion function
83 * @link http://www.php.net/manual/en/function.readline-completion-function.php
84 * @param function callable <p>
85 * You must supply the name of an existing function which accepts a
86 * partial command line and returns an array of possible matches.
87 * </p>
88 * @return bool Returns true on success, false on failure.
89 */
90 function readline_completion_function ($function) {}
91
92 /**
93 * Initializes the readline callback interface and terminal, prints the prompt and returns immediately
94 * @link http://www.php.net/manual/en/function.readline-callback-handler-install.php
95 * @param prompt string <p>
96 * The prompt message.
97 * </p>
98 * @param callback callable <p>
99 * The callback function takes one parameter; the
100 * user input returned.
101 * </p>
102 * @return bool Returns true on success, false on failure.
103 */
104 function readline_callback_handler_install ($prompt, $callback) {}
105
106 /**
107 * Reads a character and informs the readline callback interface when a line is received
108 * @link http://www.php.net/manual/en/function.readline-callback-read-char.php
109 * @return void
110 */
111 function readline_callback_read_char () {}
112
113 /**
114 * Removes a previously installed callback handler and restores terminal settings
115 * @link http://www.php.net/manual/en/function.readline-callback-handler-remove.php
116 * @return bool true if a previously installed callback handler was removed, or
117 * false if one could not be found.
118 */
119 function readline_callback_handler_remove () {}
120
121 /**
122 * Redraws the display
123 * @link http://www.php.net/manual/en/function.readline-redisplay.php
124 * @return void
125 */
126 function readline_redisplay () {}
127
128 define ('READLINE_LIB', "readline");
129
130 // End of readline v.5.6.0
131 ?>