SecurityCookie.php 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Security\Model;
  7. use Magento\Framework\Stdlib\Cookie\CookieReaderInterface;
  8. /**
  9. * Manager for a cookie with logout reason
  10. *
  11. * @api
  12. * @since 100.1.0
  13. */
  14. class SecurityCookie
  15. {
  16. /**
  17. * Cookie name
  18. */
  19. const LOGOUT_REASON_CODE_COOKIE_NAME = 'loggedOutReasonCode';
  20. /**
  21. * @var \Magento\Framework\Stdlib\Cookie\PhpCookieManager
  22. */
  23. private $phpCookieManager;
  24. /**
  25. * @var \Magento\Backend\Helper\Data
  26. */
  27. private $backendData;
  28. /**
  29. * @var \Magento\Framework\Stdlib\Cookie\PublicCookieMetadataFactory
  30. */
  31. private $cookieMetadataFactory;
  32. /**
  33. * @var CookieReaderInterface
  34. */
  35. private $cookieReader;
  36. /**
  37. * @param \Magento\Framework\Stdlib\Cookie\PhpCookieManager $phpCookieManager
  38. * @param \Magento\Framework\Stdlib\Cookie\PublicCookieMetadataFactory $cookieMetadataFactory
  39. * @param CookieReaderInterface $cookieReader
  40. * @param \Magento\Backend\Helper\Data $backendData
  41. */
  42. public function __construct(
  43. \Magento\Framework\Stdlib\Cookie\PhpCookieManager $phpCookieManager,
  44. \Magento\Framework\Stdlib\Cookie\PublicCookieMetadataFactory $cookieMetadataFactory,
  45. CookieReaderInterface $cookieReader,
  46. \Magento\Backend\Helper\Data $backendData
  47. ) {
  48. $this->phpCookieManager = $phpCookieManager;
  49. $this->cookieMetadataFactory = $cookieMetadataFactory;
  50. $this->cookieReader = $cookieReader;
  51. $this->backendData = $backendData;
  52. }
  53. /**
  54. * Get cookie with logout reason code
  55. *
  56. * @return string|int
  57. * @since 100.1.0
  58. */
  59. public function getLogoutReasonCookie()
  60. {
  61. return (int) $this->cookieReader->getCookie(self::LOGOUT_REASON_CODE_COOKIE_NAME, -1);
  62. }
  63. /**
  64. * Set logout reason cookie
  65. *
  66. * @param int $status
  67. * @return $this
  68. * @since 100.1.0
  69. */
  70. public function setLogoutReasonCookie($status)
  71. {
  72. $metaData = $this->createCookieMetaData();
  73. $metaData->setPath('/' . $this->backendData->getAreaFrontName());
  74. $this->phpCookieManager->setPublicCookie(
  75. self::LOGOUT_REASON_CODE_COOKIE_NAME,
  76. (int) $status,
  77. $metaData
  78. );
  79. return $this;
  80. }
  81. /**
  82. * Delete cookie with reason of logout
  83. *
  84. * @return $this
  85. * @since 100.1.0
  86. */
  87. public function deleteLogoutReasonCookie()
  88. {
  89. $metaData = $this->createCookieMetaData();
  90. $metaData->setPath('/' . $this->backendData->getAreaFrontName())->setDuration(-1);
  91. $this->phpCookieManager->setPublicCookie(
  92. self::LOGOUT_REASON_CODE_COOKIE_NAME,
  93. '',
  94. $metaData
  95. );
  96. return $this;
  97. }
  98. /**
  99. * Create Cookie Metadata instance
  100. *
  101. * @return \Magento\Framework\Stdlib\Cookie\PublicCookieMetadata
  102. */
  103. private function createCookieMetaData()
  104. {
  105. return $this->cookieMetadataFactory->create();
  106. }
  107. }