Verzeichnisstruktur phpBB-3.3.15
- Veröffentlicht
- 28.08.2024
So funktioniert es
|
|
Auf das letzte Element klicken. Dies geht jeweils ein Schritt zurück |
Auf das Icon klicken, dies öffnet das Verzeichnis. Nochmal klicken schließt das Verzeichnis. |
|
|
(Beispiel Datei-Icons)
|
Auf das Icon klicken um den Quellcode anzuzeigen |
iohandler_interface.php
001 <?php
002 /**
003 *
004 * This file is part of the phpBB Forum Software package.
005 *
006 * @copyright (c) phpBB Limited <https://www.phpbb.com>
007 * @license GNU General Public License, version 2 (GPL-2.0)
008 *
009 * For full copyright and license information, please see
010 * the docs/CREDITS.txt file.
011 *
012 */
013
014 namespace phpbb\install\helper\iohandler;
015
016 /**
017 * Input-Output handler interface for the installer
018 */
019 interface iohandler_interface
020 {
021 /**
022 * Renders or returns response message
023 *
024 * @param bool $no_more_output Whether or not there will be more output in this output unit
025 */
026 public function send_response($no_more_output = false);
027
028 /**
029 * Returns input variable
030 *
031 * @param string $name Name of the input variable to obtain
032 * @param mixed $default A default value that is returned if the variable was not set.
033 * This function will always return a value of the same type as the default.
034 * @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
035 * Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
036 *
037 * @return mixed Value of the input variable
038 */
039 public function get_input($name, $default, $multibyte = false);
040
041 /**
042 * Returns raw input variable
043 *
044 * @param string $name Name of the input variable to obtain
045 * @param mixed $default A default value that is returned if the variable was not set.
046 * This function will always return a value of the same type as the default.
047 *
048 * @return mixed Value of the raw input variable
049 */
050 public function get_raw_input($name, $default);
051
052 /**
053 * Returns server variable
054 *
055 * This function should work the same as request_interface::server().
056 *
057 * @param string $name Name of the server variable
058 * @param mixed $default Default value to return when the requested variable does not exist
059 *
060 * @return mixed Value of the server variable
061 */
062 public function get_server_variable($name, $default = '');
063
064 /**
065 * Wrapper function for request_interface::header()
066 *
067 * @param string $name Name of the request header variable
068 * @param mixed $default Default value to return when the requested variable does not exist
069 *
070 * @return mixed
071 */
072 public function get_header_variable($name, $default = '');
073
074 /**
075 * Returns true if the connection is encrypted
076 *
077 * @return bool
078 */
079 public function is_secure();
080
081 /**
082 * Adds an error message to the rendering queue
083 *
084 * Note: When an array is passed into the parameters below, it will be
085 * resolved as printf($param[0], $param[1], ...).
086 *
087 * @param string|array $error_title Title of the error message.
088 * @param string|bool|array $error_description Description of the error (and possibly guidelines to resolve it),
089 * or false if the error description is not available.
090 */
091 public function add_error_message($error_title, $error_description = false);
092
093 /**
094 * Adds a warning message to the rendering queue
095 *
096 * Note: When an array is passed into the parameters below, it will be
097 * resolved as printf($param[0], $param[1], ...).
098 *
099 * @param string|array $warning_title Title of the warning message
100 * @param string|bool|array $warning_description Description of the warning (and possibly guidelines to resolve it),
101 * or false if the warning description is not available
102 */
103 public function add_warning_message($warning_title, $warning_description = false);
104
105 /**
106 * Adds a log message to the rendering queue
107 *
108 * Note: When an array is passed into the parameters below, it will be
109 * resolved as printf($param[0], $param[1], ...).
110 *
111 * @param string|array $log_title Title of the log message
112 * @param string|bool|array $log_description Description of the log,
113 * or false if the log description is not available
114 */
115 public function add_log_message($log_title, $log_description = false);
116
117 /**
118 * Adds a success message to the rendering queue
119 *
120 * Note: When an array is passed into the parameters below, it will be
121 * resolved as printf($param[0], $param[1], ...).
122 *
123 * @param string|array $success_title Title of the success message
124 * @param string|bool|array $success_description Description of the success,
125 * or false if the success description is not available
126 *
127 * @return null
128 */
129 public function add_success_message($success_title, $success_description = false);
130
131 /**
132 * Adds a requested data group to the rendering queue
133 *
134 * @param string $title Language variable with the title of the form
135 * @param array $form An array describing the required data (options etc)
136 */
137 public function add_user_form_group($title, $form);
138
139 /**
140 * Returns the rendering information for the form
141 *
142 * @param string $title Language variable with the title of the form
143 * @param array $form An array describing the required data (options etc)
144 *
145 * @return string Information to render the form
146 */
147 public function generate_form_render_data($title, $form);
148
149 /**
150 * Sets the number of tasks belonging to the installer in the current mode.
151 *
152 * @param int $task_count Number of tasks
153 * @param bool $restart Whether or not to restart the progress bar, false by default
154 */
155 public function set_task_count($task_count, $restart = false);
156
157 /**
158 * Sets the progress information
159 *
160 * @param string $task_lang_key Language key for the name of the task
161 * @param int $task_number Position of the current task in the task queue
162 */
163 public function set_progress($task_lang_key, $task_number);
164
165 /**
166 * Sends refresh request to the client
167 */
168 public function request_refresh();
169
170 /**
171 * Marks stage as active in the navigation bar
172 *
173 * @param array $menu_path Array to the navigation elem
174 */
175 public function set_active_stage_menu($menu_path);
176
177 /**
178 * Marks stage as completed in the navigation bar
179 *
180 * @param array $menu_path Array to the navigation elem
181 */
182 public function set_finished_stage_menu($menu_path);
183
184 /**
185 * Finish the progress bar
186 *
187 * @param string $message_lang_key Language key for the message
188 */
189 public function finish_progress($message_lang_key);
190
191 /**
192 * Adds a download link
193 *
194 * @param string $route Route for the link
195 * @param string $title Language key for the title
196 * @param string|null|array $msg Language key for the message
197 */
198 public function add_download_link($route, $title, $msg = null);
199
200 /**
201 * Redirects the user to a new page
202 *
203 * @param string $url URL to redirect to
204 * @param bool $use_ajax Whether or not to use AJAX redirect
205 */
206 public function redirect($url, $use_ajax = false);
207
208 /**
209 * Renders the status of update files
210 *
211 * @param array $status_array Array containing files in groups to render
212 */
213 public function render_update_file_status($status_array);
214
215 /**
216 * Sends and sets cookies
217 *
218 * @param string $cookie_name Name of the cookie to set
219 * @param string $cookie_value Value of the cookie to set
220 */
221 public function set_cookie($cookie_name, $cookie_value);
222 }
223