vendor/pimcore/pimcore/lib/Tool/Session.php line 133

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6. * Pimcore
  7. *
  8. * This source file is available under two different licenses:
  9. * - GNU General Public License version 3 (GPLv3)
  10. * - Pimcore Commercial License (PCL)
  11. * Full copyright and license information is available in
  12. * LICENSE.md which is distributed with this source code.
  13. *
  14. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15. * @license http://www.pimcore.org/license GPLv3 and PCL
  16. */
  18. namespace Pimcore\Tool;
  20. use Pimcore\Bundle\AdminBundle\Session\Handler\AdminSessionHandler;
  21. use Pimcore\Bundle\AdminBundle\Session\Handler\AdminSessionHandlerInterface;
  22. use Symfony\Component\HttpFoundation\Request;
  23. use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
  25. final class Session
  26. {
  27. /**
  28. * @var AdminSessionHandlerInterface
  29. */
  30. private static $handler;
  32. public static function getHandler(): AdminSessionHandlerInterface
  33. {
  34. if (null === static::$handler) {
  35. static::$handler = \Pimcore::getContainer()->get(AdminSessionHandler::class);
  36. }
  38. return static::$handler;
  39. }
  41. public static function setHandler(AdminSessionHandlerInterface $handler)
  42. {
  43. static::$handler = $handler;
  44. }
  46. /**
  47. * @param callable $func
  48. * @param string $namespace
  49. *
  50. * @return mixed
  51. */
  52. public static function useSession($func, string $namespace = 'pimcore_admin')
  53. {
  54. return static::getHandler()->useSessionAttributeBag($func, $namespace);
  55. }
  57. /**
  58. * @return string
  59. */
  60. public static function getSessionId()
  61. {
  62. return static::getHandler()->getSessionId();
  63. }
  65. /**
  66. * @return string
  67. */
  68. public static function getSessionName()
  69. {
  70. return static::getHandler()->getSessionName();
  71. }
  73. /**
  74. * @return bool
  75. */
  76. public static function invalidate(): bool
  77. {
  78. return static::getHandler()->invalidate();
  79. }
  81. /**
  82. * @return bool
  83. */
  84. public static function regenerateId(): bool
  85. {
  86. return static::getHandler()->regenerateId();
  87. }
  89. /**
  90. * @param Request $request
  91. * @param bool $checkRequestParams
  92. *
  93. * @return bool
  94. */
  95. public static function requestHasSessionId(Request $request, bool $checkRequestParams = false): bool
  96. {
  97. return static::getHandler()->requestHasSessionId($request, $checkRequestParams);
  98. }
  100. /**
  101. * @param Request $request
  102. * @param bool $checkRequestParams
  103. *
  104. * @return string
  105. */
  106. public static function getSessionIdFromRequest(Request $request, bool $checkRequestParams = false)
  107. {
  108. return static::getHandler()->getSessionIdFromRequest($request, $checkRequestParams);
  109. }
  111. /**
  112. * Start session and get an attribute bag
  113. *
  114. * @param string $namespace
  115. *
  116. * @return AttributeBagInterface|null
  117. */
  118. public static function get(string $namespace = 'pimcore_admin')
  119. {
  120. $bag = static::getHandler()->loadAttributeBag($namespace);
  121. if ($bag instanceof AttributeBagInterface) {
  122. return $bag;
  123. }
  125. return null;
  126. }
  128. /**
  129. * @param string $namespace
  130. *
  131. * @return AttributeBagInterface
  132. */
  133. public static function getReadOnly(string $namespace = 'pimcore_admin'): AttributeBagInterface
  134. {
  135. return static::getHandler()->getReadOnlyAttributeBag($namespace);
  136. }
  138. /**
  139. * Saves the session if it is the last admin session which was opene
  140. */
  141. public static function writeClose()
  142. {
  143. return static::getHandler()->writeClose();
  144. }
  145. }