@@ -25,52 +25,52 @@ |
||
| 25 | 25 | abstract class Middleware implements RequestDecoratorInterface |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var RequestDecoratorInterface $request_stack_app |
|
| 30 | - */ |
|
| 31 | - protected $request_stack_app; |
|
| 28 | + /** |
|
| 29 | + * @var RequestDecoratorInterface $request_stack_app |
|
| 30 | + */ |
|
| 31 | + protected $request_stack_app; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var RequestInterface $request |
|
| 35 | - */ |
|
| 36 | - protected $request; |
|
| 33 | + /** |
|
| 34 | + * @var RequestInterface $request |
|
| 35 | + */ |
|
| 36 | + protected $request; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var ResponseInterface $response |
|
| 40 | - */ |
|
| 41 | - protected $response; |
|
| 38 | + /** |
|
| 39 | + * @var ResponseInterface $response |
|
| 40 | + */ |
|
| 41 | + protected $response; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @var LoaderInterface |
|
| 45 | - */ |
|
| 46 | - protected $loader; |
|
| 43 | + /** |
|
| 44 | + * @var LoaderInterface |
|
| 45 | + */ |
|
| 46 | + protected $loader; |
|
| 47 | 47 | |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @param RequestDecoratorInterface $request_stack_app |
|
| 51 | - * @param LoaderInterface $loader |
|
| 52 | - */ |
|
| 53 | - public function __construct(RequestDecoratorInterface $request_stack_app, LoaderInterface $loader) |
|
| 54 | - { |
|
| 55 | - $this->request_stack_app = $request_stack_app; |
|
| 56 | - $this->loader = $loader; |
|
| 57 | - } |
|
| 49 | + /** |
|
| 50 | + * @param RequestDecoratorInterface $request_stack_app |
|
| 51 | + * @param LoaderInterface $loader |
|
| 52 | + */ |
|
| 53 | + public function __construct(RequestDecoratorInterface $request_stack_app, LoaderInterface $loader) |
|
| 54 | + { |
|
| 55 | + $this->request_stack_app = $request_stack_app; |
|
| 56 | + $this->loader = $loader; |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * process_request_stack |
|
| 62 | - * |
|
| 63 | - * @param RequestInterface $request |
|
| 64 | - * @param ResponseInterface $response |
|
| 65 | - * @return ResponseInterface |
|
| 66 | - */ |
|
| 67 | - protected function processRequestStack(RequestInterface $request, ResponseInterface $response) |
|
| 68 | - { |
|
| 69 | - $this->request = $request; |
|
| 70 | - $this->response = $response; |
|
| 71 | - if (! $this->response->requestTerminated()) { |
|
| 72 | - $this->response = $this->request_stack_app->handleRequest($this->request, $this->response); |
|
| 73 | - } |
|
| 74 | - return $this->response; |
|
| 75 | - } |
|
| 60 | + /** |
|
| 61 | + * process_request_stack |
|
| 62 | + * |
|
| 63 | + * @param RequestInterface $request |
|
| 64 | + * @param ResponseInterface $response |
|
| 65 | + * @return ResponseInterface |
|
| 66 | + */ |
|
| 67 | + protected function processRequestStack(RequestInterface $request, ResponseInterface $response) |
|
| 68 | + { |
|
| 69 | + $this->request = $request; |
|
| 70 | + $this->response = $response; |
|
| 71 | + if (! $this->response->requestTerminated()) { |
|
| 72 | + $this->response = $this->request_stack_app->handleRequest($this->request, $this->response); |
|
| 73 | + } |
|
| 74 | + return $this->response; |
|
| 75 | + } |
|
| 76 | 76 | } |
@@ -68,7 +68,7 @@ |
||
| 68 | 68 | { |
| 69 | 69 | $this->request = $request; |
| 70 | 70 | $this->response = $response; |
| 71 | - if (! $this->response->requestTerminated()) { |
|
| 71 | + if ( ! $this->response->requestTerminated()) { |
|
| 72 | 72 | $this->response = $this->request_stack_app->handleRequest($this->request, $this->response); |
| 73 | 73 | } |
| 74 | 74 | return $this->response; |
@@ -16,37 +16,37 @@ |
||
| 16 | 16 | { |
| 17 | 17 | |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * setCollectionInterface |
|
| 21 | - * |
|
| 22 | - * @access protected |
|
| 23 | - * @param string $collection_interface |
|
| 24 | - */ |
|
| 25 | - protected function setCollectionInterface($collection_interface) |
|
| 26 | - { |
|
| 27 | - $this->collection_interface = ''; |
|
| 28 | - } |
|
| 19 | + /** |
|
| 20 | + * setCollectionInterface |
|
| 21 | + * |
|
| 22 | + * @access protected |
|
| 23 | + * @param string $collection_interface |
|
| 24 | + */ |
|
| 25 | + protected function setCollectionInterface($collection_interface) |
|
| 26 | + { |
|
| 27 | + $this->collection_interface = ''; |
|
| 28 | + } |
|
| 29 | 29 | |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * add |
|
| 33 | - * attaches an object to the Collection |
|
| 34 | - * and sets any supplied data associated with the current iterator entry |
|
| 35 | - * by calling EE_Object_Collection::set_identifier() |
|
| 36 | - * |
|
| 37 | - * @access public |
|
| 38 | - * @param mixed $object |
|
| 39 | - * @param mixed $identifier |
|
| 40 | - * @return bool |
|
| 41 | - * @throws InvalidEntityException |
|
| 42 | - */ |
|
| 43 | - public function add($object, $identifier = null) |
|
| 44 | - { |
|
| 45 | - if (! is_object($object)) { |
|
| 46 | - throw new InvalidEntityException($object, 'object'); |
|
| 47 | - } |
|
| 48 | - $this->attach($object); |
|
| 49 | - $this->setIdentifier($object, $identifier); |
|
| 50 | - return $this->contains($object); |
|
| 51 | - } |
|
| 31 | + /** |
|
| 32 | + * add |
|
| 33 | + * attaches an object to the Collection |
|
| 34 | + * and sets any supplied data associated with the current iterator entry |
|
| 35 | + * by calling EE_Object_Collection::set_identifier() |
|
| 36 | + * |
|
| 37 | + * @access public |
|
| 38 | + * @param mixed $object |
|
| 39 | + * @param mixed $identifier |
|
| 40 | + * @return bool |
|
| 41 | + * @throws InvalidEntityException |
|
| 42 | + */ |
|
| 43 | + public function add($object, $identifier = null) |
|
| 44 | + { |
|
| 45 | + if (! is_object($object)) { |
|
| 46 | + throw new InvalidEntityException($object, 'object'); |
|
| 47 | + } |
|
| 48 | + $this->attach($object); |
|
| 49 | + $this->setIdentifier($object, $identifier); |
|
| 50 | + return $this->contains($object); |
|
| 51 | + } |
|
| 52 | 52 | } |
@@ -42,7 +42,7 @@ |
||
| 42 | 42 | */ |
| 43 | 43 | public function add($object, $identifier = null) |
| 44 | 44 | { |
| 45 | - if (! is_object($object)) { |
|
| 45 | + if ( ! is_object($object)) { |
|
| 46 | 46 | throw new InvalidEntityException($object, 'object'); |
| 47 | 47 | } |
| 48 | 48 | $this->attach($object); |
@@ -12,71 +12,71 @@ |
||
| 12 | 12 | abstract class NoticeConverter implements NoticeConverterInterface |
| 13 | 13 | { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var NoticesContainerInterface $notices |
|
| 17 | - */ |
|
| 18 | - private $notices; |
|
| 19 | - |
|
| 20 | - /** |
|
| 21 | - * if set to true, then errors will be thrown as exceptions |
|
| 22 | - * |
|
| 23 | - * @var boolean $throw_exceptions |
|
| 24 | - */ |
|
| 25 | - private $throw_exceptions; |
|
| 26 | - |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * NoticeConverter constructor. |
|
| 30 | - * |
|
| 31 | - * @param bool $throw_exceptions |
|
| 32 | - */ |
|
| 33 | - public function __construct($throw_exceptions = false) |
|
| 34 | - { |
|
| 35 | - $this->throw_exceptions = $throw_exceptions; |
|
| 36 | - } |
|
| 37 | - |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * @return NoticesContainerInterface |
|
| 41 | - */ |
|
| 42 | - public function getNotices() |
|
| 43 | - { |
|
| 44 | - return $this->notices; |
|
| 45 | - } |
|
| 46 | - |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @param NoticesContainerInterface $notices |
|
| 50 | - */ |
|
| 51 | - protected function setNotices(NoticesContainerInterface $notices) |
|
| 52 | - { |
|
| 53 | - $this->notices = $notices; |
|
| 54 | - } |
|
| 55 | - |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * @return bool |
|
| 59 | - */ |
|
| 60 | - public function getThrowExceptions() |
|
| 61 | - { |
|
| 62 | - return $this->throw_exceptions; |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @param bool $throw_exceptions |
|
| 68 | - */ |
|
| 69 | - public function setThrowExceptions($throw_exceptions) |
|
| 70 | - { |
|
| 71 | - $this->throw_exceptions = filter_var($throw_exceptions, FILTER_VALIDATE_BOOLEAN); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * @return void; |
|
| 77 | - */ |
|
| 78 | - public function clearNotices() |
|
| 79 | - { |
|
| 80 | - $this->notices = null; |
|
| 81 | - } |
|
| 15 | + /** |
|
| 16 | + * @var NoticesContainerInterface $notices |
|
| 17 | + */ |
|
| 18 | + private $notices; |
|
| 19 | + |
|
| 20 | + /** |
|
| 21 | + * if set to true, then errors will be thrown as exceptions |
|
| 22 | + * |
|
| 23 | + * @var boolean $throw_exceptions |
|
| 24 | + */ |
|
| 25 | + private $throw_exceptions; |
|
| 26 | + |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * NoticeConverter constructor. |
|
| 30 | + * |
|
| 31 | + * @param bool $throw_exceptions |
|
| 32 | + */ |
|
| 33 | + public function __construct($throw_exceptions = false) |
|
| 34 | + { |
|
| 35 | + $this->throw_exceptions = $throw_exceptions; |
|
| 36 | + } |
|
| 37 | + |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * @return NoticesContainerInterface |
|
| 41 | + */ |
|
| 42 | + public function getNotices() |
|
| 43 | + { |
|
| 44 | + return $this->notices; |
|
| 45 | + } |
|
| 46 | + |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @param NoticesContainerInterface $notices |
|
| 50 | + */ |
|
| 51 | + protected function setNotices(NoticesContainerInterface $notices) |
|
| 52 | + { |
|
| 53 | + $this->notices = $notices; |
|
| 54 | + } |
|
| 55 | + |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * @return bool |
|
| 59 | + */ |
|
| 60 | + public function getThrowExceptions() |
|
| 61 | + { |
|
| 62 | + return $this->throw_exceptions; |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @param bool $throw_exceptions |
|
| 68 | + */ |
|
| 69 | + public function setThrowExceptions($throw_exceptions) |
|
| 70 | + { |
|
| 71 | + $this->throw_exceptions = filter_var($throw_exceptions, FILTER_VALIDATE_BOOLEAN); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * @return void; |
|
| 77 | + */ |
|
| 78 | + public function clearNotices() |
|
| 79 | + { |
|
| 80 | + $this->notices = null; |
|
| 81 | + } |
|
| 82 | 82 | } |
@@ -13,119 +13,119 @@ |
||
| 13 | 13 | class AdminNotice |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - const ERROR = 'notice-error'; |
|
| 17 | - |
|
| 18 | - const WARNING = 'notice-warning'; |
|
| 19 | - |
|
| 20 | - const SUCCESS = 'notice-success'; |
|
| 21 | - |
|
| 22 | - const INFORMATION = 'notice-info'; |
|
| 23 | - |
|
| 24 | - const DISMISSABLE = ' is-dismissible'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * generic system notice to be converted into a WP admin notice |
|
| 28 | - * |
|
| 29 | - * @var NoticeInterface $notice |
|
| 30 | - */ |
|
| 31 | - private $notice; |
|
| 32 | - |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * AdminNotice constructor. |
|
| 36 | - * |
|
| 37 | - * @param NoticeInterface $notice |
|
| 38 | - * @param bool $display_now |
|
| 39 | - */ |
|
| 40 | - public function __construct(NoticeInterface $notice, $display_now = true) |
|
| 41 | - { |
|
| 42 | - $this->notice = $notice; |
|
| 43 | - if (! did_action('admin_notices')) { |
|
| 44 | - add_action('admin_notices', array($this, 'displayNotice')); |
|
| 45 | - } elseif ($display_now) { |
|
| 46 | - $this->displayNotice(); |
|
| 47 | - } |
|
| 48 | - } |
|
| 49 | - |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @return void |
|
| 53 | - */ |
|
| 54 | - public function displayNotice() |
|
| 55 | - { |
|
| 56 | - echo $this->getNotice(); |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * produces something like: |
|
| 62 | - * <div class="notice notice-success is-dismissible event-espresso-admin-notice"> |
|
| 63 | - * <p>YOU DID IT!</p> |
|
| 64 | - * <button type="button" class="notice-dismiss"><span class="screen-reader-text">Dismiss this |
|
| 65 | - * notice.</span></button> |
|
| 66 | - * </div> |
|
| 67 | - * |
|
| 68 | - * @return string |
|
| 69 | - */ |
|
| 70 | - public function getNotice() |
|
| 71 | - { |
|
| 72 | - return sprintf( |
|
| 73 | - '<div class="notice %1$s%2$s event-espresso-admin-notice"><p>%3$s</p></div>', |
|
| 74 | - $this->getType(), |
|
| 75 | - $this->notice->isDismissible() ? AdminNotice::DISMISSABLE : '', |
|
| 76 | - $this->getMessage() |
|
| 77 | - ); |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * @return string |
|
| 83 | - */ |
|
| 84 | - private function getType() |
|
| 85 | - { |
|
| 86 | - switch ($this->notice->type()) { |
|
| 87 | - case Notice::ERROR: |
|
| 88 | - return AdminNotice::ERROR; |
|
| 89 | - break; |
|
| 90 | - case Notice::ATTENTION: |
|
| 91 | - return AdminNotice::WARNING; |
|
| 92 | - break; |
|
| 93 | - case Notice::SUCCESS: |
|
| 94 | - return AdminNotice::SUCCESS; |
|
| 95 | - break; |
|
| 96 | - case Notice::INFORMATION: |
|
| 97 | - default: |
|
| 98 | - return AdminNotice::INFORMATION; |
|
| 99 | - break; |
|
| 100 | - } |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - |
|
| 104 | - /** |
|
| 105 | - * @return string |
|
| 106 | - */ |
|
| 107 | - protected function getMessage() |
|
| 108 | - { |
|
| 109 | - $message = $this->notice->message(); |
|
| 110 | - if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) { |
|
| 111 | - $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>'; |
|
| 112 | - } |
|
| 113 | - return $message; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * create error code from filepath, function name, |
|
| 119 | - * and line number where notice was generated |
|
| 120 | - * |
|
| 121 | - * @return string |
|
| 122 | - */ |
|
| 123 | - protected function generateErrorCode() |
|
| 124 | - { |
|
| 125 | - $file = explode('.', basename($this->notice->file())); |
|
| 126 | - $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
| 127 | - $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func(); |
|
| 128 | - $error_code .= ' - ' . $this->notice->line(); |
|
| 129 | - return $error_code; |
|
| 130 | - } |
|
| 16 | + const ERROR = 'notice-error'; |
|
| 17 | + |
|
| 18 | + const WARNING = 'notice-warning'; |
|
| 19 | + |
|
| 20 | + const SUCCESS = 'notice-success'; |
|
| 21 | + |
|
| 22 | + const INFORMATION = 'notice-info'; |
|
| 23 | + |
|
| 24 | + const DISMISSABLE = ' is-dismissible'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * generic system notice to be converted into a WP admin notice |
|
| 28 | + * |
|
| 29 | + * @var NoticeInterface $notice |
|
| 30 | + */ |
|
| 31 | + private $notice; |
|
| 32 | + |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * AdminNotice constructor. |
|
| 36 | + * |
|
| 37 | + * @param NoticeInterface $notice |
|
| 38 | + * @param bool $display_now |
|
| 39 | + */ |
|
| 40 | + public function __construct(NoticeInterface $notice, $display_now = true) |
|
| 41 | + { |
|
| 42 | + $this->notice = $notice; |
|
| 43 | + if (! did_action('admin_notices')) { |
|
| 44 | + add_action('admin_notices', array($this, 'displayNotice')); |
|
| 45 | + } elseif ($display_now) { |
|
| 46 | + $this->displayNotice(); |
|
| 47 | + } |
|
| 48 | + } |
|
| 49 | + |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @return void |
|
| 53 | + */ |
|
| 54 | + public function displayNotice() |
|
| 55 | + { |
|
| 56 | + echo $this->getNotice(); |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * produces something like: |
|
| 62 | + * <div class="notice notice-success is-dismissible event-espresso-admin-notice"> |
|
| 63 | + * <p>YOU DID IT!</p> |
|
| 64 | + * <button type="button" class="notice-dismiss"><span class="screen-reader-text">Dismiss this |
|
| 65 | + * notice.</span></button> |
|
| 66 | + * </div> |
|
| 67 | + * |
|
| 68 | + * @return string |
|
| 69 | + */ |
|
| 70 | + public function getNotice() |
|
| 71 | + { |
|
| 72 | + return sprintf( |
|
| 73 | + '<div class="notice %1$s%2$s event-espresso-admin-notice"><p>%3$s</p></div>', |
|
| 74 | + $this->getType(), |
|
| 75 | + $this->notice->isDismissible() ? AdminNotice::DISMISSABLE : '', |
|
| 76 | + $this->getMessage() |
|
| 77 | + ); |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * @return string |
|
| 83 | + */ |
|
| 84 | + private function getType() |
|
| 85 | + { |
|
| 86 | + switch ($this->notice->type()) { |
|
| 87 | + case Notice::ERROR: |
|
| 88 | + return AdminNotice::ERROR; |
|
| 89 | + break; |
|
| 90 | + case Notice::ATTENTION: |
|
| 91 | + return AdminNotice::WARNING; |
|
| 92 | + break; |
|
| 93 | + case Notice::SUCCESS: |
|
| 94 | + return AdminNotice::SUCCESS; |
|
| 95 | + break; |
|
| 96 | + case Notice::INFORMATION: |
|
| 97 | + default: |
|
| 98 | + return AdminNotice::INFORMATION; |
|
| 99 | + break; |
|
| 100 | + } |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + |
|
| 104 | + /** |
|
| 105 | + * @return string |
|
| 106 | + */ |
|
| 107 | + protected function getMessage() |
|
| 108 | + { |
|
| 109 | + $message = $this->notice->message(); |
|
| 110 | + if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) { |
|
| 111 | + $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>'; |
|
| 112 | + } |
|
| 113 | + return $message; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * create error code from filepath, function name, |
|
| 119 | + * and line number where notice was generated |
|
| 120 | + * |
|
| 121 | + * @return string |
|
| 122 | + */ |
|
| 123 | + protected function generateErrorCode() |
|
| 124 | + { |
|
| 125 | + $file = explode('.', basename($this->notice->file())); |
|
| 126 | + $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
| 127 | + $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func(); |
|
| 128 | + $error_code .= ' - ' . $this->notice->line(); |
|
| 129 | + return $error_code; |
|
| 130 | + } |
|
| 131 | 131 | } |
@@ -40,7 +40,7 @@ discard block |
||
| 40 | 40 | public function __construct(NoticeInterface $notice, $display_now = true) |
| 41 | 41 | { |
| 42 | 42 | $this->notice = $notice; |
| 43 | - if (! did_action('admin_notices')) { |
|
| 43 | + if ( ! did_action('admin_notices')) { |
|
| 44 | 44 | add_action('admin_notices', array($this, 'displayNotice')); |
| 45 | 45 | } elseif ($display_now) { |
| 46 | 46 | $this->displayNotice(); |
@@ -108,7 +108,7 @@ discard block |
||
| 108 | 108 | { |
| 109 | 109 | $message = $this->notice->message(); |
| 110 | 110 | if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) { |
| 111 | - $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>'; |
|
| 111 | + $message .= '<br/><span class="tiny-text">'.$this->generateErrorCode().'</span>'; |
|
| 112 | 112 | } |
| 113 | 113 | return $message; |
| 114 | 114 | } |
@@ -124,8 +124,8 @@ discard block |
||
| 124 | 124 | { |
| 125 | 125 | $file = explode('.', basename($this->notice->file())); |
| 126 | 126 | $error_code = ! empty($file[0]) ? $file[0] : ''; |
| 127 | - $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func(); |
|
| 128 | - $error_code .= ' - ' . $this->notice->line(); |
|
| 127 | + $error_code .= ! empty($error_code) ? ' - '.$this->notice->func() : $this->notice->func(); |
|
| 128 | + $error_code .= ' - '.$this->notice->line(); |
|
| 129 | 129 | return $error_code; |
| 130 | 130 | } |
| 131 | 131 | } |
@@ -15,218 +15,218 @@ |
||
| 15 | 15 | { |
| 16 | 16 | |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @var NoticeInterface[] $information |
|
| 20 | - */ |
|
| 21 | - private $information = array(); |
|
| 22 | - |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * @var NoticeInterface[] $attention |
|
| 26 | - */ |
|
| 27 | - private $attention = array(); |
|
| 28 | - |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var NoticeInterface[] $error |
|
| 32 | - */ |
|
| 33 | - private $error = array(); |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var NoticeInterface[] $success |
|
| 38 | - */ |
|
| 39 | - private $success = array(); |
|
| 40 | - |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * @param string $notice |
|
| 44 | - * @param bool $dismissible |
|
| 45 | - * @param string $file |
|
| 46 | - * @param string $func |
|
| 47 | - * @param string $line |
|
| 48 | - * @throws InvalidDataTypeException |
|
| 49 | - */ |
|
| 50 | - public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 51 | - { |
|
| 52 | - $this->information[] = new Notice( |
|
| 53 | - Notice::INFORMATION, |
|
| 54 | - $notice, |
|
| 55 | - $dismissible, |
|
| 56 | - $file, |
|
| 57 | - $func, |
|
| 58 | - $line |
|
| 59 | - ); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * @param string $notice |
|
| 65 | - * @param bool $dismissible |
|
| 66 | - * @param string $file |
|
| 67 | - * @param string $func |
|
| 68 | - * @param string $line |
|
| 69 | - * @throws InvalidDataTypeException |
|
| 70 | - */ |
|
| 71 | - public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | - { |
|
| 73 | - $this->attention[] = new Notice( |
|
| 74 | - Notice::ATTENTION, |
|
| 75 | - $notice, |
|
| 76 | - $dismissible, |
|
| 77 | - $file, |
|
| 78 | - $func, |
|
| 79 | - $line |
|
| 80 | - ); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd |
|
| 84 | - /** |
|
| 85 | - * @param string $notice |
|
| 86 | - * @param bool $dismissible |
|
| 87 | - * @param string $file |
|
| 88 | - * @param string $func |
|
| 89 | - * @param string $line |
|
| 90 | - * @throws InvalidDataTypeException |
|
| 91 | - */ |
|
| 92 | - public function addError($notice, $dismissible = true, $file, $func, $line) |
|
| 93 | - { |
|
| 94 | - $this->error[] = new Notice( |
|
| 95 | - Notice::ERROR, |
|
| 96 | - $notice, |
|
| 97 | - $dismissible, |
|
| 98 | - $file, |
|
| 99 | - $func, |
|
| 100 | - $line |
|
| 101 | - ); |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * @param string $notice |
|
| 107 | - * @param bool $dismissible |
|
| 108 | - * @param string $file |
|
| 109 | - * @param string $func |
|
| 110 | - * @param string $line |
|
| 111 | - * @throws InvalidDataTypeException |
|
| 112 | - */ |
|
| 113 | - public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 114 | - { |
|
| 115 | - $this->success[] = new Notice( |
|
| 116 | - Notice::SUCCESS, |
|
| 117 | - $notice, |
|
| 118 | - $dismissible, |
|
| 119 | - $file, |
|
| 120 | - $func, |
|
| 121 | - $line |
|
| 122 | - ); |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * @return boolean |
|
| 128 | - */ |
|
| 129 | - public function hasInformation() |
|
| 130 | - { |
|
| 131 | - return ! empty($this->information); |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * @return boolean |
|
| 137 | - */ |
|
| 138 | - public function hasAttention() |
|
| 139 | - { |
|
| 140 | - return ! empty($this->attention); |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * @return boolean |
|
| 146 | - */ |
|
| 147 | - public function hasError() |
|
| 148 | - { |
|
| 149 | - return ! empty($this->error); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * @return boolean |
|
| 155 | - */ |
|
| 156 | - public function hasSuccess() |
|
| 157 | - { |
|
| 158 | - return ! empty($this->success); |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * @return int |
|
| 164 | - */ |
|
| 165 | - public function countInformation() |
|
| 166 | - { |
|
| 167 | - return count($this->information); |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * @return int |
|
| 173 | - */ |
|
| 174 | - public function countAttention() |
|
| 175 | - { |
|
| 176 | - return count($this->attention); |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * @return int |
|
| 182 | - */ |
|
| 183 | - public function countError() |
|
| 184 | - { |
|
| 185 | - return count($this->error); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * @return int |
|
| 191 | - */ |
|
| 192 | - public function countSuccess() |
|
| 193 | - { |
|
| 194 | - return count($this->success); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - |
|
| 198 | - /** |
|
| 199 | - * @return NoticeInterface[] |
|
| 200 | - */ |
|
| 201 | - public function getInformation() |
|
| 202 | - { |
|
| 203 | - return $this->information; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @return NoticeInterface[] |
|
| 209 | - */ |
|
| 210 | - public function getAttention() |
|
| 211 | - { |
|
| 212 | - return $this->attention; |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - |
|
| 216 | - /** |
|
| 217 | - * @return NoticeInterface[] |
|
| 218 | - */ |
|
| 219 | - public function getError() |
|
| 220 | - { |
|
| 221 | - return $this->error; |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @return NoticeInterface[] |
|
| 227 | - */ |
|
| 228 | - public function getSuccess() |
|
| 229 | - { |
|
| 230 | - return $this->success; |
|
| 231 | - } |
|
| 18 | + /** |
|
| 19 | + * @var NoticeInterface[] $information |
|
| 20 | + */ |
|
| 21 | + private $information = array(); |
|
| 22 | + |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * @var NoticeInterface[] $attention |
|
| 26 | + */ |
|
| 27 | + private $attention = array(); |
|
| 28 | + |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var NoticeInterface[] $error |
|
| 32 | + */ |
|
| 33 | + private $error = array(); |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var NoticeInterface[] $success |
|
| 38 | + */ |
|
| 39 | + private $success = array(); |
|
| 40 | + |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * @param string $notice |
|
| 44 | + * @param bool $dismissible |
|
| 45 | + * @param string $file |
|
| 46 | + * @param string $func |
|
| 47 | + * @param string $line |
|
| 48 | + * @throws InvalidDataTypeException |
|
| 49 | + */ |
|
| 50 | + public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 51 | + { |
|
| 52 | + $this->information[] = new Notice( |
|
| 53 | + Notice::INFORMATION, |
|
| 54 | + $notice, |
|
| 55 | + $dismissible, |
|
| 56 | + $file, |
|
| 57 | + $func, |
|
| 58 | + $line |
|
| 59 | + ); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * @param string $notice |
|
| 65 | + * @param bool $dismissible |
|
| 66 | + * @param string $file |
|
| 67 | + * @param string $func |
|
| 68 | + * @param string $line |
|
| 69 | + * @throws InvalidDataTypeException |
|
| 70 | + */ |
|
| 71 | + public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | + { |
|
| 73 | + $this->attention[] = new Notice( |
|
| 74 | + Notice::ATTENTION, |
|
| 75 | + $notice, |
|
| 76 | + $dismissible, |
|
| 77 | + $file, |
|
| 78 | + $func, |
|
| 79 | + $line |
|
| 80 | + ); |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd |
|
| 84 | + /** |
|
| 85 | + * @param string $notice |
|
| 86 | + * @param bool $dismissible |
|
| 87 | + * @param string $file |
|
| 88 | + * @param string $func |
|
| 89 | + * @param string $line |
|
| 90 | + * @throws InvalidDataTypeException |
|
| 91 | + */ |
|
| 92 | + public function addError($notice, $dismissible = true, $file, $func, $line) |
|
| 93 | + { |
|
| 94 | + $this->error[] = new Notice( |
|
| 95 | + Notice::ERROR, |
|
| 96 | + $notice, |
|
| 97 | + $dismissible, |
|
| 98 | + $file, |
|
| 99 | + $func, |
|
| 100 | + $line |
|
| 101 | + ); |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * @param string $notice |
|
| 107 | + * @param bool $dismissible |
|
| 108 | + * @param string $file |
|
| 109 | + * @param string $func |
|
| 110 | + * @param string $line |
|
| 111 | + * @throws InvalidDataTypeException |
|
| 112 | + */ |
|
| 113 | + public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 114 | + { |
|
| 115 | + $this->success[] = new Notice( |
|
| 116 | + Notice::SUCCESS, |
|
| 117 | + $notice, |
|
| 118 | + $dismissible, |
|
| 119 | + $file, |
|
| 120 | + $func, |
|
| 121 | + $line |
|
| 122 | + ); |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * @return boolean |
|
| 128 | + */ |
|
| 129 | + public function hasInformation() |
|
| 130 | + { |
|
| 131 | + return ! empty($this->information); |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * @return boolean |
|
| 137 | + */ |
|
| 138 | + public function hasAttention() |
|
| 139 | + { |
|
| 140 | + return ! empty($this->attention); |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * @return boolean |
|
| 146 | + */ |
|
| 147 | + public function hasError() |
|
| 148 | + { |
|
| 149 | + return ! empty($this->error); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * @return boolean |
|
| 155 | + */ |
|
| 156 | + public function hasSuccess() |
|
| 157 | + { |
|
| 158 | + return ! empty($this->success); |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * @return int |
|
| 164 | + */ |
|
| 165 | + public function countInformation() |
|
| 166 | + { |
|
| 167 | + return count($this->information); |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * @return int |
|
| 173 | + */ |
|
| 174 | + public function countAttention() |
|
| 175 | + { |
|
| 176 | + return count($this->attention); |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * @return int |
|
| 182 | + */ |
|
| 183 | + public function countError() |
|
| 184 | + { |
|
| 185 | + return count($this->error); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * @return int |
|
| 191 | + */ |
|
| 192 | + public function countSuccess() |
|
| 193 | + { |
|
| 194 | + return count($this->success); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + |
|
| 198 | + /** |
|
| 199 | + * @return NoticeInterface[] |
|
| 200 | + */ |
|
| 201 | + public function getInformation() |
|
| 202 | + { |
|
| 203 | + return $this->information; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @return NoticeInterface[] |
|
| 209 | + */ |
|
| 210 | + public function getAttention() |
|
| 211 | + { |
|
| 212 | + return $this->attention; |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + |
|
| 216 | + /** |
|
| 217 | + * @return NoticeInterface[] |
|
| 218 | + */ |
|
| 219 | + public function getError() |
|
| 220 | + { |
|
| 221 | + return $this->error; |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @return NoticeInterface[] |
|
| 227 | + */ |
|
| 228 | + public function getSuccess() |
|
| 229 | + { |
|
| 230 | + return $this->success; |
|
| 231 | + } |
|
| 232 | 232 | } |
@@ -20,192 +20,192 @@ |
||
| 20 | 20 | class OpenCoffeeShop |
| 21 | 21 | { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * @var CoffeeShop $CoffeeShop |
|
| 25 | - */ |
|
| 26 | - private $CoffeeShop; |
|
| 23 | + /** |
|
| 24 | + * @var CoffeeShop $CoffeeShop |
|
| 25 | + */ |
|
| 26 | + private $CoffeeShop; |
|
| 27 | 27 | |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * OpenCoffeeShop constructor |
|
| 31 | - * |
|
| 32 | - * @throws InvalidInterfaceException |
|
| 33 | - */ |
|
| 34 | - public function __construct() |
|
| 35 | - { |
|
| 36 | - // instantiate the DI container |
|
| 37 | - $this->CoffeeShop = new CoffeeShop(); |
|
| 38 | - } |
|
| 29 | + /** |
|
| 30 | + * OpenCoffeeShop constructor |
|
| 31 | + * |
|
| 32 | + * @throws InvalidInterfaceException |
|
| 33 | + */ |
|
| 34 | + public function __construct() |
|
| 35 | + { |
|
| 36 | + // instantiate the DI container |
|
| 37 | + $this->CoffeeShop = new CoffeeShop(); |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | 40 | |
| 41 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 42 | - /** |
|
| 43 | - * @return CoffeeShop |
|
| 44 | - */ |
|
| 45 | - public function CoffeeShop() |
|
| 46 | - { |
|
| 47 | - return $this->CoffeeShop; |
|
| 48 | - } |
|
| 41 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 42 | + /** |
|
| 43 | + * @return CoffeeShop |
|
| 44 | + */ |
|
| 45 | + public function CoffeeShop() |
|
| 46 | + { |
|
| 47 | + return $this->CoffeeShop; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * configure coffee makers which control the different kinds of brews |
|
| 53 | - * ( shared services, new factory objects, etc ) |
|
| 54 | - * |
|
| 55 | - * @throws InvalidEntityException |
|
| 56 | - */ |
|
| 57 | - public function setupCoffeeMakers() |
|
| 58 | - { |
|
| 59 | - // create a dependency injector class for resolving class constructor arguments |
|
| 60 | - $DependencyInjector = new DependencyInjector( |
|
| 61 | - $this->CoffeeShop, |
|
| 62 | - new \EEH_Array() |
|
| 63 | - ); |
|
| 64 | - // and some coffeemakers, one for creating new instances |
|
| 65 | - $this->CoffeeShop->addCoffeeMaker( |
|
| 66 | - new NewCoffeeMaker($this->CoffeeShop, $DependencyInjector), |
|
| 67 | - CoffeeMaker::BREW_NEW |
|
| 68 | - ); |
|
| 69 | - // one for shared services |
|
| 70 | - $this->CoffeeShop->addCoffeeMaker( |
|
| 71 | - new SharedCoffeeMaker($this->CoffeeShop, $DependencyInjector), |
|
| 72 | - CoffeeMaker::BREW_SHARED |
|
| 73 | - ); |
|
| 74 | - // and one for classes that only get loaded |
|
| 75 | - $this->CoffeeShop->addCoffeeMaker( |
|
| 76 | - new LoadOnlyCoffeeMaker($this->CoffeeShop, $DependencyInjector), |
|
| 77 | - CoffeeMaker::BREW_LOAD_ONLY |
|
| 78 | - ); |
|
| 79 | - } |
|
| 51 | + /** |
|
| 52 | + * configure coffee makers which control the different kinds of brews |
|
| 53 | + * ( shared services, new factory objects, etc ) |
|
| 54 | + * |
|
| 55 | + * @throws InvalidEntityException |
|
| 56 | + */ |
|
| 57 | + public function setupCoffeeMakers() |
|
| 58 | + { |
|
| 59 | + // create a dependency injector class for resolving class constructor arguments |
|
| 60 | + $DependencyInjector = new DependencyInjector( |
|
| 61 | + $this->CoffeeShop, |
|
| 62 | + new \EEH_Array() |
|
| 63 | + ); |
|
| 64 | + // and some coffeemakers, one for creating new instances |
|
| 65 | + $this->CoffeeShop->addCoffeeMaker( |
|
| 66 | + new NewCoffeeMaker($this->CoffeeShop, $DependencyInjector), |
|
| 67 | + CoffeeMaker::BREW_NEW |
|
| 68 | + ); |
|
| 69 | + // one for shared services |
|
| 70 | + $this->CoffeeShop->addCoffeeMaker( |
|
| 71 | + new SharedCoffeeMaker($this->CoffeeShop, $DependencyInjector), |
|
| 72 | + CoffeeMaker::BREW_SHARED |
|
| 73 | + ); |
|
| 74 | + // and one for classes that only get loaded |
|
| 75 | + $this->CoffeeShop->addCoffeeMaker( |
|
| 76 | + new LoadOnlyCoffeeMaker($this->CoffeeShop, $DependencyInjector), |
|
| 77 | + CoffeeMaker::BREW_LOAD_ONLY |
|
| 78 | + ); |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Recipes define how to load legacy classes |
|
| 84 | - * |
|
| 85 | - * @throws InvalidIdentifierException |
|
| 86 | - */ |
|
| 87 | - public function addRecipes() |
|
| 88 | - { |
|
| 89 | - // add default recipe, which should handle loading for most PSR-4 compatible classes |
|
| 90 | - // as long as they are not type hinting for interfaces |
|
| 91 | - $this->CoffeeShop->addRecipe( |
|
| 92 | - new Recipe( |
|
| 93 | - Recipe::DEFAULT_ID |
|
| 94 | - ) |
|
| 95 | - ); |
|
| 96 | - // PSR-4 compatible class with aliases |
|
| 97 | - $this->CoffeeShop->addRecipe( |
|
| 98 | - new Recipe( |
|
| 99 | - 'CommandHandlerManager', |
|
| 100 | - 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
| 101 | - array( |
|
| 102 | - 'CommandHandlerManagerInterface', |
|
| 103 | - 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
| 104 | - ), |
|
| 105 | - array(), |
|
| 106 | - CoffeeMaker::BREW_SHARED |
|
| 107 | - ) |
|
| 108 | - ); |
|
| 109 | - // PSR-4 compatible class with aliases, which dependency on CommandHandlerManager |
|
| 110 | - $this->CoffeeShop->addRecipe( |
|
| 111 | - new Recipe( |
|
| 112 | - 'CommandBus', |
|
| 113 | - 'EventEspresso\core\services\commands\CommandBus', |
|
| 114 | - array( |
|
| 115 | - 'CommandBusInterface', |
|
| 116 | - 'EventEspresso\core\services\commands\CommandBusInterface', |
|
| 117 | - ), |
|
| 118 | - array(), |
|
| 119 | - CoffeeMaker::BREW_SHARED |
|
| 120 | - ) |
|
| 121 | - ); |
|
| 122 | - // LEGACY classes that are NOT compatible with PSR-4 autoloading, and so must specify a filepath |
|
| 123 | - // add a wildcard recipe for loading legacy core interfaces |
|
| 124 | - $this->CoffeeShop->addRecipe( |
|
| 125 | - new Recipe( |
|
| 126 | - 'EEI_*', |
|
| 127 | - '', |
|
| 128 | - array(), |
|
| 129 | - array(), |
|
| 130 | - CoffeeMaker::BREW_LOAD_ONLY, |
|
| 131 | - array( |
|
| 132 | - EE_INTERFACES . '*.php', |
|
| 133 | - EE_INTERFACES . '*.interfaces.php', |
|
| 134 | - ) |
|
| 135 | - ) |
|
| 136 | - ); |
|
| 137 | - // add a wildcard recipe for loading models |
|
| 138 | - $this->CoffeeShop->addRecipe( |
|
| 139 | - new Recipe( |
|
| 140 | - 'EEM_*', |
|
| 141 | - '', |
|
| 142 | - array(), |
|
| 143 | - array(), |
|
| 144 | - CoffeeMaker::BREW_SHARED, |
|
| 145 | - EE_MODELS . '*.model.php' |
|
| 146 | - ) |
|
| 147 | - ); |
|
| 148 | - // add a wildcard recipe for loading core classes |
|
| 149 | - $this->CoffeeShop->addRecipe( |
|
| 150 | - new Recipe( |
|
| 151 | - 'EE_*', |
|
| 152 | - '', |
|
| 153 | - array(), |
|
| 154 | - array(), |
|
| 155 | - CoffeeMaker::BREW_SHARED, |
|
| 156 | - array( |
|
| 157 | - EE_CORE . '*.core.php', |
|
| 158 | - EE_ADMIN . '*.core.php', |
|
| 159 | - EE_CPTS . '*.core.php', |
|
| 160 | - EE_CORE . 'data_migration_scripts' . DS . '*.core.php', |
|
| 161 | - ) |
|
| 162 | - ) |
|
| 163 | - ); |
|
| 164 | - // load admin page parent class |
|
| 165 | - $this->CoffeeShop->addRecipe( |
|
| 166 | - new Recipe( |
|
| 167 | - 'EE_Admin_Page*', |
|
| 168 | - '', |
|
| 169 | - array(), |
|
| 170 | - array(), |
|
| 171 | - CoffeeMaker::BREW_LOAD_ONLY, |
|
| 172 | - array(EE_ADMIN . '*.core.php') |
|
| 173 | - ) |
|
| 174 | - ); |
|
| 175 | - // add a wildcard recipe for loading core classes |
|
| 176 | - // $this->CoffeeShop->addRecipe( |
|
| 177 | - // new Recipe( |
|
| 178 | - // '*_Admin_Page', |
|
| 179 | - // '', |
|
| 180 | - // array(), |
|
| 181 | - // array(), |
|
| 182 | - // CoffeeMaker::BREW_SHARED, |
|
| 183 | - // array( |
|
| 184 | - // EE_ADMIN_PAGES . 'transactions' . DS . '*.core.php', |
|
| 185 | - // ) |
|
| 186 | - // ) |
|
| 187 | - // ); |
|
| 188 | - } |
|
| 82 | + /** |
|
| 83 | + * Recipes define how to load legacy classes |
|
| 84 | + * |
|
| 85 | + * @throws InvalidIdentifierException |
|
| 86 | + */ |
|
| 87 | + public function addRecipes() |
|
| 88 | + { |
|
| 89 | + // add default recipe, which should handle loading for most PSR-4 compatible classes |
|
| 90 | + // as long as they are not type hinting for interfaces |
|
| 91 | + $this->CoffeeShop->addRecipe( |
|
| 92 | + new Recipe( |
|
| 93 | + Recipe::DEFAULT_ID |
|
| 94 | + ) |
|
| 95 | + ); |
|
| 96 | + // PSR-4 compatible class with aliases |
|
| 97 | + $this->CoffeeShop->addRecipe( |
|
| 98 | + new Recipe( |
|
| 99 | + 'CommandHandlerManager', |
|
| 100 | + 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
| 101 | + array( |
|
| 102 | + 'CommandHandlerManagerInterface', |
|
| 103 | + 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
| 104 | + ), |
|
| 105 | + array(), |
|
| 106 | + CoffeeMaker::BREW_SHARED |
|
| 107 | + ) |
|
| 108 | + ); |
|
| 109 | + // PSR-4 compatible class with aliases, which dependency on CommandHandlerManager |
|
| 110 | + $this->CoffeeShop->addRecipe( |
|
| 111 | + new Recipe( |
|
| 112 | + 'CommandBus', |
|
| 113 | + 'EventEspresso\core\services\commands\CommandBus', |
|
| 114 | + array( |
|
| 115 | + 'CommandBusInterface', |
|
| 116 | + 'EventEspresso\core\services\commands\CommandBusInterface', |
|
| 117 | + ), |
|
| 118 | + array(), |
|
| 119 | + CoffeeMaker::BREW_SHARED |
|
| 120 | + ) |
|
| 121 | + ); |
|
| 122 | + // LEGACY classes that are NOT compatible with PSR-4 autoloading, and so must specify a filepath |
|
| 123 | + // add a wildcard recipe for loading legacy core interfaces |
|
| 124 | + $this->CoffeeShop->addRecipe( |
|
| 125 | + new Recipe( |
|
| 126 | + 'EEI_*', |
|
| 127 | + '', |
|
| 128 | + array(), |
|
| 129 | + array(), |
|
| 130 | + CoffeeMaker::BREW_LOAD_ONLY, |
|
| 131 | + array( |
|
| 132 | + EE_INTERFACES . '*.php', |
|
| 133 | + EE_INTERFACES . '*.interfaces.php', |
|
| 134 | + ) |
|
| 135 | + ) |
|
| 136 | + ); |
|
| 137 | + // add a wildcard recipe for loading models |
|
| 138 | + $this->CoffeeShop->addRecipe( |
|
| 139 | + new Recipe( |
|
| 140 | + 'EEM_*', |
|
| 141 | + '', |
|
| 142 | + array(), |
|
| 143 | + array(), |
|
| 144 | + CoffeeMaker::BREW_SHARED, |
|
| 145 | + EE_MODELS . '*.model.php' |
|
| 146 | + ) |
|
| 147 | + ); |
|
| 148 | + // add a wildcard recipe for loading core classes |
|
| 149 | + $this->CoffeeShop->addRecipe( |
|
| 150 | + new Recipe( |
|
| 151 | + 'EE_*', |
|
| 152 | + '', |
|
| 153 | + array(), |
|
| 154 | + array(), |
|
| 155 | + CoffeeMaker::BREW_SHARED, |
|
| 156 | + array( |
|
| 157 | + EE_CORE . '*.core.php', |
|
| 158 | + EE_ADMIN . '*.core.php', |
|
| 159 | + EE_CPTS . '*.core.php', |
|
| 160 | + EE_CORE . 'data_migration_scripts' . DS . '*.core.php', |
|
| 161 | + ) |
|
| 162 | + ) |
|
| 163 | + ); |
|
| 164 | + // load admin page parent class |
|
| 165 | + $this->CoffeeShop->addRecipe( |
|
| 166 | + new Recipe( |
|
| 167 | + 'EE_Admin_Page*', |
|
| 168 | + '', |
|
| 169 | + array(), |
|
| 170 | + array(), |
|
| 171 | + CoffeeMaker::BREW_LOAD_ONLY, |
|
| 172 | + array(EE_ADMIN . '*.core.php') |
|
| 173 | + ) |
|
| 174 | + ); |
|
| 175 | + // add a wildcard recipe for loading core classes |
|
| 176 | + // $this->CoffeeShop->addRecipe( |
|
| 177 | + // new Recipe( |
|
| 178 | + // '*_Admin_Page', |
|
| 179 | + // '', |
|
| 180 | + // array(), |
|
| 181 | + // array(), |
|
| 182 | + // CoffeeMaker::BREW_SHARED, |
|
| 183 | + // array( |
|
| 184 | + // EE_ADMIN_PAGES . 'transactions' . DS . '*.core.php', |
|
| 185 | + // ) |
|
| 186 | + // ) |
|
| 187 | + // ); |
|
| 188 | + } |
|
| 189 | 189 | |
| 190 | 190 | |
| 191 | - /** |
|
| 192 | - * bootstrap EE and the request stack |
|
| 193 | - * |
|
| 194 | - * @throws ServiceNotFoundException |
|
| 195 | - * @throws InvalidClassException |
|
| 196 | - * @throws InvalidDataTypeException |
|
| 197 | - * @throws InvalidIdentifierException |
|
| 198 | - * @throws exceptions\ServiceExistsException |
|
| 199 | - * @throws OutOfBoundsException |
|
| 200 | - * @throws exceptions\InstantiationException |
|
| 201 | - */ |
|
| 202 | - public function firstBrew() |
|
| 203 | - { |
|
| 204 | - $this->CoffeeShop->brew( |
|
| 205 | - 'EventEspresso\core\services\request\Request', |
|
| 206 | - array($_GET, $_POST, $_COOKIE, $_SERVER) |
|
| 207 | - ); |
|
| 208 | - $this->CoffeeShop->brew('EventEspresso\core\services\request\Response'); |
|
| 209 | - $this->CoffeeShop->brew('EE_Bootstrap'); |
|
| 210 | - } |
|
| 191 | + /** |
|
| 192 | + * bootstrap EE and the request stack |
|
| 193 | + * |
|
| 194 | + * @throws ServiceNotFoundException |
|
| 195 | + * @throws InvalidClassException |
|
| 196 | + * @throws InvalidDataTypeException |
|
| 197 | + * @throws InvalidIdentifierException |
|
| 198 | + * @throws exceptions\ServiceExistsException |
|
| 199 | + * @throws OutOfBoundsException |
|
| 200 | + * @throws exceptions\InstantiationException |
|
| 201 | + */ |
|
| 202 | + public function firstBrew() |
|
| 203 | + { |
|
| 204 | + $this->CoffeeShop->brew( |
|
| 205 | + 'EventEspresso\core\services\request\Request', |
|
| 206 | + array($_GET, $_POST, $_COOKIE, $_SERVER) |
|
| 207 | + ); |
|
| 208 | + $this->CoffeeShop->brew('EventEspresso\core\services\request\Response'); |
|
| 209 | + $this->CoffeeShop->brew('EE_Bootstrap'); |
|
| 210 | + } |
|
| 211 | 211 | } |
@@ -129,8 +129,8 @@ discard block |
||
| 129 | 129 | array(), |
| 130 | 130 | CoffeeMaker::BREW_LOAD_ONLY, |
| 131 | 131 | array( |
| 132 | - EE_INTERFACES . '*.php', |
|
| 133 | - EE_INTERFACES . '*.interfaces.php', |
|
| 132 | + EE_INTERFACES.'*.php', |
|
| 133 | + EE_INTERFACES.'*.interfaces.php', |
|
| 134 | 134 | ) |
| 135 | 135 | ) |
| 136 | 136 | ); |
@@ -142,7 +142,7 @@ discard block |
||
| 142 | 142 | array(), |
| 143 | 143 | array(), |
| 144 | 144 | CoffeeMaker::BREW_SHARED, |
| 145 | - EE_MODELS . '*.model.php' |
|
| 145 | + EE_MODELS.'*.model.php' |
|
| 146 | 146 | ) |
| 147 | 147 | ); |
| 148 | 148 | // add a wildcard recipe for loading core classes |
@@ -154,10 +154,10 @@ discard block |
||
| 154 | 154 | array(), |
| 155 | 155 | CoffeeMaker::BREW_SHARED, |
| 156 | 156 | array( |
| 157 | - EE_CORE . '*.core.php', |
|
| 158 | - EE_ADMIN . '*.core.php', |
|
| 159 | - EE_CPTS . '*.core.php', |
|
| 160 | - EE_CORE . 'data_migration_scripts' . DS . '*.core.php', |
|
| 157 | + EE_CORE.'*.core.php', |
|
| 158 | + EE_ADMIN.'*.core.php', |
|
| 159 | + EE_CPTS.'*.core.php', |
|
| 160 | + EE_CORE.'data_migration_scripts'.DS.'*.core.php', |
|
| 161 | 161 | ) |
| 162 | 162 | ) |
| 163 | 163 | ); |
@@ -169,7 +169,7 @@ discard block |
||
| 169 | 169 | array(), |
| 170 | 170 | array(), |
| 171 | 171 | CoffeeMaker::BREW_LOAD_ONLY, |
| 172 | - array(EE_ADMIN . '*.core.php') |
|
| 172 | + array(EE_ADMIN.'*.core.php') |
|
| 173 | 173 | ) |
| 174 | 174 | ); |
| 175 | 175 | // add a wildcard recipe for loading core classes |
@@ -15,59 +15,59 @@ |
||
| 15 | 15 | class CoffeeMill |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @var CoffeeShop $coffee_shop |
|
| 20 | - */ |
|
| 21 | - private static $coffee_shop; |
|
| 18 | + /** |
|
| 19 | + * @var CoffeeShop $coffee_shop |
|
| 20 | + */ |
|
| 21 | + private static $coffee_shop; |
|
| 22 | 22 | |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * @return mixed |
|
| 26 | - */ |
|
| 27 | - public static function getCoffeeShop() |
|
| 28 | - { |
|
| 29 | - return self::$coffee_shop; |
|
| 30 | - } |
|
| 24 | + /** |
|
| 25 | + * @return mixed |
|
| 26 | + */ |
|
| 27 | + public static function getCoffeeShop() |
|
| 28 | + { |
|
| 29 | + return self::$coffee_shop; |
|
| 30 | + } |
|
| 31 | 31 | |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @param CoffeeShop $coffee_shop |
|
| 35 | - */ |
|
| 36 | - public static function setCoffeeShop(CoffeeShop $coffee_shop) |
|
| 37 | - { |
|
| 38 | - self::$coffee_shop = $coffee_shop; |
|
| 39 | - } |
|
| 33 | + /** |
|
| 34 | + * @param CoffeeShop $coffee_shop |
|
| 35 | + */ |
|
| 36 | + public static function setCoffeeShop(CoffeeShop $coffee_shop) |
|
| 37 | + { |
|
| 38 | + self::$coffee_shop = $coffee_shop; |
|
| 39 | + } |
|
| 40 | 40 | |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @param string $identifier |
|
| 44 | - * @param array $arguments |
|
| 45 | - * @param string $type |
|
| 46 | - * @return mixed |
|
| 47 | - * @throws ServiceNotFoundException |
|
| 48 | - */ |
|
| 49 | - public static function createNew($identifier, $arguments = array(), $type = CoffeeMaker::BREW_NEW) |
|
| 50 | - { |
|
| 51 | - return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 52 | - } |
|
| 42 | + /** |
|
| 43 | + * @param string $identifier |
|
| 44 | + * @param array $arguments |
|
| 45 | + * @param string $type |
|
| 46 | + * @return mixed |
|
| 47 | + * @throws ServiceNotFoundException |
|
| 48 | + */ |
|
| 49 | + public static function createNew($identifier, $arguments = array(), $type = CoffeeMaker::BREW_NEW) |
|
| 50 | + { |
|
| 51 | + return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * IMPORTANT!!! |
|
| 57 | - * Usage of this method is discouraged as it promotes service location. |
|
| 58 | - * It's current use is only as a stop gap measure until the CoffeeShop |
|
| 59 | - * Dependency Injection Container can be implemented properly for all classes. |
|
| 60 | - * If it is at all possible, inject your dependencies via your class constructor. |
|
| 61 | - * This method WILL BE DEPRECATED at some point in the near future. |
|
| 62 | - * |
|
| 63 | - * @param string $identifier |
|
| 64 | - * @param array $arguments |
|
| 65 | - * @param string $type |
|
| 66 | - * @return mixed |
|
| 67 | - * @throws ServiceNotFoundException |
|
| 68 | - */ |
|
| 69 | - public static function getService($identifier, $arguments = array(), $type = CoffeeMaker::BREW_SHARED) |
|
| 70 | - { |
|
| 71 | - return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 72 | - } |
|
| 55 | + /** |
|
| 56 | + * IMPORTANT!!! |
|
| 57 | + * Usage of this method is discouraged as it promotes service location. |
|
| 58 | + * It's current use is only as a stop gap measure until the CoffeeShop |
|
| 59 | + * Dependency Injection Container can be implemented properly for all classes. |
|
| 60 | + * If it is at all possible, inject your dependencies via your class constructor. |
|
| 61 | + * This method WILL BE DEPRECATED at some point in the near future. |
|
| 62 | + * |
|
| 63 | + * @param string $identifier |
|
| 64 | + * @param array $arguments |
|
| 65 | + * @param string $type |
|
| 66 | + * @return mixed |
|
| 67 | + * @throws ServiceNotFoundException |
|
| 68 | + */ |
|
| 69 | + public static function getService($identifier, $arguments = array(), $type = CoffeeMaker::BREW_SHARED) |
|
| 70 | + { |
|
| 71 | + return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 72 | + } |
|
| 73 | 73 | } |
@@ -15,25 +15,25 @@ |
||
| 15 | 15 | class InstantiationException extends BadMethodCallException |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * InstantiationException constructor. |
|
| 20 | - * |
|
| 21 | - * @param string $identifier the name of the requested entity or service |
|
| 22 | - * @param string $message |
|
| 23 | - * @param int $code |
|
| 24 | - * @param \Exception $previous |
|
| 25 | - */ |
|
| 26 | - public function __construct($identifier, $message = '', $code = 0, \Exception $previous = null) |
|
| 27 | - { |
|
| 28 | - if (empty($message)) { |
|
| 29 | - $message = sprintf( |
|
| 30 | - __( |
|
| 31 | - 'The "%1$s" class could not be constructed.', |
|
| 32 | - 'event_espresso' |
|
| 33 | - ), |
|
| 34 | - $identifier |
|
| 35 | - ); |
|
| 36 | - } |
|
| 37 | - parent::__construct($message, $code, $previous); |
|
| 38 | - } |
|
| 18 | + /** |
|
| 19 | + * InstantiationException constructor. |
|
| 20 | + * |
|
| 21 | + * @param string $identifier the name of the requested entity or service |
|
| 22 | + * @param string $message |
|
| 23 | + * @param int $code |
|
| 24 | + * @param \Exception $previous |
|
| 25 | + */ |
|
| 26 | + public function __construct($identifier, $message = '', $code = 0, \Exception $previous = null) |
|
| 27 | + { |
|
| 28 | + if (empty($message)) { |
|
| 29 | + $message = sprintf( |
|
| 30 | + __( |
|
| 31 | + 'The "%1$s" class could not be constructed.', |
|
| 32 | + 'event_espresso' |
|
| 33 | + ), |
|
| 34 | + $identifier |
|
| 35 | + ); |
|
| 36 | + } |
|
| 37 | + parent::__construct($message, $code, $previous); |
|
| 38 | + } |
|
| 39 | 39 | } |
@@ -14,26 +14,26 @@ |
||
| 14 | 14 | { |
| 15 | 15 | |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * ServiceExistsException constructor |
|
| 19 | - * |
|
| 20 | - * @param string $service_name the name of the requested service |
|
| 21 | - * @param string $message |
|
| 22 | - * @param int $code |
|
| 23 | - * @param \Exception $previous |
|
| 24 | - */ |
|
| 25 | - public function __construct( |
|
| 26 | - $service_name, |
|
| 27 | - $message = '', |
|
| 28 | - $code = 0, |
|
| 29 | - \Exception $previous = null |
|
| 30 | - ) { |
|
| 31 | - if (empty($message)) { |
|
| 32 | - $message = sprintf( |
|
| 33 | - __('The "%1$s" service already exists in the CoffeeShop and can not be added again.', 'event_espresso'), |
|
| 34 | - $service_name |
|
| 35 | - ); |
|
| 36 | - } |
|
| 37 | - parent::__construct($message, $code, $previous); |
|
| 38 | - } |
|
| 17 | + /** |
|
| 18 | + * ServiceExistsException constructor |
|
| 19 | + * |
|
| 20 | + * @param string $service_name the name of the requested service |
|
| 21 | + * @param string $message |
|
| 22 | + * @param int $code |
|
| 23 | + * @param \Exception $previous |
|
| 24 | + */ |
|
| 25 | + public function __construct( |
|
| 26 | + $service_name, |
|
| 27 | + $message = '', |
|
| 28 | + $code = 0, |
|
| 29 | + \Exception $previous = null |
|
| 30 | + ) { |
|
| 31 | + if (empty($message)) { |
|
| 32 | + $message = sprintf( |
|
| 33 | + __('The "%1$s" service already exists in the CoffeeShop and can not be added again.', 'event_espresso'), |
|
| 34 | + $service_name |
|
| 35 | + ); |
|
| 36 | + } |
|
| 37 | + parent::__construct($message, $code, $previous); |
|
| 38 | + } |
|
| 39 | 39 | } |