diff options
author | Roeland Jago Douma <roeland@famdouma.nl> | 2019-01-17 14:30:47 +0300 |
---|---|---|
committer | Roeland Jago Douma <roeland@famdouma.nl> | 2019-01-30 00:21:54 +0300 |
commit | f30877ea7c758346b700e4ac0f9c684a5ae99c7f (patch) | |
tree | ffbdd342c3bcc42d08d7315e78dc3075fe93a2b9 /lib/public/IInitialStateService.php | |
parent | 139055c1ddec25465dd7644de9866cd6a1048da2 (diff) |
Provide initial state
Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
Diffstat (limited to 'lib/public/IInitialStateService.php')
-rw-r--r-- | lib/public/IInitialStateService.php | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/lib/public/IInitialStateService.php b/lib/public/IInitialStateService.php new file mode 100644 index 00000000000..ff6144e0d45 --- /dev/null +++ b/lib/public/IInitialStateService.php @@ -0,0 +1,56 @@ +<?php +declare(strict_types=1); +/** + * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl> + * + * @author Roeland Jago Douma <roeland@famdouma.nl> + * + * @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; + +/** + * @since 16.0.0 + */ +interface IInitialStateService { + /** + * Allows an app to provide its initial state to the template system. + * Use this if you know your initial state sill be used for example if + * you are in the render function of you controller. + * + * @since 16.0.0 + * + * @param string $appName + * @param bool|int|float|string|array|\JsonSerializable $data + */ + public function provideInitialState(string $appName, $data); + + /** + * Allows an app to provide its initial state via a lazy method. + * This will call the closure when the template is being generated. + * Use this if your app is injected into pages. Since then the render method + * is not called explicitly. But we do not want to load the state on webdav + * requests for example. + * + * @since 16.0.0 + * + * @param string $appName + * @param \Closure $closure Has to return an object that implements JsonSerializable + */ + public function provideLazyInitialState(string $appName, \Closure $closure); +} |