diff options
Diffstat (limited to 'lib/public/Http/WellKnown/IRequestContext.php')
-rw-r--r-- | lib/public/Http/WellKnown/IRequestContext.php | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/lib/public/Http/WellKnown/IRequestContext.php b/lib/public/Http/WellKnown/IRequestContext.php new file mode 100644 index 00000000000..d064c467d68 --- /dev/null +++ b/lib/public/Http/WellKnown/IRequestContext.php @@ -0,0 +1,46 @@ +<?php + +declare(strict_types=1); + +/* + * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * 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 + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +namespace OCP\Http\WellKnown; + +use OCP\IRequest; + +/** + * The context object for \OCP\Http\IWellKnownHandler::handle + * + * Objects of this type will transport any optional information, e.g. the request + * object through which the app well known handler can obtain URL parameters + * + * @since 21.0.0 + */ +interface IRequestContext { + + /** + * @return IRequest + * + * @since 21.0.0 + */ + public function getHttpRequest(): IRequest; +} |