-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20852 from nextcloud/enh/initialstate/appframework
Add InitialState Appframework service
- Loading branch information
Showing
5 changed files
with
114 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2020, 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 OC\AppFramework\Services; | ||
|
|
||
| use OCP\AppFramework\Services\IInitialState; | ||
| use OCP\IInitialStateService; | ||
|
|
||
| class InitialState implements IInitialState { | ||
| /** @var IInitialStateService */ | ||
| private $state; | ||
|
|
||
| /** @var string */ | ||
| private $appName; | ||
|
|
||
| public function __construct(IInitialStateService $state, string $appName) { | ||
| $this->state = $state; | ||
| $this->appName = $appName; | ||
| } | ||
|
|
||
| public function provideInitialState(string $key, $data): void { | ||
| $this->state->provideInitialState($this->appName, $key, $data); | ||
| } | ||
|
|
||
| public function provideLazyInitialState(string $key, \Closure $closure): void { | ||
| $this->state->provideLazyInitialState($this->appName, $key, $closure); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2020, 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\AppFramework\Services; | ||
|
|
||
| /** | ||
| * @since 20.0.0 | ||
| */ | ||
| interface IInitialState { | ||
|
|
||
| /** | ||
| * 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 20.0.0 | ||
| * | ||
| * @param string $key | ||
| * @param bool|int|float|string|array|\JsonSerializable $data | ||
| */ | ||
| public function provideInitialState(string $key, $data): void; | ||
|
|
||
| /** | ||
| * 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 20.0.0 | ||
| * | ||
| * @param string $key | ||
| * @param Closure $closure returns a primitive or an object that implements JsonSerializable | ||
| */ | ||
| public function provideLazyInitialState(string $key, \Closure $closure): void; | ||
| } |