ConfigInterface.php 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. <?php
  2. /**
  3. * Session config interface
  4. *
  5. * Copyright © Magento, Inc. All rights reserved.
  6. * See COPYING.txt for license details.
  7. */
  8. namespace Magento\Framework\Session\Config;
  9. /**
  10. * Interface \Magento\Framework\Session\Config\ConfigInterface
  11. *
  12. */
  13. interface ConfigInterface
  14. {
  15. /**
  16. * Set array of options
  17. *
  18. * @param array $options
  19. * @return $this
  20. */
  21. public function setOptions($options);
  22. /**
  23. * Get all options set
  24. *
  25. * @return array
  26. */
  27. public function getOptions();
  28. /**
  29. * Set an individual option
  30. *
  31. * @param string $option
  32. * @param mixed $value
  33. * @return $this
  34. */
  35. public function setOption($option, $value);
  36. /**
  37. * Get an individual option
  38. *
  39. * @param string $option
  40. * @return mixed
  41. */
  42. public function getOption($option);
  43. /**
  44. * Convert config to array
  45. *
  46. * @return array
  47. */
  48. public function toArray();
  49. /**
  50. * Set session.name
  51. *
  52. * @param string $name
  53. * @return $this
  54. */
  55. public function setName($name);
  56. /**
  57. * Get session.name
  58. *
  59. * @return string
  60. */
  61. public function getName();
  62. /**
  63. * Set session.save_path
  64. *
  65. * @param string $savePath
  66. * @return $this
  67. */
  68. public function setSavePath($savePath);
  69. /**
  70. * Set session.save_path
  71. *
  72. * @return string
  73. */
  74. public function getSavePath();
  75. /**
  76. * Set session.cookie_lifetime
  77. *
  78. * @param int $cookieLifetime
  79. * @return $this
  80. */
  81. public function setCookieLifetime($cookieLifetime);
  82. /**
  83. * Get session.cookie_lifetime
  84. *
  85. * @return int
  86. */
  87. public function getCookieLifetime();
  88. /**
  89. * Set session.cookie_path
  90. *
  91. * @param string $cookiePath
  92. * @return $this
  93. */
  94. public function setCookiePath($cookiePath);
  95. /**
  96. * Get session.cookie_path
  97. *
  98. * @return string
  99. */
  100. public function getCookiePath();
  101. /**
  102. * Set session.cookie_domain
  103. *
  104. * @param string $cookieDomain
  105. * @return $this
  106. */
  107. public function setCookieDomain($cookieDomain);
  108. /**
  109. * Get session.cookie_domain
  110. *
  111. * @return string
  112. */
  113. public function getCookieDomain();
  114. /**
  115. * Set session.cookie_secure
  116. *
  117. * @param bool $cookieSecure
  118. * @return $this
  119. */
  120. public function setCookieSecure($cookieSecure);
  121. /**
  122. * Get session.cookie_secure
  123. *
  124. * @return bool
  125. * @SuppressWarnings(PHPMD.BooleanGetMethodName)
  126. */
  127. public function getCookieSecure();
  128. /**
  129. * Set session.cookie_httponly
  130. *
  131. * @param bool $cookieHttpOnly
  132. * @return $this
  133. */
  134. public function setCookieHttpOnly($cookieHttpOnly);
  135. /**
  136. * Get session.cookie_httponly
  137. *
  138. * @return bool
  139. * @SuppressWarnings(PHPMD.BooleanGetMethodName)
  140. */
  141. public function getCookieHttpOnly();
  142. /**
  143. * Set session.use_cookies
  144. *
  145. * @param bool $useCookies
  146. * @return $this
  147. */
  148. public function setUseCookies($useCookies);
  149. /**
  150. * Get session.use_cookies
  151. *
  152. * @return bool
  153. * @SuppressWarnings(PHPMD.BooleanGetMethodName)
  154. */
  155. public function getUseCookies();
  156. }