IInitialStateService.php 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP;
  26. use Closure;
  27. /**
  28. * @since 16.0.0
  29. * @deprecated 21 Use OCP\AppFramework\Services\IInitialState or OCP\AppFramework\Services\InitialStateProvider
  30. * @see \OCP\AppFramework\Services\IInitialState
  31. */
  32. interface IInitialStateService {
  33. /**
  34. * Allows an app to provide its initial state to the template system.
  35. * Use this if you know your initial state sill be used for example if
  36. * you are in the render function of you controller.
  37. *
  38. * @since 16.0.0
  39. *
  40. * @param string $appName
  41. * @param string $key
  42. * @param bool|int|float|string|array|\JsonSerializable $data
  43. *
  44. * @deprecated 21 Use OCP\AppFramework\Services\IInitialState or OCP\AppFramework\Services\InitialStateProvider
  45. * @see \OCP\AppFramework\Services\IInitialState::provideInitialState()
  46. */
  47. public function provideInitialState(string $appName, string $key, $data): void;
  48. /**
  49. * Allows an app to provide its initial state via a lazy method.
  50. * This will call the closure when the template is being generated.
  51. * Use this if your app is injected into pages. Since then the render method
  52. * is not called explicitly. But we do not want to load the state on webdav
  53. * requests for example.
  54. *
  55. * @since 16.0.0
  56. *
  57. * @param string $appName
  58. * @param string $key
  59. * @param Closure $closure returns a primitive or an object that implements JsonSerializable
  60. *
  61. * @deprecated 21 Use OCP\AppFramework\Services\IInitialState or OCP\AppFramework\Services\InitialStateProvider
  62. * @see \OCP\AppFramework\Services\IInitialState::provideLazyInitialState()
  63. */
  64. public function provideLazyInitialState(string $appName, string $key, Closure $closure): void;
  65. }