@@ -16,198 +16,198 @@ |
||
16 | 16 | class EventListQuery extends WP_Query |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var string $title |
|
21 | - */ |
|
22 | - private $title; |
|
23 | - |
|
24 | - /** |
|
25 | - * @var integer $limit |
|
26 | - */ |
|
27 | - private $limit = 10; |
|
28 | - |
|
29 | - /** |
|
30 | - * @var string $css_class |
|
31 | - */ |
|
32 | - private $css_class; |
|
33 | - |
|
34 | - /** |
|
35 | - * @var boolean $show_expired |
|
36 | - */ |
|
37 | - private $show_expired = false; |
|
38 | - |
|
39 | - /** |
|
40 | - * @var string $month |
|
41 | - */ |
|
42 | - private $month; |
|
43 | - |
|
44 | - /** |
|
45 | - * @var string $category_slug |
|
46 | - */ |
|
47 | - private $category_slug; |
|
48 | - |
|
49 | - /** |
|
50 | - * @var string $order_by |
|
51 | - */ |
|
52 | - private $order_by; |
|
53 | - |
|
54 | - /** |
|
55 | - * @var string $sort |
|
56 | - */ |
|
57 | - private $sort; |
|
58 | - |
|
59 | - /** |
|
60 | - * @var boolean $show_title |
|
61 | - */ |
|
62 | - private $show_title = true; |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * EE_Event_List_Query Constructor * |
|
67 | - * |
|
68 | - * @param array $args |
|
69 | - */ |
|
70 | - public function __construct($args = array()) |
|
71 | - { |
|
72 | - $args = $this->parseArgs((array) $args); |
|
73 | - $this->setupEventQueryHelper(); |
|
74 | - $this->setupFilters(); |
|
75 | - $args = $this->getQueryArgs($args); |
|
76 | - // run the query |
|
77 | - parent::__construct($args); |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - /** |
|
82 | - * @param array $args |
|
83 | - * @return array |
|
84 | - */ |
|
85 | - private function parseArgs(array $args) |
|
86 | - { |
|
87 | - // incoming args could be a mix of WP query args + EE shortcode args |
|
88 | - foreach ($args as $property => $value) { |
|
89 | - // if the arg is a property of this class, then it's an EE shortcode arg |
|
90 | - if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
91 | - // set the property value |
|
92 | - $this->{$property} = $value; |
|
93 | - // then remove it from the array of args that will later be passed to WP_Query() |
|
94 | - unset($args[ $property ]); |
|
95 | - } |
|
96 | - } |
|
97 | - return $args; |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - private function setupEventQueryHelper() |
|
102 | - { |
|
103 | - // add query filters |
|
104 | - EEH_Event_Query::add_query_filters(); |
|
105 | - // set params that will get used by the filters |
|
106 | - EEH_Event_Query::set_query_params( |
|
107 | - $this->month, |
|
108 | - $this->category_slug, |
|
109 | - $this->show_expired, |
|
110 | - $this->order_by, |
|
111 | - $this->sort |
|
112 | - ); |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - private function setupFilters() |
|
117 | - { |
|
118 | - // first off, let's remove any filters from previous queries |
|
119 | - remove_filter( |
|
120 | - 'FHEE__archive_espresso_events_template__show_header', |
|
121 | - array($this, 'show_event_list_title') |
|
122 | - ); |
|
123 | - remove_filter( |
|
124 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
125 | - array($this, 'event_list_title') |
|
126 | - ); |
|
127 | - remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
128 | - // Event List Title ? |
|
129 | - add_filter( |
|
130 | - 'FHEE__archive_espresso_events_template__show_header', |
|
131 | - array($this, 'show_event_list_title') |
|
132 | - ); |
|
133 | - add_filter( |
|
134 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
135 | - array($this, 'event_list_title'), |
|
136 | - 10, |
|
137 | - 1 |
|
138 | - ); |
|
139 | - // add the css class |
|
140 | - add_filter( |
|
141 | - 'FHEE__content_espresso_events__event_class', |
|
142 | - array($this, 'event_list_css'), |
|
143 | - 10, |
|
144 | - 1 |
|
145 | - ); |
|
146 | - } |
|
147 | - |
|
148 | - |
|
149 | - private function getQueryArgs(array $args) |
|
150 | - { |
|
151 | - // the current "page" we are viewing |
|
152 | - $paged = max(1, get_query_var('paged')); |
|
153 | - // Force these args |
|
154 | - return array_merge( |
|
155 | - $args, |
|
156 | - array( |
|
157 | - 'post_type' => 'espresso_events', |
|
158 | - 'posts_per_page' => $this->limit, |
|
159 | - 'update_post_term_cache' => false, |
|
160 | - 'update_post_meta_cache' => false, |
|
161 | - 'paged' => $paged, |
|
162 | - 'offset' => ($paged - 1) * $this->limit, |
|
163 | - ) |
|
164 | - ); |
|
165 | - } |
|
166 | - |
|
167 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
168 | - |
|
169 | - /** |
|
170 | - * show_event_list_title |
|
171 | - * |
|
172 | - * @return boolean |
|
173 | - */ |
|
174 | - public function show_event_list_title() |
|
175 | - { |
|
176 | - return filter_var( |
|
177 | - $this->show_title, |
|
178 | - FILTER_VALIDATE_BOOLEAN |
|
179 | - ); |
|
180 | - } |
|
181 | - |
|
182 | - |
|
183 | - /** |
|
184 | - * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
185 | - * |
|
186 | - * @param string $event_list_title |
|
187 | - * @return string |
|
188 | - */ |
|
189 | - public function event_list_title($event_list_title = '') |
|
190 | - { |
|
191 | - if (! empty($this->title)) { |
|
192 | - return $this->title; |
|
193 | - } |
|
194 | - return $event_list_title; |
|
195 | - } |
|
196 | - |
|
197 | - |
|
198 | - /** |
|
199 | - * callback for FHEE__content_espresso_events__event_class filter |
|
200 | - * |
|
201 | - * @param string $event_list_css |
|
202 | - * @return string |
|
203 | - */ |
|
204 | - public function event_list_css($event_list_css = '') |
|
205 | - { |
|
206 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
207 | - $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
208 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
209 | - $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
210 | - return $event_list_css; |
|
211 | - } |
|
212 | - // phpcs:enable |
|
19 | + /** |
|
20 | + * @var string $title |
|
21 | + */ |
|
22 | + private $title; |
|
23 | + |
|
24 | + /** |
|
25 | + * @var integer $limit |
|
26 | + */ |
|
27 | + private $limit = 10; |
|
28 | + |
|
29 | + /** |
|
30 | + * @var string $css_class |
|
31 | + */ |
|
32 | + private $css_class; |
|
33 | + |
|
34 | + /** |
|
35 | + * @var boolean $show_expired |
|
36 | + */ |
|
37 | + private $show_expired = false; |
|
38 | + |
|
39 | + /** |
|
40 | + * @var string $month |
|
41 | + */ |
|
42 | + private $month; |
|
43 | + |
|
44 | + /** |
|
45 | + * @var string $category_slug |
|
46 | + */ |
|
47 | + private $category_slug; |
|
48 | + |
|
49 | + /** |
|
50 | + * @var string $order_by |
|
51 | + */ |
|
52 | + private $order_by; |
|
53 | + |
|
54 | + /** |
|
55 | + * @var string $sort |
|
56 | + */ |
|
57 | + private $sort; |
|
58 | + |
|
59 | + /** |
|
60 | + * @var boolean $show_title |
|
61 | + */ |
|
62 | + private $show_title = true; |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * EE_Event_List_Query Constructor * |
|
67 | + * |
|
68 | + * @param array $args |
|
69 | + */ |
|
70 | + public function __construct($args = array()) |
|
71 | + { |
|
72 | + $args = $this->parseArgs((array) $args); |
|
73 | + $this->setupEventQueryHelper(); |
|
74 | + $this->setupFilters(); |
|
75 | + $args = $this->getQueryArgs($args); |
|
76 | + // run the query |
|
77 | + parent::__construct($args); |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + /** |
|
82 | + * @param array $args |
|
83 | + * @return array |
|
84 | + */ |
|
85 | + private function parseArgs(array $args) |
|
86 | + { |
|
87 | + // incoming args could be a mix of WP query args + EE shortcode args |
|
88 | + foreach ($args as $property => $value) { |
|
89 | + // if the arg is a property of this class, then it's an EE shortcode arg |
|
90 | + if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
91 | + // set the property value |
|
92 | + $this->{$property} = $value; |
|
93 | + // then remove it from the array of args that will later be passed to WP_Query() |
|
94 | + unset($args[ $property ]); |
|
95 | + } |
|
96 | + } |
|
97 | + return $args; |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + private function setupEventQueryHelper() |
|
102 | + { |
|
103 | + // add query filters |
|
104 | + EEH_Event_Query::add_query_filters(); |
|
105 | + // set params that will get used by the filters |
|
106 | + EEH_Event_Query::set_query_params( |
|
107 | + $this->month, |
|
108 | + $this->category_slug, |
|
109 | + $this->show_expired, |
|
110 | + $this->order_by, |
|
111 | + $this->sort |
|
112 | + ); |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + private function setupFilters() |
|
117 | + { |
|
118 | + // first off, let's remove any filters from previous queries |
|
119 | + remove_filter( |
|
120 | + 'FHEE__archive_espresso_events_template__show_header', |
|
121 | + array($this, 'show_event_list_title') |
|
122 | + ); |
|
123 | + remove_filter( |
|
124 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
125 | + array($this, 'event_list_title') |
|
126 | + ); |
|
127 | + remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
128 | + // Event List Title ? |
|
129 | + add_filter( |
|
130 | + 'FHEE__archive_espresso_events_template__show_header', |
|
131 | + array($this, 'show_event_list_title') |
|
132 | + ); |
|
133 | + add_filter( |
|
134 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
135 | + array($this, 'event_list_title'), |
|
136 | + 10, |
|
137 | + 1 |
|
138 | + ); |
|
139 | + // add the css class |
|
140 | + add_filter( |
|
141 | + 'FHEE__content_espresso_events__event_class', |
|
142 | + array($this, 'event_list_css'), |
|
143 | + 10, |
|
144 | + 1 |
|
145 | + ); |
|
146 | + } |
|
147 | + |
|
148 | + |
|
149 | + private function getQueryArgs(array $args) |
|
150 | + { |
|
151 | + // the current "page" we are viewing |
|
152 | + $paged = max(1, get_query_var('paged')); |
|
153 | + // Force these args |
|
154 | + return array_merge( |
|
155 | + $args, |
|
156 | + array( |
|
157 | + 'post_type' => 'espresso_events', |
|
158 | + 'posts_per_page' => $this->limit, |
|
159 | + 'update_post_term_cache' => false, |
|
160 | + 'update_post_meta_cache' => false, |
|
161 | + 'paged' => $paged, |
|
162 | + 'offset' => ($paged - 1) * $this->limit, |
|
163 | + ) |
|
164 | + ); |
|
165 | + } |
|
166 | + |
|
167 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
168 | + |
|
169 | + /** |
|
170 | + * show_event_list_title |
|
171 | + * |
|
172 | + * @return boolean |
|
173 | + */ |
|
174 | + public function show_event_list_title() |
|
175 | + { |
|
176 | + return filter_var( |
|
177 | + $this->show_title, |
|
178 | + FILTER_VALIDATE_BOOLEAN |
|
179 | + ); |
|
180 | + } |
|
181 | + |
|
182 | + |
|
183 | + /** |
|
184 | + * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
185 | + * |
|
186 | + * @param string $event_list_title |
|
187 | + * @return string |
|
188 | + */ |
|
189 | + public function event_list_title($event_list_title = '') |
|
190 | + { |
|
191 | + if (! empty($this->title)) { |
|
192 | + return $this->title; |
|
193 | + } |
|
194 | + return $event_list_title; |
|
195 | + } |
|
196 | + |
|
197 | + |
|
198 | + /** |
|
199 | + * callback for FHEE__content_espresso_events__event_class filter |
|
200 | + * |
|
201 | + * @param string $event_list_css |
|
202 | + * @return string |
|
203 | + */ |
|
204 | + public function event_list_css($event_list_css = '') |
|
205 | + { |
|
206 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
207 | + $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
208 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
209 | + $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
210 | + return $event_list_css; |
|
211 | + } |
|
212 | + // phpcs:enable |
|
213 | 213 | } |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | // set the property value |
92 | 92 | $this->{$property} = $value; |
93 | 93 | // then remove it from the array of args that will later be passed to WP_Query() |
94 | - unset($args[ $property ]); |
|
94 | + unset($args[$property]); |
|
95 | 95 | } |
96 | 96 | } |
97 | 97 | return $args; |
@@ -188,7 +188,7 @@ discard block |
||
188 | 188 | */ |
189 | 189 | public function event_list_title($event_list_title = '') |
190 | 190 | { |
191 | - if (! empty($this->title)) { |
|
191 | + if ( ! empty($this->title)) { |
|
192 | 192 | return $this->title; |
193 | 193 | } |
194 | 194 | return $event_list_title; |
@@ -15,112 +15,112 @@ |
||
15 | 15 | class Basic implements EmailValidatorInterface |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * @param string $email_address |
|
20 | - * @return bool |
|
21 | - * @throws EmailValidationException |
|
22 | - */ |
|
23 | - public function validate($email_address) |
|
24 | - { |
|
25 | - if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
26 | - // email not in correct {string}@{string} format |
|
27 | - throw new EmailValidationException( |
|
28 | - esc_html__('Email does not have the required @ sign.', 'event_espresso') |
|
29 | - ); |
|
30 | - } |
|
31 | - $atIndex = $this->getAtIndex($email_address); |
|
32 | - $local = $this->getLocalPartOfEmail($email_address, $atIndex); |
|
33 | - $localLen = strlen($local); |
|
34 | - if ($localLen < 1) { |
|
35 | - // no local part |
|
36 | - throw new EmailValidationException( |
|
37 | - esc_html__('Email local-part (before the @) is required.', 'event_espresso') |
|
38 | - ); |
|
39 | - } |
|
40 | - if ($localLen > 64) { |
|
41 | - // local part length exceeded |
|
42 | - throw new EmailValidationException( |
|
43 | - esc_html__('Email local-part (before the @) is too long.', 'event_espresso') |
|
44 | - ); |
|
45 | - } |
|
46 | - if ($local[0] === '.') { |
|
47 | - // local part starts with '.' |
|
48 | - throw new EmailValidationException( |
|
49 | - esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
|
50 | - ); |
|
51 | - } |
|
52 | - if ($local[ $localLen - 1 ] === '.') { |
|
53 | - // local part starts or ends with '.' |
|
54 | - throw new EmailValidationException( |
|
55 | - esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
|
56 | - ); |
|
57 | - } |
|
58 | - if (preg_match('/\\.\\./', $local)) { |
|
59 | - // local part has two consecutive dots |
|
60 | - throw new EmailValidationException( |
|
61 | - esc_html__( |
|
62 | - 'Email local-part (before the @) must not have two consecutive periods.', |
|
63 | - 'event_espresso' |
|
64 | - ) |
|
65 | - ); |
|
66 | - } |
|
67 | - $domain = $this->getDomainPartOfEmail($email_address, $atIndex); |
|
68 | - $domainLen = strlen($domain); |
|
69 | - if ($domainLen < 1) { |
|
70 | - throw new EmailValidationException( |
|
71 | - esc_html__('Email domain (after the @) is required.', 'event_espresso') |
|
72 | - ); |
|
73 | - } |
|
74 | - if ($domainLen > 255) { |
|
75 | - // domain part length exceeded |
|
76 | - throw new EmailValidationException( |
|
77 | - esc_html__('Email domain (after the @) is too long.', 'event_espresso') |
|
78 | - ); |
|
79 | - } |
|
80 | - if (preg_match('/\\.\\./', $domain)) { |
|
81 | - // domain part has two consecutive dots |
|
82 | - throw new EmailValidationException( |
|
83 | - esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso') |
|
84 | - ); |
|
85 | - } |
|
86 | - return true; |
|
87 | - } |
|
18 | + /** |
|
19 | + * @param string $email_address |
|
20 | + * @return bool |
|
21 | + * @throws EmailValidationException |
|
22 | + */ |
|
23 | + public function validate($email_address) |
|
24 | + { |
|
25 | + if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
26 | + // email not in correct {string}@{string} format |
|
27 | + throw new EmailValidationException( |
|
28 | + esc_html__('Email does not have the required @ sign.', 'event_espresso') |
|
29 | + ); |
|
30 | + } |
|
31 | + $atIndex = $this->getAtIndex($email_address); |
|
32 | + $local = $this->getLocalPartOfEmail($email_address, $atIndex); |
|
33 | + $localLen = strlen($local); |
|
34 | + if ($localLen < 1) { |
|
35 | + // no local part |
|
36 | + throw new EmailValidationException( |
|
37 | + esc_html__('Email local-part (before the @) is required.', 'event_espresso') |
|
38 | + ); |
|
39 | + } |
|
40 | + if ($localLen > 64) { |
|
41 | + // local part length exceeded |
|
42 | + throw new EmailValidationException( |
|
43 | + esc_html__('Email local-part (before the @) is too long.', 'event_espresso') |
|
44 | + ); |
|
45 | + } |
|
46 | + if ($local[0] === '.') { |
|
47 | + // local part starts with '.' |
|
48 | + throw new EmailValidationException( |
|
49 | + esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
|
50 | + ); |
|
51 | + } |
|
52 | + if ($local[ $localLen - 1 ] === '.') { |
|
53 | + // local part starts or ends with '.' |
|
54 | + throw new EmailValidationException( |
|
55 | + esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
|
56 | + ); |
|
57 | + } |
|
58 | + if (preg_match('/\\.\\./', $local)) { |
|
59 | + // local part has two consecutive dots |
|
60 | + throw new EmailValidationException( |
|
61 | + esc_html__( |
|
62 | + 'Email local-part (before the @) must not have two consecutive periods.', |
|
63 | + 'event_espresso' |
|
64 | + ) |
|
65 | + ); |
|
66 | + } |
|
67 | + $domain = $this->getDomainPartOfEmail($email_address, $atIndex); |
|
68 | + $domainLen = strlen($domain); |
|
69 | + if ($domainLen < 1) { |
|
70 | + throw new EmailValidationException( |
|
71 | + esc_html__('Email domain (after the @) is required.', 'event_espresso') |
|
72 | + ); |
|
73 | + } |
|
74 | + if ($domainLen > 255) { |
|
75 | + // domain part length exceeded |
|
76 | + throw new EmailValidationException( |
|
77 | + esc_html__('Email domain (after the @) is too long.', 'event_espresso') |
|
78 | + ); |
|
79 | + } |
|
80 | + if (preg_match('/\\.\\./', $domain)) { |
|
81 | + // domain part has two consecutive dots |
|
82 | + throw new EmailValidationException( |
|
83 | + esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso') |
|
84 | + ); |
|
85 | + } |
|
86 | + return true; |
|
87 | + } |
|
88 | 88 | |
89 | 89 | |
90 | - /** |
|
91 | - * returns the location of the @ symbol |
|
92 | - * |
|
93 | - * @param string $email_address |
|
94 | - * @return bool|string |
|
95 | - */ |
|
96 | - protected function getAtIndex($email_address) |
|
97 | - { |
|
98 | - return strrpos($email_address, '@'); |
|
99 | - } |
|
90 | + /** |
|
91 | + * returns the location of the @ symbol |
|
92 | + * |
|
93 | + * @param string $email_address |
|
94 | + * @return bool|string |
|
95 | + */ |
|
96 | + protected function getAtIndex($email_address) |
|
97 | + { |
|
98 | + return strrpos($email_address, '@'); |
|
99 | + } |
|
100 | 100 | |
101 | 101 | |
102 | - /** |
|
103 | - * Gets the local part of the email |
|
104 | - * |
|
105 | - * @param string $email_address |
|
106 | - * @param bool|int $atIndex |
|
107 | - * @return bool|string |
|
108 | - */ |
|
109 | - protected function getLocalPartOfEmail($email_address, $atIndex) |
|
110 | - { |
|
111 | - return substr($email_address, 0, $atIndex); |
|
112 | - } |
|
102 | + /** |
|
103 | + * Gets the local part of the email |
|
104 | + * |
|
105 | + * @param string $email_address |
|
106 | + * @param bool|int $atIndex |
|
107 | + * @return bool|string |
|
108 | + */ |
|
109 | + protected function getLocalPartOfEmail($email_address, $atIndex) |
|
110 | + { |
|
111 | + return substr($email_address, 0, $atIndex); |
|
112 | + } |
|
113 | 113 | |
114 | 114 | |
115 | - /** |
|
116 | - * Gets the domain part of the email |
|
117 | - * |
|
118 | - * @param string $email_address |
|
119 | - * @param bool|int $atIndex |
|
120 | - * @return bool|string |
|
121 | - */ |
|
122 | - protected function getDomainPartOfEmail($email_address, $atIndex) |
|
123 | - { |
|
124 | - return substr($email_address, $atIndex + 1); |
|
125 | - } |
|
115 | + /** |
|
116 | + * Gets the domain part of the email |
|
117 | + * |
|
118 | + * @param string $email_address |
|
119 | + * @param bool|int $atIndex |
|
120 | + * @return bool|string |
|
121 | + */ |
|
122 | + protected function getDomainPartOfEmail($email_address, $atIndex) |
|
123 | + { |
|
124 | + return substr($email_address, $atIndex + 1); |
|
125 | + } |
|
126 | 126 | } |
@@ -22,7 +22,7 @@ discard block |
||
22 | 22 | */ |
23 | 23 | public function validate($email_address) |
24 | 24 | { |
25 | - if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
25 | + if ( ! preg_match('/^.+\@\S+$/', $email_address)) { |
|
26 | 26 | // email not in correct {string}@{string} format |
27 | 27 | throw new EmailValidationException( |
28 | 28 | esc_html__('Email does not have the required @ sign.', 'event_espresso') |
@@ -49,7 +49,7 @@ discard block |
||
49 | 49 | esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
50 | 50 | ); |
51 | 51 | } |
52 | - if ($local[ $localLen - 1 ] === '.') { |
|
52 | + if ($local[$localLen - 1] === '.') { |
|
53 | 53 | // local part starts or ends with '.' |
54 | 54 | throw new EmailValidationException( |
55 | 55 | esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
@@ -70,14 +70,14 @@ |
||
70 | 70 | 'REG_code' => $reg_code, |
71 | 71 | ) |
72 | 72 | ); |
73 | - if (! $registration instanceof EE_Registration) { |
|
73 | + if ( ! $registration instanceof EE_Registration) { |
|
74 | 74 | throw new UnexpectedEntityException($registration, 'EE_Registration'); |
75 | 75 | } |
76 | 76 | // save registration so that we have an ID |
77 | 77 | $registration->save(); |
78 | 78 | // track reservation on reg but don't adjust ticket and datetime reserved counts |
79 | 79 | // because that is done as soon as the tickets are added/removed from the cart |
80 | - $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__); |
|
80 | + $registration->reserve_ticket(false, 'CreateRegistrationService:'.__LINE__); |
|
81 | 81 | $registration->_add_relation_to($event, 'Event', array(), $event->ID()); |
82 | 82 | $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID()); |
83 | 83 | $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID()); |
@@ -29,102 +29,102 @@ |
||
29 | 29 | { |
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * @param EE_Event $event |
|
34 | - * @param EE_Transaction $transaction |
|
35 | - * @param EE_Ticket $ticket |
|
36 | - * @param EE_Line_Item $ticket_line_item |
|
37 | - * @param $reg_count |
|
38 | - * @param $reg_group_size |
|
39 | - * @param string $reg_status |
|
40 | - * @return EE_Registration |
|
41 | - * @throws OutOfRangeException |
|
42 | - * @throws EE_Error |
|
43 | - * @throws UnexpectedEntityException |
|
44 | - */ |
|
45 | - public function create( |
|
46 | - EE_Event $event, |
|
47 | - EE_Transaction $transaction, |
|
48 | - EE_Ticket $ticket, |
|
49 | - EE_Line_Item $ticket_line_item, |
|
50 | - $reg_count, |
|
51 | - $reg_group_size, |
|
52 | - $reg_status = EEM_Registration::status_id_incomplete |
|
53 | - ) { |
|
54 | - $registrations = $transaction->registrations(); |
|
55 | - $reg_count = $reg_count ? $reg_count : count($registrations) + 1; |
|
56 | - $reg_url_link = new RegUrlLink($reg_count, $ticket_line_item); |
|
57 | - $reg_code = new RegCode($reg_url_link, $transaction, $ticket); |
|
58 | - // generate new EE_Registration |
|
59 | - $registration = EE_Registration::new_instance( |
|
60 | - array( |
|
61 | - 'EVT_ID' => $event->ID(), |
|
62 | - 'TXN_ID' => $transaction->ID(), |
|
63 | - 'TKT_ID' => $ticket->ID(), |
|
64 | - 'STS_ID' => $reg_status, |
|
65 | - 'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item), |
|
66 | - 'REG_session' => EE_Registry::instance()->SSN->id(), |
|
67 | - 'REG_count' => $reg_count, |
|
68 | - 'REG_group_size' => $reg_group_size ? $reg_group_size : $this->incrementRegGroupSize($registrations), |
|
69 | - 'REG_url_link' => $reg_url_link, |
|
70 | - 'REG_code' => $reg_code, |
|
71 | - ) |
|
72 | - ); |
|
73 | - if (! $registration instanceof EE_Registration) { |
|
74 | - throw new UnexpectedEntityException($registration, 'EE_Registration'); |
|
75 | - } |
|
76 | - // save registration so that we have an ID |
|
77 | - $registration->save(); |
|
78 | - // track reservation on reg but don't adjust ticket and datetime reserved counts |
|
79 | - // because that is done as soon as the tickets are added/removed from the cart |
|
80 | - $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__); |
|
81 | - $registration->_add_relation_to($event, 'Event', array(), $event->ID()); |
|
82 | - $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID()); |
|
83 | - $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID()); |
|
84 | - $registration->save(); |
|
85 | - return $registration; |
|
86 | - } |
|
32 | + /** |
|
33 | + * @param EE_Event $event |
|
34 | + * @param EE_Transaction $transaction |
|
35 | + * @param EE_Ticket $ticket |
|
36 | + * @param EE_Line_Item $ticket_line_item |
|
37 | + * @param $reg_count |
|
38 | + * @param $reg_group_size |
|
39 | + * @param string $reg_status |
|
40 | + * @return EE_Registration |
|
41 | + * @throws OutOfRangeException |
|
42 | + * @throws EE_Error |
|
43 | + * @throws UnexpectedEntityException |
|
44 | + */ |
|
45 | + public function create( |
|
46 | + EE_Event $event, |
|
47 | + EE_Transaction $transaction, |
|
48 | + EE_Ticket $ticket, |
|
49 | + EE_Line_Item $ticket_line_item, |
|
50 | + $reg_count, |
|
51 | + $reg_group_size, |
|
52 | + $reg_status = EEM_Registration::status_id_incomplete |
|
53 | + ) { |
|
54 | + $registrations = $transaction->registrations(); |
|
55 | + $reg_count = $reg_count ? $reg_count : count($registrations) + 1; |
|
56 | + $reg_url_link = new RegUrlLink($reg_count, $ticket_line_item); |
|
57 | + $reg_code = new RegCode($reg_url_link, $transaction, $ticket); |
|
58 | + // generate new EE_Registration |
|
59 | + $registration = EE_Registration::new_instance( |
|
60 | + array( |
|
61 | + 'EVT_ID' => $event->ID(), |
|
62 | + 'TXN_ID' => $transaction->ID(), |
|
63 | + 'TKT_ID' => $ticket->ID(), |
|
64 | + 'STS_ID' => $reg_status, |
|
65 | + 'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item), |
|
66 | + 'REG_session' => EE_Registry::instance()->SSN->id(), |
|
67 | + 'REG_count' => $reg_count, |
|
68 | + 'REG_group_size' => $reg_group_size ? $reg_group_size : $this->incrementRegGroupSize($registrations), |
|
69 | + 'REG_url_link' => $reg_url_link, |
|
70 | + 'REG_code' => $reg_code, |
|
71 | + ) |
|
72 | + ); |
|
73 | + if (! $registration instanceof EE_Registration) { |
|
74 | + throw new UnexpectedEntityException($registration, 'EE_Registration'); |
|
75 | + } |
|
76 | + // save registration so that we have an ID |
|
77 | + $registration->save(); |
|
78 | + // track reservation on reg but don't adjust ticket and datetime reserved counts |
|
79 | + // because that is done as soon as the tickets are added/removed from the cart |
|
80 | + $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__); |
|
81 | + $registration->_add_relation_to($event, 'Event', array(), $event->ID()); |
|
82 | + $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID()); |
|
83 | + $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID()); |
|
84 | + $registration->save(); |
|
85 | + return $registration; |
|
86 | + } |
|
87 | 87 | |
88 | 88 | |
89 | - /** |
|
90 | - * @param EE_Transaction $transaction |
|
91 | - * @param EE_Ticket $ticket |
|
92 | - * @param EE_Line_Item $ticket_line_item |
|
93 | - * @return float |
|
94 | - * @throws EE_Error |
|
95 | - * @throws OutOfRangeException |
|
96 | - */ |
|
97 | - protected function resolveFinalPrice( |
|
98 | - EE_Transaction $transaction, |
|
99 | - EE_Ticket $ticket, |
|
100 | - EE_Line_Item $ticket_line_item |
|
101 | - ) { |
|
102 | - $final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item( |
|
103 | - $transaction->total_line_item(), |
|
104 | - $ticket_line_item |
|
105 | - ); |
|
106 | - $final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes(); |
|
107 | - return (float) $final_price; |
|
108 | - } |
|
89 | + /** |
|
90 | + * @param EE_Transaction $transaction |
|
91 | + * @param EE_Ticket $ticket |
|
92 | + * @param EE_Line_Item $ticket_line_item |
|
93 | + * @return float |
|
94 | + * @throws EE_Error |
|
95 | + * @throws OutOfRangeException |
|
96 | + */ |
|
97 | + protected function resolveFinalPrice( |
|
98 | + EE_Transaction $transaction, |
|
99 | + EE_Ticket $ticket, |
|
100 | + EE_Line_Item $ticket_line_item |
|
101 | + ) { |
|
102 | + $final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item( |
|
103 | + $transaction->total_line_item(), |
|
104 | + $ticket_line_item |
|
105 | + ); |
|
106 | + $final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes(); |
|
107 | + return (float) $final_price; |
|
108 | + } |
|
109 | 109 | |
110 | 110 | |
111 | - /** |
|
112 | - * @param EE_Registration[] $registrations |
|
113 | - * @param boolean $update_existing_registrations |
|
114 | - * @return int |
|
115 | - * @throws EE_Error |
|
116 | - */ |
|
117 | - protected function incrementRegGroupSize(array $registrations, $update_existing_registrations = true) |
|
118 | - { |
|
119 | - $new_reg_group_size = count($registrations) + 1; |
|
120 | - if ($update_existing_registrations) { |
|
121 | - foreach ($registrations as $registration) { |
|
122 | - if ($registration instanceof EE_Registration) { |
|
123 | - $registration->set_group_size($new_reg_group_size); |
|
124 | - $registration->save(); |
|
125 | - } |
|
126 | - } |
|
127 | - } |
|
128 | - return $new_reg_group_size; |
|
129 | - } |
|
111 | + /** |
|
112 | + * @param EE_Registration[] $registrations |
|
113 | + * @param boolean $update_existing_registrations |
|
114 | + * @return int |
|
115 | + * @throws EE_Error |
|
116 | + */ |
|
117 | + protected function incrementRegGroupSize(array $registrations, $update_existing_registrations = true) |
|
118 | + { |
|
119 | + $new_reg_group_size = count($registrations) + 1; |
|
120 | + if ($update_existing_registrations) { |
|
121 | + foreach ($registrations as $registration) { |
|
122 | + if ($registration instanceof EE_Registration) { |
|
123 | + $registration->set_group_size($new_reg_group_size); |
|
124 | + $registration->save(); |
|
125 | + } |
|
126 | + } |
|
127 | + } |
|
128 | + return $new_reg_group_size; |
|
129 | + } |
|
130 | 130 | } |
@@ -83,7 +83,7 @@ discard block |
||
83 | 83 | $reindexed_answers = array(); |
84 | 84 | foreach ($answers as $answer) { |
85 | 85 | if ($answer instanceof EE_Answer) { |
86 | - $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
86 | + $reindexed_answers[$answer->question_ID()] = $answer->value(); |
|
87 | 87 | } |
88 | 88 | } |
89 | 89 | return $reindexed_answers; |
@@ -103,8 +103,8 @@ discard block |
||
103 | 103 | EE_Registration $registration, |
104 | 104 | $previous_answers |
105 | 105 | ) { |
106 | - $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
107 | - ? $previous_answers[ $question->ID() ] |
|
106 | + $old_answer_value = isset($previous_answers[$question->ID()]) |
|
107 | + ? $previous_answers[$question->ID()] |
|
108 | 108 | : ''; |
109 | 109 | $new_answer = EE_Answer::new_instance( |
110 | 110 | array( |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | 'ANS_value' => $old_answer_value, |
114 | 114 | ) |
115 | 115 | ); |
116 | - if (! $new_answer instanceof EE_Answer) { |
|
116 | + if ( ! $new_answer instanceof EE_Answer) { |
|
117 | 117 | throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
118 | 118 | } |
119 | 119 | $new_answer->save(); |
@@ -150,7 +150,7 @@ discard block |
||
150 | 150 | 'RPY_amount' => $payment_amount, |
151 | 151 | ) |
152 | 152 | ); |
153 | - if (! $new_registration_payment instanceof EE_Registration_Payment) { |
|
153 | + if ( ! $new_registration_payment instanceof EE_Registration_Payment) { |
|
154 | 154 | throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
155 | 155 | } |
156 | 156 | $new_registration_payment->save(); |
@@ -27,151 +27,151 @@ |
||
27 | 27 | { |
28 | 28 | |
29 | 29 | |
30 | - /** |
|
31 | - * @param EE_Registration $target_registration |
|
32 | - * @param EE_Registration $registration_to_copy |
|
33 | - * @return bool |
|
34 | - * @throws UnexpectedEntityException |
|
35 | - * @throws EntityNotFoundException |
|
36 | - * @throws RuntimeException |
|
37 | - * @throws EE_Error |
|
38 | - */ |
|
39 | - public function copyRegistrationDetails( |
|
40 | - EE_Registration $target_registration, |
|
41 | - EE_Registration $registration_to_copy |
|
42 | - ) { |
|
43 | - // copy attendee |
|
44 | - $target_registration->set_attendee_id($registration_to_copy->attendee_ID()); |
|
45 | - $target_registration->updateStatusBasedOnTotalPaid(false); |
|
46 | - $target_registration->save(); |
|
47 | - // get answers to previous reg questions |
|
48 | - $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers()); |
|
49 | - // get questions to new event reg form |
|
50 | - $new_event = $target_registration->event(); |
|
51 | - $field_name = 'Event_Question_Group.' |
|
52 | - . EEM_Event_Question_Group::instance()->fieldNameForContext( |
|
53 | - $registration_to_copy->is_primary_registrant() |
|
54 | - ); |
|
55 | - $question_groups = $new_event->question_groups([ |
|
56 | - [ |
|
57 | - 'Event.EVT_ID' => $new_event->ID(), |
|
58 | - $field_name => true, |
|
59 | - ], |
|
60 | - 'order_by' => ['QSG_order' => 'ASC'], |
|
61 | - ]); |
|
62 | - foreach ($question_groups as $question_group) { |
|
63 | - if ($question_group instanceof \EE_Question_Group) { |
|
64 | - foreach ($question_group->questions() as $question) { |
|
65 | - if ($question instanceof EE_Question) { |
|
66 | - $this->generateNewAnswer( |
|
67 | - $question, |
|
68 | - $target_registration, |
|
69 | - $answers |
|
70 | - ); |
|
71 | - } |
|
72 | - } |
|
73 | - } |
|
74 | - } |
|
75 | - return true; |
|
76 | - } |
|
30 | + /** |
|
31 | + * @param EE_Registration $target_registration |
|
32 | + * @param EE_Registration $registration_to_copy |
|
33 | + * @return bool |
|
34 | + * @throws UnexpectedEntityException |
|
35 | + * @throws EntityNotFoundException |
|
36 | + * @throws RuntimeException |
|
37 | + * @throws EE_Error |
|
38 | + */ |
|
39 | + public function copyRegistrationDetails( |
|
40 | + EE_Registration $target_registration, |
|
41 | + EE_Registration $registration_to_copy |
|
42 | + ) { |
|
43 | + // copy attendee |
|
44 | + $target_registration->set_attendee_id($registration_to_copy->attendee_ID()); |
|
45 | + $target_registration->updateStatusBasedOnTotalPaid(false); |
|
46 | + $target_registration->save(); |
|
47 | + // get answers to previous reg questions |
|
48 | + $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers()); |
|
49 | + // get questions to new event reg form |
|
50 | + $new_event = $target_registration->event(); |
|
51 | + $field_name = 'Event_Question_Group.' |
|
52 | + . EEM_Event_Question_Group::instance()->fieldNameForContext( |
|
53 | + $registration_to_copy->is_primary_registrant() |
|
54 | + ); |
|
55 | + $question_groups = $new_event->question_groups([ |
|
56 | + [ |
|
57 | + 'Event.EVT_ID' => $new_event->ID(), |
|
58 | + $field_name => true, |
|
59 | + ], |
|
60 | + 'order_by' => ['QSG_order' => 'ASC'], |
|
61 | + ]); |
|
62 | + foreach ($question_groups as $question_group) { |
|
63 | + if ($question_group instanceof \EE_Question_Group) { |
|
64 | + foreach ($question_group->questions() as $question) { |
|
65 | + if ($question instanceof EE_Question) { |
|
66 | + $this->generateNewAnswer( |
|
67 | + $question, |
|
68 | + $target_registration, |
|
69 | + $answers |
|
70 | + ); |
|
71 | + } |
|
72 | + } |
|
73 | + } |
|
74 | + } |
|
75 | + return true; |
|
76 | + } |
|
77 | 77 | |
78 | 78 | |
79 | - /** |
|
80 | - * @param EE_Answer[] $answers |
|
81 | - * @return array |
|
82 | - * @throws EE_Error |
|
83 | - */ |
|
84 | - protected function reindexAnswersByQuestionId(array $answers) |
|
85 | - { |
|
86 | - $reindexed_answers = array(); |
|
87 | - foreach ($answers as $answer) { |
|
88 | - if ($answer instanceof EE_Answer) { |
|
89 | - $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
90 | - } |
|
91 | - } |
|
92 | - return $reindexed_answers; |
|
93 | - } |
|
79 | + /** |
|
80 | + * @param EE_Answer[] $answers |
|
81 | + * @return array |
|
82 | + * @throws EE_Error |
|
83 | + */ |
|
84 | + protected function reindexAnswersByQuestionId(array $answers) |
|
85 | + { |
|
86 | + $reindexed_answers = array(); |
|
87 | + foreach ($answers as $answer) { |
|
88 | + if ($answer instanceof EE_Answer) { |
|
89 | + $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
90 | + } |
|
91 | + } |
|
92 | + return $reindexed_answers; |
|
93 | + } |
|
94 | 94 | |
95 | 95 | |
96 | - /** |
|
97 | - * @param EE_Question $question |
|
98 | - * @param EE_Registration $registration |
|
99 | - * @param $previous_answers |
|
100 | - * @return EE_Answer |
|
101 | - * @throws UnexpectedEntityException |
|
102 | - * @throws EE_Error |
|
103 | - */ |
|
104 | - protected function generateNewAnswer( |
|
105 | - EE_Question $question, |
|
106 | - EE_Registration $registration, |
|
107 | - $previous_answers |
|
108 | - ) { |
|
109 | - $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
110 | - ? $previous_answers[ $question->ID() ] |
|
111 | - : ''; |
|
112 | - $new_answer = EE_Answer::new_instance( |
|
113 | - array( |
|
114 | - 'QST_ID' => $question->ID(), |
|
115 | - 'REG_ID' => $registration->ID(), |
|
116 | - 'ANS_value' => $old_answer_value, |
|
117 | - ) |
|
118 | - ); |
|
119 | - if (! $new_answer instanceof EE_Answer) { |
|
120 | - throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
|
121 | - } |
|
122 | - $new_answer->save(); |
|
123 | - return $new_answer; |
|
124 | - } |
|
96 | + /** |
|
97 | + * @param EE_Question $question |
|
98 | + * @param EE_Registration $registration |
|
99 | + * @param $previous_answers |
|
100 | + * @return EE_Answer |
|
101 | + * @throws UnexpectedEntityException |
|
102 | + * @throws EE_Error |
|
103 | + */ |
|
104 | + protected function generateNewAnswer( |
|
105 | + EE_Question $question, |
|
106 | + EE_Registration $registration, |
|
107 | + $previous_answers |
|
108 | + ) { |
|
109 | + $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
110 | + ? $previous_answers[ $question->ID() ] |
|
111 | + : ''; |
|
112 | + $new_answer = EE_Answer::new_instance( |
|
113 | + array( |
|
114 | + 'QST_ID' => $question->ID(), |
|
115 | + 'REG_ID' => $registration->ID(), |
|
116 | + 'ANS_value' => $old_answer_value, |
|
117 | + ) |
|
118 | + ); |
|
119 | + if (! $new_answer instanceof EE_Answer) { |
|
120 | + throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
|
121 | + } |
|
122 | + $new_answer->save(); |
|
123 | + return $new_answer; |
|
124 | + } |
|
125 | 125 | |
126 | 126 | |
127 | - /** |
|
128 | - * @param EE_Registration $target_registration |
|
129 | - * @param EE_Registration $registration_to_copy |
|
130 | - * @return bool |
|
131 | - * @throws RuntimeException |
|
132 | - * @throws UnexpectedEntityException |
|
133 | - * @throws EE_Error |
|
134 | - */ |
|
135 | - public function copyPaymentDetails( |
|
136 | - EE_Registration $target_registration, |
|
137 | - EE_Registration $registration_to_copy |
|
138 | - ) { |
|
139 | - $save = false; |
|
140 | - $previous_registration_payments = $registration_to_copy->registration_payments(); |
|
141 | - $new_registration_payment_total = 0; |
|
142 | - $registration_to_copy_total = $registration_to_copy->paid(); |
|
143 | - foreach ($previous_registration_payments as $previous_registration_payment) { |
|
144 | - if ($previous_registration_payment instanceof EE_Registration_Payment |
|
145 | - && $previous_registration_payment->payment() instanceof EE_Payment |
|
146 | - && $previous_registration_payment->payment()->is_approved() |
|
147 | - ) { |
|
148 | - $payment_amount = $previous_registration_payment->amount(); |
|
149 | - $new_registration_payment = EE_Registration_Payment::new_instance( |
|
150 | - array( |
|
151 | - 'REG_ID' => $target_registration->ID(), |
|
152 | - 'PAY_ID' => $previous_registration_payment->payment()->ID(), |
|
153 | - 'RPY_amount' => $payment_amount, |
|
154 | - ) |
|
155 | - ); |
|
156 | - if (! $new_registration_payment instanceof EE_Registration_Payment) { |
|
157 | - throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
|
158 | - } |
|
159 | - $new_registration_payment->save(); |
|
160 | - // if new reg payment is good, then set old reg payment amount to zero |
|
161 | - $previous_registration_payment->set_amount(0); |
|
162 | - $previous_registration_payment->save(); |
|
163 | - // now increment/decrement payment amounts |
|
164 | - $new_registration_payment_total += $payment_amount; |
|
165 | - $registration_to_copy_total -= $payment_amount; |
|
166 | - $save = true; |
|
167 | - } |
|
168 | - } |
|
169 | - if ($save) { |
|
170 | - $target_registration->set_paid($new_registration_payment_total); |
|
171 | - $target_registration->save(); |
|
172 | - $registration_to_copy->set_paid($registration_to_copy_total); |
|
173 | - $registration_to_copy->save(); |
|
174 | - } |
|
175 | - return true; |
|
176 | - } |
|
127 | + /** |
|
128 | + * @param EE_Registration $target_registration |
|
129 | + * @param EE_Registration $registration_to_copy |
|
130 | + * @return bool |
|
131 | + * @throws RuntimeException |
|
132 | + * @throws UnexpectedEntityException |
|
133 | + * @throws EE_Error |
|
134 | + */ |
|
135 | + public function copyPaymentDetails( |
|
136 | + EE_Registration $target_registration, |
|
137 | + EE_Registration $registration_to_copy |
|
138 | + ) { |
|
139 | + $save = false; |
|
140 | + $previous_registration_payments = $registration_to_copy->registration_payments(); |
|
141 | + $new_registration_payment_total = 0; |
|
142 | + $registration_to_copy_total = $registration_to_copy->paid(); |
|
143 | + foreach ($previous_registration_payments as $previous_registration_payment) { |
|
144 | + if ($previous_registration_payment instanceof EE_Registration_Payment |
|
145 | + && $previous_registration_payment->payment() instanceof EE_Payment |
|
146 | + && $previous_registration_payment->payment()->is_approved() |
|
147 | + ) { |
|
148 | + $payment_amount = $previous_registration_payment->amount(); |
|
149 | + $new_registration_payment = EE_Registration_Payment::new_instance( |
|
150 | + array( |
|
151 | + 'REG_ID' => $target_registration->ID(), |
|
152 | + 'PAY_ID' => $previous_registration_payment->payment()->ID(), |
|
153 | + 'RPY_amount' => $payment_amount, |
|
154 | + ) |
|
155 | + ); |
|
156 | + if (! $new_registration_payment instanceof EE_Registration_Payment) { |
|
157 | + throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
|
158 | + } |
|
159 | + $new_registration_payment->save(); |
|
160 | + // if new reg payment is good, then set old reg payment amount to zero |
|
161 | + $previous_registration_payment->set_amount(0); |
|
162 | + $previous_registration_payment->save(); |
|
163 | + // now increment/decrement payment amounts |
|
164 | + $new_registration_payment_total += $payment_amount; |
|
165 | + $registration_to_copy_total -= $payment_amount; |
|
166 | + $save = true; |
|
167 | + } |
|
168 | + } |
|
169 | + if ($save) { |
|
170 | + $target_registration->set_paid($new_registration_payment_total); |
|
171 | + $target_registration->save(); |
|
172 | + $registration_to_copy->set_paid($registration_to_copy_total); |
|
173 | + $registration_to_copy->save(); |
|
174 | + } |
|
175 | + return true; |
|
176 | + } |
|
177 | 177 | } |
@@ -174,14 +174,14 @@ discard block |
||
174 | 174 | */ |
175 | 175 | public function setActiveTickets(array $active_tickets = array()) |
176 | 176 | { |
177 | - if (! empty($active_tickets)) { |
|
177 | + if ( ! empty($active_tickets)) { |
|
178 | 178 | foreach ($active_tickets as $active_ticket) { |
179 | 179 | $this->validateTicket($active_ticket); |
180 | 180 | } |
181 | 181 | // sort incoming array by ticket quantity (asc) |
182 | 182 | usort( |
183 | 183 | $active_tickets, |
184 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
184 | + function(EE_Ticket $a, EE_Ticket $b) { |
|
185 | 185 | if ($a->qty() === $b->qty()) { |
186 | 186 | return 0; |
187 | 187 | } |
@@ -203,7 +203,7 @@ discard block |
||
203 | 203 | */ |
204 | 204 | private function validateTicket($ticket) |
205 | 205 | { |
206 | - if (! $ticket instanceof EE_Ticket) { |
|
206 | + if ( ! $ticket instanceof EE_Ticket) { |
|
207 | 207 | throw new DomainException( |
208 | 208 | esc_html__( |
209 | 209 | 'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.', |
@@ -254,7 +254,7 @@ discard block |
||
254 | 254 | ) |
255 | 255 | ); |
256 | 256 | } |
257 | - $this->datetimes[ $datetime->ID() ] = $datetime; |
|
257 | + $this->datetimes[$datetime->ID()] = $datetime; |
|
258 | 258 | } |
259 | 259 | |
260 | 260 | |
@@ -327,7 +327,7 @@ discard block |
||
327 | 327 | $this->tickets_sold = array(); |
328 | 328 | $this->total_spaces = array(); |
329 | 329 | $active_tickets = $this->getActiveTickets(); |
330 | - if (! empty($active_tickets)) { |
|
330 | + if ( ! empty($active_tickets)) { |
|
331 | 331 | foreach ($active_tickets as $ticket) { |
332 | 332 | $this->validateTicket($ticket); |
333 | 333 | // we need to index our data arrays using strings for the purpose of sorting, |
@@ -349,16 +349,16 @@ discard block |
||
349 | 349 | // we are going to move all of our data into the following arrays: |
350 | 350 | // datetime spaces initially represents the reg limit for each datetime, |
351 | 351 | // but this will get adjusted as tickets are accounted for |
352 | - $this->datetime_spaces[ $datetime_identifier ] = $reg_limit; |
|
352 | + $this->datetime_spaces[$datetime_identifier] = $reg_limit; |
|
353 | 353 | // just an array of ticket IDs grouped by datetime |
354 | - $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier; |
|
354 | + $this->datetime_tickets[$datetime_identifier][] = $ticket_identifier; |
|
355 | 355 | // and an array of datetime IDs grouped by ticket |
356 | - $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier; |
|
356 | + $this->ticket_datetimes[$ticket_identifier][] = $datetime_identifier; |
|
357 | 357 | } |
358 | 358 | // total quantity of sold and reserved for each ticket |
359 | - $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved(); |
|
359 | + $this->tickets_sold[$ticket_identifier] = $ticket->sold() + $ticket->reserved(); |
|
360 | 360 | // and the maximum ticket quantities for each ticket (adjusted for reg limit) |
361 | - $this->ticket_quantities[ $ticket_identifier ] = $max_tickets; |
|
361 | + $this->ticket_quantities[$ticket_identifier] = $max_tickets; |
|
362 | 362 | } |
363 | 363 | } |
364 | 364 | // sort datetime spaces by reg limit, but maintain our string indexes |
@@ -417,11 +417,11 @@ discard block |
||
417 | 417 | \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
418 | 418 | } |
419 | 419 | foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) { |
420 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
421 | - $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold; |
|
420 | + if (isset($this->ticket_quantities[$ticket_identifier])) { |
|
421 | + $this->ticket_quantities[$ticket_identifier] -= $tickets_sold; |
|
422 | 422 | // don't let values go below zero |
423 | - $this->ticket_quantities[ $ticket_identifier ] = max( |
|
424 | - $this->ticket_quantities[ $ticket_identifier ], |
|
423 | + $this->ticket_quantities[$ticket_identifier] = max( |
|
424 | + $this->ticket_quantities[$ticket_identifier], |
|
425 | 425 | 0 |
426 | 426 | ); |
427 | 427 | if ($this->debug) { |
@@ -433,15 +433,15 @@ discard block |
||
433 | 433 | ); |
434 | 434 | } |
435 | 435 | } |
436 | - if (isset($this->ticket_datetimes[ $ticket_identifier ]) |
|
437 | - && is_array($this->ticket_datetimes[ $ticket_identifier ]) |
|
436 | + if (isset($this->ticket_datetimes[$ticket_identifier]) |
|
437 | + && is_array($this->ticket_datetimes[$ticket_identifier]) |
|
438 | 438 | ) { |
439 | - foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) { |
|
440 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
441 | - $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold; |
|
439 | + foreach ($this->ticket_datetimes[$ticket_identifier] as $ticket_datetime) { |
|
440 | + if (isset($this->ticket_quantities[$ticket_identifier])) { |
|
441 | + $this->datetime_spaces[$ticket_datetime] -= $tickets_sold; |
|
442 | 442 | // don't let values go below zero |
443 | - $this->datetime_spaces[ $ticket_datetime ] = max( |
|
444 | - $this->datetime_spaces[ $ticket_datetime ], |
|
443 | + $this->datetime_spaces[$ticket_datetime] = max( |
|
444 | + $this->datetime_spaces[$ticket_datetime], |
|
445 | 445 | 0 |
446 | 446 | ); |
447 | 447 | if ($this->debug) { |
@@ -466,11 +466,11 @@ discard block |
||
466 | 466 | private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets) |
467 | 467 | { |
468 | 468 | // make sure a reg limit is set for the datetime |
469 | - $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ]) |
|
470 | - ? $this->datetime_spaces[ $datetime_identifier ] |
|
469 | + $reg_limit = isset($this->datetime_spaces[$datetime_identifier]) |
|
470 | + ? $this->datetime_spaces[$datetime_identifier] |
|
471 | 471 | : 0; |
472 | 472 | // and bail if it is not |
473 | - if (! $reg_limit) { |
|
473 | + if ( ! $reg_limit) { |
|
474 | 474 | if ($this->debug) { |
475 | 475 | \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__); |
476 | 476 | } |
@@ -487,7 +487,7 @@ discard block |
||
487 | 487 | } |
488 | 488 | // number of allocated spaces always starts at zero |
489 | 489 | $spaces_allocated = 0; |
490 | - $this->total_spaces[ $datetime_identifier ] = 0; |
|
490 | + $this->total_spaces[$datetime_identifier] = 0; |
|
491 | 491 | foreach ($tickets as $ticket_identifier) { |
492 | 492 | $spaces_allocated = $this->calculateAvailableSpacesForTicket( |
493 | 493 | $datetime_identifier, |
@@ -500,7 +500,7 @@ discard block |
||
500 | 500 | $spaces_allocated = max($spaces_allocated, 0); |
501 | 501 | if ($spaces_allocated) { |
502 | 502 | // track any non-zero values |
503 | - $this->total_spaces[ $datetime_identifier ] += $spaces_allocated; |
|
503 | + $this->total_spaces[$datetime_identifier] += $spaces_allocated; |
|
504 | 504 | if ($this->debug) { |
505 | 505 | \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__); |
506 | 506 | } |
@@ -511,7 +511,7 @@ discard block |
||
511 | 511 | } |
512 | 512 | if ($this->debug) { |
513 | 513 | \EEH_Debug_Tools::printr( |
514 | - $this->total_spaces[ $datetime_identifier ], |
|
514 | + $this->total_spaces[$datetime_identifier], |
|
515 | 515 | '$total_spaces', |
516 | 516 | __FILE__, |
517 | 517 | __LINE__ |
@@ -536,8 +536,8 @@ discard block |
||
536 | 536 | $spaces_allocated |
537 | 537 | ) { |
538 | 538 | // make sure ticket quantity is set |
539 | - $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ]) |
|
540 | - ? $this->ticket_quantities[ $ticket_identifier ] |
|
539 | + $ticket_quantity = isset($this->ticket_quantities[$ticket_identifier]) |
|
540 | + ? $this->ticket_quantities[$ticket_identifier] |
|
541 | 541 | : 0; |
542 | 542 | if ($this->debug) { |
543 | 543 | \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__); |
@@ -567,7 +567,7 @@ discard block |
||
567 | 567 | // or the maximum ticket quantity |
568 | 568 | $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity); |
569 | 569 | // adjust the available quantity in our tracking array |
570 | - $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity; |
|
570 | + $this->ticket_quantities[$ticket_identifier] -= $ticket_quantity; |
|
571 | 571 | // and increment spaces allocated for this datetime |
572 | 572 | $spaces_allocated += $ticket_quantity; |
573 | 573 | $at_capacity = $spaces_allocated >= $reg_limit; |
@@ -624,14 +624,14 @@ discard block |
||
624 | 624 | $ticket_quantity |
625 | 625 | ); |
626 | 626 | // skip to next ticket if nothing changed |
627 | - if (! ($adjusted || $at_capacity)) { |
|
627 | + if ( ! ($adjusted || $at_capacity)) { |
|
628 | 628 | continue; |
629 | 629 | } |
630 | 630 | // then all of it's tickets are now unavailable |
631 | 631 | foreach ($datetime_tickets as $datetime_ticket) { |
632 | 632 | if (($ticket_identifier === $datetime_ticket || $at_capacity) |
633 | - && isset($this->ticket_quantities[ $datetime_ticket ]) |
|
634 | - && $this->ticket_quantities[ $datetime_ticket ] > 0 |
|
633 | + && isset($this->ticket_quantities[$datetime_ticket]) |
|
634 | + && $this->ticket_quantities[$datetime_ticket] > 0 |
|
635 | 635 | ) { |
636 | 636 | if ($this->debug) { |
637 | 637 | \EEH_Debug_Tools::printr( |
@@ -645,14 +645,14 @@ discard block |
||
645 | 645 | // otherwise just subtract the ticket quantity |
646 | 646 | $new_quantity = $at_capacity |
647 | 647 | ? 0 |
648 | - : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity; |
|
648 | + : $this->ticket_quantities[$datetime_ticket] - $ticket_quantity; |
|
649 | 649 | // don't let ticket quantity go below zero |
650 | - $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0); |
|
650 | + $this->ticket_quantities[$datetime_ticket] = max($new_quantity, 0); |
|
651 | 651 | if ($this->debug) { |
652 | 652 | \EEH_Debug_Tools::printr( |
653 | 653 | $at_capacity |
654 | 654 | ? "0 because Datetime {$datetime_identifier} is at capacity" |
655 | - : "{$this->ticket_quantities[ $datetime_ticket ]}", |
|
655 | + : "{$this->ticket_quantities[$datetime_ticket]}", |
|
656 | 656 | " . . . . {$datetime_ticket} quantity set to ", |
657 | 657 | __FILE__, |
658 | 658 | __LINE__ |
@@ -661,8 +661,8 @@ discard block |
||
661 | 661 | } |
662 | 662 | // but we also need to adjust spaces for any other datetimes this ticket has access to |
663 | 663 | if ($datetime_ticket === $ticket_identifier) { |
664 | - if (isset($this->ticket_datetimes[ $datetime_ticket ]) |
|
665 | - && is_array($this->ticket_datetimes[ $datetime_ticket ]) |
|
664 | + if (isset($this->ticket_datetimes[$datetime_ticket]) |
|
665 | + && is_array($this->ticket_datetimes[$datetime_ticket]) |
|
666 | 666 | ) { |
667 | 667 | if ($this->debug) { |
668 | 668 | \EEH_Debug_Tools::printr( |
@@ -672,7 +672,7 @@ discard block |
||
672 | 672 | __LINE__ |
673 | 673 | ); |
674 | 674 | } |
675 | - foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) { |
|
675 | + foreach ($this->ticket_datetimes[$datetime_ticket] as $datetime) { |
|
676 | 676 | // don't adjust the current datetime twice |
677 | 677 | if ($datetime !== $datetime_identifier) { |
678 | 678 | $this->adjustDatetimeSpaces( |
@@ -692,24 +692,24 @@ discard block |
||
692 | 692 | { |
693 | 693 | // does datetime have spaces available? |
694 | 694 | // and does the supplied ticket have access to this datetime ? |
695 | - if ($this->datetime_spaces[ $datetime_identifier ] > 0 |
|
696 | - && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ]) |
|
697 | - && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true) |
|
695 | + if ($this->datetime_spaces[$datetime_identifier] > 0 |
|
696 | + && isset($this->datetime_spaces[$datetime_identifier], $this->datetime_tickets[$datetime_identifier]) |
|
697 | + && in_array($ticket_identifier, $this->datetime_tickets[$datetime_identifier], true) |
|
698 | 698 | ) { |
699 | 699 | if ($this->debug) { |
700 | 700 | \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__); |
701 | 701 | \EEH_Debug_Tools::printr( |
702 | - "{$this->datetime_spaces[ $datetime_identifier ]}", |
|
702 | + "{$this->datetime_spaces[$datetime_identifier]}", |
|
703 | 703 | " . . current {$datetime_identifier} spaces available", |
704 | 704 | __FILE__, |
705 | 705 | __LINE__ |
706 | 706 | ); |
707 | 707 | } |
708 | 708 | // then decrement the available spaces for the datetime |
709 | - $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity; |
|
709 | + $this->datetime_spaces[$datetime_identifier] -= $ticket_quantity; |
|
710 | 710 | // but don't let quantities go below zero |
711 | - $this->datetime_spaces[ $datetime_identifier ] = max( |
|
712 | - $this->datetime_spaces[ $datetime_identifier ], |
|
711 | + $this->datetime_spaces[$datetime_identifier] = max( |
|
712 | + $this->datetime_spaces[$datetime_identifier], |
|
713 | 713 | 0 |
714 | 714 | ); |
715 | 715 | if ($this->debug) { |
@@ -26,715 +26,715 @@ |
||
26 | 26 | class EventSpacesCalculator |
27 | 27 | { |
28 | 28 | |
29 | - /** |
|
30 | - * @var EE_Event $event |
|
31 | - */ |
|
32 | - private $event; |
|
33 | - |
|
34 | - /** |
|
35 | - * @var array $datetime_query_params |
|
36 | - */ |
|
37 | - private $datetime_query_params; |
|
38 | - |
|
39 | - /** |
|
40 | - * @var EE_Ticket[] $active_tickets |
|
41 | - */ |
|
42 | - private $active_tickets = array(); |
|
43 | - |
|
44 | - /** |
|
45 | - * @var EE_Datetime[] $datetimes |
|
46 | - */ |
|
47 | - private $datetimes = array(); |
|
48 | - |
|
49 | - /** |
|
50 | - * Array of Ticket IDs grouped by Datetime |
|
51 | - * |
|
52 | - * @var array $datetimes |
|
53 | - */ |
|
54 | - private $datetime_tickets = array(); |
|
55 | - |
|
56 | - /** |
|
57 | - * Max spaces for each Datetime (reg limit - previous sold) |
|
58 | - * |
|
59 | - * @var array $datetime_spaces |
|
60 | - */ |
|
61 | - private $datetime_spaces = array(); |
|
62 | - |
|
63 | - /** |
|
64 | - * Array of Datetime IDs grouped by Ticket |
|
65 | - * |
|
66 | - * @var array[] $ticket_datetimes |
|
67 | - */ |
|
68 | - private $ticket_datetimes = array(); |
|
69 | - |
|
70 | - /** |
|
71 | - * maximum ticket quantities for each ticket (adjusted for reg limit) |
|
72 | - * |
|
73 | - * @var array $ticket_quantities |
|
74 | - */ |
|
75 | - private $ticket_quantities = array(); |
|
76 | - |
|
77 | - /** |
|
78 | - * total quantity of sold and reserved for each ticket |
|
79 | - * |
|
80 | - * @var array $tickets_sold |
|
81 | - */ |
|
82 | - private $tickets_sold = array(); |
|
83 | - |
|
84 | - /** |
|
85 | - * total spaces available across all datetimes |
|
86 | - * |
|
87 | - * @var array $total_spaces |
|
88 | - */ |
|
89 | - private $total_spaces = array(); |
|
90 | - |
|
91 | - /** |
|
92 | - * @var boolean $debug |
|
93 | - */ |
|
94 | - private $debug = false; // true false |
|
95 | - |
|
96 | - /** |
|
97 | - * @var null|int $spaces_remaining |
|
98 | - */ |
|
99 | - private $spaces_remaining; |
|
100 | - |
|
101 | - /** |
|
102 | - * @var null|int $total_spaces_available |
|
103 | - */ |
|
104 | - private $total_spaces_available; |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * EventSpacesCalculator constructor. |
|
109 | - * |
|
110 | - * @param EE_Event $event |
|
111 | - * @param array $datetime_query_params |
|
112 | - * @throws EE_Error |
|
113 | - */ |
|
114 | - public function __construct(EE_Event $event, array $datetime_query_params = array()) |
|
115 | - { |
|
116 | - if ($this->debug) { |
|
117 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
118 | - \EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__); |
|
119 | - } |
|
120 | - $this->event = $event; |
|
121 | - $this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC')); |
|
122 | - $this->setHooks(); |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @return void |
|
128 | - */ |
|
129 | - private function setHooks() |
|
130 | - { |
|
131 | - add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults')); |
|
132 | - add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults')); |
|
133 | - add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults')); |
|
134 | - add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults')); |
|
135 | - add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults')); |
|
136 | - add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults')); |
|
137 | - add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults')); |
|
138 | - add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults')); |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * @return void |
|
144 | - */ |
|
145 | - public function clearResults() |
|
146 | - { |
|
147 | - if ($this->debug) { |
|
148 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
149 | - } |
|
150 | - $this->spaces_remaining = null; |
|
151 | - $this->total_spaces_available = null; |
|
152 | - } |
|
153 | - |
|
154 | - |
|
155 | - /** |
|
156 | - * @return EE_Ticket[] |
|
157 | - * @throws EE_Error |
|
158 | - * @throws InvalidDataTypeException |
|
159 | - * @throws InvalidInterfaceException |
|
160 | - * @throws InvalidArgumentException |
|
161 | - */ |
|
162 | - public function getActiveTickets() |
|
163 | - { |
|
164 | - if (empty($this->active_tickets)) { |
|
165 | - $this->active_tickets = $this->event->tickets( |
|
166 | - array( |
|
167 | - array('TKT_deleted' => false), |
|
168 | - 'order_by' => array('TKT_qty' => 'ASC'), |
|
169 | - ) |
|
170 | - ); |
|
171 | - } |
|
172 | - return $this->active_tickets; |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - /** |
|
177 | - * @param EE_Ticket[] $active_tickets |
|
178 | - * @throws EE_Error |
|
179 | - * @throws DomainException |
|
180 | - * @throws UnexpectedEntityException |
|
181 | - */ |
|
182 | - public function setActiveTickets(array $active_tickets = array()) |
|
183 | - { |
|
184 | - if (! empty($active_tickets)) { |
|
185 | - foreach ($active_tickets as $active_ticket) { |
|
186 | - $this->validateTicket($active_ticket); |
|
187 | - } |
|
188 | - // sort incoming array by ticket quantity (asc) |
|
189 | - usort( |
|
190 | - $active_tickets, |
|
191 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
192 | - if ($a->qty() === $b->qty()) { |
|
193 | - return 0; |
|
194 | - } |
|
195 | - return ($a->qty() < $b->qty()) |
|
196 | - ? -1 |
|
197 | - : 1; |
|
198 | - } |
|
199 | - ); |
|
200 | - } |
|
201 | - $this->active_tickets = $active_tickets; |
|
202 | - } |
|
203 | - |
|
204 | - |
|
205 | - /** |
|
206 | - * @param $ticket |
|
207 | - * @throws DomainException |
|
208 | - * @throws EE_Error |
|
209 | - * @throws UnexpectedEntityException |
|
210 | - */ |
|
211 | - private function validateTicket($ticket) |
|
212 | - { |
|
213 | - if (! $ticket instanceof EE_Ticket) { |
|
214 | - throw new DomainException( |
|
215 | - esc_html__( |
|
216 | - 'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.', |
|
217 | - 'event_espresso' |
|
218 | - ) |
|
219 | - ); |
|
220 | - } |
|
221 | - if ($ticket->get_event_ID() !== $this->event->ID()) { |
|
222 | - throw new DomainException( |
|
223 | - sprintf( |
|
224 | - esc_html__( |
|
225 | - 'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
226 | - 'event_espresso' |
|
227 | - ), |
|
228 | - $ticket->get_event_ID(), |
|
229 | - $this->event->ID() |
|
230 | - ) |
|
231 | - ); |
|
232 | - } |
|
233 | - } |
|
234 | - |
|
235 | - |
|
236 | - /** |
|
237 | - * @return EE_Datetime[] |
|
238 | - */ |
|
239 | - public function getDatetimes() |
|
240 | - { |
|
241 | - return $this->datetimes; |
|
242 | - } |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * @param EE_Datetime $datetime |
|
247 | - * @throws EE_Error |
|
248 | - * @throws DomainException |
|
249 | - */ |
|
250 | - public function setDatetime(EE_Datetime $datetime) |
|
251 | - { |
|
252 | - if ($datetime->event()->ID() !== $this->event->ID()) { |
|
253 | - throw new DomainException( |
|
254 | - sprintf( |
|
255 | - esc_html__( |
|
256 | - 'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
257 | - 'event_espresso' |
|
258 | - ), |
|
259 | - $datetime->event()->ID(), |
|
260 | - $this->event->ID() |
|
261 | - ) |
|
262 | - ); |
|
263 | - } |
|
264 | - $this->datetimes[ $datetime->ID() ] = $datetime; |
|
265 | - } |
|
266 | - |
|
267 | - |
|
268 | - /** |
|
269 | - * calculate spaces remaining based on "saleable" tickets |
|
270 | - * |
|
271 | - * @return float|int |
|
272 | - * @throws EE_Error |
|
273 | - * @throws DomainException |
|
274 | - * @throws UnexpectedEntityException |
|
275 | - * @throws InvalidDataTypeException |
|
276 | - * @throws InvalidInterfaceException |
|
277 | - * @throws InvalidArgumentException |
|
278 | - */ |
|
279 | - public function spacesRemaining() |
|
280 | - { |
|
281 | - if ($this->debug) { |
|
282 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
283 | - } |
|
284 | - if ($this->spaces_remaining === null) { |
|
285 | - $this->initialize(); |
|
286 | - $this->spaces_remaining = $this->calculate(); |
|
287 | - } |
|
288 | - return $this->spaces_remaining; |
|
289 | - } |
|
290 | - |
|
291 | - |
|
292 | - /** |
|
293 | - * calculates total available spaces for an event with no regard for sold tickets |
|
294 | - * |
|
295 | - * @return int|float |
|
296 | - * @throws EE_Error |
|
297 | - * @throws DomainException |
|
298 | - * @throws UnexpectedEntityException |
|
299 | - * @throws InvalidDataTypeException |
|
300 | - * @throws InvalidInterfaceException |
|
301 | - * @throws InvalidArgumentException |
|
302 | - */ |
|
303 | - public function totalSpacesAvailable() |
|
304 | - { |
|
305 | - if ($this->debug) { |
|
306 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
307 | - } |
|
308 | - if ($this->total_spaces_available === null) { |
|
309 | - $this->initialize(); |
|
310 | - $this->total_spaces_available = $this->calculate(false); |
|
311 | - } |
|
312 | - return $this->total_spaces_available; |
|
313 | - } |
|
314 | - |
|
315 | - |
|
316 | - /** |
|
317 | - * Loops through the active tickets for the event |
|
318 | - * and builds a series of data arrays that will be used for calculating |
|
319 | - * the total maximum available spaces, as well as the spaces remaining. |
|
320 | - * Because ticket quantities affect datetime spaces and vice versa, |
|
321 | - * we need to be constantly updating these data arrays as things change, |
|
322 | - * which is the entire reason for their existence. |
|
323 | - * |
|
324 | - * @throws EE_Error |
|
325 | - * @throws DomainException |
|
326 | - * @throws UnexpectedEntityException |
|
327 | - * @throws InvalidDataTypeException |
|
328 | - * @throws InvalidInterfaceException |
|
329 | - * @throws InvalidArgumentException |
|
330 | - */ |
|
331 | - private function initialize() |
|
332 | - { |
|
333 | - if ($this->debug) { |
|
334 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
335 | - } |
|
336 | - $this->datetime_tickets = array(); |
|
337 | - $this->datetime_spaces = array(); |
|
338 | - $this->ticket_datetimes = array(); |
|
339 | - $this->ticket_quantities = array(); |
|
340 | - $this->tickets_sold = array(); |
|
341 | - $this->total_spaces = array(); |
|
342 | - $active_tickets = $this->getActiveTickets(); |
|
343 | - if (! empty($active_tickets)) { |
|
344 | - foreach ($active_tickets as $ticket) { |
|
345 | - $this->validateTicket($ticket); |
|
346 | - // we need to index our data arrays using strings for the purpose of sorting, |
|
347 | - // but we also need them to be unique, so we'll just prepend a letter T to the ID |
|
348 | - $ticket_identifier = "T{$ticket->ID()}"; |
|
349 | - // to start, we'll just consider the raw qty to be the maximum availability for this ticket, |
|
350 | - // unless the ticket is past its "sell until" date, in which case the qty will be 0 |
|
351 | - $max_tickets = $ticket->is_expired() ? 0 : $ticket->qty(); |
|
352 | - // but we'll adjust that after looping over each datetime for the ticket and checking reg limits |
|
353 | - $ticket_datetimes = $ticket->datetimes($this->datetime_query_params); |
|
354 | - foreach ($ticket_datetimes as $datetime) { |
|
355 | - // save all datetimes |
|
356 | - $this->setDatetime($datetime); |
|
357 | - $datetime_identifier = "D{$datetime->ID()}"; |
|
358 | - $reg_limit = $datetime->reg_limit(); |
|
359 | - // ticket quantity can not exceed datetime reg limit |
|
360 | - $max_tickets = min($max_tickets, $reg_limit); |
|
361 | - // as described earlier, because we need to be able to constantly adjust numbers for things, |
|
362 | - // we are going to move all of our data into the following arrays: |
|
363 | - // datetime spaces initially represents the reg limit for each datetime, |
|
364 | - // but this will get adjusted as tickets are accounted for |
|
365 | - $this->datetime_spaces[ $datetime_identifier ] = $reg_limit; |
|
366 | - // just an array of ticket IDs grouped by datetime |
|
367 | - $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier; |
|
368 | - // and an array of datetime IDs grouped by ticket |
|
369 | - $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier; |
|
370 | - } |
|
371 | - // total quantity of sold and reserved for each ticket |
|
372 | - $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved(); |
|
373 | - // and the maximum ticket quantities for each ticket (adjusted for reg limit) |
|
374 | - $this->ticket_quantities[ $ticket_identifier ] = $max_tickets; |
|
375 | - } |
|
376 | - } |
|
377 | - // sort datetime spaces by reg limit, but maintain our string indexes |
|
378 | - asort($this->datetime_spaces, SORT_NUMERIC); |
|
379 | - // datetime tickets need to be sorted in the SAME order as the above array... |
|
380 | - // so we'll just use array_merge() to take the structure of datetime_spaces |
|
381 | - // but overwrite all of the data with that from datetime_tickets |
|
382 | - $this->datetime_tickets = array_merge( |
|
383 | - $this->datetime_spaces, |
|
384 | - $this->datetime_tickets |
|
385 | - ); |
|
386 | - if ($this->debug) { |
|
387 | - \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
388 | - \EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__); |
|
389 | - \EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__); |
|
390 | - } |
|
391 | - } |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * performs calculations on initialized data |
|
396 | - * |
|
397 | - * @param bool $consider_sold |
|
398 | - * @return int|float |
|
399 | - */ |
|
400 | - private function calculate($consider_sold = true) |
|
401 | - { |
|
402 | - if ($this->debug) { |
|
403 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
404 | - \EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__); |
|
405 | - } |
|
406 | - if ($consider_sold) { |
|
407 | - // subtract amounts sold from all ticket quantities and datetime spaces |
|
408 | - $this->adjustTicketQuantitiesDueToSales(); |
|
409 | - } |
|
410 | - foreach ($this->datetime_tickets as $datetime_identifier => $tickets) { |
|
411 | - $this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets); |
|
412 | - } |
|
413 | - // total spaces available is just the sum of the spaces available for each datetime |
|
414 | - $spaces_remaining = array_sum($this->total_spaces); |
|
415 | - if ($this->debug) { |
|
416 | - \EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__); |
|
417 | - \EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__); |
|
418 | - \EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__); |
|
419 | - } |
|
420 | - return $spaces_remaining; |
|
421 | - } |
|
422 | - |
|
423 | - |
|
424 | - /** |
|
425 | - * subtracts amount of tickets sold from ticket quantities and datetime spaces |
|
426 | - */ |
|
427 | - private function adjustTicketQuantitiesDueToSales() |
|
428 | - { |
|
429 | - if ($this->debug) { |
|
430 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
431 | - } |
|
432 | - foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) { |
|
433 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
434 | - $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold; |
|
435 | - // don't let values go below zero |
|
436 | - $this->ticket_quantities[ $ticket_identifier ] = max( |
|
437 | - $this->ticket_quantities[ $ticket_identifier ], |
|
438 | - 0 |
|
439 | - ); |
|
440 | - if ($this->debug) { |
|
441 | - \EEH_Debug_Tools::printr( |
|
442 | - "{$tickets_sold} sales for ticket {$ticket_identifier} ", |
|
443 | - 'subtracting', |
|
444 | - __FILE__, |
|
445 | - __LINE__ |
|
446 | - ); |
|
447 | - } |
|
448 | - } |
|
449 | - if (isset($this->ticket_datetimes[ $ticket_identifier ]) |
|
450 | - && is_array($this->ticket_datetimes[ $ticket_identifier ]) |
|
451 | - ) { |
|
452 | - foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) { |
|
453 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
454 | - $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold; |
|
455 | - // don't let values go below zero |
|
456 | - $this->datetime_spaces[ $ticket_datetime ] = max( |
|
457 | - $this->datetime_spaces[ $ticket_datetime ], |
|
458 | - 0 |
|
459 | - ); |
|
460 | - if ($this->debug) { |
|
461 | - \EEH_Debug_Tools::printr( |
|
462 | - "{$tickets_sold} sales for datetime {$ticket_datetime} ", |
|
463 | - 'subtracting', |
|
464 | - __FILE__, |
|
465 | - __LINE__ |
|
466 | - ); |
|
467 | - } |
|
468 | - } |
|
469 | - } |
|
470 | - } |
|
471 | - } |
|
472 | - } |
|
473 | - |
|
474 | - |
|
475 | - /** |
|
476 | - * @param string $datetime_identifier |
|
477 | - * @param array $tickets |
|
478 | - */ |
|
479 | - private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets) |
|
480 | - { |
|
481 | - // make sure a reg limit is set for the datetime |
|
482 | - $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ]) |
|
483 | - ? $this->datetime_spaces[ $datetime_identifier ] |
|
484 | - : 0; |
|
485 | - // and bail if it is not |
|
486 | - if (! $reg_limit) { |
|
487 | - if ($this->debug) { |
|
488 | - \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__); |
|
489 | - } |
|
490 | - return; |
|
491 | - } |
|
492 | - if ($this->debug) { |
|
493 | - \EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1); |
|
494 | - \EEH_Debug_Tools::printr( |
|
495 | - "{$reg_limit}", |
|
496 | - 'REG LIMIT', |
|
497 | - __FILE__, |
|
498 | - __LINE__ |
|
499 | - ); |
|
500 | - } |
|
501 | - // number of allocated spaces always starts at zero |
|
502 | - $spaces_allocated = 0; |
|
503 | - $this->total_spaces[ $datetime_identifier ] = 0; |
|
504 | - foreach ($tickets as $ticket_identifier) { |
|
505 | - $spaces_allocated = $this->calculateAvailableSpacesForTicket( |
|
506 | - $datetime_identifier, |
|
507 | - $reg_limit, |
|
508 | - $ticket_identifier, |
|
509 | - $spaces_allocated |
|
510 | - ); |
|
511 | - } |
|
512 | - // spaces can't be negative |
|
513 | - $spaces_allocated = max($spaces_allocated, 0); |
|
514 | - if ($spaces_allocated) { |
|
515 | - // track any non-zero values |
|
516 | - $this->total_spaces[ $datetime_identifier ] += $spaces_allocated; |
|
517 | - if ($this->debug) { |
|
518 | - \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__); |
|
519 | - } |
|
520 | - } else { |
|
521 | - if ($this->debug) { |
|
522 | - \EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__); |
|
523 | - } |
|
524 | - } |
|
525 | - if ($this->debug) { |
|
526 | - \EEH_Debug_Tools::printr( |
|
527 | - $this->total_spaces[ $datetime_identifier ], |
|
528 | - '$total_spaces', |
|
529 | - __FILE__, |
|
530 | - __LINE__ |
|
531 | - ); |
|
532 | - \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__); |
|
533 | - \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
534 | - } |
|
535 | - } |
|
536 | - |
|
537 | - |
|
538 | - /** |
|
539 | - * @param string $datetime_identifier |
|
540 | - * @param int $reg_limit |
|
541 | - * @param string $ticket_identifier |
|
542 | - * @param int $spaces_allocated |
|
543 | - * @return int |
|
544 | - */ |
|
545 | - private function calculateAvailableSpacesForTicket( |
|
546 | - $datetime_identifier, |
|
547 | - $reg_limit, |
|
548 | - $ticket_identifier, |
|
549 | - $spaces_allocated |
|
550 | - ) { |
|
551 | - // make sure ticket quantity is set |
|
552 | - $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ]) |
|
553 | - ? $this->ticket_quantities[ $ticket_identifier ] |
|
554 | - : 0; |
|
555 | - if ($this->debug) { |
|
556 | - \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__); |
|
557 | - \EEH_Debug_Tools::printr( |
|
558 | - "{$ticket_quantity}", |
|
559 | - "ticket $ticket_identifier quantity: ", |
|
560 | - __FILE__, |
|
561 | - __LINE__, |
|
562 | - 2 |
|
563 | - ); |
|
564 | - } |
|
565 | - if ($ticket_quantity) { |
|
566 | - if ($this->debug) { |
|
567 | - \EEH_Debug_Tools::printr( |
|
568 | - ($spaces_allocated <= $reg_limit) |
|
569 | - ? 'true' |
|
570 | - : 'false', |
|
571 | - ' . spaces_allocated <= reg_limit = ', |
|
572 | - __FILE__, |
|
573 | - __LINE__ |
|
574 | - ); |
|
575 | - } |
|
576 | - // if the datetime is NOT at full capacity yet |
|
577 | - if ($spaces_allocated <= $reg_limit) { |
|
578 | - // then the maximum ticket quantity we can allocate is the lowest value of either: |
|
579 | - // the number of remaining spaces for the datetime, which is the limit - spaces already taken |
|
580 | - // or the maximum ticket quantity |
|
581 | - $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity); |
|
582 | - // adjust the available quantity in our tracking array |
|
583 | - $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity; |
|
584 | - // and increment spaces allocated for this datetime |
|
585 | - $spaces_allocated += $ticket_quantity; |
|
586 | - $at_capacity = $spaces_allocated >= $reg_limit; |
|
587 | - if ($this->debug) { |
|
588 | - \EEH_Debug_Tools::printr( |
|
589 | - "{$ticket_quantity} {$ticket_identifier} tickets", |
|
590 | - ' > > allocate ', |
|
591 | - __FILE__, |
|
592 | - __LINE__, |
|
593 | - 3 |
|
594 | - ); |
|
595 | - if ($at_capacity) { |
|
596 | - \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3); |
|
597 | - } |
|
598 | - } |
|
599 | - // now adjust all other datetimes that allow access to this ticket |
|
600 | - $this->adjustDatetimes( |
|
601 | - $datetime_identifier, |
|
602 | - $ticket_identifier, |
|
603 | - $ticket_quantity, |
|
604 | - $at_capacity |
|
605 | - ); |
|
606 | - } |
|
607 | - } |
|
608 | - return $spaces_allocated; |
|
609 | - } |
|
610 | - |
|
611 | - |
|
612 | - /** |
|
613 | - * subtracts ticket amounts from all datetime reg limits |
|
614 | - * that allow access to the ticket specified, |
|
615 | - * because that ticket could be used |
|
616 | - * to attend any of the datetimes it has access to |
|
617 | - * |
|
618 | - * @param string $datetime_identifier |
|
619 | - * @param string $ticket_identifier |
|
620 | - * @param bool $at_capacity |
|
621 | - * @param int $ticket_quantity |
|
622 | - */ |
|
623 | - private function adjustDatetimes( |
|
624 | - $datetime_identifier, |
|
625 | - $ticket_identifier, |
|
626 | - $ticket_quantity, |
|
627 | - $at_capacity |
|
628 | - ) { |
|
629 | - /** @var array $datetime_tickets */ |
|
630 | - foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) { |
|
631 | - if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) { |
|
632 | - continue; |
|
633 | - } |
|
634 | - $adjusted = $this->adjustDatetimeSpaces( |
|
635 | - $datetime_ID, |
|
636 | - $ticket_identifier, |
|
637 | - $ticket_quantity |
|
638 | - ); |
|
639 | - // skip to next ticket if nothing changed |
|
640 | - if (! ($adjusted || $at_capacity)) { |
|
641 | - continue; |
|
642 | - } |
|
643 | - // then all of it's tickets are now unavailable |
|
644 | - foreach ($datetime_tickets as $datetime_ticket) { |
|
645 | - if (($ticket_identifier === $datetime_ticket || $at_capacity) |
|
646 | - && isset($this->ticket_quantities[ $datetime_ticket ]) |
|
647 | - && $this->ticket_quantities[ $datetime_ticket ] > 0 |
|
648 | - ) { |
|
649 | - if ($this->debug) { |
|
650 | - \EEH_Debug_Tools::printr( |
|
651 | - $datetime_ticket, |
|
652 | - ' . . . adjust ticket quantities for', |
|
653 | - __FILE__, |
|
654 | - __LINE__ |
|
655 | - ); |
|
656 | - } |
|
657 | - // if this datetime is at full capacity, set any tracked available quantities to zero |
|
658 | - // otherwise just subtract the ticket quantity |
|
659 | - $new_quantity = $at_capacity |
|
660 | - ? 0 |
|
661 | - : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity; |
|
662 | - // don't let ticket quantity go below zero |
|
663 | - $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0); |
|
664 | - if ($this->debug) { |
|
665 | - \EEH_Debug_Tools::printr( |
|
666 | - $at_capacity |
|
667 | - ? "0 because Datetime {$datetime_identifier} is at capacity" |
|
668 | - : "{$this->ticket_quantities[ $datetime_ticket ]}", |
|
669 | - " . . . . {$datetime_ticket} quantity set to ", |
|
670 | - __FILE__, |
|
671 | - __LINE__ |
|
672 | - ); |
|
673 | - } |
|
674 | - } |
|
675 | - // but we also need to adjust spaces for any other datetimes this ticket has access to |
|
676 | - if ($datetime_ticket === $ticket_identifier) { |
|
677 | - if (isset($this->ticket_datetimes[ $datetime_ticket ]) |
|
678 | - && is_array($this->ticket_datetimes[ $datetime_ticket ]) |
|
679 | - ) { |
|
680 | - if ($this->debug) { |
|
681 | - \EEH_Debug_Tools::printr( |
|
682 | - $datetime_ticket, |
|
683 | - ' . . adjust other Datetimes for', |
|
684 | - __FILE__, |
|
685 | - __LINE__ |
|
686 | - ); |
|
687 | - } |
|
688 | - foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) { |
|
689 | - // don't adjust the current datetime twice |
|
690 | - if ($datetime !== $datetime_identifier) { |
|
691 | - $this->adjustDatetimeSpaces( |
|
692 | - $datetime, |
|
693 | - $datetime_ticket, |
|
694 | - $ticket_quantity |
|
695 | - ); |
|
696 | - } |
|
697 | - } |
|
698 | - } |
|
699 | - } |
|
700 | - } |
|
701 | - } |
|
702 | - } |
|
703 | - |
|
704 | - private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0) |
|
705 | - { |
|
706 | - // does datetime have spaces available? |
|
707 | - // and does the supplied ticket have access to this datetime ? |
|
708 | - if ($this->datetime_spaces[ $datetime_identifier ] > 0 |
|
709 | - && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ]) |
|
710 | - && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true) |
|
711 | - ) { |
|
712 | - if ($this->debug) { |
|
713 | - \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__); |
|
714 | - \EEH_Debug_Tools::printr( |
|
715 | - "{$this->datetime_spaces[ $datetime_identifier ]}", |
|
716 | - " . . current {$datetime_identifier} spaces available", |
|
717 | - __FILE__, |
|
718 | - __LINE__ |
|
719 | - ); |
|
720 | - } |
|
721 | - // then decrement the available spaces for the datetime |
|
722 | - $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity; |
|
723 | - // but don't let quantities go below zero |
|
724 | - $this->datetime_spaces[ $datetime_identifier ] = max( |
|
725 | - $this->datetime_spaces[ $datetime_identifier ], |
|
726 | - 0 |
|
727 | - ); |
|
728 | - if ($this->debug) { |
|
729 | - \EEH_Debug_Tools::printr( |
|
730 | - "{$ticket_quantity}", |
|
731 | - " . . . {$datetime_identifier} capacity reduced by", |
|
732 | - __FILE__, |
|
733 | - __LINE__ |
|
734 | - ); |
|
735 | - } |
|
736 | - return true; |
|
737 | - } |
|
738 | - return false; |
|
739 | - } |
|
29 | + /** |
|
30 | + * @var EE_Event $event |
|
31 | + */ |
|
32 | + private $event; |
|
33 | + |
|
34 | + /** |
|
35 | + * @var array $datetime_query_params |
|
36 | + */ |
|
37 | + private $datetime_query_params; |
|
38 | + |
|
39 | + /** |
|
40 | + * @var EE_Ticket[] $active_tickets |
|
41 | + */ |
|
42 | + private $active_tickets = array(); |
|
43 | + |
|
44 | + /** |
|
45 | + * @var EE_Datetime[] $datetimes |
|
46 | + */ |
|
47 | + private $datetimes = array(); |
|
48 | + |
|
49 | + /** |
|
50 | + * Array of Ticket IDs grouped by Datetime |
|
51 | + * |
|
52 | + * @var array $datetimes |
|
53 | + */ |
|
54 | + private $datetime_tickets = array(); |
|
55 | + |
|
56 | + /** |
|
57 | + * Max spaces for each Datetime (reg limit - previous sold) |
|
58 | + * |
|
59 | + * @var array $datetime_spaces |
|
60 | + */ |
|
61 | + private $datetime_spaces = array(); |
|
62 | + |
|
63 | + /** |
|
64 | + * Array of Datetime IDs grouped by Ticket |
|
65 | + * |
|
66 | + * @var array[] $ticket_datetimes |
|
67 | + */ |
|
68 | + private $ticket_datetimes = array(); |
|
69 | + |
|
70 | + /** |
|
71 | + * maximum ticket quantities for each ticket (adjusted for reg limit) |
|
72 | + * |
|
73 | + * @var array $ticket_quantities |
|
74 | + */ |
|
75 | + private $ticket_quantities = array(); |
|
76 | + |
|
77 | + /** |
|
78 | + * total quantity of sold and reserved for each ticket |
|
79 | + * |
|
80 | + * @var array $tickets_sold |
|
81 | + */ |
|
82 | + private $tickets_sold = array(); |
|
83 | + |
|
84 | + /** |
|
85 | + * total spaces available across all datetimes |
|
86 | + * |
|
87 | + * @var array $total_spaces |
|
88 | + */ |
|
89 | + private $total_spaces = array(); |
|
90 | + |
|
91 | + /** |
|
92 | + * @var boolean $debug |
|
93 | + */ |
|
94 | + private $debug = false; // true false |
|
95 | + |
|
96 | + /** |
|
97 | + * @var null|int $spaces_remaining |
|
98 | + */ |
|
99 | + private $spaces_remaining; |
|
100 | + |
|
101 | + /** |
|
102 | + * @var null|int $total_spaces_available |
|
103 | + */ |
|
104 | + private $total_spaces_available; |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * EventSpacesCalculator constructor. |
|
109 | + * |
|
110 | + * @param EE_Event $event |
|
111 | + * @param array $datetime_query_params |
|
112 | + * @throws EE_Error |
|
113 | + */ |
|
114 | + public function __construct(EE_Event $event, array $datetime_query_params = array()) |
|
115 | + { |
|
116 | + if ($this->debug) { |
|
117 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
118 | + \EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__); |
|
119 | + } |
|
120 | + $this->event = $event; |
|
121 | + $this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC')); |
|
122 | + $this->setHooks(); |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @return void |
|
128 | + */ |
|
129 | + private function setHooks() |
|
130 | + { |
|
131 | + add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults')); |
|
132 | + add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults')); |
|
133 | + add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults')); |
|
134 | + add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults')); |
|
135 | + add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults')); |
|
136 | + add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults')); |
|
137 | + add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults')); |
|
138 | + add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults')); |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * @return void |
|
144 | + */ |
|
145 | + public function clearResults() |
|
146 | + { |
|
147 | + if ($this->debug) { |
|
148 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
149 | + } |
|
150 | + $this->spaces_remaining = null; |
|
151 | + $this->total_spaces_available = null; |
|
152 | + } |
|
153 | + |
|
154 | + |
|
155 | + /** |
|
156 | + * @return EE_Ticket[] |
|
157 | + * @throws EE_Error |
|
158 | + * @throws InvalidDataTypeException |
|
159 | + * @throws InvalidInterfaceException |
|
160 | + * @throws InvalidArgumentException |
|
161 | + */ |
|
162 | + public function getActiveTickets() |
|
163 | + { |
|
164 | + if (empty($this->active_tickets)) { |
|
165 | + $this->active_tickets = $this->event->tickets( |
|
166 | + array( |
|
167 | + array('TKT_deleted' => false), |
|
168 | + 'order_by' => array('TKT_qty' => 'ASC'), |
|
169 | + ) |
|
170 | + ); |
|
171 | + } |
|
172 | + return $this->active_tickets; |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + /** |
|
177 | + * @param EE_Ticket[] $active_tickets |
|
178 | + * @throws EE_Error |
|
179 | + * @throws DomainException |
|
180 | + * @throws UnexpectedEntityException |
|
181 | + */ |
|
182 | + public function setActiveTickets(array $active_tickets = array()) |
|
183 | + { |
|
184 | + if (! empty($active_tickets)) { |
|
185 | + foreach ($active_tickets as $active_ticket) { |
|
186 | + $this->validateTicket($active_ticket); |
|
187 | + } |
|
188 | + // sort incoming array by ticket quantity (asc) |
|
189 | + usort( |
|
190 | + $active_tickets, |
|
191 | + function (EE_Ticket $a, EE_Ticket $b) { |
|
192 | + if ($a->qty() === $b->qty()) { |
|
193 | + return 0; |
|
194 | + } |
|
195 | + return ($a->qty() < $b->qty()) |
|
196 | + ? -1 |
|
197 | + : 1; |
|
198 | + } |
|
199 | + ); |
|
200 | + } |
|
201 | + $this->active_tickets = $active_tickets; |
|
202 | + } |
|
203 | + |
|
204 | + |
|
205 | + /** |
|
206 | + * @param $ticket |
|
207 | + * @throws DomainException |
|
208 | + * @throws EE_Error |
|
209 | + * @throws UnexpectedEntityException |
|
210 | + */ |
|
211 | + private function validateTicket($ticket) |
|
212 | + { |
|
213 | + if (! $ticket instanceof EE_Ticket) { |
|
214 | + throw new DomainException( |
|
215 | + esc_html__( |
|
216 | + 'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.', |
|
217 | + 'event_espresso' |
|
218 | + ) |
|
219 | + ); |
|
220 | + } |
|
221 | + if ($ticket->get_event_ID() !== $this->event->ID()) { |
|
222 | + throw new DomainException( |
|
223 | + sprintf( |
|
224 | + esc_html__( |
|
225 | + 'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
226 | + 'event_espresso' |
|
227 | + ), |
|
228 | + $ticket->get_event_ID(), |
|
229 | + $this->event->ID() |
|
230 | + ) |
|
231 | + ); |
|
232 | + } |
|
233 | + } |
|
234 | + |
|
235 | + |
|
236 | + /** |
|
237 | + * @return EE_Datetime[] |
|
238 | + */ |
|
239 | + public function getDatetimes() |
|
240 | + { |
|
241 | + return $this->datetimes; |
|
242 | + } |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * @param EE_Datetime $datetime |
|
247 | + * @throws EE_Error |
|
248 | + * @throws DomainException |
|
249 | + */ |
|
250 | + public function setDatetime(EE_Datetime $datetime) |
|
251 | + { |
|
252 | + if ($datetime->event()->ID() !== $this->event->ID()) { |
|
253 | + throw new DomainException( |
|
254 | + sprintf( |
|
255 | + esc_html__( |
|
256 | + 'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
257 | + 'event_espresso' |
|
258 | + ), |
|
259 | + $datetime->event()->ID(), |
|
260 | + $this->event->ID() |
|
261 | + ) |
|
262 | + ); |
|
263 | + } |
|
264 | + $this->datetimes[ $datetime->ID() ] = $datetime; |
|
265 | + } |
|
266 | + |
|
267 | + |
|
268 | + /** |
|
269 | + * calculate spaces remaining based on "saleable" tickets |
|
270 | + * |
|
271 | + * @return float|int |
|
272 | + * @throws EE_Error |
|
273 | + * @throws DomainException |
|
274 | + * @throws UnexpectedEntityException |
|
275 | + * @throws InvalidDataTypeException |
|
276 | + * @throws InvalidInterfaceException |
|
277 | + * @throws InvalidArgumentException |
|
278 | + */ |
|
279 | + public function spacesRemaining() |
|
280 | + { |
|
281 | + if ($this->debug) { |
|
282 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
283 | + } |
|
284 | + if ($this->spaces_remaining === null) { |
|
285 | + $this->initialize(); |
|
286 | + $this->spaces_remaining = $this->calculate(); |
|
287 | + } |
|
288 | + return $this->spaces_remaining; |
|
289 | + } |
|
290 | + |
|
291 | + |
|
292 | + /** |
|
293 | + * calculates total available spaces for an event with no regard for sold tickets |
|
294 | + * |
|
295 | + * @return int|float |
|
296 | + * @throws EE_Error |
|
297 | + * @throws DomainException |
|
298 | + * @throws UnexpectedEntityException |
|
299 | + * @throws InvalidDataTypeException |
|
300 | + * @throws InvalidInterfaceException |
|
301 | + * @throws InvalidArgumentException |
|
302 | + */ |
|
303 | + public function totalSpacesAvailable() |
|
304 | + { |
|
305 | + if ($this->debug) { |
|
306 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
307 | + } |
|
308 | + if ($this->total_spaces_available === null) { |
|
309 | + $this->initialize(); |
|
310 | + $this->total_spaces_available = $this->calculate(false); |
|
311 | + } |
|
312 | + return $this->total_spaces_available; |
|
313 | + } |
|
314 | + |
|
315 | + |
|
316 | + /** |
|
317 | + * Loops through the active tickets for the event |
|
318 | + * and builds a series of data arrays that will be used for calculating |
|
319 | + * the total maximum available spaces, as well as the spaces remaining. |
|
320 | + * Because ticket quantities affect datetime spaces and vice versa, |
|
321 | + * we need to be constantly updating these data arrays as things change, |
|
322 | + * which is the entire reason for their existence. |
|
323 | + * |
|
324 | + * @throws EE_Error |
|
325 | + * @throws DomainException |
|
326 | + * @throws UnexpectedEntityException |
|
327 | + * @throws InvalidDataTypeException |
|
328 | + * @throws InvalidInterfaceException |
|
329 | + * @throws InvalidArgumentException |
|
330 | + */ |
|
331 | + private function initialize() |
|
332 | + { |
|
333 | + if ($this->debug) { |
|
334 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
335 | + } |
|
336 | + $this->datetime_tickets = array(); |
|
337 | + $this->datetime_spaces = array(); |
|
338 | + $this->ticket_datetimes = array(); |
|
339 | + $this->ticket_quantities = array(); |
|
340 | + $this->tickets_sold = array(); |
|
341 | + $this->total_spaces = array(); |
|
342 | + $active_tickets = $this->getActiveTickets(); |
|
343 | + if (! empty($active_tickets)) { |
|
344 | + foreach ($active_tickets as $ticket) { |
|
345 | + $this->validateTicket($ticket); |
|
346 | + // we need to index our data arrays using strings for the purpose of sorting, |
|
347 | + // but we also need them to be unique, so we'll just prepend a letter T to the ID |
|
348 | + $ticket_identifier = "T{$ticket->ID()}"; |
|
349 | + // to start, we'll just consider the raw qty to be the maximum availability for this ticket, |
|
350 | + // unless the ticket is past its "sell until" date, in which case the qty will be 0 |
|
351 | + $max_tickets = $ticket->is_expired() ? 0 : $ticket->qty(); |
|
352 | + // but we'll adjust that after looping over each datetime for the ticket and checking reg limits |
|
353 | + $ticket_datetimes = $ticket->datetimes($this->datetime_query_params); |
|
354 | + foreach ($ticket_datetimes as $datetime) { |
|
355 | + // save all datetimes |
|
356 | + $this->setDatetime($datetime); |
|
357 | + $datetime_identifier = "D{$datetime->ID()}"; |
|
358 | + $reg_limit = $datetime->reg_limit(); |
|
359 | + // ticket quantity can not exceed datetime reg limit |
|
360 | + $max_tickets = min($max_tickets, $reg_limit); |
|
361 | + // as described earlier, because we need to be able to constantly adjust numbers for things, |
|
362 | + // we are going to move all of our data into the following arrays: |
|
363 | + // datetime spaces initially represents the reg limit for each datetime, |
|
364 | + // but this will get adjusted as tickets are accounted for |
|
365 | + $this->datetime_spaces[ $datetime_identifier ] = $reg_limit; |
|
366 | + // just an array of ticket IDs grouped by datetime |
|
367 | + $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier; |
|
368 | + // and an array of datetime IDs grouped by ticket |
|
369 | + $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier; |
|
370 | + } |
|
371 | + // total quantity of sold and reserved for each ticket |
|
372 | + $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved(); |
|
373 | + // and the maximum ticket quantities for each ticket (adjusted for reg limit) |
|
374 | + $this->ticket_quantities[ $ticket_identifier ] = $max_tickets; |
|
375 | + } |
|
376 | + } |
|
377 | + // sort datetime spaces by reg limit, but maintain our string indexes |
|
378 | + asort($this->datetime_spaces, SORT_NUMERIC); |
|
379 | + // datetime tickets need to be sorted in the SAME order as the above array... |
|
380 | + // so we'll just use array_merge() to take the structure of datetime_spaces |
|
381 | + // but overwrite all of the data with that from datetime_tickets |
|
382 | + $this->datetime_tickets = array_merge( |
|
383 | + $this->datetime_spaces, |
|
384 | + $this->datetime_tickets |
|
385 | + ); |
|
386 | + if ($this->debug) { |
|
387 | + \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
388 | + \EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__); |
|
389 | + \EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__); |
|
390 | + } |
|
391 | + } |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * performs calculations on initialized data |
|
396 | + * |
|
397 | + * @param bool $consider_sold |
|
398 | + * @return int|float |
|
399 | + */ |
|
400 | + private function calculate($consider_sold = true) |
|
401 | + { |
|
402 | + if ($this->debug) { |
|
403 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
404 | + \EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__); |
|
405 | + } |
|
406 | + if ($consider_sold) { |
|
407 | + // subtract amounts sold from all ticket quantities and datetime spaces |
|
408 | + $this->adjustTicketQuantitiesDueToSales(); |
|
409 | + } |
|
410 | + foreach ($this->datetime_tickets as $datetime_identifier => $tickets) { |
|
411 | + $this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets); |
|
412 | + } |
|
413 | + // total spaces available is just the sum of the spaces available for each datetime |
|
414 | + $spaces_remaining = array_sum($this->total_spaces); |
|
415 | + if ($this->debug) { |
|
416 | + \EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__); |
|
417 | + \EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__); |
|
418 | + \EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__); |
|
419 | + } |
|
420 | + return $spaces_remaining; |
|
421 | + } |
|
422 | + |
|
423 | + |
|
424 | + /** |
|
425 | + * subtracts amount of tickets sold from ticket quantities and datetime spaces |
|
426 | + */ |
|
427 | + private function adjustTicketQuantitiesDueToSales() |
|
428 | + { |
|
429 | + if ($this->debug) { |
|
430 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
431 | + } |
|
432 | + foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) { |
|
433 | + if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
434 | + $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold; |
|
435 | + // don't let values go below zero |
|
436 | + $this->ticket_quantities[ $ticket_identifier ] = max( |
|
437 | + $this->ticket_quantities[ $ticket_identifier ], |
|
438 | + 0 |
|
439 | + ); |
|
440 | + if ($this->debug) { |
|
441 | + \EEH_Debug_Tools::printr( |
|
442 | + "{$tickets_sold} sales for ticket {$ticket_identifier} ", |
|
443 | + 'subtracting', |
|
444 | + __FILE__, |
|
445 | + __LINE__ |
|
446 | + ); |
|
447 | + } |
|
448 | + } |
|
449 | + if (isset($this->ticket_datetimes[ $ticket_identifier ]) |
|
450 | + && is_array($this->ticket_datetimes[ $ticket_identifier ]) |
|
451 | + ) { |
|
452 | + foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) { |
|
453 | + if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
454 | + $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold; |
|
455 | + // don't let values go below zero |
|
456 | + $this->datetime_spaces[ $ticket_datetime ] = max( |
|
457 | + $this->datetime_spaces[ $ticket_datetime ], |
|
458 | + 0 |
|
459 | + ); |
|
460 | + if ($this->debug) { |
|
461 | + \EEH_Debug_Tools::printr( |
|
462 | + "{$tickets_sold} sales for datetime {$ticket_datetime} ", |
|
463 | + 'subtracting', |
|
464 | + __FILE__, |
|
465 | + __LINE__ |
|
466 | + ); |
|
467 | + } |
|
468 | + } |
|
469 | + } |
|
470 | + } |
|
471 | + } |
|
472 | + } |
|
473 | + |
|
474 | + |
|
475 | + /** |
|
476 | + * @param string $datetime_identifier |
|
477 | + * @param array $tickets |
|
478 | + */ |
|
479 | + private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets) |
|
480 | + { |
|
481 | + // make sure a reg limit is set for the datetime |
|
482 | + $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ]) |
|
483 | + ? $this->datetime_spaces[ $datetime_identifier ] |
|
484 | + : 0; |
|
485 | + // and bail if it is not |
|
486 | + if (! $reg_limit) { |
|
487 | + if ($this->debug) { |
|
488 | + \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__); |
|
489 | + } |
|
490 | + return; |
|
491 | + } |
|
492 | + if ($this->debug) { |
|
493 | + \EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1); |
|
494 | + \EEH_Debug_Tools::printr( |
|
495 | + "{$reg_limit}", |
|
496 | + 'REG LIMIT', |
|
497 | + __FILE__, |
|
498 | + __LINE__ |
|
499 | + ); |
|
500 | + } |
|
501 | + // number of allocated spaces always starts at zero |
|
502 | + $spaces_allocated = 0; |
|
503 | + $this->total_spaces[ $datetime_identifier ] = 0; |
|
504 | + foreach ($tickets as $ticket_identifier) { |
|
505 | + $spaces_allocated = $this->calculateAvailableSpacesForTicket( |
|
506 | + $datetime_identifier, |
|
507 | + $reg_limit, |
|
508 | + $ticket_identifier, |
|
509 | + $spaces_allocated |
|
510 | + ); |
|
511 | + } |
|
512 | + // spaces can't be negative |
|
513 | + $spaces_allocated = max($spaces_allocated, 0); |
|
514 | + if ($spaces_allocated) { |
|
515 | + // track any non-zero values |
|
516 | + $this->total_spaces[ $datetime_identifier ] += $spaces_allocated; |
|
517 | + if ($this->debug) { |
|
518 | + \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__); |
|
519 | + } |
|
520 | + } else { |
|
521 | + if ($this->debug) { |
|
522 | + \EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__); |
|
523 | + } |
|
524 | + } |
|
525 | + if ($this->debug) { |
|
526 | + \EEH_Debug_Tools::printr( |
|
527 | + $this->total_spaces[ $datetime_identifier ], |
|
528 | + '$total_spaces', |
|
529 | + __FILE__, |
|
530 | + __LINE__ |
|
531 | + ); |
|
532 | + \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__); |
|
533 | + \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
534 | + } |
|
535 | + } |
|
536 | + |
|
537 | + |
|
538 | + /** |
|
539 | + * @param string $datetime_identifier |
|
540 | + * @param int $reg_limit |
|
541 | + * @param string $ticket_identifier |
|
542 | + * @param int $spaces_allocated |
|
543 | + * @return int |
|
544 | + */ |
|
545 | + private function calculateAvailableSpacesForTicket( |
|
546 | + $datetime_identifier, |
|
547 | + $reg_limit, |
|
548 | + $ticket_identifier, |
|
549 | + $spaces_allocated |
|
550 | + ) { |
|
551 | + // make sure ticket quantity is set |
|
552 | + $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ]) |
|
553 | + ? $this->ticket_quantities[ $ticket_identifier ] |
|
554 | + : 0; |
|
555 | + if ($this->debug) { |
|
556 | + \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__); |
|
557 | + \EEH_Debug_Tools::printr( |
|
558 | + "{$ticket_quantity}", |
|
559 | + "ticket $ticket_identifier quantity: ", |
|
560 | + __FILE__, |
|
561 | + __LINE__, |
|
562 | + 2 |
|
563 | + ); |
|
564 | + } |
|
565 | + if ($ticket_quantity) { |
|
566 | + if ($this->debug) { |
|
567 | + \EEH_Debug_Tools::printr( |
|
568 | + ($spaces_allocated <= $reg_limit) |
|
569 | + ? 'true' |
|
570 | + : 'false', |
|
571 | + ' . spaces_allocated <= reg_limit = ', |
|
572 | + __FILE__, |
|
573 | + __LINE__ |
|
574 | + ); |
|
575 | + } |
|
576 | + // if the datetime is NOT at full capacity yet |
|
577 | + if ($spaces_allocated <= $reg_limit) { |
|
578 | + // then the maximum ticket quantity we can allocate is the lowest value of either: |
|
579 | + // the number of remaining spaces for the datetime, which is the limit - spaces already taken |
|
580 | + // or the maximum ticket quantity |
|
581 | + $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity); |
|
582 | + // adjust the available quantity in our tracking array |
|
583 | + $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity; |
|
584 | + // and increment spaces allocated for this datetime |
|
585 | + $spaces_allocated += $ticket_quantity; |
|
586 | + $at_capacity = $spaces_allocated >= $reg_limit; |
|
587 | + if ($this->debug) { |
|
588 | + \EEH_Debug_Tools::printr( |
|
589 | + "{$ticket_quantity} {$ticket_identifier} tickets", |
|
590 | + ' > > allocate ', |
|
591 | + __FILE__, |
|
592 | + __LINE__, |
|
593 | + 3 |
|
594 | + ); |
|
595 | + if ($at_capacity) { |
|
596 | + \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3); |
|
597 | + } |
|
598 | + } |
|
599 | + // now adjust all other datetimes that allow access to this ticket |
|
600 | + $this->adjustDatetimes( |
|
601 | + $datetime_identifier, |
|
602 | + $ticket_identifier, |
|
603 | + $ticket_quantity, |
|
604 | + $at_capacity |
|
605 | + ); |
|
606 | + } |
|
607 | + } |
|
608 | + return $spaces_allocated; |
|
609 | + } |
|
610 | + |
|
611 | + |
|
612 | + /** |
|
613 | + * subtracts ticket amounts from all datetime reg limits |
|
614 | + * that allow access to the ticket specified, |
|
615 | + * because that ticket could be used |
|
616 | + * to attend any of the datetimes it has access to |
|
617 | + * |
|
618 | + * @param string $datetime_identifier |
|
619 | + * @param string $ticket_identifier |
|
620 | + * @param bool $at_capacity |
|
621 | + * @param int $ticket_quantity |
|
622 | + */ |
|
623 | + private function adjustDatetimes( |
|
624 | + $datetime_identifier, |
|
625 | + $ticket_identifier, |
|
626 | + $ticket_quantity, |
|
627 | + $at_capacity |
|
628 | + ) { |
|
629 | + /** @var array $datetime_tickets */ |
|
630 | + foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) { |
|
631 | + if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) { |
|
632 | + continue; |
|
633 | + } |
|
634 | + $adjusted = $this->adjustDatetimeSpaces( |
|
635 | + $datetime_ID, |
|
636 | + $ticket_identifier, |
|
637 | + $ticket_quantity |
|
638 | + ); |
|
639 | + // skip to next ticket if nothing changed |
|
640 | + if (! ($adjusted || $at_capacity)) { |
|
641 | + continue; |
|
642 | + } |
|
643 | + // then all of it's tickets are now unavailable |
|
644 | + foreach ($datetime_tickets as $datetime_ticket) { |
|
645 | + if (($ticket_identifier === $datetime_ticket || $at_capacity) |
|
646 | + && isset($this->ticket_quantities[ $datetime_ticket ]) |
|
647 | + && $this->ticket_quantities[ $datetime_ticket ] > 0 |
|
648 | + ) { |
|
649 | + if ($this->debug) { |
|
650 | + \EEH_Debug_Tools::printr( |
|
651 | + $datetime_ticket, |
|
652 | + ' . . . adjust ticket quantities for', |
|
653 | + __FILE__, |
|
654 | + __LINE__ |
|
655 | + ); |
|
656 | + } |
|
657 | + // if this datetime is at full capacity, set any tracked available quantities to zero |
|
658 | + // otherwise just subtract the ticket quantity |
|
659 | + $new_quantity = $at_capacity |
|
660 | + ? 0 |
|
661 | + : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity; |
|
662 | + // don't let ticket quantity go below zero |
|
663 | + $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0); |
|
664 | + if ($this->debug) { |
|
665 | + \EEH_Debug_Tools::printr( |
|
666 | + $at_capacity |
|
667 | + ? "0 because Datetime {$datetime_identifier} is at capacity" |
|
668 | + : "{$this->ticket_quantities[ $datetime_ticket ]}", |
|
669 | + " . . . . {$datetime_ticket} quantity set to ", |
|
670 | + __FILE__, |
|
671 | + __LINE__ |
|
672 | + ); |
|
673 | + } |
|
674 | + } |
|
675 | + // but we also need to adjust spaces for any other datetimes this ticket has access to |
|
676 | + if ($datetime_ticket === $ticket_identifier) { |
|
677 | + if (isset($this->ticket_datetimes[ $datetime_ticket ]) |
|
678 | + && is_array($this->ticket_datetimes[ $datetime_ticket ]) |
|
679 | + ) { |
|
680 | + if ($this->debug) { |
|
681 | + \EEH_Debug_Tools::printr( |
|
682 | + $datetime_ticket, |
|
683 | + ' . . adjust other Datetimes for', |
|
684 | + __FILE__, |
|
685 | + __LINE__ |
|
686 | + ); |
|
687 | + } |
|
688 | + foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) { |
|
689 | + // don't adjust the current datetime twice |
|
690 | + if ($datetime !== $datetime_identifier) { |
|
691 | + $this->adjustDatetimeSpaces( |
|
692 | + $datetime, |
|
693 | + $datetime_ticket, |
|
694 | + $ticket_quantity |
|
695 | + ); |
|
696 | + } |
|
697 | + } |
|
698 | + } |
|
699 | + } |
|
700 | + } |
|
701 | + } |
|
702 | + } |
|
703 | + |
|
704 | + private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0) |
|
705 | + { |
|
706 | + // does datetime have spaces available? |
|
707 | + // and does the supplied ticket have access to this datetime ? |
|
708 | + if ($this->datetime_spaces[ $datetime_identifier ] > 0 |
|
709 | + && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ]) |
|
710 | + && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true) |
|
711 | + ) { |
|
712 | + if ($this->debug) { |
|
713 | + \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__); |
|
714 | + \EEH_Debug_Tools::printr( |
|
715 | + "{$this->datetime_spaces[ $datetime_identifier ]}", |
|
716 | + " . . current {$datetime_identifier} spaces available", |
|
717 | + __FILE__, |
|
718 | + __LINE__ |
|
719 | + ); |
|
720 | + } |
|
721 | + // then decrement the available spaces for the datetime |
|
722 | + $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity; |
|
723 | + // but don't let quantities go below zero |
|
724 | + $this->datetime_spaces[ $datetime_identifier ] = max( |
|
725 | + $this->datetime_spaces[ $datetime_identifier ], |
|
726 | + 0 |
|
727 | + ); |
|
728 | + if ($this->debug) { |
|
729 | + \EEH_Debug_Tools::printr( |
|
730 | + "{$ticket_quantity}", |
|
731 | + " . . . {$datetime_identifier} capacity reduced by", |
|
732 | + __FILE__, |
|
733 | + __LINE__ |
|
734 | + ); |
|
735 | + } |
|
736 | + return true; |
|
737 | + } |
|
738 | + return false; |
|
739 | + } |
|
740 | 740 | } |
@@ -20,113 +20,113 @@ |
||
20 | 20 | { |
21 | 21 | |
22 | 22 | |
23 | - /** |
|
24 | - * @param \EE_Registration $registration |
|
25 | - * @param int $quantity |
|
26 | - * @return bool|int |
|
27 | - */ |
|
28 | - public function forRegistration(\EE_Registration $registration, $quantity = 1) |
|
29 | - { |
|
30 | - return $this->cancel( |
|
31 | - $registration->transaction(), |
|
32 | - $registration->ticket(), |
|
33 | - $quantity, |
|
34 | - $registration->ticket_line_item() |
|
35 | - ); |
|
36 | - } |
|
23 | + /** |
|
24 | + * @param \EE_Registration $registration |
|
25 | + * @param int $quantity |
|
26 | + * @return bool|int |
|
27 | + */ |
|
28 | + public function forRegistration(\EE_Registration $registration, $quantity = 1) |
|
29 | + { |
|
30 | + return $this->cancel( |
|
31 | + $registration->transaction(), |
|
32 | + $registration->ticket(), |
|
33 | + $quantity, |
|
34 | + $registration->ticket_line_item() |
|
35 | + ); |
|
36 | + } |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * @param \EE_Transaction $transaction |
|
41 | - * @param \EE_Ticket $ticket |
|
42 | - * @param int $quantity |
|
43 | - * @param \EE_Line_Item $ticket_line_item |
|
44 | - * @return bool|int |
|
45 | - */ |
|
46 | - public function cancel( |
|
47 | - \EE_Transaction $transaction, |
|
48 | - \EE_Ticket $ticket, |
|
49 | - $quantity = 1, |
|
50 | - \EE_Line_Item $ticket_line_item = null |
|
51 | - ) { |
|
52 | - $ticket_line_item = $ticket_line_item instanceof \EE_Line_Item |
|
53 | - ? $ticket_line_item |
|
54 | - : $this->getTicketLineItem($transaction, $ticket); |
|
55 | - // first we need to decrement the ticket quantity |
|
56 | - \EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity); |
|
57 | - // no tickets left for this line item ? |
|
58 | - if ((int) $ticket_line_item->quantity() === 0) { |
|
59 | - // then just set this line item as cancelled, save, and get out |
|
60 | - $ticket_line_item->set_type(\EEM_Line_Item::type_cancellation); |
|
61 | - $success = $ticket_line_item->save(); |
|
62 | - } else { |
|
63 | - // otherwise create a new cancelled line item, so that we have a record of the cancellation |
|
64 | - $items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal( |
|
65 | - \EEH_Line_Item::get_event_line_item_for_ticket( |
|
66 | - $transaction->total_line_item(), |
|
67 | - $ticket |
|
68 | - ) |
|
69 | - ); |
|
70 | - $cancelled_line_item = \EE_Line_Item::new_instance( |
|
71 | - array( |
|
72 | - 'LIN_name' => $ticket_line_item->name(), |
|
73 | - 'LIN_desc' => sprintf( |
|
74 | - __('%1$s Cancelled: %2$s', 'event_espresso'), |
|
75 | - $ticket_line_item->desc(), |
|
76 | - date('Y-m-d h:i a') |
|
77 | - ), |
|
78 | - 'LIN_unit_price' => (float) $ticket_line_item->unit_price(), |
|
79 | - 'LIN_quantity' => $quantity, |
|
80 | - 'LIN_percent' => null, |
|
81 | - 'LIN_is_taxable' => false, |
|
82 | - 'LIN_order' => $items_subtotal instanceof \EE_Line_Item |
|
83 | - ? count($items_subtotal->children()) |
|
84 | - : 0, |
|
85 | - 'LIN_total' => (float) $ticket_line_item->unit_price(), |
|
86 | - 'LIN_type' => \EEM_Line_Item::type_cancellation, |
|
87 | - ) |
|
88 | - ); |
|
89 | - $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item); |
|
90 | - } |
|
91 | - if (! $success) { |
|
92 | - throw new \RuntimeException( |
|
93 | - sprintf( |
|
94 | - __('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'), |
|
95 | - $ticket_line_item->ID() |
|
96 | - ) |
|
97 | - ); |
|
98 | - } |
|
99 | - return $success; |
|
100 | - } |
|
39 | + /** |
|
40 | + * @param \EE_Transaction $transaction |
|
41 | + * @param \EE_Ticket $ticket |
|
42 | + * @param int $quantity |
|
43 | + * @param \EE_Line_Item $ticket_line_item |
|
44 | + * @return bool|int |
|
45 | + */ |
|
46 | + public function cancel( |
|
47 | + \EE_Transaction $transaction, |
|
48 | + \EE_Ticket $ticket, |
|
49 | + $quantity = 1, |
|
50 | + \EE_Line_Item $ticket_line_item = null |
|
51 | + ) { |
|
52 | + $ticket_line_item = $ticket_line_item instanceof \EE_Line_Item |
|
53 | + ? $ticket_line_item |
|
54 | + : $this->getTicketLineItem($transaction, $ticket); |
|
55 | + // first we need to decrement the ticket quantity |
|
56 | + \EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity); |
|
57 | + // no tickets left for this line item ? |
|
58 | + if ((int) $ticket_line_item->quantity() === 0) { |
|
59 | + // then just set this line item as cancelled, save, and get out |
|
60 | + $ticket_line_item->set_type(\EEM_Line_Item::type_cancellation); |
|
61 | + $success = $ticket_line_item->save(); |
|
62 | + } else { |
|
63 | + // otherwise create a new cancelled line item, so that we have a record of the cancellation |
|
64 | + $items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal( |
|
65 | + \EEH_Line_Item::get_event_line_item_for_ticket( |
|
66 | + $transaction->total_line_item(), |
|
67 | + $ticket |
|
68 | + ) |
|
69 | + ); |
|
70 | + $cancelled_line_item = \EE_Line_Item::new_instance( |
|
71 | + array( |
|
72 | + 'LIN_name' => $ticket_line_item->name(), |
|
73 | + 'LIN_desc' => sprintf( |
|
74 | + __('%1$s Cancelled: %2$s', 'event_espresso'), |
|
75 | + $ticket_line_item->desc(), |
|
76 | + date('Y-m-d h:i a') |
|
77 | + ), |
|
78 | + 'LIN_unit_price' => (float) $ticket_line_item->unit_price(), |
|
79 | + 'LIN_quantity' => $quantity, |
|
80 | + 'LIN_percent' => null, |
|
81 | + 'LIN_is_taxable' => false, |
|
82 | + 'LIN_order' => $items_subtotal instanceof \EE_Line_Item |
|
83 | + ? count($items_subtotal->children()) |
|
84 | + : 0, |
|
85 | + 'LIN_total' => (float) $ticket_line_item->unit_price(), |
|
86 | + 'LIN_type' => \EEM_Line_Item::type_cancellation, |
|
87 | + ) |
|
88 | + ); |
|
89 | + $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item); |
|
90 | + } |
|
91 | + if (! $success) { |
|
92 | + throw new \RuntimeException( |
|
93 | + sprintf( |
|
94 | + __('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'), |
|
95 | + $ticket_line_item->ID() |
|
96 | + ) |
|
97 | + ); |
|
98 | + } |
|
99 | + return $success; |
|
100 | + } |
|
101 | 101 | |
102 | 102 | |
103 | - /** |
|
104 | - * @param \EE_Transaction $transaction |
|
105 | - * @param \EE_Ticket $ticket |
|
106 | - * @return \EE_Line_Item |
|
107 | - * @throws EntityNotFoundException |
|
108 | - * @throws \EE_Error |
|
109 | - */ |
|
110 | - protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket) |
|
111 | - { |
|
112 | - $line_item = null; |
|
113 | - $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs( |
|
114 | - $transaction->total_line_item(), |
|
115 | - 'Ticket', |
|
116 | - array($ticket->ID()) |
|
117 | - ); |
|
118 | - foreach ($ticket_line_items as $ticket_line_item) { |
|
119 | - if ($ticket_line_item instanceof \EE_Line_Item |
|
120 | - && $ticket_line_item->OBJ_type() === 'Ticket' |
|
121 | - && $ticket_line_item->OBJ_ID() === $ticket->ID() |
|
122 | - ) { |
|
123 | - $line_item = $ticket_line_item; |
|
124 | - break; |
|
125 | - } |
|
126 | - } |
|
127 | - if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
128 | - throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
|
129 | - } |
|
130 | - return $line_item; |
|
131 | - } |
|
103 | + /** |
|
104 | + * @param \EE_Transaction $transaction |
|
105 | + * @param \EE_Ticket $ticket |
|
106 | + * @return \EE_Line_Item |
|
107 | + * @throws EntityNotFoundException |
|
108 | + * @throws \EE_Error |
|
109 | + */ |
|
110 | + protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket) |
|
111 | + { |
|
112 | + $line_item = null; |
|
113 | + $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs( |
|
114 | + $transaction->total_line_item(), |
|
115 | + 'Ticket', |
|
116 | + array($ticket->ID()) |
|
117 | + ); |
|
118 | + foreach ($ticket_line_items as $ticket_line_item) { |
|
119 | + if ($ticket_line_item instanceof \EE_Line_Item |
|
120 | + && $ticket_line_item->OBJ_type() === 'Ticket' |
|
121 | + && $ticket_line_item->OBJ_ID() === $ticket->ID() |
|
122 | + ) { |
|
123 | + $line_item = $ticket_line_item; |
|
124 | + break; |
|
125 | + } |
|
126 | + } |
|
127 | + if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
128 | + throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
|
129 | + } |
|
130 | + return $line_item; |
|
131 | + } |
|
132 | 132 | } |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | ); |
89 | 89 | $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item); |
90 | 90 | } |
91 | - if (! $success) { |
|
91 | + if ( ! $success) { |
|
92 | 92 | throw new \RuntimeException( |
93 | 93 | sprintf( |
94 | 94 | __('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'), |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | break; |
125 | 125 | } |
126 | 126 | } |
127 | - if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
127 | + if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
128 | 128 | throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
129 | 129 | } |
130 | 130 | return $line_item; |
@@ -18,84 +18,84 @@ |
||
18 | 18 | class CapabilitiesChecker implements CapabilitiesCheckerInterface |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * @type EE_Capabilities $capabilities |
|
23 | - */ |
|
24 | - private $capabilities; |
|
21 | + /** |
|
22 | + * @type EE_Capabilities $capabilities |
|
23 | + */ |
|
24 | + private $capabilities; |
|
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * CapabilitiesChecker constructor |
|
29 | - * |
|
30 | - * @param EE_Capabilities $capabilities |
|
31 | - */ |
|
32 | - public function __construct(EE_Capabilities $capabilities) |
|
33 | - { |
|
34 | - $this->capabilities = $capabilities; |
|
35 | - } |
|
27 | + /** |
|
28 | + * CapabilitiesChecker constructor |
|
29 | + * |
|
30 | + * @param EE_Capabilities $capabilities |
|
31 | + */ |
|
32 | + public function __construct(EE_Capabilities $capabilities) |
|
33 | + { |
|
34 | + $this->capabilities = $capabilities; |
|
35 | + } |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * @return EE_Capabilities |
|
40 | - */ |
|
41 | - protected function capabilities() |
|
42 | - { |
|
43 | - return $this->capabilities; |
|
44 | - } |
|
38 | + /** |
|
39 | + * @return EE_Capabilities |
|
40 | + */ |
|
41 | + protected function capabilities() |
|
42 | + { |
|
43 | + return $this->capabilities; |
|
44 | + } |
|
45 | 45 | |
46 | 46 | |
47 | - /** |
|
48 | - * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO. |
|
49 | - * If any of the individual capability checks fails, then the command will NOT be executed. |
|
50 | - * |
|
51 | - * @param CapCheckInterface|CapCheckInterface[] $cap_check |
|
52 | - * @return bool |
|
53 | - * @throws InvalidClassException |
|
54 | - * @throws InsufficientPermissionsException |
|
55 | - */ |
|
56 | - public function processCapCheck($cap_check) |
|
57 | - { |
|
58 | - if (is_array($cap_check)) { |
|
59 | - foreach ($cap_check as $check) { |
|
60 | - $this->processCapCheck($check); |
|
61 | - } |
|
62 | - return true; |
|
63 | - } |
|
64 | - // at this point, $cap_check should be an individual instance of CapCheck |
|
65 | - if (! $cap_check instanceof CapCheckInterface) { |
|
66 | - throw new InvalidClassException( |
|
67 | - '\EventEspresso\core\domain\services\capabilities\CapCheckInterface' |
|
68 | - ); |
|
69 | - } |
|
70 | - // sometimes cap checks are conditional, and no capabilities are required |
|
71 | - if ($cap_check instanceof PublicCapabilities) { |
|
72 | - return true; |
|
73 | - } |
|
74 | - $capabilities = (array) $cap_check->capability(); |
|
75 | - foreach ($capabilities as $capability) { |
|
76 | - if (! $this->capabilities()->current_user_can( |
|
77 | - $capability, |
|
78 | - $cap_check->context(), |
|
79 | - $cap_check->ID() |
|
80 | - )) { |
|
81 | - throw new InsufficientPermissionsException($cap_check->context()); |
|
82 | - } |
|
83 | - } |
|
84 | - return true; |
|
85 | - } |
|
47 | + /** |
|
48 | + * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO. |
|
49 | + * If any of the individual capability checks fails, then the command will NOT be executed. |
|
50 | + * |
|
51 | + * @param CapCheckInterface|CapCheckInterface[] $cap_check |
|
52 | + * @return bool |
|
53 | + * @throws InvalidClassException |
|
54 | + * @throws InsufficientPermissionsException |
|
55 | + */ |
|
56 | + public function processCapCheck($cap_check) |
|
57 | + { |
|
58 | + if (is_array($cap_check)) { |
|
59 | + foreach ($cap_check as $check) { |
|
60 | + $this->processCapCheck($check); |
|
61 | + } |
|
62 | + return true; |
|
63 | + } |
|
64 | + // at this point, $cap_check should be an individual instance of CapCheck |
|
65 | + if (! $cap_check instanceof CapCheckInterface) { |
|
66 | + throw new InvalidClassException( |
|
67 | + '\EventEspresso\core\domain\services\capabilities\CapCheckInterface' |
|
68 | + ); |
|
69 | + } |
|
70 | + // sometimes cap checks are conditional, and no capabilities are required |
|
71 | + if ($cap_check instanceof PublicCapabilities) { |
|
72 | + return true; |
|
73 | + } |
|
74 | + $capabilities = (array) $cap_check->capability(); |
|
75 | + foreach ($capabilities as $capability) { |
|
76 | + if (! $this->capabilities()->current_user_can( |
|
77 | + $capability, |
|
78 | + $cap_check->context(), |
|
79 | + $cap_check->ID() |
|
80 | + )) { |
|
81 | + throw new InsufficientPermissionsException($cap_check->context()); |
|
82 | + } |
|
83 | + } |
|
84 | + return true; |
|
85 | + } |
|
86 | 86 | |
87 | 87 | |
88 | - /** |
|
89 | - * @param string $capability - the capability to be checked, like: 'ee_edit_registrations' |
|
90 | - * @param string $context - what the user is attempting to do, like: 'Edit Registration' |
|
91 | - * @param int $ID - (optional) ID for item where current_user_can is being called from |
|
92 | - * @return bool |
|
93 | - * @throws InvalidDataTypeException |
|
94 | - * @throws InsufficientPermissionsException |
|
95 | - * @throws InvalidClassException |
|
96 | - */ |
|
97 | - public function process($capability, $context, $ID = 0) |
|
98 | - { |
|
99 | - return $this->processCapCheck(new CapCheck($capability, $context, $ID)); |
|
100 | - } |
|
88 | + /** |
|
89 | + * @param string $capability - the capability to be checked, like: 'ee_edit_registrations' |
|
90 | + * @param string $context - what the user is attempting to do, like: 'Edit Registration' |
|
91 | + * @param int $ID - (optional) ID for item where current_user_can is being called from |
|
92 | + * @return bool |
|
93 | + * @throws InvalidDataTypeException |
|
94 | + * @throws InsufficientPermissionsException |
|
95 | + * @throws InvalidClassException |
|
96 | + */ |
|
97 | + public function process($capability, $context, $ID = 0) |
|
98 | + { |
|
99 | + return $this->processCapCheck(new CapCheck($capability, $context, $ID)); |
|
100 | + } |
|
101 | 101 | } |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | return true; |
63 | 63 | } |
64 | 64 | // at this point, $cap_check should be an individual instance of CapCheck |
65 | - if (! $cap_check instanceof CapCheckInterface) { |
|
65 | + if ( ! $cap_check instanceof CapCheckInterface) { |
|
66 | 66 | throw new InvalidClassException( |
67 | 67 | '\EventEspresso\core\domain\services\capabilities\CapCheckInterface' |
68 | 68 | ); |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | } |
74 | 74 | $capabilities = (array) $cap_check->capability(); |
75 | 75 | foreach ($capabilities as $capability) { |
76 | - if (! $this->capabilities()->current_user_can( |
|
76 | + if ( ! $this->capabilities()->current_user_can( |
|
77 | 77 | $capability, |
78 | 78 | $cap_check->context(), |
79 | 79 | $cap_check->ID() |
@@ -27,84 +27,84 @@ |
||
27 | 27 | { |
28 | 28 | |
29 | 29 | |
30 | - protected $attendee; |
|
30 | + protected $attendee; |
|
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * AttendeeContactDetailsMetaboxFormHandler constructor. |
|
35 | - * |
|
36 | - * @param EE_Attendee $attendee |
|
37 | - * @param EE_Registry $registry |
|
38 | - * @throws DomainException |
|
39 | - * @throws InvalidDataTypeException |
|
40 | - * @throws InvalidArgumentException |
|
41 | - */ |
|
42 | - public function __construct(EE_Attendee $attendee, EE_Registry $registry) |
|
43 | - { |
|
44 | - $this->attendee = $attendee; |
|
45 | - $label = esc_html__('Contact Details', 'event_espresso'); |
|
46 | - parent::__construct( |
|
47 | - $label, |
|
48 | - $label, |
|
49 | - 'attendee_contact_details', |
|
50 | - '', |
|
51 | - FormHandler::DO_NOT_SETUP_FORM, |
|
52 | - $registry |
|
53 | - ); |
|
54 | - } |
|
33 | + /** |
|
34 | + * AttendeeContactDetailsMetaboxFormHandler constructor. |
|
35 | + * |
|
36 | + * @param EE_Attendee $attendee |
|
37 | + * @param EE_Registry $registry |
|
38 | + * @throws DomainException |
|
39 | + * @throws InvalidDataTypeException |
|
40 | + * @throws InvalidArgumentException |
|
41 | + */ |
|
42 | + public function __construct(EE_Attendee $attendee, EE_Registry $registry) |
|
43 | + { |
|
44 | + $this->attendee = $attendee; |
|
45 | + $label = esc_html__('Contact Details', 'event_espresso'); |
|
46 | + parent::__construct( |
|
47 | + $label, |
|
48 | + $label, |
|
49 | + 'attendee_contact_details', |
|
50 | + '', |
|
51 | + FormHandler::DO_NOT_SETUP_FORM, |
|
52 | + $registry |
|
53 | + ); |
|
54 | + } |
|
55 | 55 | |
56 | - /** |
|
57 | - * creates and returns the actual form |
|
58 | - * |
|
59 | - * @return EE_Form_Section_Proper |
|
60 | - * @throws EE_Error |
|
61 | - */ |
|
62 | - public function generate() |
|
63 | - { |
|
64 | - return new EE_Form_Section_Proper( |
|
65 | - array( |
|
66 | - 'name' => 'attendee_contact_details', |
|
67 | - 'html_id' => 'attendee-contact-details', |
|
68 | - 'html_class' => 'form-table', |
|
69 | - 'layout_strategy' => new EE_Admin_One_Column_Layout(), |
|
70 | - 'subsections' => array( |
|
71 | - 'ATT_email' => new EE_Email_Input( |
|
72 | - array( |
|
73 | - 'default' => $this->attendee->email(), |
|
74 | - 'html_label_text' => esc_html__('Email Address', 'event_espresso'), |
|
75 | - 'required' => true, |
|
76 | - ) |
|
77 | - ), |
|
78 | - 'ATT_phone' => new EE_Text_Input( |
|
79 | - array( |
|
80 | - 'default' => $this->attendee->phone(), |
|
81 | - 'html_label_text' => esc_html__('Phone Number', 'event_espresso'), |
|
82 | - ) |
|
83 | - ), |
|
84 | - ), |
|
85 | - ) |
|
86 | - ); |
|
87 | - } |
|
56 | + /** |
|
57 | + * creates and returns the actual form |
|
58 | + * |
|
59 | + * @return EE_Form_Section_Proper |
|
60 | + * @throws EE_Error |
|
61 | + */ |
|
62 | + public function generate() |
|
63 | + { |
|
64 | + return new EE_Form_Section_Proper( |
|
65 | + array( |
|
66 | + 'name' => 'attendee_contact_details', |
|
67 | + 'html_id' => 'attendee-contact-details', |
|
68 | + 'html_class' => 'form-table', |
|
69 | + 'layout_strategy' => new EE_Admin_One_Column_Layout(), |
|
70 | + 'subsections' => array( |
|
71 | + 'ATT_email' => new EE_Email_Input( |
|
72 | + array( |
|
73 | + 'default' => $this->attendee->email(), |
|
74 | + 'html_label_text' => esc_html__('Email Address', 'event_espresso'), |
|
75 | + 'required' => true, |
|
76 | + ) |
|
77 | + ), |
|
78 | + 'ATT_phone' => new EE_Text_Input( |
|
79 | + array( |
|
80 | + 'default' => $this->attendee->phone(), |
|
81 | + 'html_label_text' => esc_html__('Phone Number', 'event_espresso'), |
|
82 | + ) |
|
83 | + ), |
|
84 | + ), |
|
85 | + ) |
|
86 | + ); |
|
87 | + } |
|
88 | 88 | |
89 | 89 | |
90 | - /** |
|
91 | - * Process form data. |
|
92 | - * |
|
93 | - * @param array $form_data |
|
94 | - * @return bool |
|
95 | - * @throws EE_Error |
|
96 | - * @throws InvalidFormSubmissionException |
|
97 | - * @throws LogicException |
|
98 | - */ |
|
99 | - public function process($form_data = array()) |
|
100 | - { |
|
101 | - $valid_data = (array) parent::process($form_data); |
|
102 | - if (empty($valid_data)) { |
|
103 | - return false; |
|
104 | - } |
|
105 | - $this->attendee->set_email($valid_data['ATT_email']); |
|
106 | - $this->attendee->set_phone($valid_data['ATT_phone']); |
|
107 | - $updated = $this->attendee->save(); |
|
108 | - return $updated !== false; |
|
109 | - } |
|
90 | + /** |
|
91 | + * Process form data. |
|
92 | + * |
|
93 | + * @param array $form_data |
|
94 | + * @return bool |
|
95 | + * @throws EE_Error |
|
96 | + * @throws InvalidFormSubmissionException |
|
97 | + * @throws LogicException |
|
98 | + */ |
|
99 | + public function process($form_data = array()) |
|
100 | + { |
|
101 | + $valid_data = (array) parent::process($form_data); |
|
102 | + if (empty($valid_data)) { |
|
103 | + return false; |
|
104 | + } |
|
105 | + $this->attendee->set_email($valid_data['ATT_email']); |
|
106 | + $this->attendee->set_phone($valid_data['ATT_phone']); |
|
107 | + $updated = $this->attendee->save(); |
|
108 | + return $updated !== false; |
|
109 | + } |
|
110 | 110 | } |
@@ -15,56 +15,56 @@ |
||
15 | 15 | class EmailAddress |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * @var string $email_address |
|
20 | - */ |
|
21 | - private $email_address; |
|
18 | + /** |
|
19 | + * @var string $email_address |
|
20 | + */ |
|
21 | + private $email_address; |
|
22 | 22 | |
23 | 23 | |
24 | - /** |
|
25 | - * EmailAddress constructor. |
|
26 | - * |
|
27 | - * @param string $email_address |
|
28 | - * @param EmailValidatorInterface $validator |
|
29 | - * @throws EmailValidationException |
|
30 | - */ |
|
31 | - public function __construct($email_address, EmailValidatorInterface $validator) |
|
32 | - { |
|
33 | - $validator->validate($email_address); |
|
34 | - $this->email_address = $email_address; |
|
35 | - } |
|
24 | + /** |
|
25 | + * EmailAddress constructor. |
|
26 | + * |
|
27 | + * @param string $email_address |
|
28 | + * @param EmailValidatorInterface $validator |
|
29 | + * @throws EmailValidationException |
|
30 | + */ |
|
31 | + public function __construct($email_address, EmailValidatorInterface $validator) |
|
32 | + { |
|
33 | + $validator->validate($email_address); |
|
34 | + $this->email_address = $email_address; |
|
35 | + } |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * returns the string value for this EmailAddress |
|
40 | - * |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function get() |
|
44 | - { |
|
45 | - return $this->email_address; |
|
46 | - } |
|
38 | + /** |
|
39 | + * returns the string value for this EmailAddress |
|
40 | + * |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function get() |
|
44 | + { |
|
45 | + return $this->email_address; |
|
46 | + } |
|
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * compare another EmailAddress to this one to determine if they are the same |
|
51 | - * |
|
52 | - * @param EmailAddress $address |
|
53 | - * @return bool |
|
54 | - */ |
|
55 | - public function equals(EmailAddress $address) |
|
56 | - { |
|
57 | - return strtolower((string) $this) === strtolower((string) $address); |
|
58 | - } |
|
49 | + /** |
|
50 | + * compare another EmailAddress to this one to determine if they are the same |
|
51 | + * |
|
52 | + * @param EmailAddress $address |
|
53 | + * @return bool |
|
54 | + */ |
|
55 | + public function equals(EmailAddress $address) |
|
56 | + { |
|
57 | + return strtolower((string) $this) === strtolower((string) $address); |
|
58 | + } |
|
59 | 59 | |
60 | 60 | |
61 | - /** |
|
62 | - * allows an EmailAddress object to be used as a string |
|
63 | - * |
|
64 | - * @return string |
|
65 | - */ |
|
66 | - public function __toString() |
|
67 | - { |
|
68 | - return $this->email_address; |
|
69 | - } |
|
61 | + /** |
|
62 | + * allows an EmailAddress object to be used as a string |
|
63 | + * |
|
64 | + * @return string |
|
65 | + */ |
|
66 | + public function __toString() |
|
67 | + { |
|
68 | + return $this->email_address; |
|
69 | + } |
|
70 | 70 | } |