@@ -14,28 +14,28 @@ |
||
14 | 14 | class EE_Detect_File_Editor_Request extends EE_Middleware |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * @deprecated |
|
19 | - * @param EE_Request $request |
|
20 | - * @param EE_Response $response |
|
21 | - * @return EE_Response |
|
22 | - */ |
|
23 | - public function handle_request(EE_Request $request, EE_Response $response) |
|
24 | - { |
|
25 | - EE_Error::doing_it_wrong( |
|
26 | - __METHOD__, |
|
27 | - sprintf( |
|
28 | - esc_html__( |
|
29 | - 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
30 | - 'event_espresso' |
|
31 | - ), |
|
32 | - 'EventEspresso\core\services\request\middleware\DetectFileEditorRequest', |
|
33 | - '\core\services\request', |
|
34 | - 'EventEspresso\core\services\request' |
|
35 | - ), |
|
36 | - '4.9.52' |
|
37 | - ); |
|
38 | - return $response; |
|
39 | - } |
|
17 | + /** |
|
18 | + * @deprecated |
|
19 | + * @param EE_Request $request |
|
20 | + * @param EE_Response $response |
|
21 | + * @return EE_Response |
|
22 | + */ |
|
23 | + public function handle_request(EE_Request $request, EE_Response $response) |
|
24 | + { |
|
25 | + EE_Error::doing_it_wrong( |
|
26 | + __METHOD__, |
|
27 | + sprintf( |
|
28 | + esc_html__( |
|
29 | + 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
30 | + 'event_espresso' |
|
31 | + ), |
|
32 | + 'EventEspresso\core\services\request\middleware\DetectFileEditorRequest', |
|
33 | + '\core\services\request', |
|
34 | + 'EventEspresso\core\services\request' |
|
35 | + ), |
|
36 | + '4.9.52' |
|
37 | + ); |
|
38 | + return $response; |
|
39 | + } |
|
40 | 40 | |
41 | 41 | } |
@@ -78,13 +78,13 @@ |
||
78 | 78 | // EE_Dependency_Map: info about how to load classes required by other classes |
79 | 79 | espresso_load_required( |
80 | 80 | 'EE_Dependency_Map', |
81 | - EE_CORE . 'EE_Dependency_Map.core.php' |
|
81 | + EE_CORE.'EE_Dependency_Map.core.php' |
|
82 | 82 | ); |
83 | 83 | $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
84 | 84 | // EE_Registry: central repository for classes (legacy) |
85 | 85 | espresso_load_required( |
86 | 86 | 'EE_Registry', |
87 | - EE_CORE . 'EE_Registry.core.php' |
|
87 | + EE_CORE.'EE_Registry.core.php' |
|
88 | 88 | ); |
89 | 89 | $this->registry = EE_Registry::instance( |
90 | 90 | $this->dependency_map, |
@@ -25,123 +25,123 @@ |
||
25 | 25 | class BootstrapDependencyInjectionContainer |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var EE_Dependency_Map $dependency_map |
|
30 | - */ |
|
31 | - protected $dependency_map; |
|
32 | - |
|
33 | - /** |
|
34 | - * @type LoaderInterface $loader |
|
35 | - */ |
|
36 | - protected $loader; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var EE_Registry $registry |
|
40 | - */ |
|
41 | - protected $registry; |
|
42 | - |
|
43 | - /** |
|
44 | - * @var ClassInterfaceCache $class_cache |
|
45 | - */ |
|
46 | - private $class_cache; |
|
47 | - |
|
48 | - /** |
|
49 | - * @var Mirror |
|
50 | - */ |
|
51 | - private $mirror; |
|
52 | - |
|
53 | - /** |
|
54 | - * @var ObjectIdentifier |
|
55 | - */ |
|
56 | - private $object_identifier; |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * Can't use this just yet until we exorcise some more of our singleton usage from core |
|
61 | - */ |
|
62 | - public function buildDependencyInjectionContainer() |
|
63 | - { |
|
64 | - // build DI container |
|
65 | - // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop(); |
|
66 | - // $OpenCoffeeShop->addRecipes(); |
|
67 | - // $CoffeeShop = $OpenCoffeeShop->CoffeeShop(); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * Setups EE_Registry and EE_Dependency_Map |
|
73 | - * |
|
74 | - * @throws EE_Error |
|
75 | - */ |
|
76 | - public function buildLegacyDependencyInjectionContainer() |
|
77 | - { |
|
78 | - $this->class_cache = new ClassInterfaceCache(); |
|
79 | - $this->object_identifier = new ObjectIdentifier($this->class_cache); |
|
80 | - $this->mirror = new Mirror(); |
|
81 | - // EE_Dependency_Map: info about how to load classes required by other classes |
|
82 | - espresso_load_required( |
|
83 | - 'EE_Dependency_Map', |
|
84 | - EE_CORE . 'EE_Dependency_Map.core.php' |
|
85 | - ); |
|
86 | - $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
|
87 | - // EE_Registry: central repository for classes (legacy) |
|
88 | - espresso_load_required( |
|
89 | - 'EE_Registry', |
|
90 | - EE_CORE . 'EE_Registry.core.php' |
|
91 | - ); |
|
92 | - $this->registry = EE_Registry::instance( |
|
93 | - $this->dependency_map, |
|
94 | - $this->mirror, |
|
95 | - $this->class_cache, |
|
96 | - $this->object_identifier |
|
97 | - ); |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * Performs initial setup for the generic Loader |
|
103 | - * |
|
104 | - * @throws InvalidDataTypeException |
|
105 | - * @throws InvalidInterfaceException |
|
106 | - * @throws InvalidArgumentException |
|
107 | - */ |
|
108 | - public function buildLoader() |
|
109 | - { |
|
110 | - $this->loader = LoaderFactory::getLoader( |
|
111 | - $this->registry, |
|
112 | - $this->class_cache, |
|
113 | - $this->object_identifier |
|
114 | - ); |
|
115 | - $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache); |
|
116 | - $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier); |
|
117 | - $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror); |
|
118 | - $this->dependency_map->setLoader($this->loader); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * @return EE_Dependency_Map |
|
124 | - */ |
|
125 | - public function getDependencyMap() |
|
126 | - { |
|
127 | - return $this->dependency_map; |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - /** |
|
132 | - * @return EE_Registry |
|
133 | - */ |
|
134 | - public function getRegistry() |
|
135 | - { |
|
136 | - return $this->registry; |
|
137 | - } |
|
138 | - |
|
139 | - |
|
140 | - /** |
|
141 | - * @return LoaderInterface |
|
142 | - */ |
|
143 | - public function getLoader() |
|
144 | - { |
|
145 | - return $this->loader; |
|
146 | - } |
|
28 | + /** |
|
29 | + * @var EE_Dependency_Map $dependency_map |
|
30 | + */ |
|
31 | + protected $dependency_map; |
|
32 | + |
|
33 | + /** |
|
34 | + * @type LoaderInterface $loader |
|
35 | + */ |
|
36 | + protected $loader; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var EE_Registry $registry |
|
40 | + */ |
|
41 | + protected $registry; |
|
42 | + |
|
43 | + /** |
|
44 | + * @var ClassInterfaceCache $class_cache |
|
45 | + */ |
|
46 | + private $class_cache; |
|
47 | + |
|
48 | + /** |
|
49 | + * @var Mirror |
|
50 | + */ |
|
51 | + private $mirror; |
|
52 | + |
|
53 | + /** |
|
54 | + * @var ObjectIdentifier |
|
55 | + */ |
|
56 | + private $object_identifier; |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * Can't use this just yet until we exorcise some more of our singleton usage from core |
|
61 | + */ |
|
62 | + public function buildDependencyInjectionContainer() |
|
63 | + { |
|
64 | + // build DI container |
|
65 | + // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop(); |
|
66 | + // $OpenCoffeeShop->addRecipes(); |
|
67 | + // $CoffeeShop = $OpenCoffeeShop->CoffeeShop(); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * Setups EE_Registry and EE_Dependency_Map |
|
73 | + * |
|
74 | + * @throws EE_Error |
|
75 | + */ |
|
76 | + public function buildLegacyDependencyInjectionContainer() |
|
77 | + { |
|
78 | + $this->class_cache = new ClassInterfaceCache(); |
|
79 | + $this->object_identifier = new ObjectIdentifier($this->class_cache); |
|
80 | + $this->mirror = new Mirror(); |
|
81 | + // EE_Dependency_Map: info about how to load classes required by other classes |
|
82 | + espresso_load_required( |
|
83 | + 'EE_Dependency_Map', |
|
84 | + EE_CORE . 'EE_Dependency_Map.core.php' |
|
85 | + ); |
|
86 | + $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
|
87 | + // EE_Registry: central repository for classes (legacy) |
|
88 | + espresso_load_required( |
|
89 | + 'EE_Registry', |
|
90 | + EE_CORE . 'EE_Registry.core.php' |
|
91 | + ); |
|
92 | + $this->registry = EE_Registry::instance( |
|
93 | + $this->dependency_map, |
|
94 | + $this->mirror, |
|
95 | + $this->class_cache, |
|
96 | + $this->object_identifier |
|
97 | + ); |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * Performs initial setup for the generic Loader |
|
103 | + * |
|
104 | + * @throws InvalidDataTypeException |
|
105 | + * @throws InvalidInterfaceException |
|
106 | + * @throws InvalidArgumentException |
|
107 | + */ |
|
108 | + public function buildLoader() |
|
109 | + { |
|
110 | + $this->loader = LoaderFactory::getLoader( |
|
111 | + $this->registry, |
|
112 | + $this->class_cache, |
|
113 | + $this->object_identifier |
|
114 | + ); |
|
115 | + $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache); |
|
116 | + $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier); |
|
117 | + $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror); |
|
118 | + $this->dependency_map->setLoader($this->loader); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * @return EE_Dependency_Map |
|
124 | + */ |
|
125 | + public function getDependencyMap() |
|
126 | + { |
|
127 | + return $this->dependency_map; |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + /** |
|
132 | + * @return EE_Registry |
|
133 | + */ |
|
134 | + public function getRegistry() |
|
135 | + { |
|
136 | + return $this->registry; |
|
137 | + } |
|
138 | + |
|
139 | + |
|
140 | + /** |
|
141 | + * @return LoaderInterface |
|
142 | + */ |
|
143 | + public function getLoader() |
|
144 | + { |
|
145 | + return $this->loader; |
|
146 | + } |
|
147 | 147 | } |
@@ -65,7 +65,7 @@ |
||
65 | 65 | */ |
66 | 66 | public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
67 | 67 | { |
68 | - $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
68 | + $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm( |
|
69 | 69 | $taxonomy, |
70 | 70 | $term_slug, |
71 | 71 | $cpt_slugs |
@@ -16,181 +16,181 @@ |
||
16 | 16 | class RegisterCustomTaxonomyTerms |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var array[] $custom_taxonomy_terms |
|
21 | - */ |
|
22 | - public $custom_taxonomy_terms = array(); |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * RegisterCustomTaxonomyTerms constructor. |
|
27 | - */ |
|
28 | - public function __construct() |
|
29 | - { |
|
30 | - // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
31 | - // IF they don't have a term for that taxonomy set. |
|
32 | - add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2); |
|
33 | - do_action( |
|
34 | - 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
35 | - $this |
|
36 | - ); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - public function registerCustomTaxonomyTerms() |
|
41 | - { |
|
42 | - // setup default terms in any of our taxonomies (but only if we're in admin). |
|
43 | - // Why not added via register_activation_hook? |
|
44 | - // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
45 | - // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
46 | - // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
47 | - // if ( is_admin() ) { |
|
48 | - // $this->set_must_use_event_types(); |
|
49 | - // } |
|
50 | - // set default terms |
|
51 | - $this->registerCustomTaxonomyTerm( |
|
52 | - 'espresso_event_type', |
|
53 | - 'single-event', |
|
54 | - array('espresso_events') |
|
55 | - ); |
|
56 | - } |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
61 | - * |
|
62 | - * @param string $taxonomy The taxonomy we're using for the default term |
|
63 | - * @param string $term_slug The slug of the term that will be the default. |
|
64 | - * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
65 | - */ |
|
66 | - public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
|
67 | - { |
|
68 | - $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
69 | - $taxonomy, |
|
70 | - $term_slug, |
|
71 | - $cpt_slugs |
|
72 | - ); |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
78 | - * |
|
79 | - * @param int $post_id ID of CPT being saved |
|
80 | - * @param WP_Post $post Post object |
|
81 | - * @return void |
|
82 | - */ |
|
83 | - public function saveDefaultTerm($post_id, WP_Post $post) |
|
84 | - { |
|
85 | - if (empty($this->custom_taxonomy_terms)) { |
|
86 | - return; |
|
87 | - } |
|
88 | - // no default terms set so lets just exit. |
|
89 | - foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) { |
|
90 | - foreach ($custom_taxonomy_terms as $custom_taxonomy_term) { |
|
91 | - if ( |
|
92 | - $post->post_status === 'publish' |
|
93 | - && $custom_taxonomy_term instanceof CustomTaxonomyTerm |
|
94 | - && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true) |
|
95 | - ) { |
|
96 | - // note some error proofing going on here to save unnecessary db queries |
|
97 | - $taxonomies = get_object_taxonomies($post->post_type); |
|
98 | - foreach ($taxonomies as $taxonomy) { |
|
99 | - $terms = wp_get_post_terms($post_id, $taxonomy); |
|
100 | - if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) { |
|
101 | - wp_set_object_terms( |
|
102 | - $post_id, |
|
103 | - array($custom_taxonomy_term->termSlug()), |
|
104 | - $taxonomy |
|
105 | - ); |
|
106 | - } |
|
107 | - } |
|
108 | - } |
|
109 | - } |
|
110 | - } |
|
111 | - } |
|
112 | - |
|
113 | - |
|
114 | - /** |
|
115 | - * @return void |
|
116 | - */ |
|
117 | - public function setMustUseEventTypes() |
|
118 | - { |
|
119 | - $term_details = array( |
|
120 | - // Attendee's register for the first date-time only |
|
121 | - 'single-event' => array( |
|
122 | - 'term' => esc_html__('Single Event', 'event_espresso'), |
|
123 | - 'desc' => esc_html__( |
|
124 | - 'A single event that spans one or more consecutive days.', |
|
125 | - 'event_espresso' |
|
126 | - ), |
|
127 | - ), |
|
128 | - // example: a party or two-day long workshop |
|
129 | - // Attendee's can register for any of the date-times |
|
130 | - 'multi-event' => array( |
|
131 | - 'term' => esc_html__('Multi Event', 'event_espresso'), |
|
132 | - 'desc' => esc_html__( |
|
133 | - 'Multiple, separate, but related events that occur on consecutive days.', |
|
134 | - 'event_espresso' |
|
135 | - ), |
|
136 | - ), |
|
137 | - // example: a three day music festival or week long conference |
|
138 | - // Attendee's register for the first date-time only |
|
139 | - 'event-series' => array( |
|
140 | - 'term' => esc_html__('Event Series', 'event_espresso'), |
|
141 | - 'desc' => esc_html__( |
|
142 | - ' Multiple events that occur over multiple non-consecutive days.', |
|
143 | - 'event_espresso' |
|
144 | - ), |
|
145 | - ), |
|
146 | - // example: an 8 week introduction to basket weaving course |
|
147 | - // Attendee's can register for any of the date-times. |
|
148 | - 'recurring-event' => array( |
|
149 | - 'term' => esc_html__('Recurring Event', 'event_espresso'), |
|
150 | - 'desc' => esc_html__( |
|
151 | - 'Multiple events that occur over multiple non-consecutive days.', |
|
152 | - 'event_espresso' |
|
153 | - ), |
|
154 | - ), |
|
155 | - // example: a yoga class |
|
156 | - 'ongoing' => array( |
|
157 | - 'term' => esc_html__('Ongoing Event', 'event_espresso'), |
|
158 | - 'desc' => esc_html__( |
|
159 | - 'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
160 | - 'event_espresso' |
|
161 | - ), |
|
162 | - ) |
|
163 | - // example: access to a museum |
|
164 | - // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
165 | - // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
166 | - // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
167 | - // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
168 | - ); |
|
169 | - $this->setMustUseTerms('espresso_event_type', $term_details); |
|
170 | - } |
|
171 | - |
|
172 | - |
|
173 | - /** |
|
174 | - * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
175 | - * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
176 | - * deleted then it WILL be recreated. |
|
177 | - * |
|
178 | - * @param string $taxonomy The name of the taxonomy |
|
179 | - * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
180 | - * description as the elements in the array |
|
181 | - * @return void |
|
182 | - */ |
|
183 | - public function setMustUseTerms($taxonomy, $term_details) |
|
184 | - { |
|
185 | - $term_details = (array) $term_details; |
|
186 | - foreach ($term_details as $slug => $details) { |
|
187 | - if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) { |
|
188 | - $insert_arr = array( |
|
189 | - 'slug' => $slug, |
|
190 | - 'description' => $details['desc'], |
|
191 | - ); |
|
192 | - wp_insert_term($details['term'], $taxonomy, $insert_arr); |
|
193 | - } |
|
194 | - } |
|
195 | - } |
|
19 | + /** |
|
20 | + * @var array[] $custom_taxonomy_terms |
|
21 | + */ |
|
22 | + public $custom_taxonomy_terms = array(); |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * RegisterCustomTaxonomyTerms constructor. |
|
27 | + */ |
|
28 | + public function __construct() |
|
29 | + { |
|
30 | + // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
31 | + // IF they don't have a term for that taxonomy set. |
|
32 | + add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2); |
|
33 | + do_action( |
|
34 | + 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
35 | + $this |
|
36 | + ); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + public function registerCustomTaxonomyTerms() |
|
41 | + { |
|
42 | + // setup default terms in any of our taxonomies (but only if we're in admin). |
|
43 | + // Why not added via register_activation_hook? |
|
44 | + // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
45 | + // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
46 | + // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
47 | + // if ( is_admin() ) { |
|
48 | + // $this->set_must_use_event_types(); |
|
49 | + // } |
|
50 | + // set default terms |
|
51 | + $this->registerCustomTaxonomyTerm( |
|
52 | + 'espresso_event_type', |
|
53 | + 'single-event', |
|
54 | + array('espresso_events') |
|
55 | + ); |
|
56 | + } |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
61 | + * |
|
62 | + * @param string $taxonomy The taxonomy we're using for the default term |
|
63 | + * @param string $term_slug The slug of the term that will be the default. |
|
64 | + * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
65 | + */ |
|
66 | + public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
|
67 | + { |
|
68 | + $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
69 | + $taxonomy, |
|
70 | + $term_slug, |
|
71 | + $cpt_slugs |
|
72 | + ); |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
78 | + * |
|
79 | + * @param int $post_id ID of CPT being saved |
|
80 | + * @param WP_Post $post Post object |
|
81 | + * @return void |
|
82 | + */ |
|
83 | + public function saveDefaultTerm($post_id, WP_Post $post) |
|
84 | + { |
|
85 | + if (empty($this->custom_taxonomy_terms)) { |
|
86 | + return; |
|
87 | + } |
|
88 | + // no default terms set so lets just exit. |
|
89 | + foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) { |
|
90 | + foreach ($custom_taxonomy_terms as $custom_taxonomy_term) { |
|
91 | + if ( |
|
92 | + $post->post_status === 'publish' |
|
93 | + && $custom_taxonomy_term instanceof CustomTaxonomyTerm |
|
94 | + && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true) |
|
95 | + ) { |
|
96 | + // note some error proofing going on here to save unnecessary db queries |
|
97 | + $taxonomies = get_object_taxonomies($post->post_type); |
|
98 | + foreach ($taxonomies as $taxonomy) { |
|
99 | + $terms = wp_get_post_terms($post_id, $taxonomy); |
|
100 | + if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) { |
|
101 | + wp_set_object_terms( |
|
102 | + $post_id, |
|
103 | + array($custom_taxonomy_term->termSlug()), |
|
104 | + $taxonomy |
|
105 | + ); |
|
106 | + } |
|
107 | + } |
|
108 | + } |
|
109 | + } |
|
110 | + } |
|
111 | + } |
|
112 | + |
|
113 | + |
|
114 | + /** |
|
115 | + * @return void |
|
116 | + */ |
|
117 | + public function setMustUseEventTypes() |
|
118 | + { |
|
119 | + $term_details = array( |
|
120 | + // Attendee's register for the first date-time only |
|
121 | + 'single-event' => array( |
|
122 | + 'term' => esc_html__('Single Event', 'event_espresso'), |
|
123 | + 'desc' => esc_html__( |
|
124 | + 'A single event that spans one or more consecutive days.', |
|
125 | + 'event_espresso' |
|
126 | + ), |
|
127 | + ), |
|
128 | + // example: a party or two-day long workshop |
|
129 | + // Attendee's can register for any of the date-times |
|
130 | + 'multi-event' => array( |
|
131 | + 'term' => esc_html__('Multi Event', 'event_espresso'), |
|
132 | + 'desc' => esc_html__( |
|
133 | + 'Multiple, separate, but related events that occur on consecutive days.', |
|
134 | + 'event_espresso' |
|
135 | + ), |
|
136 | + ), |
|
137 | + // example: a three day music festival or week long conference |
|
138 | + // Attendee's register for the first date-time only |
|
139 | + 'event-series' => array( |
|
140 | + 'term' => esc_html__('Event Series', 'event_espresso'), |
|
141 | + 'desc' => esc_html__( |
|
142 | + ' Multiple events that occur over multiple non-consecutive days.', |
|
143 | + 'event_espresso' |
|
144 | + ), |
|
145 | + ), |
|
146 | + // example: an 8 week introduction to basket weaving course |
|
147 | + // Attendee's can register for any of the date-times. |
|
148 | + 'recurring-event' => array( |
|
149 | + 'term' => esc_html__('Recurring Event', 'event_espresso'), |
|
150 | + 'desc' => esc_html__( |
|
151 | + 'Multiple events that occur over multiple non-consecutive days.', |
|
152 | + 'event_espresso' |
|
153 | + ), |
|
154 | + ), |
|
155 | + // example: a yoga class |
|
156 | + 'ongoing' => array( |
|
157 | + 'term' => esc_html__('Ongoing Event', 'event_espresso'), |
|
158 | + 'desc' => esc_html__( |
|
159 | + 'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
160 | + 'event_espresso' |
|
161 | + ), |
|
162 | + ) |
|
163 | + // example: access to a museum |
|
164 | + // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
165 | + // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
166 | + // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
167 | + // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
168 | + ); |
|
169 | + $this->setMustUseTerms('espresso_event_type', $term_details); |
|
170 | + } |
|
171 | + |
|
172 | + |
|
173 | + /** |
|
174 | + * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
175 | + * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
176 | + * deleted then it WILL be recreated. |
|
177 | + * |
|
178 | + * @param string $taxonomy The name of the taxonomy |
|
179 | + * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
180 | + * description as the elements in the array |
|
181 | + * @return void |
|
182 | + */ |
|
183 | + public function setMustUseTerms($taxonomy, $term_details) |
|
184 | + { |
|
185 | + $term_details = (array) $term_details; |
|
186 | + foreach ($term_details as $slug => $details) { |
|
187 | + if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) { |
|
188 | + $insert_arr = array( |
|
189 | + 'slug' => $slug, |
|
190 | + 'description' => $details['desc'], |
|
191 | + ); |
|
192 | + wp_insert_term($details['term'], $taxonomy, $insert_arr); |
|
193 | + } |
|
194 | + } |
|
195 | + } |
|
196 | 196 | } |
@@ -47,7 +47,7 @@ |
||
47 | 47 | */ |
48 | 48 | public function __construct($generator) |
49 | 49 | { |
50 | - if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
50 | + if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
51 | 51 | throw new InvalidArgumentException( |
52 | 52 | esc_html__( |
53 | 53 | 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
@@ -29,111 +29,111 @@ |
||
29 | 29 | class CoreLoader implements LoaderDecoratorInterface |
30 | 30 | { |
31 | 31 | |
32 | - /** |
|
33 | - * @var EE_Registry|CoffeeShop $generator |
|
34 | - */ |
|
35 | - private $generator; |
|
32 | + /** |
|
33 | + * @var EE_Registry|CoffeeShop $generator |
|
34 | + */ |
|
35 | + private $generator; |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * CoreLoader constructor. |
|
40 | - * |
|
41 | - * @param EE_Registry|CoffeeShop $generator |
|
42 | - * @throws InvalidArgumentException |
|
43 | - */ |
|
44 | - public function __construct($generator) |
|
45 | - { |
|
46 | - if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
47 | - throw new InvalidArgumentException( |
|
48 | - esc_html__( |
|
49 | - 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
50 | - 'event_espresso' |
|
51 | - ) |
|
52 | - ); |
|
53 | - } |
|
54 | - $this->generator = $generator; |
|
55 | - } |
|
38 | + /** |
|
39 | + * CoreLoader constructor. |
|
40 | + * |
|
41 | + * @param EE_Registry|CoffeeShop $generator |
|
42 | + * @throws InvalidArgumentException |
|
43 | + */ |
|
44 | + public function __construct($generator) |
|
45 | + { |
|
46 | + if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
47 | + throw new InvalidArgumentException( |
|
48 | + esc_html__( |
|
49 | + 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
50 | + 'event_espresso' |
|
51 | + ) |
|
52 | + ); |
|
53 | + } |
|
54 | + $this->generator = $generator; |
|
55 | + } |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * Calls the appropriate loading method from the installed generator; |
|
60 | - * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method |
|
61 | - * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(), |
|
62 | - * but NOT to the class being instantiated. |
|
63 | - * This is done by adding the parameters to the $arguments array as follows: |
|
64 | - * array( |
|
65 | - * 'EE_Registry::create(from_db)' => true, // boolean value, default = false |
|
66 | - * 'EE_Registry::create(load_only)' => true, // boolean value, default = false |
|
67 | - * 'EE_Registry::create(addon)' => true, // boolean value, default = false |
|
68 | - * ) |
|
69 | - * |
|
70 | - * @param string $fqcn |
|
71 | - * @param array $arguments |
|
72 | - * @param bool $shared |
|
73 | - * @return mixed |
|
74 | - * @throws OutOfBoundsException |
|
75 | - * @throws ServiceExistsException |
|
76 | - * @throws InstantiationException |
|
77 | - * @throws InvalidIdentifierException |
|
78 | - * @throws InvalidDataTypeException |
|
79 | - * @throws InvalidClassException |
|
80 | - * @throws EE_Error |
|
81 | - * @throws ServiceNotFoundException |
|
82 | - * @throws ReflectionException |
|
83 | - * @throws InvalidInterfaceException |
|
84 | - * @throws InvalidArgumentException |
|
85 | - */ |
|
86 | - public function load($fqcn, $arguments = array(), $shared = true) |
|
87 | - { |
|
88 | - $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN); |
|
89 | - if ($this->generator instanceof EE_Registry) { |
|
90 | - // check if additional EE_Registry::create() arguments have been passed |
|
91 | - // from_db |
|
92 | - $from_db = isset($arguments['EE_Registry::create(from_db)']) |
|
93 | - ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN) |
|
94 | - : false; |
|
95 | - // load_only |
|
96 | - $load_only = isset($arguments['EE_Registry::create(load_only)']) |
|
97 | - ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN) |
|
98 | - : false; |
|
99 | - // addon |
|
100 | - $addon = isset($arguments['EE_Registry::create(addon)']) |
|
101 | - ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN) |
|
102 | - : false; |
|
103 | - unset( |
|
104 | - $arguments['EE_Registry::create(from_db)'], |
|
105 | - $arguments['EE_Registry::create(load_only)'], |
|
106 | - $arguments['EE_Registry::create(addon)'] |
|
107 | - ); |
|
108 | - // addons need to be cached on EE_Registry |
|
109 | - $shared = $addon ? true : $shared; |
|
110 | - return $this->generator->create( |
|
111 | - $fqcn, |
|
112 | - $arguments, |
|
113 | - $shared, |
|
114 | - $from_db, |
|
115 | - $load_only, |
|
116 | - $addon |
|
117 | - ); |
|
118 | - } |
|
119 | - return $this->generator->brew( |
|
120 | - $fqcn, |
|
121 | - $arguments, |
|
122 | - $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW |
|
123 | - ); |
|
124 | - } |
|
58 | + /** |
|
59 | + * Calls the appropriate loading method from the installed generator; |
|
60 | + * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method |
|
61 | + * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(), |
|
62 | + * but NOT to the class being instantiated. |
|
63 | + * This is done by adding the parameters to the $arguments array as follows: |
|
64 | + * array( |
|
65 | + * 'EE_Registry::create(from_db)' => true, // boolean value, default = false |
|
66 | + * 'EE_Registry::create(load_only)' => true, // boolean value, default = false |
|
67 | + * 'EE_Registry::create(addon)' => true, // boolean value, default = false |
|
68 | + * ) |
|
69 | + * |
|
70 | + * @param string $fqcn |
|
71 | + * @param array $arguments |
|
72 | + * @param bool $shared |
|
73 | + * @return mixed |
|
74 | + * @throws OutOfBoundsException |
|
75 | + * @throws ServiceExistsException |
|
76 | + * @throws InstantiationException |
|
77 | + * @throws InvalidIdentifierException |
|
78 | + * @throws InvalidDataTypeException |
|
79 | + * @throws InvalidClassException |
|
80 | + * @throws EE_Error |
|
81 | + * @throws ServiceNotFoundException |
|
82 | + * @throws ReflectionException |
|
83 | + * @throws InvalidInterfaceException |
|
84 | + * @throws InvalidArgumentException |
|
85 | + */ |
|
86 | + public function load($fqcn, $arguments = array(), $shared = true) |
|
87 | + { |
|
88 | + $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN); |
|
89 | + if ($this->generator instanceof EE_Registry) { |
|
90 | + // check if additional EE_Registry::create() arguments have been passed |
|
91 | + // from_db |
|
92 | + $from_db = isset($arguments['EE_Registry::create(from_db)']) |
|
93 | + ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN) |
|
94 | + : false; |
|
95 | + // load_only |
|
96 | + $load_only = isset($arguments['EE_Registry::create(load_only)']) |
|
97 | + ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN) |
|
98 | + : false; |
|
99 | + // addon |
|
100 | + $addon = isset($arguments['EE_Registry::create(addon)']) |
|
101 | + ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN) |
|
102 | + : false; |
|
103 | + unset( |
|
104 | + $arguments['EE_Registry::create(from_db)'], |
|
105 | + $arguments['EE_Registry::create(load_only)'], |
|
106 | + $arguments['EE_Registry::create(addon)'] |
|
107 | + ); |
|
108 | + // addons need to be cached on EE_Registry |
|
109 | + $shared = $addon ? true : $shared; |
|
110 | + return $this->generator->create( |
|
111 | + $fqcn, |
|
112 | + $arguments, |
|
113 | + $shared, |
|
114 | + $from_db, |
|
115 | + $load_only, |
|
116 | + $addon |
|
117 | + ); |
|
118 | + } |
|
119 | + return $this->generator->brew( |
|
120 | + $fqcn, |
|
121 | + $arguments, |
|
122 | + $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW |
|
123 | + ); |
|
124 | + } |
|
125 | 125 | |
126 | 126 | |
127 | - /** |
|
128 | - * calls reset() on generator if method exists |
|
129 | - * |
|
130 | - * @throws EE_Error |
|
131 | - * @throws ReflectionException |
|
132 | - */ |
|
133 | - public function reset() |
|
134 | - { |
|
135 | - if ($this->generator instanceof ResettableInterface) { |
|
136 | - $this->generator->reset(); |
|
137 | - } |
|
138 | - } |
|
127 | + /** |
|
128 | + * calls reset() on generator if method exists |
|
129 | + * |
|
130 | + * @throws EE_Error |
|
131 | + * @throws ReflectionException |
|
132 | + */ |
|
133 | + public function reset() |
|
134 | + { |
|
135 | + if ($this->generator instanceof ResettableInterface) { |
|
136 | + $this->generator->reset(); |
|
137 | + } |
|
138 | + } |
|
139 | 139 | } |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | $identifier = '' |
54 | 54 | ) { |
55 | 55 | parent::__construct($loader); |
56 | - $this->cache = $cache; |
|
56 | + $this->cache = $cache; |
|
57 | 57 | $this->object_identifier = $object_identifier; |
58 | 58 | $this->setIdentifier($identifier); |
59 | 59 | if ($this->identifier !== '') { |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | */ |
90 | 90 | private function setIdentifier($identifier) |
91 | 91 | { |
92 | - if (! is_string($identifier)) { |
|
92 | + if ( ! is_string($identifier)) { |
|
93 | 93 | throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
94 | 94 | } |
95 | 95 | $this->identifier = $identifier; |
@@ -17,186 +17,186 @@ |
||
17 | 17 | class CachingLoader extends CachingLoaderDecorator |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var bool |
|
22 | - */ |
|
23 | - protected $bypass; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var CollectionInterface |
|
27 | - */ |
|
28 | - protected $cache; |
|
29 | - |
|
30 | - /** |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $identifier; |
|
34 | - |
|
35 | - /** |
|
36 | - * @var ObjectIdentifier |
|
37 | - */ |
|
38 | - private $object_identifier; |
|
39 | - |
|
40 | - |
|
41 | - /** |
|
42 | - * CachingLoader constructor. |
|
43 | - * |
|
44 | - * @param LoaderDecoratorInterface $loader |
|
45 | - * @param CollectionInterface $cache |
|
46 | - * @param ObjectIdentifier $object_identifier |
|
47 | - * @param string $identifier |
|
48 | - * @throws InvalidDataTypeException |
|
49 | - */ |
|
50 | - public function __construct( |
|
51 | - LoaderDecoratorInterface $loader, |
|
52 | - CollectionInterface $cache, |
|
53 | - ObjectIdentifier $object_identifier, |
|
54 | - $identifier = '' |
|
55 | - ) { |
|
56 | - parent::__construct($loader); |
|
57 | - $this->cache = $cache; |
|
58 | - $this->object_identifier = $object_identifier; |
|
59 | - $this->setIdentifier($identifier); |
|
60 | - if ($this->identifier !== '') { |
|
61 | - // to only clear this cache, and assuming an identifier has been set, simply do the following: |
|
62 | - // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER'); |
|
63 | - // where "IDENTIFIER" = the string that was set during construction |
|
64 | - add_action( |
|
65 | - "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}", |
|
66 | - array($this, 'reset') |
|
67 | - ); |
|
68 | - } |
|
69 | - // to clear ALL caches, simply do the following: |
|
70 | - // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache'); |
|
71 | - add_action( |
|
72 | - 'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache', |
|
73 | - array($this, 'reset') |
|
74 | - ); |
|
75 | - // caching can be turned off via the following code: |
|
76 | - // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
77 | - $this->bypass = filter_var( |
|
78 | - apply_filters( |
|
79 | - 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', |
|
80 | - false, |
|
81 | - $this |
|
82 | - ), |
|
83 | - FILTER_VALIDATE_BOOLEAN |
|
84 | - ); |
|
85 | - } |
|
86 | - |
|
87 | - |
|
88 | - /** |
|
89 | - * @return string |
|
90 | - */ |
|
91 | - public function identifier() |
|
92 | - { |
|
93 | - return $this->identifier; |
|
94 | - } |
|
95 | - |
|
96 | - |
|
97 | - /** |
|
98 | - * @param string $identifier |
|
99 | - * @throws InvalidDataTypeException |
|
100 | - */ |
|
101 | - private function setIdentifier($identifier) |
|
102 | - { |
|
103 | - if (! is_string($identifier)) { |
|
104 | - throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
|
105 | - } |
|
106 | - $this->identifier = $identifier; |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * @param FullyQualifiedName|string $fqcn |
|
112 | - * @param mixed $object |
|
113 | - * @param array $arguments |
|
114 | - * @return bool |
|
115 | - * @throws InvalidArgumentException |
|
116 | - */ |
|
117 | - public function share($fqcn, $object, array $arguments = array()) |
|
118 | - { |
|
119 | - if ($object instanceof $fqcn) { |
|
120 | - return $this->cache->add( |
|
121 | - $object, |
|
122 | - $this->object_identifier->getIdentifier($fqcn, $arguments) |
|
123 | - ); |
|
124 | - } |
|
125 | - throw new InvalidArgumentException( |
|
126 | - sprintf( |
|
127 | - esc_html__( |
|
128 | - 'The supplied class name "%1$s" must match the class of the supplied object.', |
|
129 | - 'event_espresso' |
|
130 | - ), |
|
131 | - $fqcn |
|
132 | - ) |
|
133 | - ); |
|
134 | - } |
|
135 | - |
|
136 | - |
|
137 | - /** |
|
138 | - * @param FullyQualifiedName|string $fqcn |
|
139 | - * @param array $arguments |
|
140 | - * @param bool $shared |
|
141 | - * @param array $interfaces |
|
142 | - * @return mixed |
|
143 | - */ |
|
144 | - public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array()) |
|
145 | - { |
|
146 | - $fqcn = ltrim($fqcn, '\\'); |
|
147 | - // caching can be turned off via the following code: |
|
148 | - // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
149 | - if ($this->bypass) { |
|
150 | - // even though $shared might be true, caching could be bypassed for whatever reason, |
|
151 | - // so we don't want the core loader to cache anything, therefore caching is turned off |
|
152 | - return $this->loader->load($fqcn, $arguments, false); |
|
153 | - } |
|
154 | - $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments); |
|
155 | - if ($this->cache->has($object_identifier)) { |
|
156 | - return $this->cache->get($object_identifier); |
|
157 | - } |
|
158 | - $object = $this->loader->load($fqcn, $arguments, $shared); |
|
159 | - if ($object instanceof $fqcn) { |
|
160 | - $this->cache->add($object, $object_identifier); |
|
161 | - } |
|
162 | - return $object; |
|
163 | - } |
|
164 | - |
|
165 | - |
|
166 | - /** |
|
167 | - * empties cache and calls reset() on loader if method exists |
|
168 | - */ |
|
169 | - public function reset() |
|
170 | - { |
|
171 | - $this->clearCache(); |
|
172 | - $this->loader->reset(); |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - /** |
|
177 | - * unsets and detaches ALL objects from the cache |
|
178 | - * |
|
179 | - * @since 4.9.62.p |
|
180 | - */ |
|
181 | - public function clearCache() |
|
182 | - { |
|
183 | - $this->cache->trashAndDetachAll(); |
|
184 | - } |
|
185 | - |
|
186 | - |
|
187 | - /** |
|
188 | - * @param string $fqcn |
|
189 | - * @param array $arguments |
|
190 | - * @return bool |
|
191 | - * @throws InvalidArgumentException |
|
192 | - */ |
|
193 | - public function remove($fqcn, array $arguments = []) |
|
194 | - { |
|
195 | - $fqcn = ltrim($fqcn, '\\'); |
|
196 | - $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments); |
|
197 | - $object = $this->cache->has($object_identifier) |
|
198 | - ? $this->cache->get($object_identifier) |
|
199 | - : $this->loader->load($fqcn, $arguments); |
|
200 | - return $this->cache->remove($object); |
|
201 | - } |
|
20 | + /** |
|
21 | + * @var bool |
|
22 | + */ |
|
23 | + protected $bypass; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var CollectionInterface |
|
27 | + */ |
|
28 | + protected $cache; |
|
29 | + |
|
30 | + /** |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $identifier; |
|
34 | + |
|
35 | + /** |
|
36 | + * @var ObjectIdentifier |
|
37 | + */ |
|
38 | + private $object_identifier; |
|
39 | + |
|
40 | + |
|
41 | + /** |
|
42 | + * CachingLoader constructor. |
|
43 | + * |
|
44 | + * @param LoaderDecoratorInterface $loader |
|
45 | + * @param CollectionInterface $cache |
|
46 | + * @param ObjectIdentifier $object_identifier |
|
47 | + * @param string $identifier |
|
48 | + * @throws InvalidDataTypeException |
|
49 | + */ |
|
50 | + public function __construct( |
|
51 | + LoaderDecoratorInterface $loader, |
|
52 | + CollectionInterface $cache, |
|
53 | + ObjectIdentifier $object_identifier, |
|
54 | + $identifier = '' |
|
55 | + ) { |
|
56 | + parent::__construct($loader); |
|
57 | + $this->cache = $cache; |
|
58 | + $this->object_identifier = $object_identifier; |
|
59 | + $this->setIdentifier($identifier); |
|
60 | + if ($this->identifier !== '') { |
|
61 | + // to only clear this cache, and assuming an identifier has been set, simply do the following: |
|
62 | + // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER'); |
|
63 | + // where "IDENTIFIER" = the string that was set during construction |
|
64 | + add_action( |
|
65 | + "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}", |
|
66 | + array($this, 'reset') |
|
67 | + ); |
|
68 | + } |
|
69 | + // to clear ALL caches, simply do the following: |
|
70 | + // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache'); |
|
71 | + add_action( |
|
72 | + 'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache', |
|
73 | + array($this, 'reset') |
|
74 | + ); |
|
75 | + // caching can be turned off via the following code: |
|
76 | + // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
77 | + $this->bypass = filter_var( |
|
78 | + apply_filters( |
|
79 | + 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', |
|
80 | + false, |
|
81 | + $this |
|
82 | + ), |
|
83 | + FILTER_VALIDATE_BOOLEAN |
|
84 | + ); |
|
85 | + } |
|
86 | + |
|
87 | + |
|
88 | + /** |
|
89 | + * @return string |
|
90 | + */ |
|
91 | + public function identifier() |
|
92 | + { |
|
93 | + return $this->identifier; |
|
94 | + } |
|
95 | + |
|
96 | + |
|
97 | + /** |
|
98 | + * @param string $identifier |
|
99 | + * @throws InvalidDataTypeException |
|
100 | + */ |
|
101 | + private function setIdentifier($identifier) |
|
102 | + { |
|
103 | + if (! is_string($identifier)) { |
|
104 | + throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
|
105 | + } |
|
106 | + $this->identifier = $identifier; |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * @param FullyQualifiedName|string $fqcn |
|
112 | + * @param mixed $object |
|
113 | + * @param array $arguments |
|
114 | + * @return bool |
|
115 | + * @throws InvalidArgumentException |
|
116 | + */ |
|
117 | + public function share($fqcn, $object, array $arguments = array()) |
|
118 | + { |
|
119 | + if ($object instanceof $fqcn) { |
|
120 | + return $this->cache->add( |
|
121 | + $object, |
|
122 | + $this->object_identifier->getIdentifier($fqcn, $arguments) |
|
123 | + ); |
|
124 | + } |
|
125 | + throw new InvalidArgumentException( |
|
126 | + sprintf( |
|
127 | + esc_html__( |
|
128 | + 'The supplied class name "%1$s" must match the class of the supplied object.', |
|
129 | + 'event_espresso' |
|
130 | + ), |
|
131 | + $fqcn |
|
132 | + ) |
|
133 | + ); |
|
134 | + } |
|
135 | + |
|
136 | + |
|
137 | + /** |
|
138 | + * @param FullyQualifiedName|string $fqcn |
|
139 | + * @param array $arguments |
|
140 | + * @param bool $shared |
|
141 | + * @param array $interfaces |
|
142 | + * @return mixed |
|
143 | + */ |
|
144 | + public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array()) |
|
145 | + { |
|
146 | + $fqcn = ltrim($fqcn, '\\'); |
|
147 | + // caching can be turned off via the following code: |
|
148 | + // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
149 | + if ($this->bypass) { |
|
150 | + // even though $shared might be true, caching could be bypassed for whatever reason, |
|
151 | + // so we don't want the core loader to cache anything, therefore caching is turned off |
|
152 | + return $this->loader->load($fqcn, $arguments, false); |
|
153 | + } |
|
154 | + $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments); |
|
155 | + if ($this->cache->has($object_identifier)) { |
|
156 | + return $this->cache->get($object_identifier); |
|
157 | + } |
|
158 | + $object = $this->loader->load($fqcn, $arguments, $shared); |
|
159 | + if ($object instanceof $fqcn) { |
|
160 | + $this->cache->add($object, $object_identifier); |
|
161 | + } |
|
162 | + return $object; |
|
163 | + } |
|
164 | + |
|
165 | + |
|
166 | + /** |
|
167 | + * empties cache and calls reset() on loader if method exists |
|
168 | + */ |
|
169 | + public function reset() |
|
170 | + { |
|
171 | + $this->clearCache(); |
|
172 | + $this->loader->reset(); |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + /** |
|
177 | + * unsets and detaches ALL objects from the cache |
|
178 | + * |
|
179 | + * @since 4.9.62.p |
|
180 | + */ |
|
181 | + public function clearCache() |
|
182 | + { |
|
183 | + $this->cache->trashAndDetachAll(); |
|
184 | + } |
|
185 | + |
|
186 | + |
|
187 | + /** |
|
188 | + * @param string $fqcn |
|
189 | + * @param array $arguments |
|
190 | + * @return bool |
|
191 | + * @throws InvalidArgumentException |
|
192 | + */ |
|
193 | + public function remove($fqcn, array $arguments = []) |
|
194 | + { |
|
195 | + $fqcn = ltrim($fqcn, '\\'); |
|
196 | + $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments); |
|
197 | + $object = $this->cache->has($object_identifier) |
|
198 | + ? $this->cache->get($object_identifier) |
|
199 | + : $this->loader->load($fqcn, $arguments); |
|
200 | + return $this->cache->remove($object); |
|
201 | + } |
|
202 | 202 | } |
@@ -80,47 +80,47 @@ |
||
80 | 80 | class LoaderFactory |
81 | 81 | { |
82 | 82 | |
83 | - /** |
|
84 | - * @var LoaderInterface $loader ; |
|
85 | - */ |
|
86 | - private static $loader; |
|
83 | + /** |
|
84 | + * @var LoaderInterface $loader ; |
|
85 | + */ |
|
86 | + private static $loader; |
|
87 | 87 | |
88 | 88 | |
89 | - /** |
|
90 | - * @param EE_Registry|CoffeeShop $generator provided during very first instantiation in |
|
91 | - * BootstrapDependencyInjectionContainer::buildLoader() |
|
92 | - * otherwise can be left null |
|
93 | - * @param ClassInterfaceCache|null $class_cache also provided during first instantiation |
|
94 | - * @param ObjectIdentifier|null $object_identifier |
|
95 | - * @return LoaderInterface |
|
96 | - * @throws InvalidArgumentException |
|
97 | - * @throws InvalidDataTypeException |
|
98 | - * @throws InvalidInterfaceException |
|
99 | - */ |
|
100 | - public static function getLoader( |
|
101 | - $generator = null, |
|
102 | - ClassInterfaceCache $class_cache = null, |
|
103 | - ObjectIdentifier $object_identifier = null |
|
104 | - ) { |
|
105 | - if ( |
|
106 | - ! LoaderFactory::$loader instanceof LoaderInterface |
|
107 | - && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop) |
|
108 | - && $class_cache instanceof ClassInterfaceCache |
|
109 | - && $object_identifier instanceof ObjectIdentifier |
|
110 | - ) { |
|
111 | - $core_loader = new CoreLoader($generator); |
|
112 | - LoaderFactory::$loader = new Loader( |
|
113 | - $core_loader, |
|
114 | - new CachingLoader( |
|
115 | - $core_loader, |
|
116 | - new LooseCollection(''), |
|
117 | - $object_identifier |
|
118 | - ), |
|
119 | - $class_cache |
|
120 | - ); |
|
121 | - } |
|
122 | - return LoaderFactory::$loader; |
|
123 | - } |
|
89 | + /** |
|
90 | + * @param EE_Registry|CoffeeShop $generator provided during very first instantiation in |
|
91 | + * BootstrapDependencyInjectionContainer::buildLoader() |
|
92 | + * otherwise can be left null |
|
93 | + * @param ClassInterfaceCache|null $class_cache also provided during first instantiation |
|
94 | + * @param ObjectIdentifier|null $object_identifier |
|
95 | + * @return LoaderInterface |
|
96 | + * @throws InvalidArgumentException |
|
97 | + * @throws InvalidDataTypeException |
|
98 | + * @throws InvalidInterfaceException |
|
99 | + */ |
|
100 | + public static function getLoader( |
|
101 | + $generator = null, |
|
102 | + ClassInterfaceCache $class_cache = null, |
|
103 | + ObjectIdentifier $object_identifier = null |
|
104 | + ) { |
|
105 | + if ( |
|
106 | + ! LoaderFactory::$loader instanceof LoaderInterface |
|
107 | + && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop) |
|
108 | + && $class_cache instanceof ClassInterfaceCache |
|
109 | + && $object_identifier instanceof ObjectIdentifier |
|
110 | + ) { |
|
111 | + $core_loader = new CoreLoader($generator); |
|
112 | + LoaderFactory::$loader = new Loader( |
|
113 | + $core_loader, |
|
114 | + new CachingLoader( |
|
115 | + $core_loader, |
|
116 | + new LooseCollection(''), |
|
117 | + $object_identifier |
|
118 | + ), |
|
119 | + $class_cache |
|
120 | + ); |
|
121 | + } |
|
122 | + return LoaderFactory::$loader; |
|
123 | + } |
|
124 | 124 | |
125 | 125 | |
126 | 126 | } |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier) |
74 | 74 | { |
75 | 75 | return $fqcn === $object_identifier |
76 | - || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0; |
|
76 | + || strpos($object_identifier, $fqcn.ObjectIdentifier::DELIMITER) === 0; |
|
77 | 77 | } |
78 | 78 | |
79 | 79 | |
@@ -93,8 +93,8 @@ discard block |
||
93 | 93 | ) |
94 | 94 | ? $this->getIdentifierForArguments($arguments) |
95 | 95 | : ''; |
96 | - if (! empty($identifier)) { |
|
97 | - $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier); |
|
96 | + if ( ! empty($identifier)) { |
|
97 | + $fqcn .= ObjectIdentifier::DELIMITER.md5($identifier); |
|
98 | 98 | } |
99 | 99 | return $fqcn; |
100 | 100 | } |
@@ -16,117 +16,117 @@ |
||
16 | 16 | class ObjectIdentifier |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * used to separate the FQCN from the class's arguments identifier |
|
21 | - */ |
|
22 | - const DELIMITER = '____'; |
|
19 | + /** |
|
20 | + * used to separate the FQCN from the class's arguments identifier |
|
21 | + */ |
|
22 | + const DELIMITER = '____'; |
|
23 | 23 | |
24 | - /** |
|
25 | - * @var ClassInterfaceCache $class_cache |
|
26 | - */ |
|
27 | - private $class_cache; |
|
24 | + /** |
|
25 | + * @var ClassInterfaceCache $class_cache |
|
26 | + */ |
|
27 | + private $class_cache; |
|
28 | 28 | |
29 | 29 | |
30 | - /** |
|
31 | - * ObjectIdentifier constructor. |
|
32 | - * |
|
33 | - * @param ClassInterfaceCache $class_cache |
|
34 | - */ |
|
35 | - public function __construct(ClassInterfaceCache $class_cache) |
|
36 | - { |
|
37 | - $this->class_cache = $class_cache; |
|
38 | - } |
|
30 | + /** |
|
31 | + * ObjectIdentifier constructor. |
|
32 | + * |
|
33 | + * @param ClassInterfaceCache $class_cache |
|
34 | + */ |
|
35 | + public function __construct(ClassInterfaceCache $class_cache) |
|
36 | + { |
|
37 | + $this->class_cache = $class_cache; |
|
38 | + } |
|
39 | 39 | |
40 | 40 | |
41 | - /** |
|
42 | - * Returns true if the supplied $object_identifier contains |
|
43 | - * the delimiter used to separate an fqcn from the arguments hash |
|
44 | - * |
|
45 | - * @param string $object_identifier |
|
46 | - * @return bool |
|
47 | - */ |
|
48 | - public function hasArguments($object_identifier) |
|
49 | - { |
|
50 | - // type casting to bool instead of using strpos() !== false |
|
51 | - // because an object identifier should never begin with the delimiter |
|
52 | - // therefore the delimiter should NOT be found at position 0 |
|
53 | - return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER); |
|
54 | - } |
|
41 | + /** |
|
42 | + * Returns true if the supplied $object_identifier contains |
|
43 | + * the delimiter used to separate an fqcn from the arguments hash |
|
44 | + * |
|
45 | + * @param string $object_identifier |
|
46 | + * @return bool |
|
47 | + */ |
|
48 | + public function hasArguments($object_identifier) |
|
49 | + { |
|
50 | + // type casting to bool instead of using strpos() !== false |
|
51 | + // because an object identifier should never begin with the delimiter |
|
52 | + // therefore the delimiter should NOT be found at position 0 |
|
53 | + return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER); |
|
54 | + } |
|
55 | 55 | |
56 | 56 | |
57 | - /** |
|
58 | - * Returns true if the supplied FQCN equals the supplied $object_identifier |
|
59 | - * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier |
|
60 | - * AND that $object_identifier is for an object with arguments. |
|
61 | - * This allows a request for an object using a FQCN to match |
|
62 | - * a previously instantiated object with arguments |
|
63 | - * without having to know those arguments. |
|
64 | - * |
|
65 | - * @param string $fqcn |
|
66 | - * @param string $object_identifier |
|
67 | - * @return bool |
|
68 | - */ |
|
69 | - public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier) |
|
70 | - { |
|
71 | - return $fqcn === $object_identifier |
|
72 | - || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0; |
|
73 | - } |
|
57 | + /** |
|
58 | + * Returns true if the supplied FQCN equals the supplied $object_identifier |
|
59 | + * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier |
|
60 | + * AND that $object_identifier is for an object with arguments. |
|
61 | + * This allows a request for an object using a FQCN to match |
|
62 | + * a previously instantiated object with arguments |
|
63 | + * without having to know those arguments. |
|
64 | + * |
|
65 | + * @param string $fqcn |
|
66 | + * @param string $object_identifier |
|
67 | + * @return bool |
|
68 | + */ |
|
69 | + public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier) |
|
70 | + { |
|
71 | + return $fqcn === $object_identifier |
|
72 | + || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0; |
|
73 | + } |
|
74 | 74 | |
75 | 75 | |
76 | - /** |
|
77 | - * build a string representation of an object's FQCN and arguments |
|
78 | - * |
|
79 | - * @param string $fqcn |
|
80 | - * @param array $arguments |
|
81 | - * @return string |
|
82 | - */ |
|
83 | - public function getIdentifier($fqcn, array $arguments = array()) |
|
84 | - { |
|
85 | - // only build identifier from arguments if class is not ReservedInstanceInterface |
|
86 | - $identifier = ! $this->class_cache->hasInterface( |
|
87 | - $fqcn, |
|
88 | - 'EventEspresso\core\interfaces\ReservedInstanceInterface' |
|
89 | - ) |
|
90 | - ? $this->getIdentifierForArguments($arguments) |
|
91 | - : ''; |
|
92 | - if (! empty($identifier)) { |
|
93 | - $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier); |
|
94 | - } |
|
95 | - return $fqcn; |
|
96 | - } |
|
76 | + /** |
|
77 | + * build a string representation of an object's FQCN and arguments |
|
78 | + * |
|
79 | + * @param string $fqcn |
|
80 | + * @param array $arguments |
|
81 | + * @return string |
|
82 | + */ |
|
83 | + public function getIdentifier($fqcn, array $arguments = array()) |
|
84 | + { |
|
85 | + // only build identifier from arguments if class is not ReservedInstanceInterface |
|
86 | + $identifier = ! $this->class_cache->hasInterface( |
|
87 | + $fqcn, |
|
88 | + 'EventEspresso\core\interfaces\ReservedInstanceInterface' |
|
89 | + ) |
|
90 | + ? $this->getIdentifierForArguments($arguments) |
|
91 | + : ''; |
|
92 | + if (! empty($identifier)) { |
|
93 | + $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier); |
|
94 | + } |
|
95 | + return $fqcn; |
|
96 | + } |
|
97 | 97 | |
98 | 98 | |
99 | - /** |
|
100 | - * build a string representation of a object's arguments |
|
101 | - * (mostly because Closures can't be serialized) |
|
102 | - * |
|
103 | - * @param array $arguments |
|
104 | - * @return string |
|
105 | - */ |
|
106 | - protected function getIdentifierForArguments(array $arguments) |
|
107 | - { |
|
108 | - if (empty($arguments)) { |
|
109 | - return ''; |
|
110 | - } |
|
111 | - $identifier = ''; |
|
112 | - foreach ($arguments as $key => $argument) { |
|
113 | - // don't include arguments used to assist with loading legacy classes |
|
114 | - if (is_string($key) && strpos($key, 'EE_Registry::create') === 0) { |
|
115 | - continue; |
|
116 | - } |
|
117 | - switch (true) { |
|
118 | - case is_object($argument): |
|
119 | - case $argument instanceof Closure: |
|
120 | - $identifier .= spl_object_hash($argument); |
|
121 | - break; |
|
122 | - case is_array($argument): |
|
123 | - $identifier .= $this->getIdentifierForArguments($argument); |
|
124 | - break; |
|
125 | - default: |
|
126 | - $identifier .= $argument; |
|
127 | - break; |
|
128 | - } |
|
129 | - } |
|
130 | - return $identifier; |
|
131 | - } |
|
99 | + /** |
|
100 | + * build a string representation of a object's arguments |
|
101 | + * (mostly because Closures can't be serialized) |
|
102 | + * |
|
103 | + * @param array $arguments |
|
104 | + * @return string |
|
105 | + */ |
|
106 | + protected function getIdentifierForArguments(array $arguments) |
|
107 | + { |
|
108 | + if (empty($arguments)) { |
|
109 | + return ''; |
|
110 | + } |
|
111 | + $identifier = ''; |
|
112 | + foreach ($arguments as $key => $argument) { |
|
113 | + // don't include arguments used to assist with loading legacy classes |
|
114 | + if (is_string($key) && strpos($key, 'EE_Registry::create') === 0) { |
|
115 | + continue; |
|
116 | + } |
|
117 | + switch (true) { |
|
118 | + case is_object($argument): |
|
119 | + case $argument instanceof Closure: |
|
120 | + $identifier .= spl_object_hash($argument); |
|
121 | + break; |
|
122 | + case is_array($argument): |
|
123 | + $identifier .= $this->getIdentifierForArguments($argument); |
|
124 | + break; |
|
125 | + default: |
|
126 | + $identifier .= $argument; |
|
127 | + break; |
|
128 | + } |
|
129 | + } |
|
130 | + return $identifier; |
|
131 | + } |
|
132 | 132 | } |
@@ -16,55 +16,55 @@ |
||
16 | 16 | interface DomainInterface extends InterminableInterface |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @return string |
|
21 | - * @throws DomainException |
|
22 | - */ |
|
23 | - public function pluginFile(); |
|
19 | + /** |
|
20 | + * @return string |
|
21 | + * @throws DomainException |
|
22 | + */ |
|
23 | + public function pluginFile(); |
|
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * @return string |
|
28 | - * @throws DomainException |
|
29 | - */ |
|
30 | - public function pluginBasename(); |
|
26 | + /** |
|
27 | + * @return string |
|
28 | + * @throws DomainException |
|
29 | + */ |
|
30 | + public function pluginBasename(); |
|
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * @return string |
|
35 | - */ |
|
36 | - public function pluginPath(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + */ |
|
36 | + public function pluginPath(); |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * @return string |
|
41 | - * @throws DomainException |
|
42 | - */ |
|
43 | - public function pluginUrl(); |
|
39 | + /** |
|
40 | + * @return string |
|
41 | + * @throws DomainException |
|
42 | + */ |
|
43 | + public function pluginUrl(); |
|
44 | 44 | |
45 | 45 | |
46 | - /** |
|
47 | - * @return string |
|
48 | - * @throws DomainException |
|
49 | - */ |
|
50 | - public function version(); |
|
46 | + /** |
|
47 | + * @return string |
|
48 | + * @throws DomainException |
|
49 | + */ |
|
50 | + public function version(); |
|
51 | 51 | |
52 | 52 | |
53 | - /** |
|
54 | - * @return string |
|
55 | - */ |
|
56 | - public function distributionAssetsPath(); |
|
53 | + /** |
|
54 | + * @return string |
|
55 | + */ |
|
56 | + public function distributionAssetsPath(); |
|
57 | 57 | |
58 | 58 | |
59 | - /** |
|
60 | - * @return string |
|
61 | - */ |
|
62 | - public function distributionAssetsUrl(); |
|
59 | + /** |
|
60 | + * @return string |
|
61 | + */ |
|
62 | + public function distributionAssetsUrl(); |
|
63 | 63 | |
64 | 64 | |
65 | - /** |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - public function assetNamespace(); |
|
65 | + /** |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + public function assetNamespace(); |
|
69 | 69 | |
70 | 70 | } |
@@ -20,55 +20,55 @@ |
||
20 | 20 | class BlockCollection extends Collection |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * Collection constructor |
|
25 | - * |
|
26 | - * @throws InvalidInterfaceException |
|
27 | - */ |
|
28 | - public function __construct() |
|
29 | - { |
|
30 | - parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface'); |
|
31 | - } |
|
23 | + /** |
|
24 | + * Collection constructor |
|
25 | + * |
|
26 | + * @throws InvalidInterfaceException |
|
27 | + */ |
|
28 | + public function __construct() |
|
29 | + { |
|
30 | + parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface'); |
|
31 | + } |
|
32 | 32 | |
33 | 33 | |
34 | - /** |
|
35 | - * unRegisterBlock |
|
36 | - * finds block in the Collection based on the identifier that was set using addObject() |
|
37 | - * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found. |
|
38 | - * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
39 | - * |
|
40 | - * @param mixed $identifier |
|
41 | - * @return boolean |
|
42 | - */ |
|
43 | - public function unRegisterBlock($identifier) |
|
44 | - { |
|
45 | - $this->rewind(); |
|
46 | - while ($this->valid()) { |
|
47 | - if ($identifier === $this->getInfo()) { |
|
48 | - $object = $this->current(); |
|
49 | - $this->rewind(); |
|
50 | - return $object->unRegisterBlock(); |
|
51 | - } |
|
52 | - $this->next(); |
|
53 | - } |
|
54 | - return false; |
|
55 | - } |
|
34 | + /** |
|
35 | + * unRegisterBlock |
|
36 | + * finds block in the Collection based on the identifier that was set using addObject() |
|
37 | + * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found. |
|
38 | + * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
39 | + * |
|
40 | + * @param mixed $identifier |
|
41 | + * @return boolean |
|
42 | + */ |
|
43 | + public function unRegisterBlock($identifier) |
|
44 | + { |
|
45 | + $this->rewind(); |
|
46 | + while ($this->valid()) { |
|
47 | + if ($identifier === $this->getInfo()) { |
|
48 | + $object = $this->current(); |
|
49 | + $this->rewind(); |
|
50 | + return $object->unRegisterBlock(); |
|
51 | + } |
|
52 | + $this->next(); |
|
53 | + } |
|
54 | + return false; |
|
55 | + } |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * unRegisterAllBlocks |
|
60 | - * calls unRegisterBlock() on all blocks in Collection. |
|
61 | - * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
62 | - * |
|
63 | - * @return void |
|
64 | - */ |
|
65 | - public function unRegisterAllBlocks() |
|
66 | - { |
|
67 | - $this->rewind(); |
|
68 | - while ($this->valid()) { |
|
69 | - $this->current()->unRegisterBlock(); |
|
70 | - $this->next(); |
|
71 | - } |
|
72 | - $this->rewind(); |
|
73 | - } |
|
58 | + /** |
|
59 | + * unRegisterAllBlocks |
|
60 | + * calls unRegisterBlock() on all blocks in Collection. |
|
61 | + * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
62 | + * |
|
63 | + * @return void |
|
64 | + */ |
|
65 | + public function unRegisterAllBlocks() |
|
66 | + { |
|
67 | + $this->rewind(); |
|
68 | + while ($this->valid()) { |
|
69 | + $this->current()->unRegisterBlock(); |
|
70 | + $this->next(); |
|
71 | + } |
|
72 | + $this->rewind(); |
|
73 | + } |
|
74 | 74 | } |