@@ -121,7 +121,7 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | protected function setId($id = '') |
| 123 | 123 | { |
| 124 | - if (! is_string($id)) { |
|
| 124 | + if ( ! is_string($id)) { |
|
| 125 | 125 | throw new InvalidDataTypeException('$id', $id, 'string'); |
| 126 | 126 | } |
| 127 | 127 | $this->id = $id; |
@@ -144,7 +144,7 @@ discard block |
||
| 144 | 144 | */ |
| 145 | 145 | protected function setOrder($order = 0) |
| 146 | 146 | { |
| 147 | - if (! is_int($order)) { |
|
| 147 | + if ( ! is_int($order)) { |
|
| 148 | 148 | throw new InvalidDataTypeException('$order', $order, 'integer'); |
| 149 | 149 | } |
| 150 | 150 | $this->order = $order; |
@@ -173,11 +173,11 @@ discard block |
||
| 173 | 173 | */ |
| 174 | 174 | protected function setHtmlClass($html_class) |
| 175 | 175 | { |
| 176 | - if (! is_string($html_class)) { |
|
| 176 | + if ( ! is_string($html_class)) { |
|
| 177 | 177 | throw new InvalidDataTypeException('$html_class', $html_class, 'string'); |
| 178 | 178 | } |
| 179 | 179 | if (strpos($html_class, 'progress-step-') === false) { |
| 180 | - $html_class = 'progress-step-' . $html_class; |
|
| 180 | + $html_class = 'progress-step-'.$html_class; |
|
| 181 | 181 | } |
| 182 | 182 | $this->html_class = $html_class; |
| 183 | 183 | } |
@@ -199,7 +199,7 @@ discard block |
||
| 199 | 199 | */ |
| 200 | 200 | protected function setText($text) |
| 201 | 201 | { |
| 202 | - if (! is_string($text)) { |
|
| 202 | + if ( ! is_string($text)) { |
|
| 203 | 203 | throw new InvalidDataTypeException('$text', $text, 'string'); |
| 204 | 204 | } |
| 205 | 205 | $this->text = $text; |
@@ -18,190 +18,190 @@ |
||
| 18 | 18 | { |
| 19 | 19 | |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * @var boolean $current |
|
| 23 | - */ |
|
| 24 | - private $current = false; |
|
| 25 | - |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * @var boolean $completed |
|
| 29 | - */ |
|
| 30 | - private $completed = false; |
|
| 31 | - |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @var string $html_class |
|
| 35 | - */ |
|
| 36 | - private $html_class; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var string $id |
|
| 40 | - */ |
|
| 41 | - private $id = ''; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * @var int $order |
|
| 45 | - */ |
|
| 46 | - private $order = 0; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @var string $text |
|
| 50 | - */ |
|
| 51 | - private $text = ''; |
|
| 52 | - |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * ProgressStep constructor |
|
| 56 | - * |
|
| 57 | - * @param int $order |
|
| 58 | - * @param string $id |
|
| 59 | - * @param string $html_class |
|
| 60 | - * @param string $text |
|
| 61 | - * @throws InvalidDataTypeException |
|
| 62 | - */ |
|
| 63 | - public function __construct($order, $id, $html_class, $text) |
|
| 64 | - { |
|
| 65 | - $this->setOrder($order); |
|
| 66 | - $this->setId($id); |
|
| 67 | - $this->setHtmlClass($html_class); |
|
| 68 | - $this->setText($text); |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * @return boolean |
|
| 74 | - */ |
|
| 75 | - public function isCurrent() |
|
| 76 | - { |
|
| 77 | - return $this->current; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * @param boolean $current |
|
| 83 | - */ |
|
| 84 | - public function setIsCurrent($current = true) |
|
| 85 | - { |
|
| 86 | - $this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * @return boolean |
|
| 92 | - */ |
|
| 93 | - public function isCompleted() |
|
| 94 | - { |
|
| 95 | - return $this->completed; |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * @param boolean $completed |
|
| 101 | - */ |
|
| 102 | - public function setIsCompleted($completed = true) |
|
| 103 | - { |
|
| 104 | - $this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * @return string |
|
| 110 | - */ |
|
| 111 | - public function id() |
|
| 112 | - { |
|
| 113 | - return $this->id; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * @access protected |
|
| 119 | - * @param string $id |
|
| 120 | - * @throws InvalidDataTypeException |
|
| 121 | - */ |
|
| 122 | - protected function setId($id = '') |
|
| 123 | - { |
|
| 124 | - if (! is_string($id)) { |
|
| 125 | - throw new InvalidDataTypeException('$id', $id, 'string'); |
|
| 126 | - } |
|
| 127 | - $this->id = $id; |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * @return int |
|
| 133 | - */ |
|
| 134 | - public function order() |
|
| 135 | - { |
|
| 136 | - return $this->order; |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * @access protected |
|
| 142 | - * @param int $order |
|
| 143 | - * @throws InvalidDataTypeException |
|
| 144 | - */ |
|
| 145 | - protected function setOrder($order = 0) |
|
| 146 | - { |
|
| 147 | - if (! is_int($order)) { |
|
| 148 | - throw new InvalidDataTypeException('$order', $order, 'integer'); |
|
| 149 | - } |
|
| 150 | - $this->order = $order; |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * @return string |
|
| 156 | - */ |
|
| 157 | - public function htmlClass() |
|
| 158 | - { |
|
| 159 | - $html_class = $this->html_class; |
|
| 160 | - if ($this->isCurrent()) { |
|
| 161 | - $html_class .= ' progress-step-active'; |
|
| 162 | - } elseif ($this->isCompleted()) { |
|
| 163 | - $html_class .= ' progress-step-completed'; |
|
| 164 | - } |
|
| 165 | - return $html_class; |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * @access protected |
|
| 171 | - * @param string $html_class |
|
| 172 | - * @throws InvalidDataTypeException |
|
| 173 | - */ |
|
| 174 | - protected function setHtmlClass($html_class) |
|
| 175 | - { |
|
| 176 | - if (! is_string($html_class)) { |
|
| 177 | - throw new InvalidDataTypeException('$html_class', $html_class, 'string'); |
|
| 178 | - } |
|
| 179 | - if (strpos($html_class, 'progress-step-') === false) { |
|
| 180 | - $html_class = 'progress-step-' . $html_class; |
|
| 181 | - } |
|
| 182 | - $this->html_class = $html_class; |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * @return string |
|
| 188 | - */ |
|
| 189 | - public function text() |
|
| 190 | - { |
|
| 191 | - return $this->text; |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * @access protected |
|
| 197 | - * @param string $text |
|
| 198 | - * @throws InvalidDataTypeException |
|
| 199 | - */ |
|
| 200 | - protected function setText($text) |
|
| 201 | - { |
|
| 202 | - if (! is_string($text)) { |
|
| 203 | - throw new InvalidDataTypeException('$text', $text, 'string'); |
|
| 204 | - } |
|
| 205 | - $this->text = $text; |
|
| 206 | - } |
|
| 21 | + /** |
|
| 22 | + * @var boolean $current |
|
| 23 | + */ |
|
| 24 | + private $current = false; |
|
| 25 | + |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * @var boolean $completed |
|
| 29 | + */ |
|
| 30 | + private $completed = false; |
|
| 31 | + |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @var string $html_class |
|
| 35 | + */ |
|
| 36 | + private $html_class; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var string $id |
|
| 40 | + */ |
|
| 41 | + private $id = ''; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * @var int $order |
|
| 45 | + */ |
|
| 46 | + private $order = 0; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @var string $text |
|
| 50 | + */ |
|
| 51 | + private $text = ''; |
|
| 52 | + |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * ProgressStep constructor |
|
| 56 | + * |
|
| 57 | + * @param int $order |
|
| 58 | + * @param string $id |
|
| 59 | + * @param string $html_class |
|
| 60 | + * @param string $text |
|
| 61 | + * @throws InvalidDataTypeException |
|
| 62 | + */ |
|
| 63 | + public function __construct($order, $id, $html_class, $text) |
|
| 64 | + { |
|
| 65 | + $this->setOrder($order); |
|
| 66 | + $this->setId($id); |
|
| 67 | + $this->setHtmlClass($html_class); |
|
| 68 | + $this->setText($text); |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * @return boolean |
|
| 74 | + */ |
|
| 75 | + public function isCurrent() |
|
| 76 | + { |
|
| 77 | + return $this->current; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * @param boolean $current |
|
| 83 | + */ |
|
| 84 | + public function setIsCurrent($current = true) |
|
| 85 | + { |
|
| 86 | + $this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * @return boolean |
|
| 92 | + */ |
|
| 93 | + public function isCompleted() |
|
| 94 | + { |
|
| 95 | + return $this->completed; |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * @param boolean $completed |
|
| 101 | + */ |
|
| 102 | + public function setIsCompleted($completed = true) |
|
| 103 | + { |
|
| 104 | + $this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * @return string |
|
| 110 | + */ |
|
| 111 | + public function id() |
|
| 112 | + { |
|
| 113 | + return $this->id; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * @access protected |
|
| 119 | + * @param string $id |
|
| 120 | + * @throws InvalidDataTypeException |
|
| 121 | + */ |
|
| 122 | + protected function setId($id = '') |
|
| 123 | + { |
|
| 124 | + if (! is_string($id)) { |
|
| 125 | + throw new InvalidDataTypeException('$id', $id, 'string'); |
|
| 126 | + } |
|
| 127 | + $this->id = $id; |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * @return int |
|
| 133 | + */ |
|
| 134 | + public function order() |
|
| 135 | + { |
|
| 136 | + return $this->order; |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * @access protected |
|
| 142 | + * @param int $order |
|
| 143 | + * @throws InvalidDataTypeException |
|
| 144 | + */ |
|
| 145 | + protected function setOrder($order = 0) |
|
| 146 | + { |
|
| 147 | + if (! is_int($order)) { |
|
| 148 | + throw new InvalidDataTypeException('$order', $order, 'integer'); |
|
| 149 | + } |
|
| 150 | + $this->order = $order; |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * @return string |
|
| 156 | + */ |
|
| 157 | + public function htmlClass() |
|
| 158 | + { |
|
| 159 | + $html_class = $this->html_class; |
|
| 160 | + if ($this->isCurrent()) { |
|
| 161 | + $html_class .= ' progress-step-active'; |
|
| 162 | + } elseif ($this->isCompleted()) { |
|
| 163 | + $html_class .= ' progress-step-completed'; |
|
| 164 | + } |
|
| 165 | + return $html_class; |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * @access protected |
|
| 171 | + * @param string $html_class |
|
| 172 | + * @throws InvalidDataTypeException |
|
| 173 | + */ |
|
| 174 | + protected function setHtmlClass($html_class) |
|
| 175 | + { |
|
| 176 | + if (! is_string($html_class)) { |
|
| 177 | + throw new InvalidDataTypeException('$html_class', $html_class, 'string'); |
|
| 178 | + } |
|
| 179 | + if (strpos($html_class, 'progress-step-') === false) { |
|
| 180 | + $html_class = 'progress-step-' . $html_class; |
|
| 181 | + } |
|
| 182 | + $this->html_class = $html_class; |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * @return string |
|
| 188 | + */ |
|
| 189 | + public function text() |
|
| 190 | + { |
|
| 191 | + return $this->text; |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * @access protected |
|
| 197 | + * @param string $text |
|
| 198 | + * @throws InvalidDataTypeException |
|
| 199 | + */ |
|
| 200 | + protected function setText($text) |
|
| 201 | + { |
|
| 202 | + if (! is_string($text)) { |
|
| 203 | + throw new InvalidDataTypeException('$text', $text, 'string'); |
|
| 204 | + } |
|
| 205 | + $this->text = $text; |
|
| 206 | + } |
|
| 207 | 207 | } |
@@ -17,13 +17,13 @@ |
||
| 17 | 17 | class ProgressStepCollection extends Collection |
| 18 | 18 | { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * ProgressStepCollection constructor. |
|
| 22 | - * |
|
| 23 | - * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
| 24 | - */ |
|
| 25 | - public function __construct() |
|
| 26 | - { |
|
| 27 | - parent::__construct('\EventEspresso\core\services\progress_steps\ProgressStepInterface'); |
|
| 28 | - } |
|
| 20 | + /** |
|
| 21 | + * ProgressStepCollection constructor. |
|
| 22 | + * |
|
| 23 | + * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
| 24 | + */ |
|
| 25 | + public function __construct() |
|
| 26 | + { |
|
| 27 | + parent::__construct('\EventEspresso\core\services\progress_steps\ProgressStepInterface'); |
|
| 28 | + } |
|
| 29 | 29 | } |
@@ -26,227 +26,227 @@ |
||
| 26 | 26 | class ProgressStepManager |
| 27 | 27 | { |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var ProgressStepInterface[] $collection |
|
| 31 | - */ |
|
| 32 | - private $collection; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * @var string $default_step |
|
| 36 | - */ |
|
| 37 | - private $default_step; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * the key used for the URL param that denotes the current form step |
|
| 41 | - * defaults to 'ee-form-step' |
|
| 42 | - * |
|
| 43 | - * @var string $form_step_url_key |
|
| 44 | - */ |
|
| 45 | - private $form_step_url_key = ''; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * @var ProgressStepsDisplayInterface $display_strategy |
|
| 49 | - */ |
|
| 50 | - private $display_strategy; |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * @var EE_Request $request |
|
| 54 | - */ |
|
| 55 | - private $request; |
|
| 56 | - |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * ProgressStepManager constructor |
|
| 60 | - * |
|
| 61 | - * @param string $display_strategy_name |
|
| 62 | - * @param string $default_step |
|
| 63 | - * @param string $form_step_url_key |
|
| 64 | - * @param CollectionInterface $collection |
|
| 65 | - * @param \EE_Request $request |
|
| 66 | - * @throws InvalidClassException |
|
| 67 | - * @throws InvalidDataTypeException |
|
| 68 | - * @throws InvalidInterfaceException |
|
| 69 | - */ |
|
| 70 | - public function __construct( |
|
| 71 | - $display_strategy_name = 'number_bubbles', |
|
| 72 | - $default_step = '', |
|
| 73 | - $form_step_url_key = '', |
|
| 74 | - CollectionInterface $collection = null, |
|
| 75 | - EE_Request $request = null |
|
| 76 | - ) { |
|
| 77 | - $this->setDisplayStrategy($display_strategy_name); |
|
| 78 | - $this->setDefaultStep($default_step); |
|
| 79 | - $this->setFormStepUrlKey($form_step_url_key); |
|
| 80 | - if (! $collection instanceof CollectionInterface) { |
|
| 81 | - $collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface'); |
|
| 82 | - } |
|
| 83 | - $this->collection = $collection; |
|
| 84 | - if (! $request instanceof EE_Request) { |
|
| 85 | - $request = \EE_Registry::instance()->load_core('Request'); |
|
| 86 | - } |
|
| 87 | - $this->request = $request; |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * @param string $display_strategy_name |
|
| 93 | - * @throws InvalidDataTypeException |
|
| 94 | - * @throws InvalidClassException |
|
| 95 | - */ |
|
| 96 | - protected function setDisplayStrategy($display_strategy_name = 'number_bubbles') |
|
| 97 | - { |
|
| 98 | - if (! is_string($display_strategy_name)) { |
|
| 99 | - throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string'); |
|
| 100 | - } |
|
| 101 | - // build up FQCN from incoming display strategy folder name |
|
| 102 | - $display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\'; |
|
| 103 | - $display_strategy_class .= $display_strategy_name . '\\'; |
|
| 104 | - $display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name))); |
|
| 105 | - $display_strategy_class .= 'ProgressStepsDisplay'; |
|
| 106 | - $display_strategy_class = apply_filters( |
|
| 107 | - 'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class', |
|
| 108 | - $display_strategy_class |
|
| 109 | - ); |
|
| 110 | - if (! class_exists($display_strategy_class)) { |
|
| 111 | - throw new InvalidClassException($display_strategy_class); |
|
| 112 | - } |
|
| 113 | - $display_strategy = new $display_strategy_class(); |
|
| 114 | - if (! $display_strategy instanceof ProgressStepsDisplayInterface) { |
|
| 115 | - throw new InvalidClassException( |
|
| 116 | - $display_strategy_class, |
|
| 117 | - sprintf( |
|
| 118 | - __('The "%1$s" Class needs to be an implementation of the "%1$s" Interface.', 'event_espresso'), |
|
| 119 | - $display_strategy_class, |
|
| 120 | - '\EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface' |
|
| 121 | - ) |
|
| 122 | - ); |
|
| 123 | - } |
|
| 124 | - $this->display_strategy = $display_strategy; |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * @param string $default_step |
|
| 130 | - * @throws InvalidDataTypeException |
|
| 131 | - */ |
|
| 132 | - public function setDefaultStep($default_step) |
|
| 133 | - { |
|
| 134 | - if (! is_string($default_step)) { |
|
| 135 | - throw new InvalidDataTypeException('$default_step', $default_step, 'string'); |
|
| 136 | - } |
|
| 137 | - $this->default_step = $default_step; |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * @param string $form_step_url_key |
|
| 143 | - * @throws InvalidDataTypeException |
|
| 144 | - */ |
|
| 145 | - public function setFormStepUrlKey($form_step_url_key = 'ee-form-step') |
|
| 146 | - { |
|
| 147 | - if (! is_string($form_step_url_key)) { |
|
| 148 | - throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string'); |
|
| 149 | - } |
|
| 150 | - $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step'; |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * @param string $step |
|
| 156 | - * @throws InvalidIdentifierException |
|
| 157 | - */ |
|
| 158 | - public function setCurrentStep($step = '') |
|
| 159 | - { |
|
| 160 | - // use incoming value if it's set, otherwise use request param if it's set, otherwise use default |
|
| 161 | - $step = ! empty($step) |
|
| 162 | - ? $step |
|
| 163 | - : $this->request->get($this->form_step_url_key, $this->default_step); |
|
| 164 | - // grab the step previously known as current, in case we need to revert |
|
| 165 | - $current_current_step = $this->collection->current(); |
|
| 166 | - // verify that requested step exists |
|
| 167 | - if (! $this->collection->has($step)) { |
|
| 168 | - throw new InvalidIdentifierException($step, $this->default_step); |
|
| 169 | - } |
|
| 170 | - if ($this->collection->setCurrent($step)) { |
|
| 171 | - // if the old boss is the same as the new boss, then nothing changes |
|
| 172 | - if ($this->collection->current() !== $current_current_step) { |
|
| 173 | - $current_current_step->setIsCurrent(false); |
|
| 174 | - } |
|
| 175 | - $this->collection->current()->setIsCurrent(); |
|
| 176 | - } else { |
|
| 177 | - $this->collection->setCurrent($current_current_step->id()); |
|
| 178 | - $current_current_step->setIsCurrent(true); |
|
| 179 | - } |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - |
|
| 183 | - /** |
|
| 184 | - * setPreviousStepsCompleted |
|
| 185 | - */ |
|
| 186 | - public function setPreviousStepsCompleted() |
|
| 187 | - { |
|
| 188 | - $current_current_step = $this->collection->current(); |
|
| 189 | - $this->collection->rewind(); |
|
| 190 | - while ($this->collection->valid()) { |
|
| 191 | - if ($this->collection->current() === $current_current_step) { |
|
| 192 | - break; |
|
| 193 | - } |
|
| 194 | - $this->setCurrentStepCompleted(); |
|
| 195 | - $this->collection->next(); |
|
| 196 | - } |
|
| 197 | - $this->collection->setCurrentUsingObject($current_current_step); |
|
| 198 | - return false; |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * @return ProgressStepInterface |
|
| 204 | - */ |
|
| 205 | - public function currentStep() |
|
| 206 | - { |
|
| 207 | - return $this->collection->current(); |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * @return ProgressStepInterface |
|
| 213 | - */ |
|
| 214 | - public function nextStep() |
|
| 215 | - { |
|
| 216 | - return $this->collection->next(); |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * @return void |
|
| 222 | - */ |
|
| 223 | - public function enqueueStylesAndScripts() |
|
| 224 | - { |
|
| 225 | - $this->display_strategy->enqueueStylesAndScripts(); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * echos out HTML |
|
| 231 | - * |
|
| 232 | - * @return string |
|
| 233 | - */ |
|
| 234 | - public function displaySteps() |
|
| 235 | - { |
|
| 236 | - return \EEH_Template::display_template( |
|
| 237 | - $this->display_strategy->getTemplate(), |
|
| 238 | - array('progress_steps' => $this->collection), |
|
| 239 | - true |
|
| 240 | - ); |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - |
|
| 244 | - /** |
|
| 245 | - * @param bool $completed |
|
| 246 | - * @return \EventEspresso\core\services\progress_steps\ProgressStepInterface |
|
| 247 | - */ |
|
| 248 | - public function setCurrentStepCompleted($completed = true) |
|
| 249 | - { |
|
| 250 | - return $this->collection->current()->setIsCompleted($completed); |
|
| 251 | - } |
|
| 29 | + /** |
|
| 30 | + * @var ProgressStepInterface[] $collection |
|
| 31 | + */ |
|
| 32 | + private $collection; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * @var string $default_step |
|
| 36 | + */ |
|
| 37 | + private $default_step; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * the key used for the URL param that denotes the current form step |
|
| 41 | + * defaults to 'ee-form-step' |
|
| 42 | + * |
|
| 43 | + * @var string $form_step_url_key |
|
| 44 | + */ |
|
| 45 | + private $form_step_url_key = ''; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * @var ProgressStepsDisplayInterface $display_strategy |
|
| 49 | + */ |
|
| 50 | + private $display_strategy; |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * @var EE_Request $request |
|
| 54 | + */ |
|
| 55 | + private $request; |
|
| 56 | + |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * ProgressStepManager constructor |
|
| 60 | + * |
|
| 61 | + * @param string $display_strategy_name |
|
| 62 | + * @param string $default_step |
|
| 63 | + * @param string $form_step_url_key |
|
| 64 | + * @param CollectionInterface $collection |
|
| 65 | + * @param \EE_Request $request |
|
| 66 | + * @throws InvalidClassException |
|
| 67 | + * @throws InvalidDataTypeException |
|
| 68 | + * @throws InvalidInterfaceException |
|
| 69 | + */ |
|
| 70 | + public function __construct( |
|
| 71 | + $display_strategy_name = 'number_bubbles', |
|
| 72 | + $default_step = '', |
|
| 73 | + $form_step_url_key = '', |
|
| 74 | + CollectionInterface $collection = null, |
|
| 75 | + EE_Request $request = null |
|
| 76 | + ) { |
|
| 77 | + $this->setDisplayStrategy($display_strategy_name); |
|
| 78 | + $this->setDefaultStep($default_step); |
|
| 79 | + $this->setFormStepUrlKey($form_step_url_key); |
|
| 80 | + if (! $collection instanceof CollectionInterface) { |
|
| 81 | + $collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface'); |
|
| 82 | + } |
|
| 83 | + $this->collection = $collection; |
|
| 84 | + if (! $request instanceof EE_Request) { |
|
| 85 | + $request = \EE_Registry::instance()->load_core('Request'); |
|
| 86 | + } |
|
| 87 | + $this->request = $request; |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * @param string $display_strategy_name |
|
| 93 | + * @throws InvalidDataTypeException |
|
| 94 | + * @throws InvalidClassException |
|
| 95 | + */ |
|
| 96 | + protected function setDisplayStrategy($display_strategy_name = 'number_bubbles') |
|
| 97 | + { |
|
| 98 | + if (! is_string($display_strategy_name)) { |
|
| 99 | + throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string'); |
|
| 100 | + } |
|
| 101 | + // build up FQCN from incoming display strategy folder name |
|
| 102 | + $display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\'; |
|
| 103 | + $display_strategy_class .= $display_strategy_name . '\\'; |
|
| 104 | + $display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name))); |
|
| 105 | + $display_strategy_class .= 'ProgressStepsDisplay'; |
|
| 106 | + $display_strategy_class = apply_filters( |
|
| 107 | + 'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class', |
|
| 108 | + $display_strategy_class |
|
| 109 | + ); |
|
| 110 | + if (! class_exists($display_strategy_class)) { |
|
| 111 | + throw new InvalidClassException($display_strategy_class); |
|
| 112 | + } |
|
| 113 | + $display_strategy = new $display_strategy_class(); |
|
| 114 | + if (! $display_strategy instanceof ProgressStepsDisplayInterface) { |
|
| 115 | + throw new InvalidClassException( |
|
| 116 | + $display_strategy_class, |
|
| 117 | + sprintf( |
|
| 118 | + __('The "%1$s" Class needs to be an implementation of the "%1$s" Interface.', 'event_espresso'), |
|
| 119 | + $display_strategy_class, |
|
| 120 | + '\EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface' |
|
| 121 | + ) |
|
| 122 | + ); |
|
| 123 | + } |
|
| 124 | + $this->display_strategy = $display_strategy; |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * @param string $default_step |
|
| 130 | + * @throws InvalidDataTypeException |
|
| 131 | + */ |
|
| 132 | + public function setDefaultStep($default_step) |
|
| 133 | + { |
|
| 134 | + if (! is_string($default_step)) { |
|
| 135 | + throw new InvalidDataTypeException('$default_step', $default_step, 'string'); |
|
| 136 | + } |
|
| 137 | + $this->default_step = $default_step; |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * @param string $form_step_url_key |
|
| 143 | + * @throws InvalidDataTypeException |
|
| 144 | + */ |
|
| 145 | + public function setFormStepUrlKey($form_step_url_key = 'ee-form-step') |
|
| 146 | + { |
|
| 147 | + if (! is_string($form_step_url_key)) { |
|
| 148 | + throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string'); |
|
| 149 | + } |
|
| 150 | + $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step'; |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * @param string $step |
|
| 156 | + * @throws InvalidIdentifierException |
|
| 157 | + */ |
|
| 158 | + public function setCurrentStep($step = '') |
|
| 159 | + { |
|
| 160 | + // use incoming value if it's set, otherwise use request param if it's set, otherwise use default |
|
| 161 | + $step = ! empty($step) |
|
| 162 | + ? $step |
|
| 163 | + : $this->request->get($this->form_step_url_key, $this->default_step); |
|
| 164 | + // grab the step previously known as current, in case we need to revert |
|
| 165 | + $current_current_step = $this->collection->current(); |
|
| 166 | + // verify that requested step exists |
|
| 167 | + if (! $this->collection->has($step)) { |
|
| 168 | + throw new InvalidIdentifierException($step, $this->default_step); |
|
| 169 | + } |
|
| 170 | + if ($this->collection->setCurrent($step)) { |
|
| 171 | + // if the old boss is the same as the new boss, then nothing changes |
|
| 172 | + if ($this->collection->current() !== $current_current_step) { |
|
| 173 | + $current_current_step->setIsCurrent(false); |
|
| 174 | + } |
|
| 175 | + $this->collection->current()->setIsCurrent(); |
|
| 176 | + } else { |
|
| 177 | + $this->collection->setCurrent($current_current_step->id()); |
|
| 178 | + $current_current_step->setIsCurrent(true); |
|
| 179 | + } |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + |
|
| 183 | + /** |
|
| 184 | + * setPreviousStepsCompleted |
|
| 185 | + */ |
|
| 186 | + public function setPreviousStepsCompleted() |
|
| 187 | + { |
|
| 188 | + $current_current_step = $this->collection->current(); |
|
| 189 | + $this->collection->rewind(); |
|
| 190 | + while ($this->collection->valid()) { |
|
| 191 | + if ($this->collection->current() === $current_current_step) { |
|
| 192 | + break; |
|
| 193 | + } |
|
| 194 | + $this->setCurrentStepCompleted(); |
|
| 195 | + $this->collection->next(); |
|
| 196 | + } |
|
| 197 | + $this->collection->setCurrentUsingObject($current_current_step); |
|
| 198 | + return false; |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * @return ProgressStepInterface |
|
| 204 | + */ |
|
| 205 | + public function currentStep() |
|
| 206 | + { |
|
| 207 | + return $this->collection->current(); |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * @return ProgressStepInterface |
|
| 213 | + */ |
|
| 214 | + public function nextStep() |
|
| 215 | + { |
|
| 216 | + return $this->collection->next(); |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * @return void |
|
| 222 | + */ |
|
| 223 | + public function enqueueStylesAndScripts() |
|
| 224 | + { |
|
| 225 | + $this->display_strategy->enqueueStylesAndScripts(); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * echos out HTML |
|
| 231 | + * |
|
| 232 | + * @return string |
|
| 233 | + */ |
|
| 234 | + public function displaySteps() |
|
| 235 | + { |
|
| 236 | + return \EEH_Template::display_template( |
|
| 237 | + $this->display_strategy->getTemplate(), |
|
| 238 | + array('progress_steps' => $this->collection), |
|
| 239 | + true |
|
| 240 | + ); |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + |
|
| 244 | + /** |
|
| 245 | + * @param bool $completed |
|
| 246 | + * @return \EventEspresso\core\services\progress_steps\ProgressStepInterface |
|
| 247 | + */ |
|
| 248 | + public function setCurrentStepCompleted($completed = true) |
|
| 249 | + { |
|
| 250 | + return $this->collection->current()->setIsCompleted($completed); |
|
| 251 | + } |
|
| 252 | 252 | } |
@@ -77,11 +77,11 @@ discard block |
||
| 77 | 77 | $this->setDisplayStrategy($display_strategy_name); |
| 78 | 78 | $this->setDefaultStep($default_step); |
| 79 | 79 | $this->setFormStepUrlKey($form_step_url_key); |
| 80 | - if (! $collection instanceof CollectionInterface) { |
|
| 80 | + if ( ! $collection instanceof CollectionInterface) { |
|
| 81 | 81 | $collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface'); |
| 82 | 82 | } |
| 83 | 83 | $this->collection = $collection; |
| 84 | - if (! $request instanceof EE_Request) { |
|
| 84 | + if ( ! $request instanceof EE_Request) { |
|
| 85 | 85 | $request = \EE_Registry::instance()->load_core('Request'); |
| 86 | 86 | } |
| 87 | 87 | $this->request = $request; |
@@ -95,23 +95,23 @@ discard block |
||
| 95 | 95 | */ |
| 96 | 96 | protected function setDisplayStrategy($display_strategy_name = 'number_bubbles') |
| 97 | 97 | { |
| 98 | - if (! is_string($display_strategy_name)) { |
|
| 98 | + if ( ! is_string($display_strategy_name)) { |
|
| 99 | 99 | throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string'); |
| 100 | 100 | } |
| 101 | 101 | // build up FQCN from incoming display strategy folder name |
| 102 | 102 | $display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\'; |
| 103 | - $display_strategy_class .= $display_strategy_name . '\\'; |
|
| 103 | + $display_strategy_class .= $display_strategy_name.'\\'; |
|
| 104 | 104 | $display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name))); |
| 105 | 105 | $display_strategy_class .= 'ProgressStepsDisplay'; |
| 106 | 106 | $display_strategy_class = apply_filters( |
| 107 | 107 | 'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class', |
| 108 | 108 | $display_strategy_class |
| 109 | 109 | ); |
| 110 | - if (! class_exists($display_strategy_class)) { |
|
| 110 | + if ( ! class_exists($display_strategy_class)) { |
|
| 111 | 111 | throw new InvalidClassException($display_strategy_class); |
| 112 | 112 | } |
| 113 | 113 | $display_strategy = new $display_strategy_class(); |
| 114 | - if (! $display_strategy instanceof ProgressStepsDisplayInterface) { |
|
| 114 | + if ( ! $display_strategy instanceof ProgressStepsDisplayInterface) { |
|
| 115 | 115 | throw new InvalidClassException( |
| 116 | 116 | $display_strategy_class, |
| 117 | 117 | sprintf( |
@@ -131,7 +131,7 @@ discard block |
||
| 131 | 131 | */ |
| 132 | 132 | public function setDefaultStep($default_step) |
| 133 | 133 | { |
| 134 | - if (! is_string($default_step)) { |
|
| 134 | + if ( ! is_string($default_step)) { |
|
| 135 | 135 | throw new InvalidDataTypeException('$default_step', $default_step, 'string'); |
| 136 | 136 | } |
| 137 | 137 | $this->default_step = $default_step; |
@@ -144,7 +144,7 @@ discard block |
||
| 144 | 144 | */ |
| 145 | 145 | public function setFormStepUrlKey($form_step_url_key = 'ee-form-step') |
| 146 | 146 | { |
| 147 | - if (! is_string($form_step_url_key)) { |
|
| 147 | + if ( ! is_string($form_step_url_key)) { |
|
| 148 | 148 | throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string'); |
| 149 | 149 | } |
| 150 | 150 | $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step'; |
@@ -164,7 +164,7 @@ discard block |
||
| 164 | 164 | // grab the step previously known as current, in case we need to revert |
| 165 | 165 | $current_current_step = $this->collection->current(); |
| 166 | 166 | // verify that requested step exists |
| 167 | - if (! $this->collection->has($step)) { |
|
| 167 | + if ( ! $this->collection->has($step)) { |
|
| 168 | 168 | throw new InvalidIdentifierException($step, $this->default_step); |
| 169 | 169 | } |
| 170 | 170 | if ($this->collection->setCurrent($step)) { |
@@ -14,19 +14,19 @@ |
||
| 14 | 14 | { |
| 15 | 15 | |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var LoaderDecoratorInterface $loader |
|
| 19 | - */ |
|
| 20 | - protected $loader; |
|
| 17 | + /** |
|
| 18 | + * @var LoaderDecoratorInterface $loader |
|
| 19 | + */ |
|
| 20 | + protected $loader; |
|
| 21 | 21 | |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * LoaderDecorator constructor. |
|
| 25 | - * |
|
| 26 | - * @param LoaderDecoratorInterface $loader |
|
| 27 | - */ |
|
| 28 | - public function __construct(LoaderDecoratorInterface $loader) |
|
| 29 | - { |
|
| 30 | - $this->loader = $loader; |
|
| 31 | - } |
|
| 23 | + /** |
|
| 24 | + * LoaderDecorator constructor. |
|
| 25 | + * |
|
| 26 | + * @param LoaderDecoratorInterface $loader |
|
| 27 | + */ |
|
| 28 | + public function __construct(LoaderDecoratorInterface $loader) |
|
| 29 | + { |
|
| 30 | + $this->loader = $loader; |
|
| 31 | + } |
|
| 32 | 32 | } |
@@ -17,43 +17,43 @@ |
||
| 17 | 17 | abstract class Locator implements LocatorInterface, Countable |
| 18 | 18 | { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * @var array $flags |
|
| 22 | - */ |
|
| 23 | - protected $flags = array(); |
|
| 24 | - |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * FileLocator constructor. |
|
| 28 | - * |
|
| 29 | - * @access public |
|
| 30 | - * @param array $flags controls how files are found and/or file data is returned |
|
| 31 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 32 | - */ |
|
| 33 | - public function __construct($flags = array()) |
|
| 34 | - { |
|
| 35 | - if (empty($flags)) { |
|
| 36 | - $flags = array( |
|
| 37 | - FilesystemIterator::SKIP_DOTS, |
|
| 38 | - FilesystemIterator::UNIX_PATHS, |
|
| 39 | - FilesystemIterator::CURRENT_AS_PATHNAME, |
|
| 40 | - ); |
|
| 41 | - } |
|
| 42 | - $this->setFlags($flags); |
|
| 43 | - } |
|
| 44 | - |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * @see http://php.net/manual/en/class.filesystemiterator.php#filesystemiterator.constants |
|
| 48 | - * @access public |
|
| 49 | - * @param array $flags |
|
| 50 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 51 | - */ |
|
| 52 | - public function setFlags($flags) |
|
| 53 | - { |
|
| 54 | - if (! is_array($flags)) { |
|
| 55 | - throw new InvalidDataTypeException('$flags', $flags, 'array'); |
|
| 56 | - } |
|
| 57 | - $this->flags = $flags; |
|
| 58 | - } |
|
| 20 | + /** |
|
| 21 | + * @var array $flags |
|
| 22 | + */ |
|
| 23 | + protected $flags = array(); |
|
| 24 | + |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * FileLocator constructor. |
|
| 28 | + * |
|
| 29 | + * @access public |
|
| 30 | + * @param array $flags controls how files are found and/or file data is returned |
|
| 31 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 32 | + */ |
|
| 33 | + public function __construct($flags = array()) |
|
| 34 | + { |
|
| 35 | + if (empty($flags)) { |
|
| 36 | + $flags = array( |
|
| 37 | + FilesystemIterator::SKIP_DOTS, |
|
| 38 | + FilesystemIterator::UNIX_PATHS, |
|
| 39 | + FilesystemIterator::CURRENT_AS_PATHNAME, |
|
| 40 | + ); |
|
| 41 | + } |
|
| 42 | + $this->setFlags($flags); |
|
| 43 | + } |
|
| 44 | + |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * @see http://php.net/manual/en/class.filesystemiterator.php#filesystemiterator.constants |
|
| 48 | + * @access public |
|
| 49 | + * @param array $flags |
|
| 50 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 51 | + */ |
|
| 52 | + public function setFlags($flags) |
|
| 53 | + { |
|
| 54 | + if (! is_array($flags)) { |
|
| 55 | + throw new InvalidDataTypeException('$flags', $flags, 'array'); |
|
| 56 | + } |
|
| 57 | + $this->flags = $flags; |
|
| 58 | + } |
|
| 59 | 59 | } |
@@ -51,7 +51,7 @@ |
||
| 51 | 51 | */ |
| 52 | 52 | public function setFlags($flags) |
| 53 | 53 | { |
| 54 | - if (! is_array($flags)) { |
|
| 54 | + if ( ! is_array($flags)) { |
|
| 55 | 55 | throw new InvalidDataTypeException('$flags', $flags, 'array'); |
| 56 | 56 | } |
| 57 | 57 | $this->flags = $flags; |
@@ -29,203 +29,203 @@ |
||
| 29 | 29 | class ShortcodesManager |
| 30 | 30 | { |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 34 | - */ |
|
| 35 | - private $legacy_shortcodes_manager; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * @var ShortcodeInterface[] $shortcodes |
|
| 39 | - */ |
|
| 40 | - private $shortcodes; |
|
| 41 | - |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * ShortcodesManager constructor |
|
| 45 | - * |
|
| 46 | - * @param LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 47 | - */ |
|
| 48 | - public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) |
|
| 49 | - { |
|
| 50 | - $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
| 51 | - // assemble a list of installed and active shortcodes |
|
| 52 | - add_action( |
|
| 53 | - 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
| 54 | - array($this, 'registerShortcodes'), |
|
| 55 | - 999 |
|
| 56 | - ); |
|
| 57 | - // call add_shortcode() for all installed shortcodes |
|
| 58 | - add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes')); |
|
| 59 | - // check content for shortcodes the old way |
|
| 60 | - add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5); |
|
| 61 | - // check content for shortcodes the NEW more efficient way |
|
| 62 | - add_action('template_redirect', array($this, 'templateRedirect'), 999); |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @return CollectionInterface|ShortcodeInterface[] |
|
| 68 | - * @throws InvalidIdentifierException |
|
| 69 | - * @throws InvalidInterfaceException |
|
| 70 | - * @throws InvalidFilePathException |
|
| 71 | - * @throws InvalidEntityException |
|
| 72 | - * @throws InvalidDataTypeException |
|
| 73 | - * @throws InvalidClassException |
|
| 74 | - */ |
|
| 75 | - public function getShortcodes() |
|
| 76 | - { |
|
| 77 | - if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 78 | - $this->shortcodes = $this->loadShortcodesCollection(); |
|
| 79 | - } |
|
| 80 | - return $this->shortcodes; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * @return CollectionInterface|ShortcodeInterface[] |
|
| 86 | - * @throws InvalidIdentifierException |
|
| 87 | - * @throws InvalidInterfaceException |
|
| 88 | - * @throws InvalidFilePathException |
|
| 89 | - * @throws InvalidEntityException |
|
| 90 | - * @throws InvalidDataTypeException |
|
| 91 | - * @throws InvalidClassException |
|
| 92 | - */ |
|
| 93 | - protected function loadShortcodesCollection() |
|
| 94 | - { |
|
| 95 | - $loader = new CollectionLoader( |
|
| 96 | - new CollectionDetails( |
|
| 97 | - // collection name |
|
| 98 | - 'shortcodes', |
|
| 99 | - // collection interface |
|
| 100 | - 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 101 | - // FQCNs for classes to add (all classes within that namespace will be loaded) |
|
| 102 | - array('EventEspresso\core\domain\entities\shortcodes'), |
|
| 103 | - // filepaths to classes to add |
|
| 104 | - array(), |
|
| 105 | - // file mask to use if parsing folder for files to add |
|
| 106 | - '', |
|
| 107 | - // what to use as identifier for collection entities |
|
| 108 | - // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 109 | - CollectionDetails::ID_CLASS_NAME |
|
| 110 | - ) |
|
| 111 | - ); |
|
| 112 | - return $loader->getCollection(); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * @return void |
|
| 118 | - * @throws DomainException |
|
| 119 | - * @throws InvalidInterfaceException |
|
| 120 | - * @throws InvalidIdentifierException |
|
| 121 | - * @throws InvalidFilePathException |
|
| 122 | - * @throws InvalidEntityException |
|
| 123 | - * @throws InvalidDataTypeException |
|
| 124 | - * @throws InvalidClassException |
|
| 125 | - */ |
|
| 126 | - public function registerShortcodes() |
|
| 127 | - { |
|
| 128 | - try { |
|
| 129 | - $this->shortcodes = apply_filters( |
|
| 130 | - 'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection', |
|
| 131 | - $this->getShortcodes() |
|
| 132 | - ); |
|
| 133 | - if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 134 | - throw new InvalidEntityException( |
|
| 135 | - $this->shortcodes, |
|
| 136 | - 'CollectionInterface', |
|
| 137 | - sprintf( |
|
| 138 | - esc_html__( |
|
| 139 | - 'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.', |
|
| 140 | - 'event_espresso' |
|
| 141 | - ), |
|
| 142 | - is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes) |
|
| 143 | - ) |
|
| 144 | - ); |
|
| 145 | - } |
|
| 146 | - $this->legacy_shortcodes_manager->registerShortcodes(); |
|
| 147 | - } catch (Exception $exception) { |
|
| 148 | - new ExceptionStackTraceDisplay($exception); |
|
| 149 | - } |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * @return void |
|
| 155 | - */ |
|
| 156 | - public function addShortcodes() |
|
| 157 | - { |
|
| 158 | - try { |
|
| 159 | - // cycle thru shortcode folders |
|
| 160 | - foreach ($this->shortcodes as $shortcode) { |
|
| 161 | - /** @var ShortcodeInterface $shortcode */ |
|
| 162 | - if ($shortcode instanceof EnqueueAssetsInterface) { |
|
| 163 | - add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10); |
|
| 164 | - add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11); |
|
| 165 | - } |
|
| 166 | - // add_shortcode() if it has not already been added |
|
| 167 | - if (! shortcode_exists($shortcode->getTag())) { |
|
| 168 | - add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback')); |
|
| 169 | - } |
|
| 170 | - } |
|
| 171 | - $this->legacy_shortcodes_manager->addShortcodes(); |
|
| 172 | - } catch (Exception $exception) { |
|
| 173 | - new ExceptionStackTraceDisplay($exception); |
|
| 174 | - } |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * callback for the "template_redirect" hook point |
|
| 180 | - * checks posts for EE shortcodes, and initializes them, |
|
| 181 | - * then toggles filter switch that loads core default assets |
|
| 182 | - * |
|
| 183 | - * @return void |
|
| 184 | - */ |
|
| 185 | - public function templateRedirect() |
|
| 186 | - { |
|
| 187 | - global $wp_query; |
|
| 188 | - if (empty($wp_query->posts)) { |
|
| 189 | - return; |
|
| 190 | - } |
|
| 191 | - $load_assets = false; |
|
| 192 | - // array of posts displayed in current request |
|
| 193 | - $posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts); |
|
| 194 | - foreach ($posts as $post) { |
|
| 195 | - // now check post content and excerpt for EE shortcodes |
|
| 196 | - $load_assets = $this->parseContentForShortcodes($post->post_content) |
|
| 197 | - ? true |
|
| 198 | - : $load_assets; |
|
| 199 | - } |
|
| 200 | - if ($load_assets) { |
|
| 201 | - $this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true); |
|
| 202 | - add_filter('FHEE_load_css', '__return_true'); |
|
| 203 | - add_filter('FHEE_load_js', '__return_true'); |
|
| 204 | - } |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * checks supplied content against list of shortcodes, |
|
| 210 | - * then initializes any found shortcodes, and returns true. |
|
| 211 | - * returns false if no shortcodes found. |
|
| 212 | - * |
|
| 213 | - * @param string $content |
|
| 214 | - * @return bool |
|
| 215 | - */ |
|
| 216 | - public function parseContentForShortcodes($content) |
|
| 217 | - { |
|
| 218 | - $has_shortcode = false; |
|
| 219 | - if (empty($this->shortcodes)) { |
|
| 220 | - return $has_shortcode; |
|
| 221 | - } |
|
| 222 | - foreach ($this->shortcodes as $shortcode) { |
|
| 223 | - /** @var ShortcodeInterface $shortcode */ |
|
| 224 | - if (has_shortcode($content, $shortcode->getTag())) { |
|
| 225 | - $shortcode->initializeShortcode(); |
|
| 226 | - $has_shortcode = true; |
|
| 227 | - } |
|
| 228 | - } |
|
| 229 | - return $has_shortcode; |
|
| 230 | - } |
|
| 32 | + /** |
|
| 33 | + * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 34 | + */ |
|
| 35 | + private $legacy_shortcodes_manager; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * @var ShortcodeInterface[] $shortcodes |
|
| 39 | + */ |
|
| 40 | + private $shortcodes; |
|
| 41 | + |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * ShortcodesManager constructor |
|
| 45 | + * |
|
| 46 | + * @param LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 47 | + */ |
|
| 48 | + public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) |
|
| 49 | + { |
|
| 50 | + $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
| 51 | + // assemble a list of installed and active shortcodes |
|
| 52 | + add_action( |
|
| 53 | + 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
| 54 | + array($this, 'registerShortcodes'), |
|
| 55 | + 999 |
|
| 56 | + ); |
|
| 57 | + // call add_shortcode() for all installed shortcodes |
|
| 58 | + add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes')); |
|
| 59 | + // check content for shortcodes the old way |
|
| 60 | + add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5); |
|
| 61 | + // check content for shortcodes the NEW more efficient way |
|
| 62 | + add_action('template_redirect', array($this, 'templateRedirect'), 999); |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @return CollectionInterface|ShortcodeInterface[] |
|
| 68 | + * @throws InvalidIdentifierException |
|
| 69 | + * @throws InvalidInterfaceException |
|
| 70 | + * @throws InvalidFilePathException |
|
| 71 | + * @throws InvalidEntityException |
|
| 72 | + * @throws InvalidDataTypeException |
|
| 73 | + * @throws InvalidClassException |
|
| 74 | + */ |
|
| 75 | + public function getShortcodes() |
|
| 76 | + { |
|
| 77 | + if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 78 | + $this->shortcodes = $this->loadShortcodesCollection(); |
|
| 79 | + } |
|
| 80 | + return $this->shortcodes; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * @return CollectionInterface|ShortcodeInterface[] |
|
| 86 | + * @throws InvalidIdentifierException |
|
| 87 | + * @throws InvalidInterfaceException |
|
| 88 | + * @throws InvalidFilePathException |
|
| 89 | + * @throws InvalidEntityException |
|
| 90 | + * @throws InvalidDataTypeException |
|
| 91 | + * @throws InvalidClassException |
|
| 92 | + */ |
|
| 93 | + protected function loadShortcodesCollection() |
|
| 94 | + { |
|
| 95 | + $loader = new CollectionLoader( |
|
| 96 | + new CollectionDetails( |
|
| 97 | + // collection name |
|
| 98 | + 'shortcodes', |
|
| 99 | + // collection interface |
|
| 100 | + 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 101 | + // FQCNs for classes to add (all classes within that namespace will be loaded) |
|
| 102 | + array('EventEspresso\core\domain\entities\shortcodes'), |
|
| 103 | + // filepaths to classes to add |
|
| 104 | + array(), |
|
| 105 | + // file mask to use if parsing folder for files to add |
|
| 106 | + '', |
|
| 107 | + // what to use as identifier for collection entities |
|
| 108 | + // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 109 | + CollectionDetails::ID_CLASS_NAME |
|
| 110 | + ) |
|
| 111 | + ); |
|
| 112 | + return $loader->getCollection(); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * @return void |
|
| 118 | + * @throws DomainException |
|
| 119 | + * @throws InvalidInterfaceException |
|
| 120 | + * @throws InvalidIdentifierException |
|
| 121 | + * @throws InvalidFilePathException |
|
| 122 | + * @throws InvalidEntityException |
|
| 123 | + * @throws InvalidDataTypeException |
|
| 124 | + * @throws InvalidClassException |
|
| 125 | + */ |
|
| 126 | + public function registerShortcodes() |
|
| 127 | + { |
|
| 128 | + try { |
|
| 129 | + $this->shortcodes = apply_filters( |
|
| 130 | + 'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection', |
|
| 131 | + $this->getShortcodes() |
|
| 132 | + ); |
|
| 133 | + if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 134 | + throw new InvalidEntityException( |
|
| 135 | + $this->shortcodes, |
|
| 136 | + 'CollectionInterface', |
|
| 137 | + sprintf( |
|
| 138 | + esc_html__( |
|
| 139 | + 'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.', |
|
| 140 | + 'event_espresso' |
|
| 141 | + ), |
|
| 142 | + is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes) |
|
| 143 | + ) |
|
| 144 | + ); |
|
| 145 | + } |
|
| 146 | + $this->legacy_shortcodes_manager->registerShortcodes(); |
|
| 147 | + } catch (Exception $exception) { |
|
| 148 | + new ExceptionStackTraceDisplay($exception); |
|
| 149 | + } |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * @return void |
|
| 155 | + */ |
|
| 156 | + public function addShortcodes() |
|
| 157 | + { |
|
| 158 | + try { |
|
| 159 | + // cycle thru shortcode folders |
|
| 160 | + foreach ($this->shortcodes as $shortcode) { |
|
| 161 | + /** @var ShortcodeInterface $shortcode */ |
|
| 162 | + if ($shortcode instanceof EnqueueAssetsInterface) { |
|
| 163 | + add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10); |
|
| 164 | + add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11); |
|
| 165 | + } |
|
| 166 | + // add_shortcode() if it has not already been added |
|
| 167 | + if (! shortcode_exists($shortcode->getTag())) { |
|
| 168 | + add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback')); |
|
| 169 | + } |
|
| 170 | + } |
|
| 171 | + $this->legacy_shortcodes_manager->addShortcodes(); |
|
| 172 | + } catch (Exception $exception) { |
|
| 173 | + new ExceptionStackTraceDisplay($exception); |
|
| 174 | + } |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * callback for the "template_redirect" hook point |
|
| 180 | + * checks posts for EE shortcodes, and initializes them, |
|
| 181 | + * then toggles filter switch that loads core default assets |
|
| 182 | + * |
|
| 183 | + * @return void |
|
| 184 | + */ |
|
| 185 | + public function templateRedirect() |
|
| 186 | + { |
|
| 187 | + global $wp_query; |
|
| 188 | + if (empty($wp_query->posts)) { |
|
| 189 | + return; |
|
| 190 | + } |
|
| 191 | + $load_assets = false; |
|
| 192 | + // array of posts displayed in current request |
|
| 193 | + $posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts); |
|
| 194 | + foreach ($posts as $post) { |
|
| 195 | + // now check post content and excerpt for EE shortcodes |
|
| 196 | + $load_assets = $this->parseContentForShortcodes($post->post_content) |
|
| 197 | + ? true |
|
| 198 | + : $load_assets; |
|
| 199 | + } |
|
| 200 | + if ($load_assets) { |
|
| 201 | + $this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true); |
|
| 202 | + add_filter('FHEE_load_css', '__return_true'); |
|
| 203 | + add_filter('FHEE_load_js', '__return_true'); |
|
| 204 | + } |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * checks supplied content against list of shortcodes, |
|
| 210 | + * then initializes any found shortcodes, and returns true. |
|
| 211 | + * returns false if no shortcodes found. |
|
| 212 | + * |
|
| 213 | + * @param string $content |
|
| 214 | + * @return bool |
|
| 215 | + */ |
|
| 216 | + public function parseContentForShortcodes($content) |
|
| 217 | + { |
|
| 218 | + $has_shortcode = false; |
|
| 219 | + if (empty($this->shortcodes)) { |
|
| 220 | + return $has_shortcode; |
|
| 221 | + } |
|
| 222 | + foreach ($this->shortcodes as $shortcode) { |
|
| 223 | + /** @var ShortcodeInterface $shortcode */ |
|
| 224 | + if (has_shortcode($content, $shortcode->getTag())) { |
|
| 225 | + $shortcode->initializeShortcode(); |
|
| 226 | + $has_shortcode = true; |
|
| 227 | + } |
|
| 228 | + } |
|
| 229 | + return $has_shortcode; |
|
| 230 | + } |
|
| 231 | 231 | } |
@@ -74,7 +74,7 @@ discard block |
||
| 74 | 74 | */ |
| 75 | 75 | public function getShortcodes() |
| 76 | 76 | { |
| 77 | - if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 77 | + if ( ! $this->shortcodes instanceof CollectionInterface) { |
|
| 78 | 78 | $this->shortcodes = $this->loadShortcodesCollection(); |
| 79 | 79 | } |
| 80 | 80 | return $this->shortcodes; |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | 'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection', |
| 131 | 131 | $this->getShortcodes() |
| 132 | 132 | ); |
| 133 | - if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 133 | + if ( ! $this->shortcodes instanceof CollectionInterface) { |
|
| 134 | 134 | throw new InvalidEntityException( |
| 135 | 135 | $this->shortcodes, |
| 136 | 136 | 'CollectionInterface', |
@@ -164,7 +164,7 @@ discard block |
||
| 164 | 164 | add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11); |
| 165 | 165 | } |
| 166 | 166 | // add_shortcode() if it has not already been added |
| 167 | - if (! shortcode_exists($shortcode->getTag())) { |
|
| 167 | + if ( ! shortcode_exists($shortcode->getTag())) { |
|
| 168 | 168 | add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback')); |
| 169 | 169 | } |
| 170 | 170 | } |
@@ -12,38 +12,38 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class AddressFormatter |
| 14 | 14 | { |
| 15 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 16 | - /** |
|
| 17 | - * @param string $address |
|
| 18 | - * @param string $address2 |
|
| 19 | - * @param string $city |
|
| 20 | - * @param string $state |
|
| 21 | - * @param string $zip |
|
| 22 | - * @param string $country |
|
| 23 | - * @param string $formatted_address |
|
| 24 | - * @param string $sub |
|
| 25 | - * @return mixed |
|
| 26 | - */ |
|
| 27 | - protected function parse_formatted_address( |
|
| 28 | - $address, |
|
| 29 | - $address2, |
|
| 30 | - $city, |
|
| 31 | - $state, |
|
| 32 | - $zip, |
|
| 33 | - $country, |
|
| 34 | - $formatted_address, |
|
| 35 | - $sub |
|
| 36 | - ) { |
|
| 37 | - // swap address part placeholders for the real text |
|
| 38 | - $formatted_address = str_replace( |
|
| 39 | - // find |
|
| 40 | - array('{address}', '{address2}', '{city}', '{state}', '{zip}', '{country}'), |
|
| 41 | - // replace |
|
| 42 | - array($address, $address2, $city, $state, $zip, $country), |
|
| 43 | - // string |
|
| 44 | - $formatted_address |
|
| 45 | - ); |
|
| 46 | - // remove placeholder from start and end, reduce repeating placeholders to singles, then replace with HTML line breaks |
|
| 47 | - return preg_replace('/%+/', $sub, trim($formatted_address, '%')); |
|
| 48 | - } |
|
| 15 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 16 | + /** |
|
| 17 | + * @param string $address |
|
| 18 | + * @param string $address2 |
|
| 19 | + * @param string $city |
|
| 20 | + * @param string $state |
|
| 21 | + * @param string $zip |
|
| 22 | + * @param string $country |
|
| 23 | + * @param string $formatted_address |
|
| 24 | + * @param string $sub |
|
| 25 | + * @return mixed |
|
| 26 | + */ |
|
| 27 | + protected function parse_formatted_address( |
|
| 28 | + $address, |
|
| 29 | + $address2, |
|
| 30 | + $city, |
|
| 31 | + $state, |
|
| 32 | + $zip, |
|
| 33 | + $country, |
|
| 34 | + $formatted_address, |
|
| 35 | + $sub |
|
| 36 | + ) { |
|
| 37 | + // swap address part placeholders for the real text |
|
| 38 | + $formatted_address = str_replace( |
|
| 39 | + // find |
|
| 40 | + array('{address}', '{address2}', '{city}', '{state}', '{zip}', '{country}'), |
|
| 41 | + // replace |
|
| 42 | + array($address, $address2, $city, $state, $zip, $country), |
|
| 43 | + // string |
|
| 44 | + $formatted_address |
|
| 45 | + ); |
|
| 46 | + // remove placeholder from start and end, reduce repeating placeholders to singles, then replace with HTML line breaks |
|
| 47 | + return preg_replace('/%+/', $sub, trim($formatted_address, '%')); |
|
| 48 | + } |
|
| 49 | 49 | } |
@@ -13,18 +13,18 @@ |
||
| 13 | 13 | class NullAddressFormatter implements \EEI_Address_Formatter |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * @param string $address |
|
| 18 | - * @param string $address2 |
|
| 19 | - * @param string $city |
|
| 20 | - * @param string $state |
|
| 21 | - * @param string $zip |
|
| 22 | - * @param string $country |
|
| 23 | - * @param string $CNT_ISO |
|
| 24 | - * @return string |
|
| 25 | - */ |
|
| 26 | - public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 27 | - { |
|
| 28 | - return null; |
|
| 29 | - } |
|
| 16 | + /** |
|
| 17 | + * @param string $address |
|
| 18 | + * @param string $address2 |
|
| 19 | + * @param string $city |
|
| 20 | + * @param string $state |
|
| 21 | + * @param string $zip |
|
| 22 | + * @param string $country |
|
| 23 | + * @param string $CNT_ISO |
|
| 24 | + * @return string |
|
| 25 | + */ |
|
| 26 | + public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 27 | + { |
|
| 28 | + return null; |
|
| 29 | + } |
|
| 30 | 30 | } |
@@ -18,36 +18,36 @@ |
||
| 18 | 18 | { |
| 19 | 19 | |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * @var LoaderInterface $loader |
|
| 23 | - */ |
|
| 24 | - private $loader; |
|
| 25 | - |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * CommandFactory constructor |
|
| 29 | - * |
|
| 30 | - * @param LoaderInterface $loader |
|
| 31 | - * @throws InvalidDataTypeException |
|
| 32 | - * @throws InvalidInterfaceException |
|
| 33 | - * @throws InvalidArgumentException |
|
| 34 | - */ |
|
| 35 | - public function __construct(LoaderInterface $loader = null) |
|
| 36 | - { |
|
| 37 | - $this->loader = $loader; |
|
| 38 | - } |
|
| 39 | - |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * @param string $command_fqcn |
|
| 43 | - * @param array $arguments |
|
| 44 | - * @return mixed |
|
| 45 | - * @throws InvalidArgumentException |
|
| 46 | - * @throws InvalidDataTypeException |
|
| 47 | - * @throws InvalidInterfaceException |
|
| 48 | - */ |
|
| 49 | - public function getNew($command_fqcn, $arguments = array()) |
|
| 50 | - { |
|
| 51 | - return $this->loader->getNew($command_fqcn, $arguments); |
|
| 52 | - } |
|
| 21 | + /** |
|
| 22 | + * @var LoaderInterface $loader |
|
| 23 | + */ |
|
| 24 | + private $loader; |
|
| 25 | + |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * CommandFactory constructor |
|
| 29 | + * |
|
| 30 | + * @param LoaderInterface $loader |
|
| 31 | + * @throws InvalidDataTypeException |
|
| 32 | + * @throws InvalidInterfaceException |
|
| 33 | + * @throws InvalidArgumentException |
|
| 34 | + */ |
|
| 35 | + public function __construct(LoaderInterface $loader = null) |
|
| 36 | + { |
|
| 37 | + $this->loader = $loader; |
|
| 38 | + } |
|
| 39 | + |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * @param string $command_fqcn |
|
| 43 | + * @param array $arguments |
|
| 44 | + * @return mixed |
|
| 45 | + * @throws InvalidArgumentException |
|
| 46 | + * @throws InvalidDataTypeException |
|
| 47 | + * @throws InvalidInterfaceException |
|
| 48 | + */ |
|
| 49 | + public function getNew($command_fqcn, $arguments = array()) |
|
| 50 | + { |
|
| 51 | + return $this->loader->getNew($command_fqcn, $arguments); |
|
| 52 | + } |
|
| 53 | 53 | } |