diff options
Diffstat (limited to 'lib/public')
| -rw-r--r-- | lib/public/IRequestId.php | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/lib/public/IRequestId.php b/lib/public/IRequestId.php new file mode 100644 index 00000000000..dba06088cc9 --- /dev/null +++ b/lib/public/IRequestId.php @@ -0,0 +1,39 @@ +<?php + +declare(strict_types=1); +/** + * @copyright Copyright (c) 2022, Joas Schilling <coding@schilljs.com> + * + * @author Joas Schilling <coding@schilljs.com> + * + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP; + +/** + * @since 24.0.0 + */ +interface IRequestId { + /** + * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging + * If `mod_unique_id` is installed this value will be taken. + * + * @return string + * @since 24.0.0 + */ + public function getId(): string; +} |