@@ -35,37 +35,37 @@ |
||
| 35 | 35 | * @see \OCP\AppFramework\Services\IInitialState |
| 36 | 36 | */ |
| 37 | 37 | interface IInitialStateService { |
| 38 | - /** |
|
| 39 | - * Allows an app to provide its initial state to the template system. |
|
| 40 | - * Use this if you know your initial state sill be used for example if |
|
| 41 | - * you are in the render function of you controller. |
|
| 42 | - * |
|
| 43 | - * @since 16.0.0 |
|
| 44 | - * |
|
| 45 | - * @param string $appName |
|
| 46 | - * @param string $key |
|
| 47 | - * @param bool|int|float|string|array|\JsonSerializable $data |
|
| 48 | - * |
|
| 49 | - * @deprecated 21 Use OCP\AppFramework\Services\IInitialState or OCP\AppFramework\Services\InitialStateProvider |
|
| 50 | - * @see \OCP\AppFramework\Services\IInitialState::provideInitialState() |
|
| 51 | - */ |
|
| 52 | - public function provideInitialState(string $appName, string $key, $data): void; |
|
| 38 | + /** |
|
| 39 | + * Allows an app to provide its initial state to the template system. |
|
| 40 | + * Use this if you know your initial state sill be used for example if |
|
| 41 | + * you are in the render function of you controller. |
|
| 42 | + * |
|
| 43 | + * @since 16.0.0 |
|
| 44 | + * |
|
| 45 | + * @param string $appName |
|
| 46 | + * @param string $key |
|
| 47 | + * @param bool|int|float|string|array|\JsonSerializable $data |
|
| 48 | + * |
|
| 49 | + * @deprecated 21 Use OCP\AppFramework\Services\IInitialState or OCP\AppFramework\Services\InitialStateProvider |
|
| 50 | + * @see \OCP\AppFramework\Services\IInitialState::provideInitialState() |
|
| 51 | + */ |
|
| 52 | + public function provideInitialState(string $appName, string $key, $data): void; |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Allows an app to provide its initial state via a lazy method. |
|
| 56 | - * This will call the closure when the template is being generated. |
|
| 57 | - * Use this if your app is injected into pages. Since then the render method |
|
| 58 | - * is not called explicitly. But we do not want to load the state on webdav |
|
| 59 | - * requests for example. |
|
| 60 | - * |
|
| 61 | - * @since 16.0.0 |
|
| 62 | - * |
|
| 63 | - * @param string $appName |
|
| 64 | - * @param string $key |
|
| 65 | - * @param Closure $closure returns a primitive or an object that implements JsonSerializable |
|
| 66 | - * |
|
| 67 | - * @deprecated 21 Use OCP\AppFramework\Services\IInitialState or OCP\AppFramework\Services\InitialStateProvider |
|
| 68 | - * @see \OCP\AppFramework\Services\IInitialState::provideLazyInitialState() |
|
| 69 | - */ |
|
| 70 | - public function provideLazyInitialState(string $appName, string $key, Closure $closure): void; |
|
| 54 | + /** |
|
| 55 | + * Allows an app to provide its initial state via a lazy method. |
|
| 56 | + * This will call the closure when the template is being generated. |
|
| 57 | + * Use this if your app is injected into pages. Since then the render method |
|
| 58 | + * is not called explicitly. But we do not want to load the state on webdav |
|
| 59 | + * requests for example. |
|
| 60 | + * |
|
| 61 | + * @since 16.0.0 |
|
| 62 | + * |
|
| 63 | + * @param string $appName |
|
| 64 | + * @param string $key |
|
| 65 | + * @param Closure $closure returns a primitive or an object that implements JsonSerializable |
|
| 66 | + * |
|
| 67 | + * @deprecated 21 Use OCP\AppFramework\Services\IInitialState or OCP\AppFramework\Services\InitialStateProvider |
|
| 68 | + * @see \OCP\AppFramework\Services\IInitialState::provideLazyInitialState() |
|
| 69 | + */ |
|
| 70 | + public function provideLazyInitialState(string $appName, string $key, Closure $closure): void; |
|
| 71 | 71 | } |