@@ -61,7 +61,7 @@ |
||
61 | 61 | { |
62 | 62 | $custom_post_types = $this->custom_post_types->getDefinitions(); |
63 | 63 | foreach ($custom_post_types as $custom_post_type => $CPT) { |
64 | - $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType( |
|
64 | + $this->wp_post_types[$custom_post_type] = $this->registerCustomPostType( |
|
65 | 65 | $custom_post_type, |
66 | 66 | $CPT['singular_name'], |
67 | 67 | $CPT['plural_name'], |
@@ -17,314 +17,314 @@ |
||
17 | 17 | */ |
18 | 18 | class RegisterCustomPostTypes |
19 | 19 | { |
20 | - /** |
|
21 | - * @var CustomPostTypeDefinitions $custom_post_types |
|
22 | - */ |
|
23 | - public $custom_post_types; |
|
20 | + /** |
|
21 | + * @var CustomPostTypeDefinitions $custom_post_types |
|
22 | + */ |
|
23 | + public $custom_post_types; |
|
24 | 24 | |
25 | - /** |
|
26 | - * @var WP_Post_Type[] $wp_post_types |
|
27 | - */ |
|
28 | - public $wp_post_types = array(); |
|
25 | + /** |
|
26 | + * @var WP_Post_Type[] $wp_post_types |
|
27 | + */ |
|
28 | + public $wp_post_types = array(); |
|
29 | 29 | |
30 | 30 | |
31 | - /** |
|
32 | - * RegisterCustomPostTypes constructor. |
|
33 | - * |
|
34 | - * @param CustomPostTypeDefinitions $custom_post_types |
|
35 | - */ |
|
36 | - public function __construct(CustomPostTypeDefinitions $custom_post_types) |
|
37 | - { |
|
38 | - $this->custom_post_types = $custom_post_types; |
|
39 | - } |
|
31 | + /** |
|
32 | + * RegisterCustomPostTypes constructor. |
|
33 | + * |
|
34 | + * @param CustomPostTypeDefinitions $custom_post_types |
|
35 | + */ |
|
36 | + public function __construct(CustomPostTypeDefinitions $custom_post_types) |
|
37 | + { |
|
38 | + $this->custom_post_types = $custom_post_types; |
|
39 | + } |
|
40 | 40 | |
41 | 41 | |
42 | - /** |
|
43 | - * @return WP_Post_Type[] |
|
44 | - */ |
|
45 | - public function getRegisteredCustomPostTypes() |
|
46 | - { |
|
47 | - return $this->wp_post_types; |
|
48 | - } |
|
42 | + /** |
|
43 | + * @return WP_Post_Type[] |
|
44 | + */ |
|
45 | + public function getRegisteredCustomPostTypes() |
|
46 | + { |
|
47 | + return $this->wp_post_types; |
|
48 | + } |
|
49 | 49 | |
50 | 50 | |
51 | - /** |
|
52 | - * @return void |
|
53 | - * @throws DomainException |
|
54 | - */ |
|
55 | - public function registerCustomPostTypes() |
|
56 | - { |
|
57 | - $custom_post_types = $this->custom_post_types->getDefinitions(); |
|
58 | - foreach ($custom_post_types as $custom_post_type => $CPT) { |
|
59 | - $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType( |
|
60 | - $custom_post_type, |
|
61 | - $CPT['singular_name'], |
|
62 | - $CPT['plural_name'], |
|
63 | - $CPT['singular_slug'], |
|
64 | - $CPT['plural_slug'], |
|
65 | - $CPT['args'] |
|
66 | - ); |
|
67 | - } |
|
68 | - } |
|
51 | + /** |
|
52 | + * @return void |
|
53 | + * @throws DomainException |
|
54 | + */ |
|
55 | + public function registerCustomPostTypes() |
|
56 | + { |
|
57 | + $custom_post_types = $this->custom_post_types->getDefinitions(); |
|
58 | + foreach ($custom_post_types as $custom_post_type => $CPT) { |
|
59 | + $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType( |
|
60 | + $custom_post_type, |
|
61 | + $CPT['singular_name'], |
|
62 | + $CPT['plural_name'], |
|
63 | + $CPT['singular_slug'], |
|
64 | + $CPT['plural_slug'], |
|
65 | + $CPT['args'] |
|
66 | + ); |
|
67 | + } |
|
68 | + } |
|
69 | 69 | |
70 | 70 | |
71 | - /** |
|
72 | - * Registers a new custom post type. Sets default settings given only the following params. |
|
73 | - * Returns the registered post type object, or an error object. |
|
74 | - * |
|
75 | - * @param string $post_type the actual post type name |
|
76 | - * IMPORTANT: |
|
77 | - * this must match what the slug is for admin pages related to this CPT |
|
78 | - * Also any models must use this slug as well |
|
79 | - * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
80 | - * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
81 | - * @param string $singular_slug |
|
82 | - * @param string $plural_slug |
|
83 | - * @param array $override_arguments exactly like $args as described in |
|
84 | - * http://codex.wordpress.org/Function_Reference/register_post_type |
|
85 | - * @return WP_Post_Type|WP_Error |
|
86 | - * @throws DomainException |
|
87 | - */ |
|
88 | - public function registerCustomPostType( |
|
89 | - $post_type, |
|
90 | - $singular_name, |
|
91 | - $plural_name, |
|
92 | - $singular_slug = '', |
|
93 | - $plural_slug = '', |
|
94 | - array $override_arguments = array() |
|
95 | - ) { |
|
96 | - $wp_post_type = register_post_type( |
|
97 | - $post_type, |
|
98 | - $this->prepareArguments( |
|
99 | - $post_type, |
|
100 | - $singular_name, |
|
101 | - $plural_name, |
|
102 | - $singular_slug, |
|
103 | - $plural_slug, |
|
104 | - $override_arguments |
|
105 | - ) |
|
106 | - ); |
|
107 | - if ($wp_post_type instanceof WP_Error) { |
|
108 | - throw new DomainException($wp_post_type->get_error_message()); |
|
109 | - } |
|
110 | - return $wp_post_type; |
|
111 | - } |
|
71 | + /** |
|
72 | + * Registers a new custom post type. Sets default settings given only the following params. |
|
73 | + * Returns the registered post type object, or an error object. |
|
74 | + * |
|
75 | + * @param string $post_type the actual post type name |
|
76 | + * IMPORTANT: |
|
77 | + * this must match what the slug is for admin pages related to this CPT |
|
78 | + * Also any models must use this slug as well |
|
79 | + * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
80 | + * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
81 | + * @param string $singular_slug |
|
82 | + * @param string $plural_slug |
|
83 | + * @param array $override_arguments exactly like $args as described in |
|
84 | + * http://codex.wordpress.org/Function_Reference/register_post_type |
|
85 | + * @return WP_Post_Type|WP_Error |
|
86 | + * @throws DomainException |
|
87 | + */ |
|
88 | + public function registerCustomPostType( |
|
89 | + $post_type, |
|
90 | + $singular_name, |
|
91 | + $plural_name, |
|
92 | + $singular_slug = '', |
|
93 | + $plural_slug = '', |
|
94 | + array $override_arguments = array() |
|
95 | + ) { |
|
96 | + $wp_post_type = register_post_type( |
|
97 | + $post_type, |
|
98 | + $this->prepareArguments( |
|
99 | + $post_type, |
|
100 | + $singular_name, |
|
101 | + $plural_name, |
|
102 | + $singular_slug, |
|
103 | + $plural_slug, |
|
104 | + $override_arguments |
|
105 | + ) |
|
106 | + ); |
|
107 | + if ($wp_post_type instanceof WP_Error) { |
|
108 | + throw new DomainException($wp_post_type->get_error_message()); |
|
109 | + } |
|
110 | + return $wp_post_type; |
|
111 | + } |
|
112 | 112 | |
113 | 113 | |
114 | - /** |
|
115 | - * @param string $post_type the actual post type name |
|
116 | - * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
117 | - * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
118 | - * @param string $singular_slug |
|
119 | - * @param string $plural_slug |
|
120 | - * @param array $override_arguments The default values set in this function will be overridden |
|
121 | - * by whatever you set in $override_arguments |
|
122 | - * @return array |
|
123 | - */ |
|
124 | - protected function prepareArguments( |
|
125 | - $post_type, |
|
126 | - $singular_name, |
|
127 | - $plural_name, |
|
128 | - $singular_slug, |
|
129 | - $plural_slug, |
|
130 | - array $override_arguments = array() |
|
131 | - ) { |
|
132 | - // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
133 | - $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
134 | - $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
135 | - $labels = $this->getLabels( |
|
136 | - $singular_name, |
|
137 | - $plural_name, |
|
138 | - $singular_slug, |
|
139 | - $plural_slug |
|
140 | - ); |
|
141 | - // note the page_templates arg in the supports index is something specific to EE. |
|
142 | - // WordPress doesn't actually have that in their register_post_type api. |
|
143 | - $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug); |
|
144 | - if ($override_arguments) { |
|
145 | - if (isset($override_arguments['labels'])) { |
|
146 | - $labels = array_merge($arguments['labels'], $override_arguments['labels']); |
|
147 | - } |
|
148 | - $arguments = array_merge($arguments, $override_arguments); |
|
149 | - $arguments['labels'] = $labels; |
|
150 | - } |
|
151 | - return $arguments; |
|
152 | - } |
|
114 | + /** |
|
115 | + * @param string $post_type the actual post type name |
|
116 | + * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
117 | + * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
118 | + * @param string $singular_slug |
|
119 | + * @param string $plural_slug |
|
120 | + * @param array $override_arguments The default values set in this function will be overridden |
|
121 | + * by whatever you set in $override_arguments |
|
122 | + * @return array |
|
123 | + */ |
|
124 | + protected function prepareArguments( |
|
125 | + $post_type, |
|
126 | + $singular_name, |
|
127 | + $plural_name, |
|
128 | + $singular_slug, |
|
129 | + $plural_slug, |
|
130 | + array $override_arguments = array() |
|
131 | + ) { |
|
132 | + // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
133 | + $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
134 | + $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
135 | + $labels = $this->getLabels( |
|
136 | + $singular_name, |
|
137 | + $plural_name, |
|
138 | + $singular_slug, |
|
139 | + $plural_slug |
|
140 | + ); |
|
141 | + // note the page_templates arg in the supports index is something specific to EE. |
|
142 | + // WordPress doesn't actually have that in their register_post_type api. |
|
143 | + $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug); |
|
144 | + if ($override_arguments) { |
|
145 | + if (isset($override_arguments['labels'])) { |
|
146 | + $labels = array_merge($arguments['labels'], $override_arguments['labels']); |
|
147 | + } |
|
148 | + $arguments = array_merge($arguments, $override_arguments); |
|
149 | + $arguments['labels'] = $labels; |
|
150 | + } |
|
151 | + return $arguments; |
|
152 | + } |
|
153 | 153 | |
154 | 154 | |
155 | - /** |
|
156 | - * @param string $singular_name |
|
157 | - * @param string $plural_name |
|
158 | - * @param string $singular_slug |
|
159 | - * @param string $plural_slug |
|
160 | - * @return array |
|
161 | - */ |
|
162 | - private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug) |
|
163 | - { |
|
164 | - return array( |
|
165 | - 'name' => $plural_name, |
|
166 | - 'singular_name' => $singular_name, |
|
167 | - 'singular_slug' => $singular_slug, |
|
168 | - 'plural_slug' => $plural_slug, |
|
169 | - 'add_new' => sprintf( |
|
170 | - /* Translators: Post Type Label */ |
|
171 | - esc_html_x('Add %s', 'Add Event', 'event_espresso'), |
|
172 | - $singular_name |
|
173 | - ), |
|
174 | - 'add_new_item' => sprintf( |
|
175 | - /* Translators: Post Type Label */ |
|
176 | - esc_html_x('Add New %s', 'Add New Event', 'event_espresso'), |
|
177 | - $singular_name |
|
178 | - ), |
|
179 | - 'edit_item' => sprintf( |
|
180 | - /* Translators: Post Type Label */ |
|
181 | - esc_html_x('Edit %s', 'Edit Event', 'event_espresso'), |
|
182 | - $singular_name |
|
183 | - ), |
|
184 | - 'new_item' => sprintf( |
|
185 | - /* Translators: Post Type Label */ |
|
186 | - esc_html_x('New %s', 'New Event', 'event_espresso'), |
|
187 | - $singular_name |
|
188 | - ), |
|
189 | - 'all_items' => sprintf( |
|
190 | - /* Translators: Post Type Label */ |
|
191 | - esc_html_x('All %s', 'All Events', 'event_espresso'), |
|
192 | - $plural_name |
|
193 | - ), |
|
194 | - 'view_item' => sprintf( |
|
195 | - /* Translators: Post Type Label */ |
|
196 | - esc_html_x('View %s', 'View Event', 'event_espresso'), |
|
197 | - $singular_name |
|
198 | - ), |
|
199 | - 'view_items' => sprintf( |
|
200 | - /* Translators: Post Type Label */ |
|
201 | - esc_html_x('View %s', 'View Events', 'event_espresso'), |
|
202 | - $plural_name |
|
203 | - ), |
|
204 | - 'archives' => sprintf( |
|
205 | - /* Translators: Post Type Label */ |
|
206 | - esc_html_x('%s Archives', 'Event Archives', 'event_espresso'), |
|
207 | - $singular_name |
|
208 | - ), |
|
209 | - 'attributes' => sprintf( |
|
210 | - /* Translators: Post Type Label */ |
|
211 | - esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'), |
|
212 | - $singular_name |
|
213 | - ), |
|
214 | - 'insert_into_item' => sprintf( |
|
215 | - /* Translators: Post Type Label */ |
|
216 | - esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'), |
|
217 | - $singular_name |
|
218 | - ), |
|
219 | - 'uploaded_to_this_item' => sprintf( |
|
220 | - /* Translators: Post Type Label */ |
|
221 | - esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'), |
|
222 | - $singular_name |
|
223 | - ), |
|
224 | - 'filter_items_list' => sprintf( |
|
225 | - /* Translators: Post Type Label */ |
|
226 | - esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'), |
|
227 | - $plural_name |
|
228 | - ), |
|
229 | - 'items_list_navigation' => sprintf( |
|
230 | - /* Translators: Post Type Label */ |
|
231 | - esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'), |
|
232 | - $plural_name |
|
233 | - ), |
|
234 | - 'items_list' => sprintf( |
|
235 | - /* Translators: Post Type Label */ |
|
236 | - esc_html_x('%s list', 'Events list', 'event_espresso'), |
|
237 | - $plural_name |
|
238 | - ), |
|
239 | - 'item_published' => sprintf( |
|
240 | - /* Translators: Post Type Label */ |
|
241 | - esc_html_x('%s published', 'Event published', 'event_espresso'), |
|
242 | - $singular_name |
|
243 | - ), |
|
244 | - 'item_published_privately' => sprintf( |
|
245 | - /* Translators: Post Type Label */ |
|
246 | - esc_html_x('%s published privately', 'Event published privately', 'event_espresso'), |
|
247 | - $singular_name |
|
248 | - ), |
|
249 | - 'item_reverted_to_draft' => sprintf( |
|
250 | - /* Translators: Post Type Label */ |
|
251 | - esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'), |
|
252 | - $singular_name |
|
253 | - ), |
|
254 | - 'item_scheduled' => sprintf( |
|
255 | - /* Translators: Post Type Label */ |
|
256 | - esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'), |
|
257 | - $singular_name |
|
258 | - ), |
|
259 | - 'item_updated' => sprintf( |
|
260 | - /* Translators: Post Type Label */ |
|
261 | - esc_html_x('%s updated', 'Event updated', 'event_espresso'), |
|
262 | - $singular_name |
|
263 | - ), |
|
264 | - 'search_items' => sprintf( |
|
265 | - /* Translators: Post Type Label */ |
|
266 | - esc_html_x('Search %s', 'Search Events', 'event_espresso'), |
|
267 | - $plural_name |
|
268 | - ), |
|
269 | - 'not_found' => sprintf( |
|
270 | - /* Translators: Post Type Label */ |
|
271 | - esc_html_x('No %s found', 'No Events found', 'event_espresso'), |
|
272 | - $plural_name |
|
273 | - ), |
|
274 | - 'not_found_in_trash' => sprintf( |
|
275 | - /* Translators: Post Type Label */ |
|
276 | - esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'), |
|
277 | - $plural_name |
|
278 | - ), |
|
279 | - 'parent_item_colon' => '', |
|
280 | - 'menu_name' => $plural_name, |
|
281 | - ); |
|
282 | - } |
|
155 | + /** |
|
156 | + * @param string $singular_name |
|
157 | + * @param string $plural_name |
|
158 | + * @param string $singular_slug |
|
159 | + * @param string $plural_slug |
|
160 | + * @return array |
|
161 | + */ |
|
162 | + private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug) |
|
163 | + { |
|
164 | + return array( |
|
165 | + 'name' => $plural_name, |
|
166 | + 'singular_name' => $singular_name, |
|
167 | + 'singular_slug' => $singular_slug, |
|
168 | + 'plural_slug' => $plural_slug, |
|
169 | + 'add_new' => sprintf( |
|
170 | + /* Translators: Post Type Label */ |
|
171 | + esc_html_x('Add %s', 'Add Event', 'event_espresso'), |
|
172 | + $singular_name |
|
173 | + ), |
|
174 | + 'add_new_item' => sprintf( |
|
175 | + /* Translators: Post Type Label */ |
|
176 | + esc_html_x('Add New %s', 'Add New Event', 'event_espresso'), |
|
177 | + $singular_name |
|
178 | + ), |
|
179 | + 'edit_item' => sprintf( |
|
180 | + /* Translators: Post Type Label */ |
|
181 | + esc_html_x('Edit %s', 'Edit Event', 'event_espresso'), |
|
182 | + $singular_name |
|
183 | + ), |
|
184 | + 'new_item' => sprintf( |
|
185 | + /* Translators: Post Type Label */ |
|
186 | + esc_html_x('New %s', 'New Event', 'event_espresso'), |
|
187 | + $singular_name |
|
188 | + ), |
|
189 | + 'all_items' => sprintf( |
|
190 | + /* Translators: Post Type Label */ |
|
191 | + esc_html_x('All %s', 'All Events', 'event_espresso'), |
|
192 | + $plural_name |
|
193 | + ), |
|
194 | + 'view_item' => sprintf( |
|
195 | + /* Translators: Post Type Label */ |
|
196 | + esc_html_x('View %s', 'View Event', 'event_espresso'), |
|
197 | + $singular_name |
|
198 | + ), |
|
199 | + 'view_items' => sprintf( |
|
200 | + /* Translators: Post Type Label */ |
|
201 | + esc_html_x('View %s', 'View Events', 'event_espresso'), |
|
202 | + $plural_name |
|
203 | + ), |
|
204 | + 'archives' => sprintf( |
|
205 | + /* Translators: Post Type Label */ |
|
206 | + esc_html_x('%s Archives', 'Event Archives', 'event_espresso'), |
|
207 | + $singular_name |
|
208 | + ), |
|
209 | + 'attributes' => sprintf( |
|
210 | + /* Translators: Post Type Label */ |
|
211 | + esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'), |
|
212 | + $singular_name |
|
213 | + ), |
|
214 | + 'insert_into_item' => sprintf( |
|
215 | + /* Translators: Post Type Label */ |
|
216 | + esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'), |
|
217 | + $singular_name |
|
218 | + ), |
|
219 | + 'uploaded_to_this_item' => sprintf( |
|
220 | + /* Translators: Post Type Label */ |
|
221 | + esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'), |
|
222 | + $singular_name |
|
223 | + ), |
|
224 | + 'filter_items_list' => sprintf( |
|
225 | + /* Translators: Post Type Label */ |
|
226 | + esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'), |
|
227 | + $plural_name |
|
228 | + ), |
|
229 | + 'items_list_navigation' => sprintf( |
|
230 | + /* Translators: Post Type Label */ |
|
231 | + esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'), |
|
232 | + $plural_name |
|
233 | + ), |
|
234 | + 'items_list' => sprintf( |
|
235 | + /* Translators: Post Type Label */ |
|
236 | + esc_html_x('%s list', 'Events list', 'event_espresso'), |
|
237 | + $plural_name |
|
238 | + ), |
|
239 | + 'item_published' => sprintf( |
|
240 | + /* Translators: Post Type Label */ |
|
241 | + esc_html_x('%s published', 'Event published', 'event_espresso'), |
|
242 | + $singular_name |
|
243 | + ), |
|
244 | + 'item_published_privately' => sprintf( |
|
245 | + /* Translators: Post Type Label */ |
|
246 | + esc_html_x('%s published privately', 'Event published privately', 'event_espresso'), |
|
247 | + $singular_name |
|
248 | + ), |
|
249 | + 'item_reverted_to_draft' => sprintf( |
|
250 | + /* Translators: Post Type Label */ |
|
251 | + esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'), |
|
252 | + $singular_name |
|
253 | + ), |
|
254 | + 'item_scheduled' => sprintf( |
|
255 | + /* Translators: Post Type Label */ |
|
256 | + esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'), |
|
257 | + $singular_name |
|
258 | + ), |
|
259 | + 'item_updated' => sprintf( |
|
260 | + /* Translators: Post Type Label */ |
|
261 | + esc_html_x('%s updated', 'Event updated', 'event_espresso'), |
|
262 | + $singular_name |
|
263 | + ), |
|
264 | + 'search_items' => sprintf( |
|
265 | + /* Translators: Post Type Label */ |
|
266 | + esc_html_x('Search %s', 'Search Events', 'event_espresso'), |
|
267 | + $plural_name |
|
268 | + ), |
|
269 | + 'not_found' => sprintf( |
|
270 | + /* Translators: Post Type Label */ |
|
271 | + esc_html_x('No %s found', 'No Events found', 'event_espresso'), |
|
272 | + $plural_name |
|
273 | + ), |
|
274 | + 'not_found_in_trash' => sprintf( |
|
275 | + /* Translators: Post Type Label */ |
|
276 | + esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'), |
|
277 | + $plural_name |
|
278 | + ), |
|
279 | + 'parent_item_colon' => '', |
|
280 | + 'menu_name' => $plural_name, |
|
281 | + ); |
|
282 | + } |
|
283 | 283 | |
284 | 284 | |
285 | - /** |
|
286 | - * @param array $labels |
|
287 | - * @param string $post_type |
|
288 | - * @param string $plural_slug |
|
289 | - * @return array |
|
290 | - */ |
|
291 | - private function getDefaultArguments(array $labels, $post_type, $plural_slug) |
|
292 | - { |
|
293 | - return array( |
|
294 | - 'labels' => $labels, |
|
295 | - 'public' => true, |
|
296 | - 'publicly_queryable' => true, |
|
297 | - 'show_ui' => false, |
|
298 | - 'show_ee_ui' => true, |
|
299 | - 'show_in_menu' => false, |
|
300 | - 'show_in_nav_menus' => false, |
|
301 | - 'query_var' => true, |
|
302 | - 'rewrite' => apply_filters( |
|
303 | - 'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite', |
|
304 | - // legacy filter applied for now, |
|
305 | - // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice |
|
306 | - apply_filters( |
|
307 | - 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
308 | - array('slug' => $plural_slug), |
|
309 | - $post_type |
|
310 | - ), |
|
311 | - $post_type, |
|
312 | - $plural_slug |
|
313 | - ), |
|
314 | - 'capability_type' => 'post', |
|
315 | - 'map_meta_cap' => true, |
|
316 | - 'has_archive' => true, |
|
317 | - 'hierarchical' => false, |
|
318 | - 'menu_position' => null, |
|
319 | - 'supports' => array( |
|
320 | - 'title', |
|
321 | - 'editor', |
|
322 | - 'author', |
|
323 | - 'thumbnail', |
|
324 | - 'excerpt', |
|
325 | - 'custom-fields', |
|
326 | - 'comments', |
|
327 | - ), |
|
328 | - ); |
|
329 | - } |
|
285 | + /** |
|
286 | + * @param array $labels |
|
287 | + * @param string $post_type |
|
288 | + * @param string $plural_slug |
|
289 | + * @return array |
|
290 | + */ |
|
291 | + private function getDefaultArguments(array $labels, $post_type, $plural_slug) |
|
292 | + { |
|
293 | + return array( |
|
294 | + 'labels' => $labels, |
|
295 | + 'public' => true, |
|
296 | + 'publicly_queryable' => true, |
|
297 | + 'show_ui' => false, |
|
298 | + 'show_ee_ui' => true, |
|
299 | + 'show_in_menu' => false, |
|
300 | + 'show_in_nav_menus' => false, |
|
301 | + 'query_var' => true, |
|
302 | + 'rewrite' => apply_filters( |
|
303 | + 'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite', |
|
304 | + // legacy filter applied for now, |
|
305 | + // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice |
|
306 | + apply_filters( |
|
307 | + 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
308 | + array('slug' => $plural_slug), |
|
309 | + $post_type |
|
310 | + ), |
|
311 | + $post_type, |
|
312 | + $plural_slug |
|
313 | + ), |
|
314 | + 'capability_type' => 'post', |
|
315 | + 'map_meta_cap' => true, |
|
316 | + 'has_archive' => true, |
|
317 | + 'hierarchical' => false, |
|
318 | + 'menu_position' => null, |
|
319 | + 'supports' => array( |
|
320 | + 'title', |
|
321 | + 'editor', |
|
322 | + 'author', |
|
323 | + 'thumbnail', |
|
324 | + 'excerpt', |
|
325 | + 'custom-fields', |
|
326 | + 'comments', |
|
327 | + ), |
|
328 | + ); |
|
329 | + } |
|
330 | 330 | } |
@@ -136,7 +136,7 @@ discard block |
||
136 | 136 | */ |
137 | 137 | public function distributionAssetsPath() |
138 | 138 | { |
139 | - return $this->pluginPath() . 'assets/dist/'; |
|
139 | + return $this->pluginPath().'assets/dist/'; |
|
140 | 140 | } |
141 | 141 | |
142 | 142 | |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | */ |
146 | 146 | public function distributionAssetsUrl() |
147 | 147 | { |
148 | - return $this->pluginUrl() . 'assets/dist/'; |
|
148 | + return $this->pluginUrl().'assets/dist/'; |
|
149 | 149 | } |
150 | 150 | |
151 | 151 |
@@ -16,153 +16,153 @@ |
||
16 | 16 | */ |
17 | 17 | abstract class DomainBase implements DomainInterface |
18 | 18 | { |
19 | - /** |
|
20 | - * Equivalent to `__FILE__` for main plugin file. |
|
21 | - * |
|
22 | - * @var FilePath |
|
23 | - */ |
|
24 | - private $plugin_file; |
|
25 | - |
|
26 | - /** |
|
27 | - * String indicating version for plugin |
|
28 | - * |
|
29 | - * @var string |
|
30 | - */ |
|
31 | - private $version; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var string $plugin_basename |
|
35 | - */ |
|
36 | - private $plugin_basename; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var string $plugin_path |
|
40 | - */ |
|
41 | - private $plugin_path; |
|
42 | - |
|
43 | - /** |
|
44 | - * @var string $plugin_url |
|
45 | - */ |
|
46 | - private $plugin_url; |
|
47 | - |
|
48 | - /** |
|
49 | - * @var string $asset_namespace |
|
50 | - */ |
|
51 | - private $asset_namespace; |
|
52 | - |
|
53 | - |
|
54 | - |
|
55 | - /** |
|
56 | - * Initializes internal properties. |
|
57 | - * |
|
58 | - * @param FilePath $plugin_file |
|
59 | - * @param Version $version |
|
60 | - */ |
|
61 | - public function __construct(FilePath $plugin_file, Version $version) |
|
62 | - { |
|
63 | - $this->plugin_file = $plugin_file; |
|
64 | - $this->version = $version; |
|
65 | - $this->plugin_basename = plugin_basename($this->pluginFile()); |
|
66 | - $this->plugin_path = plugin_dir_path($this->pluginFile()); |
|
67 | - $this->plugin_url = plugin_dir_url($this->pluginFile()); |
|
68 | - $this->setAssetNamespace(); |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @return string |
|
74 | - */ |
|
75 | - public function pluginFile() |
|
76 | - { |
|
77 | - return (string) $this->plugin_file; |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * @return string |
|
84 | - */ |
|
85 | - public function pluginBasename() |
|
86 | - { |
|
87 | - return $this->plugin_basename; |
|
88 | - } |
|
89 | - |
|
90 | - |
|
91 | - |
|
92 | - /** |
|
93 | - * @return string |
|
94 | - */ |
|
95 | - public function pluginPath() |
|
96 | - { |
|
97 | - return $this->plugin_path; |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - |
|
102 | - /** |
|
103 | - * @return string |
|
104 | - */ |
|
105 | - public function pluginUrl() |
|
106 | - { |
|
107 | - return $this->plugin_url; |
|
108 | - } |
|
109 | - |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * @return string |
|
114 | - */ |
|
115 | - public function version() |
|
116 | - { |
|
117 | - return (string) $this->version; |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * @return Version |
|
124 | - */ |
|
125 | - public function versionValueObject() |
|
126 | - { |
|
127 | - return $this->version; |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - /** |
|
132 | - * @return string |
|
133 | - */ |
|
134 | - public function distributionAssetsPath() |
|
135 | - { |
|
136 | - return $this->pluginPath() . 'assets/dist/'; |
|
137 | - } |
|
138 | - |
|
139 | - |
|
140 | - /** |
|
141 | - * @return string |
|
142 | - */ |
|
143 | - public function distributionAssetsUrl() |
|
144 | - { |
|
145 | - return $this->pluginUrl() . 'assets/dist/'; |
|
146 | - } |
|
147 | - |
|
148 | - |
|
149 | - /** |
|
150 | - * @return string |
|
151 | - */ |
|
152 | - public function assetNamespace() |
|
153 | - { |
|
154 | - return $this->asset_namespace; |
|
155 | - } |
|
156 | - |
|
157 | - |
|
158 | - /** |
|
159 | - * @return void |
|
160 | - */ |
|
161 | - private function setAssetNamespace() |
|
162 | - { |
|
163 | - $this->asset_namespace = sanitize_key( |
|
164 | - // convert directory separators to dashes and remove file extension |
|
165 | - str_replace(array('/', '.php'), array('-', ''), $this->plugin_basename) |
|
166 | - ); |
|
167 | - } |
|
19 | + /** |
|
20 | + * Equivalent to `__FILE__` for main plugin file. |
|
21 | + * |
|
22 | + * @var FilePath |
|
23 | + */ |
|
24 | + private $plugin_file; |
|
25 | + |
|
26 | + /** |
|
27 | + * String indicating version for plugin |
|
28 | + * |
|
29 | + * @var string |
|
30 | + */ |
|
31 | + private $version; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var string $plugin_basename |
|
35 | + */ |
|
36 | + private $plugin_basename; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var string $plugin_path |
|
40 | + */ |
|
41 | + private $plugin_path; |
|
42 | + |
|
43 | + /** |
|
44 | + * @var string $plugin_url |
|
45 | + */ |
|
46 | + private $plugin_url; |
|
47 | + |
|
48 | + /** |
|
49 | + * @var string $asset_namespace |
|
50 | + */ |
|
51 | + private $asset_namespace; |
|
52 | + |
|
53 | + |
|
54 | + |
|
55 | + /** |
|
56 | + * Initializes internal properties. |
|
57 | + * |
|
58 | + * @param FilePath $plugin_file |
|
59 | + * @param Version $version |
|
60 | + */ |
|
61 | + public function __construct(FilePath $plugin_file, Version $version) |
|
62 | + { |
|
63 | + $this->plugin_file = $plugin_file; |
|
64 | + $this->version = $version; |
|
65 | + $this->plugin_basename = plugin_basename($this->pluginFile()); |
|
66 | + $this->plugin_path = plugin_dir_path($this->pluginFile()); |
|
67 | + $this->plugin_url = plugin_dir_url($this->pluginFile()); |
|
68 | + $this->setAssetNamespace(); |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @return string |
|
74 | + */ |
|
75 | + public function pluginFile() |
|
76 | + { |
|
77 | + return (string) $this->plugin_file; |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * @return string |
|
84 | + */ |
|
85 | + public function pluginBasename() |
|
86 | + { |
|
87 | + return $this->plugin_basename; |
|
88 | + } |
|
89 | + |
|
90 | + |
|
91 | + |
|
92 | + /** |
|
93 | + * @return string |
|
94 | + */ |
|
95 | + public function pluginPath() |
|
96 | + { |
|
97 | + return $this->plugin_path; |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + |
|
102 | + /** |
|
103 | + * @return string |
|
104 | + */ |
|
105 | + public function pluginUrl() |
|
106 | + { |
|
107 | + return $this->plugin_url; |
|
108 | + } |
|
109 | + |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * @return string |
|
114 | + */ |
|
115 | + public function version() |
|
116 | + { |
|
117 | + return (string) $this->version; |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * @return Version |
|
124 | + */ |
|
125 | + public function versionValueObject() |
|
126 | + { |
|
127 | + return $this->version; |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + /** |
|
132 | + * @return string |
|
133 | + */ |
|
134 | + public function distributionAssetsPath() |
|
135 | + { |
|
136 | + return $this->pluginPath() . 'assets/dist/'; |
|
137 | + } |
|
138 | + |
|
139 | + |
|
140 | + /** |
|
141 | + * @return string |
|
142 | + */ |
|
143 | + public function distributionAssetsUrl() |
|
144 | + { |
|
145 | + return $this->pluginUrl() . 'assets/dist/'; |
|
146 | + } |
|
147 | + |
|
148 | + |
|
149 | + /** |
|
150 | + * @return string |
|
151 | + */ |
|
152 | + public function assetNamespace() |
|
153 | + { |
|
154 | + return $this->asset_namespace; |
|
155 | + } |
|
156 | + |
|
157 | + |
|
158 | + /** |
|
159 | + * @return void |
|
160 | + */ |
|
161 | + private function setAssetNamespace() |
|
162 | + { |
|
163 | + $this->asset_namespace = sanitize_key( |
|
164 | + // convert directory separators to dashes and remove file extension |
|
165 | + str_replace(array('/', '.php'), array('-', ''), $this->plugin_basename) |
|
166 | + ); |
|
167 | + } |
|
168 | 168 | } |
@@ -16,26 +16,26 @@ |
||
16 | 16 | class ManifestFile extends Asset |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * Asset constructor. |
|
21 | - * |
|
22 | - * @param DomainInterface $domain |
|
23 | - * @throws InvalidDataTypeException |
|
24 | - */ |
|
25 | - public function __construct(DomainInterface $domain) |
|
26 | - { |
|
27 | - parent::__construct(Asset::TYPE_MANIFEST, $domain->assetNamespace(), $domain); |
|
28 | - } |
|
29 | - |
|
30 | - |
|
31 | - public function urlBase() |
|
32 | - { |
|
33 | - return $this->domain->distributionAssetsUrl(); |
|
34 | - } |
|
35 | - |
|
36 | - |
|
37 | - public function filepath() |
|
38 | - { |
|
39 | - return $this->domain->distributionAssetsPath(); |
|
40 | - } |
|
19 | + /** |
|
20 | + * Asset constructor. |
|
21 | + * |
|
22 | + * @param DomainInterface $domain |
|
23 | + * @throws InvalidDataTypeException |
|
24 | + */ |
|
25 | + public function __construct(DomainInterface $domain) |
|
26 | + { |
|
27 | + parent::__construct(Asset::TYPE_MANIFEST, $domain->assetNamespace(), $domain); |
|
28 | + } |
|
29 | + |
|
30 | + |
|
31 | + public function urlBase() |
|
32 | + { |
|
33 | + return $this->domain->distributionAssetsUrl(); |
|
34 | + } |
|
35 | + |
|
36 | + |
|
37 | + public function filepath() |
|
38 | + { |
|
39 | + return $this->domain->distributionAssetsPath(); |
|
40 | + } |
|
41 | 41 | } |
@@ -82,7 +82,7 @@ discard block |
||
82 | 82 | */ |
83 | 83 | private function setType($type) |
84 | 84 | { |
85 | - if (! in_array($type, $this->validAssetTypes(), true)) { |
|
85 | + if ( ! in_array($type, $this->validAssetTypes(), true)) { |
|
86 | 86 | throw new InvalidDataTypeException( |
87 | 87 | 'Asset::$type', |
88 | 88 | $type, |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | */ |
100 | 100 | private function setHandle($handle) |
101 | 101 | { |
102 | - if (! is_string($handle)) { |
|
102 | + if ( ! is_string($handle)) { |
|
103 | 103 | throw new InvalidDataTypeException( |
104 | 104 | '$handle', |
105 | 105 | $handle, |
@@ -15,183 +15,183 @@ |
||
15 | 15 | */ |
16 | 16 | abstract class Asset |
17 | 17 | { |
18 | - /** |
|
19 | - * indicates the file extension for a CSS file |
|
20 | - */ |
|
21 | - const EXT_CSS = '.css'; |
|
22 | - |
|
23 | - /** |
|
24 | - * indicates the file extension for a JS file |
|
25 | - */ |
|
26 | - const EXT_JS = '.js'; |
|
27 | - |
|
28 | - /** |
|
29 | - * indicates the file extension for a JS file |
|
30 | - */ |
|
31 | - const EXT_PHP = '.php'; |
|
32 | - |
|
33 | - /** |
|
34 | - * indicates the file extension for a build distribution CSS file |
|
35 | - */ |
|
36 | - const FILE_EXTENSION_DISTRIBUTION_CSS = '.dist.css'; |
|
37 | - |
|
38 | - /** |
|
39 | - * indicates the file extension for a build distribution JS file |
|
40 | - */ |
|
41 | - const FILE_EXTENSION_DISTRIBUTION_JS = '.dist.js'; |
|
42 | - |
|
43 | - /** |
|
44 | - * Indicates the file extension for a build distribution dependencies json file. |
|
45 | - */ |
|
46 | - const FILE_EXTENSION_DISTRIBUTION_DEPS = '.dist.deps.php'; |
|
47 | - |
|
48 | - /** |
|
49 | - * indicates a Cascading Style Sheet asset |
|
50 | - */ |
|
51 | - const TYPE_CSS = 'css'; |
|
52 | - |
|
53 | - /** |
|
54 | - * indicates a Javascript asset |
|
55 | - */ |
|
56 | - const TYPE_JS = 'js'; |
|
57 | - |
|
58 | - /** |
|
59 | - * indicates a JSON asset |
|
60 | - */ |
|
61 | - CONST TYPE_JSON = 'json'; |
|
62 | - /** |
|
63 | - * indicates a PHP asset |
|
64 | - */ |
|
65 | - CONST TYPE_PHP = 'php'; |
|
66 | - |
|
67 | - /** |
|
68 | - * indicates a Javascript manifest file |
|
69 | - */ |
|
70 | - const TYPE_MANIFEST = 'manifest'; |
|
71 | - |
|
72 | - /** |
|
73 | - * @var DomainInterface $domain |
|
74 | - */ |
|
75 | - protected $domain; |
|
76 | - |
|
77 | - /** |
|
78 | - * @var string $type |
|
79 | - */ |
|
80 | - private $type; |
|
81 | - |
|
82 | - /** |
|
83 | - * @var string $handle |
|
84 | - */ |
|
85 | - private $handle; |
|
86 | - |
|
87 | - /** |
|
88 | - * @var bool $registered |
|
89 | - */ |
|
90 | - private $registered = false; |
|
91 | - |
|
92 | - |
|
93 | - /** |
|
94 | - * Asset constructor. |
|
95 | - * |
|
96 | - * @param $type |
|
97 | - * @param string $handle |
|
98 | - * @param DomainInterface $domain |
|
99 | - * @throws InvalidDataTypeException |
|
100 | - */ |
|
101 | - public function __construct($type, $handle, DomainInterface $domain) |
|
102 | - { |
|
103 | - $this->domain = $domain; |
|
104 | - $this->setType($type); |
|
105 | - $this->setHandle($handle); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @return array |
|
111 | - */ |
|
112 | - public function validAssetTypes() |
|
113 | - { |
|
114 | - return array( |
|
115 | - Asset::TYPE_CSS, |
|
116 | - Asset::TYPE_JS, |
|
117 | - Asset::TYPE_MANIFEST, |
|
118 | - ); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * @param string $type |
|
124 | - * @throws InvalidDataTypeException |
|
125 | - */ |
|
126 | - private function setType($type) |
|
127 | - { |
|
128 | - if (! in_array($type, $this->validAssetTypes(), true)) { |
|
129 | - throw new InvalidDataTypeException( |
|
130 | - 'Asset::$type', |
|
131 | - $type, |
|
132 | - 'one of the TYPE_* class constants on \EventEspresso\core\domain\values\Asset is required' |
|
133 | - ); |
|
134 | - } |
|
135 | - $this->type = $type; |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @param string $handle |
|
141 | - * @throws InvalidDataTypeException |
|
142 | - */ |
|
143 | - private function setHandle($handle) |
|
144 | - { |
|
145 | - if (! is_string($handle)) { |
|
146 | - throw new InvalidDataTypeException( |
|
147 | - '$handle', |
|
148 | - $handle, |
|
149 | - 'string' |
|
150 | - ); |
|
151 | - } |
|
152 | - $this->handle = $handle; |
|
153 | - } |
|
154 | - |
|
155 | - |
|
156 | - /** |
|
157 | - * @return string |
|
158 | - */ |
|
159 | - public function assetNamespace() |
|
160 | - { |
|
161 | - return $this->domain->assetNamespace(); |
|
162 | - } |
|
163 | - |
|
164 | - |
|
165 | - /** |
|
166 | - * @return string |
|
167 | - */ |
|
168 | - public function type() |
|
169 | - { |
|
170 | - return $this->type; |
|
171 | - } |
|
172 | - |
|
173 | - |
|
174 | - /** |
|
175 | - * @return string |
|
176 | - */ |
|
177 | - public function handle() |
|
178 | - { |
|
179 | - return $this->handle; |
|
180 | - } |
|
181 | - |
|
182 | - /** |
|
183 | - * @return bool |
|
184 | - */ |
|
185 | - public function isRegistered() |
|
186 | - { |
|
187 | - return $this->registered; |
|
188 | - } |
|
189 | - |
|
190 | - /** |
|
191 | - * @param bool $registered |
|
192 | - */ |
|
193 | - public function setRegistered($registered = true) |
|
194 | - { |
|
195 | - $this->registered = filter_var($registered, FILTER_VALIDATE_BOOLEAN); |
|
196 | - } |
|
18 | + /** |
|
19 | + * indicates the file extension for a CSS file |
|
20 | + */ |
|
21 | + const EXT_CSS = '.css'; |
|
22 | + |
|
23 | + /** |
|
24 | + * indicates the file extension for a JS file |
|
25 | + */ |
|
26 | + const EXT_JS = '.js'; |
|
27 | + |
|
28 | + /** |
|
29 | + * indicates the file extension for a JS file |
|
30 | + */ |
|
31 | + const EXT_PHP = '.php'; |
|
32 | + |
|
33 | + /** |
|
34 | + * indicates the file extension for a build distribution CSS file |
|
35 | + */ |
|
36 | + const FILE_EXTENSION_DISTRIBUTION_CSS = '.dist.css'; |
|
37 | + |
|
38 | + /** |
|
39 | + * indicates the file extension for a build distribution JS file |
|
40 | + */ |
|
41 | + const FILE_EXTENSION_DISTRIBUTION_JS = '.dist.js'; |
|
42 | + |
|
43 | + /** |
|
44 | + * Indicates the file extension for a build distribution dependencies json file. |
|
45 | + */ |
|
46 | + const FILE_EXTENSION_DISTRIBUTION_DEPS = '.dist.deps.php'; |
|
47 | + |
|
48 | + /** |
|
49 | + * indicates a Cascading Style Sheet asset |
|
50 | + */ |
|
51 | + const TYPE_CSS = 'css'; |
|
52 | + |
|
53 | + /** |
|
54 | + * indicates a Javascript asset |
|
55 | + */ |
|
56 | + const TYPE_JS = 'js'; |
|
57 | + |
|
58 | + /** |
|
59 | + * indicates a JSON asset |
|
60 | + */ |
|
61 | + CONST TYPE_JSON = 'json'; |
|
62 | + /** |
|
63 | + * indicates a PHP asset |
|
64 | + */ |
|
65 | + CONST TYPE_PHP = 'php'; |
|
66 | + |
|
67 | + /** |
|
68 | + * indicates a Javascript manifest file |
|
69 | + */ |
|
70 | + const TYPE_MANIFEST = 'manifest'; |
|
71 | + |
|
72 | + /** |
|
73 | + * @var DomainInterface $domain |
|
74 | + */ |
|
75 | + protected $domain; |
|
76 | + |
|
77 | + /** |
|
78 | + * @var string $type |
|
79 | + */ |
|
80 | + private $type; |
|
81 | + |
|
82 | + /** |
|
83 | + * @var string $handle |
|
84 | + */ |
|
85 | + private $handle; |
|
86 | + |
|
87 | + /** |
|
88 | + * @var bool $registered |
|
89 | + */ |
|
90 | + private $registered = false; |
|
91 | + |
|
92 | + |
|
93 | + /** |
|
94 | + * Asset constructor. |
|
95 | + * |
|
96 | + * @param $type |
|
97 | + * @param string $handle |
|
98 | + * @param DomainInterface $domain |
|
99 | + * @throws InvalidDataTypeException |
|
100 | + */ |
|
101 | + public function __construct($type, $handle, DomainInterface $domain) |
|
102 | + { |
|
103 | + $this->domain = $domain; |
|
104 | + $this->setType($type); |
|
105 | + $this->setHandle($handle); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @return array |
|
111 | + */ |
|
112 | + public function validAssetTypes() |
|
113 | + { |
|
114 | + return array( |
|
115 | + Asset::TYPE_CSS, |
|
116 | + Asset::TYPE_JS, |
|
117 | + Asset::TYPE_MANIFEST, |
|
118 | + ); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * @param string $type |
|
124 | + * @throws InvalidDataTypeException |
|
125 | + */ |
|
126 | + private function setType($type) |
|
127 | + { |
|
128 | + if (! in_array($type, $this->validAssetTypes(), true)) { |
|
129 | + throw new InvalidDataTypeException( |
|
130 | + 'Asset::$type', |
|
131 | + $type, |
|
132 | + 'one of the TYPE_* class constants on \EventEspresso\core\domain\values\Asset is required' |
|
133 | + ); |
|
134 | + } |
|
135 | + $this->type = $type; |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @param string $handle |
|
141 | + * @throws InvalidDataTypeException |
|
142 | + */ |
|
143 | + private function setHandle($handle) |
|
144 | + { |
|
145 | + if (! is_string($handle)) { |
|
146 | + throw new InvalidDataTypeException( |
|
147 | + '$handle', |
|
148 | + $handle, |
|
149 | + 'string' |
|
150 | + ); |
|
151 | + } |
|
152 | + $this->handle = $handle; |
|
153 | + } |
|
154 | + |
|
155 | + |
|
156 | + /** |
|
157 | + * @return string |
|
158 | + */ |
|
159 | + public function assetNamespace() |
|
160 | + { |
|
161 | + return $this->domain->assetNamespace(); |
|
162 | + } |
|
163 | + |
|
164 | + |
|
165 | + /** |
|
166 | + * @return string |
|
167 | + */ |
|
168 | + public function type() |
|
169 | + { |
|
170 | + return $this->type; |
|
171 | + } |
|
172 | + |
|
173 | + |
|
174 | + /** |
|
175 | + * @return string |
|
176 | + */ |
|
177 | + public function handle() |
|
178 | + { |
|
179 | + return $this->handle; |
|
180 | + } |
|
181 | + |
|
182 | + /** |
|
183 | + * @return bool |
|
184 | + */ |
|
185 | + public function isRegistered() |
|
186 | + { |
|
187 | + return $this->registered; |
|
188 | + } |
|
189 | + |
|
190 | + /** |
|
191 | + * @param bool $registered |
|
192 | + */ |
|
193 | + public function setRegistered($registered = true) |
|
194 | + { |
|
195 | + $this->registered = filter_var($registered, FILTER_VALIDATE_BOOLEAN); |
|
196 | + } |
|
197 | 197 | } |
@@ -54,7 +54,7 @@ |
||
54 | 54 | */ |
55 | 55 | private function setMedia($media) |
56 | 56 | { |
57 | - if (! is_string($media)) { |
|
57 | + if ( ! is_string($media)) { |
|
58 | 58 | throw new InvalidDataTypeException( |
59 | 59 | '$media', |
60 | 60 | $media, |
@@ -17,68 +17,68 @@ |
||
17 | 17 | class StylesheetAsset extends BrowserAsset |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var string $media |
|
22 | - */ |
|
23 | - private $media; |
|
20 | + /** |
|
21 | + * @var string $media |
|
22 | + */ |
|
23 | + private $media; |
|
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * CssFile constructor. |
|
28 | - * |
|
29 | - * @param $handle |
|
30 | - * @param string $source |
|
31 | - * @param array $dependencies |
|
32 | - * @param DomainInterface $domain |
|
33 | - * @param string $media |
|
34 | - * @param string $version |
|
35 | - * @throws InvalidDataTypeException |
|
36 | - * @throws DomainException |
|
37 | - */ |
|
38 | - public function __construct( |
|
39 | - $handle, |
|
40 | - $source, |
|
41 | - array $dependencies, |
|
42 | - DomainInterface $domain, |
|
43 | - $media = 'all', |
|
44 | - $version = '' |
|
45 | - ) { |
|
46 | - parent::__construct(Asset::TYPE_CSS, $handle, $source, $dependencies, $domain, $version); |
|
47 | - $this->setMedia($media); |
|
48 | - } |
|
26 | + /** |
|
27 | + * CssFile constructor. |
|
28 | + * |
|
29 | + * @param $handle |
|
30 | + * @param string $source |
|
31 | + * @param array $dependencies |
|
32 | + * @param DomainInterface $domain |
|
33 | + * @param string $media |
|
34 | + * @param string $version |
|
35 | + * @throws InvalidDataTypeException |
|
36 | + * @throws DomainException |
|
37 | + */ |
|
38 | + public function __construct( |
|
39 | + $handle, |
|
40 | + $source, |
|
41 | + array $dependencies, |
|
42 | + DomainInterface $domain, |
|
43 | + $media = 'all', |
|
44 | + $version = '' |
|
45 | + ) { |
|
46 | + parent::__construct(Asset::TYPE_CSS, $handle, $source, $dependencies, $domain, $version); |
|
47 | + $this->setMedia($media); |
|
48 | + } |
|
49 | 49 | |
50 | 50 | |
51 | - /** |
|
52 | - * @return string |
|
53 | - */ |
|
54 | - public function media() |
|
55 | - { |
|
56 | - return $this->media; |
|
57 | - } |
|
51 | + /** |
|
52 | + * @return string |
|
53 | + */ |
|
54 | + public function media() |
|
55 | + { |
|
56 | + return $this->media; |
|
57 | + } |
|
58 | 58 | |
59 | 59 | |
60 | - /** |
|
61 | - * @param string $media |
|
62 | - * @throws InvalidDataTypeException |
|
63 | - */ |
|
64 | - private function setMedia($media) |
|
65 | - { |
|
66 | - if (! is_string($media)) { |
|
67 | - throw new InvalidDataTypeException( |
|
68 | - '$media', |
|
69 | - $media, |
|
70 | - 'string' |
|
71 | - ); |
|
72 | - } |
|
73 | - $this->media = $media; |
|
74 | - } |
|
60 | + /** |
|
61 | + * @param string $media |
|
62 | + * @throws InvalidDataTypeException |
|
63 | + */ |
|
64 | + private function setMedia($media) |
|
65 | + { |
|
66 | + if (! is_string($media)) { |
|
67 | + throw new InvalidDataTypeException( |
|
68 | + '$media', |
|
69 | + $media, |
|
70 | + 'string' |
|
71 | + ); |
|
72 | + } |
|
73 | + $this->media = $media; |
|
74 | + } |
|
75 | 75 | |
76 | 76 | |
77 | - /** |
|
78 | - * @since 4.9.62.p |
|
79 | - */ |
|
80 | - public function enqueueAsset() |
|
81 | - { |
|
82 | - wp_enqueue_style($this->handle()); |
|
83 | - } |
|
77 | + /** |
|
78 | + * @since 4.9.62.p |
|
79 | + */ |
|
80 | + public function enqueueAsset() |
|
81 | + { |
|
82 | + wp_enqueue_style($this->handle()); |
|
83 | + } |
|
84 | 84 | } |
@@ -35,6 +35,6 @@ |
||
35 | 35 | */ |
36 | 36 | public static function getIdBase($widget_class) |
37 | 37 | { |
38 | - return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget'; |
|
38 | + return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)).'-widget'; |
|
39 | 39 | } |
40 | 40 | } |
@@ -11,28 +11,28 @@ |
||
11 | 11 | */ |
12 | 12 | class EspressoWidget extends \WP_Widget |
13 | 13 | { |
14 | - /** |
|
15 | - * @param string $name |
|
16 | - * @param array $widget_options |
|
17 | - * @param array $control_options |
|
18 | - */ |
|
19 | - public function __construct($name = '', array $widget_options = array(), array $control_options = array()) |
|
20 | - { |
|
21 | - $id_base = EspressoWidget::getIdBase(get_class($this)); |
|
22 | - $control_options['id_base'] = $id_base; |
|
23 | - $control_options['height'] = isset($control_options['height']) ? $control_options['height'] : 300; |
|
24 | - $control_options['width'] = isset($control_options['width']) ? $control_options['width'] : 350; |
|
25 | - // Register widget with WordPress |
|
26 | - parent::__construct($id_base, $name, $widget_options, $control_options); |
|
27 | - } |
|
14 | + /** |
|
15 | + * @param string $name |
|
16 | + * @param array $widget_options |
|
17 | + * @param array $control_options |
|
18 | + */ |
|
19 | + public function __construct($name = '', array $widget_options = array(), array $control_options = array()) |
|
20 | + { |
|
21 | + $id_base = EspressoWidget::getIdBase(get_class($this)); |
|
22 | + $control_options['id_base'] = $id_base; |
|
23 | + $control_options['height'] = isset($control_options['height']) ? $control_options['height'] : 300; |
|
24 | + $control_options['width'] = isset($control_options['width']) ? $control_options['width'] : 350; |
|
25 | + // Register widget with WordPress |
|
26 | + parent::__construct($id_base, $name, $widget_options, $control_options); |
|
27 | + } |
|
28 | 28 | |
29 | 29 | |
30 | - /** |
|
31 | - * @param string $widget_class |
|
32 | - * @return string |
|
33 | - */ |
|
34 | - public static function getIdBase($widget_class) |
|
35 | - { |
|
36 | - return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget'; |
|
37 | - } |
|
30 | + /** |
|
31 | + * @param string $widget_class |
|
32 | + * @return string |
|
33 | + */ |
|
34 | + public static function getIdBase($widget_class) |
|
35 | + { |
|
36 | + return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget'; |
|
37 | + } |
|
38 | 38 | } |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | $this |
61 | 61 | ) |
62 | 62 | ); |
63 | - if (! apply_filters('FHEE__EED_Ticket_Selector__ticket_selector_iframe__load_theme_css', false, $this)) { |
|
63 | + if ( ! apply_filters('FHEE__EED_Ticket_Selector__ticket_selector_iframe__load_theme_css', false, $this)) { |
|
64 | 64 | $this->addStylesheets(array('site_theme' => '')); |
65 | 65 | } |
66 | 66 | $this->addScripts( |
@@ -79,7 +79,7 @@ discard block |
||
79 | 79 | array(), |
80 | 80 | $this |
81 | 81 | ); |
82 | - if (! empty($js_attributes)) { |
|
82 | + if ( ! empty($js_attributes)) { |
|
83 | 83 | $this->addScriptAttributes($js_attributes); |
84 | 84 | } |
85 | 85 | $this->addLocalizedVars( |
@@ -19,77 +19,77 @@ |
||
19 | 19 | */ |
20 | 20 | class TicketSelectorIframe extends Iframe |
21 | 21 | { |
22 | - /** |
|
23 | - * TicketSelectorIframe constructor. |
|
24 | - * |
|
25 | - * @param EEM_Event $event_model |
|
26 | - * @param CurrentPage $current_page |
|
27 | - * @param RequestInterface $request |
|
28 | - * @throws EE_Error |
|
29 | - */ |
|
30 | - public function __construct(EEM_Event $event_model, CurrentPage $current_page, RequestInterface $request) |
|
31 | - { |
|
32 | - $current_page->setEspressoPage(true); |
|
33 | - $ticket_selector = LoaderFactory::getLoader()->getNew(DisplayTicketSelector::class); |
|
34 | - $ticket_selector->setIframe(); |
|
35 | - $event = $event_model->get_one_by_ID($request->getRequestParam('event', 0, 'int')); |
|
36 | - parent::__construct( |
|
37 | - esc_html__('Ticket Selector', 'event_espresso'), |
|
38 | - $ticket_selector->display($event) |
|
39 | - ); |
|
40 | - $this->addStylesheets( |
|
41 | - apply_filters( |
|
42 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css', |
|
43 | - array( |
|
44 | - 'ticket_selector_embed' => TICKET_SELECTOR_ASSETS_URL |
|
45 | - . 'ticket_selector_embed.css?ver=' |
|
46 | - . EVENT_ESPRESSO_VERSION, |
|
47 | - 'ticket_selector' => TICKET_SELECTOR_ASSETS_URL |
|
48 | - . 'ticket_selector.css?ver=' |
|
49 | - . EVENT_ESPRESSO_VERSION, |
|
50 | - ), |
|
51 | - $this |
|
52 | - ) |
|
53 | - ); |
|
54 | - if (! apply_filters('FHEE__EED_Ticket_Selector__ticket_selector_iframe__load_theme_css', false, $this)) { |
|
55 | - $this->addStylesheets(array('site_theme' => '')); |
|
56 | - } |
|
57 | - $this->addScripts( |
|
58 | - apply_filters( |
|
59 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
60 | - array( |
|
61 | - 'ticket_selector_iframe_embed' => TICKET_SELECTOR_ASSETS_URL |
|
62 | - . 'ticket_selector_iframe_embed.js?ver=' |
|
63 | - . EVENT_ESPRESSO_VERSION, |
|
64 | - ), |
|
65 | - $this |
|
66 | - ) |
|
67 | - ); |
|
68 | - $js_attributes = apply_filters( |
|
69 | - 'FHEE__EventEspresso_modules_ticket_selector_TicketSelectorIframe__construct__js_attributes', |
|
70 | - array(), |
|
71 | - $this |
|
72 | - ); |
|
73 | - if (! empty($js_attributes)) { |
|
74 | - $this->addScriptAttributes($js_attributes); |
|
75 | - } |
|
76 | - $this->addLocalizedVars( |
|
77 | - apply_filters( |
|
78 | - 'FHEE__EventEspresso_modules_ticket_selector_TicketSelectorIframe__construct__localized_vars', |
|
79 | - array( |
|
80 | - 'ticket_selector_iframe' => true, |
|
81 | - 'EEDTicketSelectorMsg' => wp_strip_all_tags( |
|
82 | - __( |
|
83 | - 'Please choose at least one ticket before continuing.', |
|
84 | - 'event_espresso' |
|
85 | - ) |
|
86 | - ), |
|
87 | - ) |
|
88 | - ) |
|
89 | - ); |
|
90 | - do_action( |
|
91 | - 'AHEE__EventEspresso_modules_ticket_selector_TicketSelectorIframe__construct__complete', |
|
92 | - $this |
|
93 | - ); |
|
94 | - } |
|
22 | + /** |
|
23 | + * TicketSelectorIframe constructor. |
|
24 | + * |
|
25 | + * @param EEM_Event $event_model |
|
26 | + * @param CurrentPage $current_page |
|
27 | + * @param RequestInterface $request |
|
28 | + * @throws EE_Error |
|
29 | + */ |
|
30 | + public function __construct(EEM_Event $event_model, CurrentPage $current_page, RequestInterface $request) |
|
31 | + { |
|
32 | + $current_page->setEspressoPage(true); |
|
33 | + $ticket_selector = LoaderFactory::getLoader()->getNew(DisplayTicketSelector::class); |
|
34 | + $ticket_selector->setIframe(); |
|
35 | + $event = $event_model->get_one_by_ID($request->getRequestParam('event', 0, 'int')); |
|
36 | + parent::__construct( |
|
37 | + esc_html__('Ticket Selector', 'event_espresso'), |
|
38 | + $ticket_selector->display($event) |
|
39 | + ); |
|
40 | + $this->addStylesheets( |
|
41 | + apply_filters( |
|
42 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css', |
|
43 | + array( |
|
44 | + 'ticket_selector_embed' => TICKET_SELECTOR_ASSETS_URL |
|
45 | + . 'ticket_selector_embed.css?ver=' |
|
46 | + . EVENT_ESPRESSO_VERSION, |
|
47 | + 'ticket_selector' => TICKET_SELECTOR_ASSETS_URL |
|
48 | + . 'ticket_selector.css?ver=' |
|
49 | + . EVENT_ESPRESSO_VERSION, |
|
50 | + ), |
|
51 | + $this |
|
52 | + ) |
|
53 | + ); |
|
54 | + if (! apply_filters('FHEE__EED_Ticket_Selector__ticket_selector_iframe__load_theme_css', false, $this)) { |
|
55 | + $this->addStylesheets(array('site_theme' => '')); |
|
56 | + } |
|
57 | + $this->addScripts( |
|
58 | + apply_filters( |
|
59 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
60 | + array( |
|
61 | + 'ticket_selector_iframe_embed' => TICKET_SELECTOR_ASSETS_URL |
|
62 | + . 'ticket_selector_iframe_embed.js?ver=' |
|
63 | + . EVENT_ESPRESSO_VERSION, |
|
64 | + ), |
|
65 | + $this |
|
66 | + ) |
|
67 | + ); |
|
68 | + $js_attributes = apply_filters( |
|
69 | + 'FHEE__EventEspresso_modules_ticket_selector_TicketSelectorIframe__construct__js_attributes', |
|
70 | + array(), |
|
71 | + $this |
|
72 | + ); |
|
73 | + if (! empty($js_attributes)) { |
|
74 | + $this->addScriptAttributes($js_attributes); |
|
75 | + } |
|
76 | + $this->addLocalizedVars( |
|
77 | + apply_filters( |
|
78 | + 'FHEE__EventEspresso_modules_ticket_selector_TicketSelectorIframe__construct__localized_vars', |
|
79 | + array( |
|
80 | + 'ticket_selector_iframe' => true, |
|
81 | + 'EEDTicketSelectorMsg' => wp_strip_all_tags( |
|
82 | + __( |
|
83 | + 'Please choose at least one ticket before continuing.', |
|
84 | + 'event_espresso' |
|
85 | + ) |
|
86 | + ), |
|
87 | + ) |
|
88 | + ) |
|
89 | + ); |
|
90 | + do_action( |
|
91 | + 'AHEE__EventEspresso_modules_ticket_selector_TicketSelectorIframe__construct__complete', |
|
92 | + $this |
|
93 | + ); |
|
94 | + } |
|
95 | 95 | } |
@@ -33,87 +33,87 @@ |
||
33 | 33 | */ |
34 | 34 | class SocketPost implements RequestMethod |
35 | 35 | { |
36 | - /** |
|
37 | - * reCAPTCHA service host. |
|
38 | - * |
|
39 | - * @const string |
|
40 | - */ |
|
41 | - const RECAPTCHA_HOST = 'www.google.com'; |
|
42 | - |
|
43 | - /** |
|
44 | - * @const string reCAPTCHA service path |
|
45 | - */ |
|
46 | - const SITE_VERIFY_PATH = '/recaptcha/api/siteverify'; |
|
47 | - |
|
48 | - /** |
|
49 | - * @const string Bad request error |
|
50 | - */ |
|
51 | - const BAD_REQUEST = '{"success": false, "error-codes": ["invalid-request"]}'; |
|
52 | - |
|
53 | - /** |
|
54 | - * @const string Bad response error |
|
55 | - */ |
|
56 | - const BAD_RESPONSE = '{"success": false, "error-codes": ["invalid-response"]}'; |
|
57 | - |
|
58 | - /** |
|
59 | - * Socket to the reCAPTCHA service |
|
60 | - * |
|
61 | - * @var Socket |
|
62 | - */ |
|
63 | - private $socket; |
|
64 | - |
|
65 | - /** |
|
66 | - * Constructor |
|
67 | - * |
|
68 | - * @param \ReCaptcha\RequestMethod\Socket $socket optional socket, injectable for testing |
|
69 | - */ |
|
70 | - public function __construct(Socket $socket = null) |
|
71 | - { |
|
72 | - if (! is_null($socket)) { |
|
73 | - $this->socket = $socket; |
|
74 | - } else { |
|
75 | - $this->socket = new Socket(); |
|
76 | - } |
|
77 | - } |
|
78 | - |
|
79 | - /** |
|
80 | - * Submit the POST request with the specified parameters. |
|
81 | - * |
|
82 | - * @param RequestParameters $params Request parameters |
|
83 | - * @return string Body of the reCAPTCHA response |
|
84 | - */ |
|
85 | - public function submit(RequestParameters $params) |
|
86 | - { |
|
87 | - $errno = 0; |
|
88 | - $errstr = ''; |
|
89 | - |
|
90 | - if ($this->socket->fsockopen('ssl://' . self::RECAPTCHA_HOST, 443, $errno, $errstr, 30) !== false) { |
|
91 | - $content = $params->toQueryString(); |
|
92 | - |
|
93 | - $request = "POST " . self::SITE_VERIFY_PATH . " HTTP/1.1\r\n"; |
|
94 | - $request .= "Host: " . self::RECAPTCHA_HOST . "\r\n"; |
|
95 | - $request .= "Content-Type: application/x-www-form-urlencoded\r\n"; |
|
96 | - $request .= "Content-length: " . strlen($content) . "\r\n"; |
|
97 | - $request .= "Connection: close\r\n\r\n"; |
|
98 | - $request .= $content . "\r\n\r\n"; |
|
99 | - |
|
100 | - $this->socket->fwrite($request); |
|
101 | - $response = ''; |
|
102 | - |
|
103 | - while (! $this->socket->feof()) { |
|
104 | - $response .= $this->socket->fgets(4096); |
|
105 | - } |
|
106 | - |
|
107 | - $this->socket->fclose(); |
|
108 | - |
|
109 | - if (0 === strpos($response, 'HTTP/1.1 200 OK')) { |
|
110 | - $parts = preg_split("#\n\s*\n#Uis", $response); |
|
111 | - return $parts[1]; |
|
112 | - } |
|
113 | - |
|
114 | - return self::BAD_RESPONSE; |
|
115 | - } |
|
116 | - |
|
117 | - return self::BAD_REQUEST; |
|
118 | - } |
|
36 | + /** |
|
37 | + * reCAPTCHA service host. |
|
38 | + * |
|
39 | + * @const string |
|
40 | + */ |
|
41 | + const RECAPTCHA_HOST = 'www.google.com'; |
|
42 | + |
|
43 | + /** |
|
44 | + * @const string reCAPTCHA service path |
|
45 | + */ |
|
46 | + const SITE_VERIFY_PATH = '/recaptcha/api/siteverify'; |
|
47 | + |
|
48 | + /** |
|
49 | + * @const string Bad request error |
|
50 | + */ |
|
51 | + const BAD_REQUEST = '{"success": false, "error-codes": ["invalid-request"]}'; |
|
52 | + |
|
53 | + /** |
|
54 | + * @const string Bad response error |
|
55 | + */ |
|
56 | + const BAD_RESPONSE = '{"success": false, "error-codes": ["invalid-response"]}'; |
|
57 | + |
|
58 | + /** |
|
59 | + * Socket to the reCAPTCHA service |
|
60 | + * |
|
61 | + * @var Socket |
|
62 | + */ |
|
63 | + private $socket; |
|
64 | + |
|
65 | + /** |
|
66 | + * Constructor |
|
67 | + * |
|
68 | + * @param \ReCaptcha\RequestMethod\Socket $socket optional socket, injectable for testing |
|
69 | + */ |
|
70 | + public function __construct(Socket $socket = null) |
|
71 | + { |
|
72 | + if (! is_null($socket)) { |
|
73 | + $this->socket = $socket; |
|
74 | + } else { |
|
75 | + $this->socket = new Socket(); |
|
76 | + } |
|
77 | + } |
|
78 | + |
|
79 | + /** |
|
80 | + * Submit the POST request with the specified parameters. |
|
81 | + * |
|
82 | + * @param RequestParameters $params Request parameters |
|
83 | + * @return string Body of the reCAPTCHA response |
|
84 | + */ |
|
85 | + public function submit(RequestParameters $params) |
|
86 | + { |
|
87 | + $errno = 0; |
|
88 | + $errstr = ''; |
|
89 | + |
|
90 | + if ($this->socket->fsockopen('ssl://' . self::RECAPTCHA_HOST, 443, $errno, $errstr, 30) !== false) { |
|
91 | + $content = $params->toQueryString(); |
|
92 | + |
|
93 | + $request = "POST " . self::SITE_VERIFY_PATH . " HTTP/1.1\r\n"; |
|
94 | + $request .= "Host: " . self::RECAPTCHA_HOST . "\r\n"; |
|
95 | + $request .= "Content-Type: application/x-www-form-urlencoded\r\n"; |
|
96 | + $request .= "Content-length: " . strlen($content) . "\r\n"; |
|
97 | + $request .= "Connection: close\r\n\r\n"; |
|
98 | + $request .= $content . "\r\n\r\n"; |
|
99 | + |
|
100 | + $this->socket->fwrite($request); |
|
101 | + $response = ''; |
|
102 | + |
|
103 | + while (! $this->socket->feof()) { |
|
104 | + $response .= $this->socket->fgets(4096); |
|
105 | + } |
|
106 | + |
|
107 | + $this->socket->fclose(); |
|
108 | + |
|
109 | + if (0 === strpos($response, 'HTTP/1.1 200 OK')) { |
|
110 | + $parts = preg_split("#\n\s*\n#Uis", $response); |
|
111 | + return $parts[1]; |
|
112 | + } |
|
113 | + |
|
114 | + return self::BAD_RESPONSE; |
|
115 | + } |
|
116 | + |
|
117 | + return self::BAD_REQUEST; |
|
118 | + } |
|
119 | 119 | } |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | */ |
70 | 70 | public function __construct(Socket $socket = null) |
71 | 71 | { |
72 | - if (! is_null($socket)) { |
|
72 | + if ( ! is_null($socket)) { |
|
73 | 73 | $this->socket = $socket; |
74 | 74 | } else { |
75 | 75 | $this->socket = new Socket(); |
@@ -87,20 +87,20 @@ discard block |
||
87 | 87 | $errno = 0; |
88 | 88 | $errstr = ''; |
89 | 89 | |
90 | - if ($this->socket->fsockopen('ssl://' . self::RECAPTCHA_HOST, 443, $errno, $errstr, 30) !== false) { |
|
90 | + if ($this->socket->fsockopen('ssl://'.self::RECAPTCHA_HOST, 443, $errno, $errstr, 30) !== false) { |
|
91 | 91 | $content = $params->toQueryString(); |
92 | 92 | |
93 | - $request = "POST " . self::SITE_VERIFY_PATH . " HTTP/1.1\r\n"; |
|
94 | - $request .= "Host: " . self::RECAPTCHA_HOST . "\r\n"; |
|
93 | + $request = "POST ".self::SITE_VERIFY_PATH." HTTP/1.1\r\n"; |
|
94 | + $request .= "Host: ".self::RECAPTCHA_HOST."\r\n"; |
|
95 | 95 | $request .= "Content-Type: application/x-www-form-urlencoded\r\n"; |
96 | - $request .= "Content-length: " . strlen($content) . "\r\n"; |
|
96 | + $request .= "Content-length: ".strlen($content)."\r\n"; |
|
97 | 97 | $request .= "Connection: close\r\n\r\n"; |
98 | - $request .= $content . "\r\n\r\n"; |
|
98 | + $request .= $content."\r\n\r\n"; |
|
99 | 99 | |
100 | 100 | $this->socket->fwrite($request); |
101 | 101 | $response = ''; |
102 | 102 | |
103 | - while (! $this->socket->feof()) { |
|
103 | + while ( ! $this->socket->feof()) { |
|
104 | 104 | $response .= $this->socket->fgets(4096); |
105 | 105 | } |
106 | 106 |
@@ -29,79 +29,79 @@ |
||
29 | 29 | */ |
30 | 30 | class Socket |
31 | 31 | { |
32 | - private $handle = null; |
|
32 | + private $handle = null; |
|
33 | 33 | |
34 | - /** |
|
35 | - * fsockopen |
|
36 | - * |
|
37 | - * @see http://php.net/fsockopen |
|
38 | - * @param string $hostname |
|
39 | - * @param int $port |
|
40 | - * @param int $errno |
|
41 | - * @param string $errstr |
|
42 | - * @param float $timeout |
|
43 | - * @return resource |
|
44 | - */ |
|
45 | - public function fsockopen($hostname, $port = -1, &$errno = 0, &$errstr = '', $timeout = null) |
|
46 | - { |
|
47 | - $this->handle = fsockopen( |
|
48 | - $hostname, |
|
49 | - $port, |
|
50 | - $errno, |
|
51 | - $errstr, |
|
52 | - (is_null($timeout) ? ini_get("default_socket_timeout") : $timeout) |
|
53 | - ); |
|
34 | + /** |
|
35 | + * fsockopen |
|
36 | + * |
|
37 | + * @see http://php.net/fsockopen |
|
38 | + * @param string $hostname |
|
39 | + * @param int $port |
|
40 | + * @param int $errno |
|
41 | + * @param string $errstr |
|
42 | + * @param float $timeout |
|
43 | + * @return resource |
|
44 | + */ |
|
45 | + public function fsockopen($hostname, $port = -1, &$errno = 0, &$errstr = '', $timeout = null) |
|
46 | + { |
|
47 | + $this->handle = fsockopen( |
|
48 | + $hostname, |
|
49 | + $port, |
|
50 | + $errno, |
|
51 | + $errstr, |
|
52 | + (is_null($timeout) ? ini_get("default_socket_timeout") : $timeout) |
|
53 | + ); |
|
54 | 54 | |
55 | - if ($this->handle != false && $errno === 0 && $errstr === '') { |
|
56 | - return $this->handle; |
|
57 | - } else { |
|
58 | - return false; |
|
59 | - } |
|
60 | - } |
|
55 | + if ($this->handle != false && $errno === 0 && $errstr === '') { |
|
56 | + return $this->handle; |
|
57 | + } else { |
|
58 | + return false; |
|
59 | + } |
|
60 | + } |
|
61 | 61 | |
62 | - /** |
|
63 | - * fwrite |
|
64 | - * |
|
65 | - * @see http://php.net/fwrite |
|
66 | - * @param string $string |
|
67 | - * @param int $length |
|
68 | - * @return int | bool |
|
69 | - */ |
|
70 | - public function fwrite($string, $length = null) |
|
71 | - { |
|
72 | - return fwrite($this->handle, $string, (is_null($length) ? strlen($string) : $length)); |
|
73 | - } |
|
62 | + /** |
|
63 | + * fwrite |
|
64 | + * |
|
65 | + * @see http://php.net/fwrite |
|
66 | + * @param string $string |
|
67 | + * @param int $length |
|
68 | + * @return int | bool |
|
69 | + */ |
|
70 | + public function fwrite($string, $length = null) |
|
71 | + { |
|
72 | + return fwrite($this->handle, $string, (is_null($length) ? strlen($string) : $length)); |
|
73 | + } |
|
74 | 74 | |
75 | - /** |
|
76 | - * fgets |
|
77 | - * |
|
78 | - * @see http://php.net/fgets |
|
79 | - * @param int $length |
|
80 | - */ |
|
81 | - public function fgets($length = null) |
|
82 | - { |
|
83 | - return fgets($this->handle, $length); |
|
84 | - } |
|
75 | + /** |
|
76 | + * fgets |
|
77 | + * |
|
78 | + * @see http://php.net/fgets |
|
79 | + * @param int $length |
|
80 | + */ |
|
81 | + public function fgets($length = null) |
|
82 | + { |
|
83 | + return fgets($this->handle, $length); |
|
84 | + } |
|
85 | 85 | |
86 | - /** |
|
87 | - * feof |
|
88 | - * |
|
89 | - * @see http://php.net/feof |
|
90 | - * @return bool |
|
91 | - */ |
|
92 | - public function feof() |
|
93 | - { |
|
94 | - return feof($this->handle); |
|
95 | - } |
|
86 | + /** |
|
87 | + * feof |
|
88 | + * |
|
89 | + * @see http://php.net/feof |
|
90 | + * @return bool |
|
91 | + */ |
|
92 | + public function feof() |
|
93 | + { |
|
94 | + return feof($this->handle); |
|
95 | + } |
|
96 | 96 | |
97 | - /** |
|
98 | - * fclose |
|
99 | - * |
|
100 | - * @see http://php.net/fclose |
|
101 | - * @return bool |
|
102 | - */ |
|
103 | - public function fclose() |
|
104 | - { |
|
105 | - return fclose($this->handle); |
|
106 | - } |
|
97 | + /** |
|
98 | + * fclose |
|
99 | + * |
|
100 | + * @see http://php.net/fclose |
|
101 | + * @return bool |
|
102 | + */ |
|
103 | + public function fclose() |
|
104 | + { |
|
105 | + return fclose($this->handle); |
|
106 | + } |
|
107 | 107 | } |