Context.php 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Backend\App\Action;
  7. use Magento\Framework\Controller\ResultFactory;
  8. /**
  9. * Constructor modification point for Magento\Backend\App\Action.
  10. *
  11. * All context classes were introduced to allow for backwards compatible constructor modifications
  12. * of classes that were supposed to be extended by extension developers.
  13. *
  14. * Do not call methods of this class directly.
  15. *
  16. * As Magento moves from inheritance-based APIs all such classes will be deprecated together with
  17. * the classes they were introduced for.
  18. *
  19. * @api
  20. * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  21. * @since 100.0.2
  22. */
  23. class Context extends \Magento\Framework\App\Action\Context
  24. {
  25. /**
  26. * @var \Magento\Framework\AuthorizationInterface
  27. */
  28. protected $_authorization;
  29. /**
  30. * @var \Magento\Backend\Model\Auth
  31. */
  32. protected $_auth;
  33. /**
  34. * @var \Magento\Backend\Helper\Data
  35. */
  36. protected $_helper;
  37. /**
  38. * @var \Magento\Backend\Model\UrlInterface
  39. */
  40. protected $_backendUrl;
  41. /**
  42. * @var \Magento\Framework\Data\Form\FormKey\Validator
  43. */
  44. protected $_formKeyValidator;
  45. /**
  46. * @var bool
  47. */
  48. protected $_canUseBaseUrl;
  49. /**
  50. * @var \Magento\Backend\Model\Session
  51. */
  52. protected $_session;
  53. /**
  54. * @var \Magento\Framework\Locale\ResolverInterface
  55. */
  56. protected $_localeResolver;
  57. /**
  58. * @param \Magento\Framework\App\RequestInterface $request
  59. * @param \Magento\Framework\App\ResponseInterface $response
  60. * @param \Magento\Framework\ObjectManagerInterface $objectManager
  61. * @param \Magento\Framework\Event\ManagerInterface $eventManager
  62. * @param \Magento\Framework\UrlInterface $url
  63. * @param \Magento\Framework\App\Response\RedirectInterface $redirect
  64. * @param \Magento\Framework\App\ActionFlag $actionFlag
  65. * @param \Magento\Framework\App\ViewInterface $view
  66. * @param \Magento\Framework\Message\ManagerInterface $messageManager
  67. * @param \Magento\Backend\Model\View\Result\RedirectFactory $resultRedirectFactory
  68. * @param \Magento\Framework\Controller\ResultFactory $resultFactory
  69. * @param \Magento\Backend\Model\Session $session
  70. * @param \Magento\Framework\AuthorizationInterface $authorization
  71. * @param \Magento\Backend\Model\Auth $auth
  72. * @param \Magento\Backend\Helper\Data $helper
  73. * @param \Magento\Backend\Model\UrlInterface $backendUrl
  74. * @param \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator
  75. * @param \Magento\Framework\Locale\ResolverInterface $localeResolver
  76. * @param bool $canUseBaseUrl
  77. * @SuppressWarnings(PHPMD.ExcessiveParameterList)
  78. */
  79. public function __construct(
  80. \Magento\Framework\App\RequestInterface $request,
  81. \Magento\Framework\App\ResponseInterface $response,
  82. \Magento\Framework\ObjectManagerInterface $objectManager,
  83. \Magento\Framework\Event\ManagerInterface $eventManager,
  84. \Magento\Framework\UrlInterface $url,
  85. \Magento\Framework\App\Response\RedirectInterface $redirect,
  86. \Magento\Framework\App\ActionFlag $actionFlag,
  87. \Magento\Framework\App\ViewInterface $view,
  88. \Magento\Framework\Message\ManagerInterface $messageManager,
  89. \Magento\Backend\Model\View\Result\RedirectFactory $resultRedirectFactory,
  90. ResultFactory $resultFactory,
  91. \Magento\Backend\Model\Session $session,
  92. \Magento\Framework\AuthorizationInterface $authorization,
  93. \Magento\Backend\Model\Auth $auth,
  94. \Magento\Backend\Helper\Data $helper,
  95. \Magento\Backend\Model\UrlInterface $backendUrl,
  96. \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator,
  97. \Magento\Framework\Locale\ResolverInterface $localeResolver,
  98. $canUseBaseUrl = false
  99. ) {
  100. parent::__construct(
  101. $request,
  102. $response,
  103. $objectManager,
  104. $eventManager,
  105. $url,
  106. $redirect,
  107. $actionFlag,
  108. $view,
  109. $messageManager,
  110. $resultRedirectFactory,
  111. $resultFactory
  112. );
  113. $this->_session = $session;
  114. $this->_authorization = $authorization;
  115. $this->_auth = $auth;
  116. $this->_helper = $helper;
  117. $this->_backendUrl = $backendUrl;
  118. $this->_formKeyValidator = $formKeyValidator;
  119. $this->_localeResolver = $localeResolver;
  120. $this->_canUseBaseUrl = $canUseBaseUrl;
  121. }
  122. /**
  123. * @return \Magento\Backend\Model\Auth
  124. */
  125. public function getAuth()
  126. {
  127. return $this->_auth;
  128. }
  129. /**
  130. * @return \Magento\Framework\AuthorizationInterface
  131. */
  132. public function getAuthorization()
  133. {
  134. return $this->_authorization;
  135. }
  136. /**
  137. * @return \Magento\Backend\Model\UrlInterface
  138. */
  139. public function getBackendUrl()
  140. {
  141. return $this->_backendUrl;
  142. }
  143. /**
  144. * @return boolean
  145. * @SuppressWarnings(PHPMD.BooleanGetMethodName)
  146. */
  147. public function getCanUseBaseUrl()
  148. {
  149. return $this->_canUseBaseUrl;
  150. }
  151. /**
  152. * @return \Magento\Framework\Data\Form\FormKey\Validator
  153. */
  154. public function getFormKeyValidator()
  155. {
  156. return $this->_formKeyValidator;
  157. }
  158. /**
  159. * @return \Magento\Backend\Helper\Data
  160. */
  161. public function getHelper()
  162. {
  163. return $this->_helper;
  164. }
  165. /**
  166. * @return \Magento\Framework\Locale\ResolverInterface
  167. */
  168. public function getLocaleResolver()
  169. {
  170. return $this->_localeResolver;
  171. }
  172. /**
  173. * @return \Magento\Backend\Model\Session
  174. */
  175. public function getSession()
  176. {
  177. return $this->_session;
  178. }
  179. }