@@ -11,41 +11,41 @@ |
||
11 | 11 | class EE_Radio_Button_Display_Strategy extends EE_Compound_Input_Display_Strategy |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * |
|
16 | - * @throws EE_Error |
|
17 | - * @return string of html to display the field |
|
18 | - */ |
|
19 | - public function display() |
|
20 | - { |
|
21 | - $input = $this->get_input(); |
|
22 | - $input->set_label_sizes(); |
|
23 | - $label_size_class = $input->get_label_size_class(); |
|
24 | - $html = ''; |
|
25 | - foreach ($input->options() as $value => $display_text) { |
|
26 | - $value = $input->get_normalization_strategy()->unnormalize($value); |
|
14 | + /** |
|
15 | + * |
|
16 | + * @throws EE_Error |
|
17 | + * @return string of html to display the field |
|
18 | + */ |
|
19 | + public function display() |
|
20 | + { |
|
21 | + $input = $this->get_input(); |
|
22 | + $input->set_label_sizes(); |
|
23 | + $label_size_class = $input->get_label_size_class(); |
|
24 | + $html = ''; |
|
25 | + foreach ($input->options() as $value => $display_text) { |
|
26 | + $value = $input->get_normalization_strategy()->unnormalize($value); |
|
27 | 27 | |
28 | - $html_id = $this->get_sub_input_id($value); |
|
29 | - $html .= EEH_HTML::nl(0, 'radio'); |
|
30 | - $html .= '<label for="' . $html_id . '"'; |
|
31 | - $html .= ' id="' . $html_id . '-lbl"'; |
|
32 | - $html .= ' class="ee-radio-label-after' . $label_size_class . '">'; |
|
33 | - $html .= EEH_HTML::nl(1, 'radio'); |
|
34 | - $html .= '<input id="' . $html_id . '"'; |
|
35 | - $html .= ' name="' . $input->html_name() . '"'; |
|
36 | - $html .= ' class="' . $input->html_class() . '"'; |
|
37 | - $html .= ' style="' . $input->html_style() . '"'; |
|
38 | - $html .= ' type="radio"'; |
|
39 | - $html .= ' value="' . esc_attr($value) . '"'; |
|
40 | - $html .= $input->raw_value() === $value ? ' checked="checked"' : ''; |
|
41 | - $html .= ' ' . $this->_input->other_html_attributes(); |
|
42 | - $html .= ' data-question_label="'. $input->html_label_id().'"'; |
|
43 | - $html .= '> '; |
|
44 | - $html .= $display_text; |
|
45 | - $html .= EEH_HTML::nl(-1, 'radio') . '</label>'; |
|
46 | - } |
|
47 | - $html .= EEH_HTML::div('', '', 'clear-float'); |
|
48 | - $html .= EEH_HTML::divx(); |
|
49 | - return $html; |
|
50 | - } |
|
28 | + $html_id = $this->get_sub_input_id($value); |
|
29 | + $html .= EEH_HTML::nl(0, 'radio'); |
|
30 | + $html .= '<label for="' . $html_id . '"'; |
|
31 | + $html .= ' id="' . $html_id . '-lbl"'; |
|
32 | + $html .= ' class="ee-radio-label-after' . $label_size_class . '">'; |
|
33 | + $html .= EEH_HTML::nl(1, 'radio'); |
|
34 | + $html .= '<input id="' . $html_id . '"'; |
|
35 | + $html .= ' name="' . $input->html_name() . '"'; |
|
36 | + $html .= ' class="' . $input->html_class() . '"'; |
|
37 | + $html .= ' style="' . $input->html_style() . '"'; |
|
38 | + $html .= ' type="radio"'; |
|
39 | + $html .= ' value="' . esc_attr($value) . '"'; |
|
40 | + $html .= $input->raw_value() === $value ? ' checked="checked"' : ''; |
|
41 | + $html .= ' ' . $this->_input->other_html_attributes(); |
|
42 | + $html .= ' data-question_label="'. $input->html_label_id().'"'; |
|
43 | + $html .= '> '; |
|
44 | + $html .= $display_text; |
|
45 | + $html .= EEH_HTML::nl(-1, 'radio') . '</label>'; |
|
46 | + } |
|
47 | + $html .= EEH_HTML::div('', '', 'clear-float'); |
|
48 | + $html .= EEH_HTML::divx(); |
|
49 | + return $html; |
|
50 | + } |
|
51 | 51 | } |
@@ -27,22 +27,22 @@ |
||
27 | 27 | |
28 | 28 | $html_id = $this->get_sub_input_id($value); |
29 | 29 | $html .= EEH_HTML::nl(0, 'radio'); |
30 | - $html .= '<label for="' . $html_id . '"'; |
|
31 | - $html .= ' id="' . $html_id . '-lbl"'; |
|
32 | - $html .= ' class="ee-radio-label-after' . $label_size_class . '">'; |
|
30 | + $html .= '<label for="'.$html_id.'"'; |
|
31 | + $html .= ' id="'.$html_id.'-lbl"'; |
|
32 | + $html .= ' class="ee-radio-label-after'.$label_size_class.'">'; |
|
33 | 33 | $html .= EEH_HTML::nl(1, 'radio'); |
34 | - $html .= '<input id="' . $html_id . '"'; |
|
35 | - $html .= ' name="' . $input->html_name() . '"'; |
|
36 | - $html .= ' class="' . $input->html_class() . '"'; |
|
37 | - $html .= ' style="' . $input->html_style() . '"'; |
|
34 | + $html .= '<input id="'.$html_id.'"'; |
|
35 | + $html .= ' name="'.$input->html_name().'"'; |
|
36 | + $html .= ' class="'.$input->html_class().'"'; |
|
37 | + $html .= ' style="'.$input->html_style().'"'; |
|
38 | 38 | $html .= ' type="radio"'; |
39 | - $html .= ' value="' . esc_attr($value) . '"'; |
|
39 | + $html .= ' value="'.esc_attr($value).'"'; |
|
40 | 40 | $html .= $input->raw_value() === $value ? ' checked="checked"' : ''; |
41 | - $html .= ' ' . $this->_input->other_html_attributes(); |
|
42 | - $html .= ' data-question_label="'. $input->html_label_id().'"'; |
|
41 | + $html .= ' '.$this->_input->other_html_attributes(); |
|
42 | + $html .= ' data-question_label="'.$input->html_label_id().'"'; |
|
43 | 43 | $html .= '> '; |
44 | 44 | $html .= $display_text; |
45 | - $html .= EEH_HTML::nl(-1, 'radio') . '</label>'; |
|
45 | + $html .= EEH_HTML::nl(-1, 'radio').'</label>'; |
|
46 | 46 | } |
47 | 47 | $html .= EEH_HTML::div('', '', 'clear-float'); |
48 | 48 | $html .= EEH_HTML::divx(); |
@@ -22,7 +22,7 @@ discard block |
||
22 | 22 | $input->set_label_sizes(); |
23 | 23 | $label_size_class = $input->get_label_size_class(); |
24 | 24 | $html = ''; |
25 | - if (! is_array($input->raw_value()) && $input->raw_value() !== null) { |
|
25 | + if ( ! is_array($input->raw_value()) && $input->raw_value() !== null) { |
|
26 | 26 | EE_Error::doing_it_wrong( |
27 | 27 | 'EE_Checkbox_Display_Strategy::display()', |
28 | 28 | sprintf( |
@@ -35,7 +35,7 @@ discard block |
||
35 | 35 | ), |
36 | 36 | $input->html_id(), |
37 | 37 | var_export($input->raw_value(), true), |
38 | - $input->html_name() . '[]' |
|
38 | + $input->html_name().'[]' |
|
39 | 39 | ), |
40 | 40 | '4.8.1' |
41 | 41 | ); |
@@ -54,19 +54,19 @@ discard block |
||
54 | 54 | . '">'; |
55 | 55 | $html .= EEH_HTML::nl(1, 'checkbox'); |
56 | 56 | $html .= '<input type="checkbox"'; |
57 | - $html .= ' name="' . $input->html_name() . '[]"'; |
|
58 | - $html .= ' id="' . $html_id . '"'; |
|
59 | - $html .= ' class="' . $input->html_class() . '"'; |
|
60 | - $html .= ' style="' . $input->html_style() . '"'; |
|
61 | - $html .= ' value="' . esc_attr($value) . '"'; |
|
57 | + $html .= ' name="'.$input->html_name().'[]"'; |
|
58 | + $html .= ' id="'.$html_id.'"'; |
|
59 | + $html .= ' class="'.$input->html_class().'"'; |
|
60 | + $html .= ' style="'.$input->html_style().'"'; |
|
61 | + $html .= ' value="'.esc_attr($value).'"'; |
|
62 | 62 | $html .= ! empty($input_raw_value) && in_array($value, $input_raw_value, true) |
63 | 63 | ? ' checked="checked"' |
64 | 64 | : ''; |
65 | - $html .= ' ' . $this->_input->other_html_attributes(); |
|
66 | - $html .= ' data-question_label="' . $input->html_label_id() . '"'; |
|
65 | + $html .= ' '.$this->_input->other_html_attributes(); |
|
66 | + $html .= ' data-question_label="'.$input->html_label_id().'"'; |
|
67 | 67 | $html .= '> '; |
68 | 68 | $html .= $display_text; |
69 | - $html .= EEH_HTML::nl(-1, 'checkbox') . '</label>'; |
|
69 | + $html .= EEH_HTML::nl(-1, 'checkbox').'</label>'; |
|
70 | 70 | } |
71 | 71 | return $html; |
72 | 72 | } |
@@ -12,60 +12,60 @@ |
||
12 | 12 | class EE_Checkbox_Display_Strategy extends EE_Compound_Input_Display_Strategy |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * @throws EE_Error |
|
17 | - * @return string of html to display the field |
|
18 | - */ |
|
19 | - public function display() |
|
20 | - { |
|
21 | - $input = $this->get_input(); |
|
22 | - $input->set_label_sizes(); |
|
23 | - $label_size_class = $input->get_label_size_class(); |
|
24 | - $html = ''; |
|
25 | - if (! is_array($input->raw_value()) && $input->raw_value() !== null) { |
|
26 | - EE_Error::doing_it_wrong( |
|
27 | - 'EE_Checkbox_Display_Strategy::display()', |
|
28 | - sprintf( |
|
29 | - esc_html_x( |
|
30 | - 'Input values for checkboxes should be an array of values, but the value for input "%1$s" is "%2$s". Please verify that the input name is exactly "%3$s"', |
|
31 | - 'Input values for checkboxes should be an array of values, but the value for input "form-input-id" is "form-input-value". Please verify that the input name is exactly "form_input_name[]"', |
|
32 | - 'event_espresso' |
|
33 | - ), |
|
34 | - $input->html_id(), |
|
35 | - var_export($input->raw_value(), true), |
|
36 | - $input->html_name() . '[]' |
|
37 | - ), |
|
38 | - '4.8.1' |
|
39 | - ); |
|
40 | - } |
|
41 | - $input_raw_value = (array) $input->raw_value(); |
|
42 | - foreach ($input->options() as $value => $display_text) { |
|
43 | - $value = $input->get_normalization_strategy()->unnormalize_one($value); |
|
44 | - $html_id = $this->get_sub_input_id($value); |
|
45 | - $html .= EEH_HTML::nl(0, 'checkbox'); |
|
46 | - $html .= '<label for="' |
|
47 | - . $html_id |
|
48 | - . '" id="' |
|
49 | - . $html_id |
|
50 | - . '-lbl" class="ee-checkbox-label-after' |
|
51 | - . $label_size_class |
|
52 | - . '">'; |
|
53 | - $html .= EEH_HTML::nl(1, 'checkbox'); |
|
54 | - $html .= '<input type="checkbox"'; |
|
55 | - $html .= ' name="' . $input->html_name() . '[]"'; |
|
56 | - $html .= ' id="' . $html_id . '"'; |
|
57 | - $html .= ' class="' . $input->html_class() . '"'; |
|
58 | - $html .= ' style="' . $input->html_style() . '"'; |
|
59 | - $html .= ' value="' . esc_attr($value) . '"'; |
|
60 | - $html .= ! empty($input_raw_value) && in_array($value, $input_raw_value, true) |
|
61 | - ? ' checked="checked"' |
|
62 | - : ''; |
|
63 | - $html .= ' ' . $this->_input->other_html_attributes(); |
|
64 | - $html .= ' data-question_label="' . $input->html_label_id() . '"'; |
|
65 | - $html .= '> '; |
|
66 | - $html .= $display_text; |
|
67 | - $html .= EEH_HTML::nl(-1, 'checkbox') . '</label>'; |
|
68 | - } |
|
69 | - return $html; |
|
70 | - } |
|
15 | + /** |
|
16 | + * @throws EE_Error |
|
17 | + * @return string of html to display the field |
|
18 | + */ |
|
19 | + public function display() |
|
20 | + { |
|
21 | + $input = $this->get_input(); |
|
22 | + $input->set_label_sizes(); |
|
23 | + $label_size_class = $input->get_label_size_class(); |
|
24 | + $html = ''; |
|
25 | + if (! is_array($input->raw_value()) && $input->raw_value() !== null) { |
|
26 | + EE_Error::doing_it_wrong( |
|
27 | + 'EE_Checkbox_Display_Strategy::display()', |
|
28 | + sprintf( |
|
29 | + esc_html_x( |
|
30 | + 'Input values for checkboxes should be an array of values, but the value for input "%1$s" is "%2$s". Please verify that the input name is exactly "%3$s"', |
|
31 | + 'Input values for checkboxes should be an array of values, but the value for input "form-input-id" is "form-input-value". Please verify that the input name is exactly "form_input_name[]"', |
|
32 | + 'event_espresso' |
|
33 | + ), |
|
34 | + $input->html_id(), |
|
35 | + var_export($input->raw_value(), true), |
|
36 | + $input->html_name() . '[]' |
|
37 | + ), |
|
38 | + '4.8.1' |
|
39 | + ); |
|
40 | + } |
|
41 | + $input_raw_value = (array) $input->raw_value(); |
|
42 | + foreach ($input->options() as $value => $display_text) { |
|
43 | + $value = $input->get_normalization_strategy()->unnormalize_one($value); |
|
44 | + $html_id = $this->get_sub_input_id($value); |
|
45 | + $html .= EEH_HTML::nl(0, 'checkbox'); |
|
46 | + $html .= '<label for="' |
|
47 | + . $html_id |
|
48 | + . '" id="' |
|
49 | + . $html_id |
|
50 | + . '-lbl" class="ee-checkbox-label-after' |
|
51 | + . $label_size_class |
|
52 | + . '">'; |
|
53 | + $html .= EEH_HTML::nl(1, 'checkbox'); |
|
54 | + $html .= '<input type="checkbox"'; |
|
55 | + $html .= ' name="' . $input->html_name() . '[]"'; |
|
56 | + $html .= ' id="' . $html_id . '"'; |
|
57 | + $html .= ' class="' . $input->html_class() . '"'; |
|
58 | + $html .= ' style="' . $input->html_style() . '"'; |
|
59 | + $html .= ' value="' . esc_attr($value) . '"'; |
|
60 | + $html .= ! empty($input_raw_value) && in_array($value, $input_raw_value, true) |
|
61 | + ? ' checked="checked"' |
|
62 | + : ''; |
|
63 | + $html .= ' ' . $this->_input->other_html_attributes(); |
|
64 | + $html .= ' data-question_label="' . $input->html_label_id() . '"'; |
|
65 | + $html .= '> '; |
|
66 | + $html .= $display_text; |
|
67 | + $html .= EEH_HTML::nl(-1, 'checkbox') . '</label>'; |
|
68 | + } |
|
69 | + return $html; |
|
70 | + } |
|
71 | 71 | } |
@@ -16,561 +16,561 @@ |
||
16 | 16 | abstract class EEM_CPT_Base extends EEM_Soft_Delete_Base |
17 | 17 | { |
18 | 18 | |
19 | - const EVENT_CATEGORY_TAXONOMY = 'espresso_event_category'; |
|
20 | - |
|
21 | - /** |
|
22 | - * @var string post_status_publish - the wp post status for published cpts |
|
23 | - */ |
|
24 | - const post_status_publish = 'publish'; |
|
25 | - |
|
26 | - /** |
|
27 | - * @var string post_status_future - the wp post status for scheduled cpts |
|
28 | - */ |
|
29 | - const post_status_future = 'future'; |
|
30 | - |
|
31 | - /** |
|
32 | - * @var string post_status_draft - the wp post status for draft cpts |
|
33 | - */ |
|
34 | - const post_status_draft = 'draft'; |
|
35 | - |
|
36 | - /** |
|
37 | - * @var string post_status_pending - the wp post status for pending cpts |
|
38 | - */ |
|
39 | - const post_status_pending = 'pending'; |
|
40 | - |
|
41 | - /** |
|
42 | - * @var string post_status_private - the wp post status for private cpts |
|
43 | - */ |
|
44 | - const post_status_private = 'private'; |
|
45 | - |
|
46 | - /** |
|
47 | - * @var string post_status_trashed - the wp post status for trashed cpts |
|
48 | - */ |
|
49 | - const post_status_trashed = 'trash'; |
|
50 | - |
|
51 | - /** |
|
52 | - * This is an array of custom statuses for the given CPT model (modified by children) |
|
53 | - * format: |
|
54 | - * array( |
|
55 | - * 'status_name' => array( |
|
56 | - * 'label' => __('Status Name', 'event_espresso'), |
|
57 | - * 'public' => TRUE //whether a public status or not. |
|
58 | - * ) |
|
59 | - * ) |
|
60 | - * |
|
61 | - * @var array |
|
62 | - */ |
|
63 | - protected $_custom_stati = array(); |
|
64 | - |
|
65 | - |
|
66 | - /** |
|
67 | - * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
68 | - * |
|
69 | - * @param string $timezone |
|
70 | - * @throws \EE_Error |
|
71 | - */ |
|
72 | - protected function __construct($timezone = null) |
|
73 | - { |
|
74 | - // adds a relationship to Term_Taxonomy for all these models. For this to work |
|
75 | - // Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly |
|
76 | - // eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry |
|
77 | - // with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value |
|
78 | - // must also be new EE_HABTM_Relation('Term_Relationship'); |
|
79 | - $this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship'); |
|
80 | - $primary_table_name = null; |
|
81 | - // add the common _status field to all CPT primary tables. |
|
82 | - foreach ($this->_tables as $alias => $table_obj) { |
|
83 | - if ($table_obj instanceof EE_Primary_Table) { |
|
84 | - $primary_table_name = $alias; |
|
85 | - } |
|
86 | - } |
|
87 | - // set default wp post statuses if child has not already set. |
|
88 | - if (! isset($this->_fields[ $primary_table_name ]['status'])) { |
|
89 | - $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field( |
|
90 | - 'post_status', |
|
91 | - __("Event Status", "event_espresso"), |
|
92 | - false, |
|
93 | - 'draft' |
|
94 | - ); |
|
95 | - } |
|
96 | - if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) { |
|
97 | - $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field( |
|
98 | - 'to_ping', |
|
99 | - __('To Ping', 'event_espresso'), |
|
100 | - false, |
|
101 | - '' |
|
102 | - ); |
|
103 | - } |
|
104 | - if (! isset($this->_fields[ $primary_table_name ]['pinged'])) { |
|
105 | - $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field( |
|
106 | - 'pinged', |
|
107 | - __('Pinged', 'event_espresso'), |
|
108 | - false, |
|
109 | - '' |
|
110 | - ); |
|
111 | - } |
|
112 | - if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) { |
|
113 | - $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field( |
|
114 | - 'comment_status', |
|
115 | - __('Comment Status', 'event_espresso'), |
|
116 | - false, |
|
117 | - 'open' |
|
118 | - ); |
|
119 | - } |
|
120 | - if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) { |
|
121 | - $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field( |
|
122 | - 'ping_status', |
|
123 | - __('Ping Status', 'event_espresso'), |
|
124 | - false, |
|
125 | - 'open' |
|
126 | - ); |
|
127 | - } |
|
128 | - if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) { |
|
129 | - $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field( |
|
130 | - 'post_content_filtered', |
|
131 | - __('Post Content Filtered', 'event_espresso'), |
|
132 | - false, |
|
133 | - '' |
|
134 | - ); |
|
135 | - } |
|
136 | - if (! isset($this->_model_relations['Post_Meta'])) { |
|
137 | - // don't block deletes though because we want to maintain the current behaviour |
|
138 | - $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false); |
|
139 | - } |
|
140 | - if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) { |
|
141 | - // nothing was set during child constructor, so set default |
|
142 | - $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type()); |
|
143 | - } |
|
144 | - if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) { |
|
145 | - // nothing was set during child constructor, so set default |
|
146 | - // it's ok for child classes to specify this, but generally this is more DRY |
|
147 | - $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type()); |
|
148 | - } |
|
149 | - parent::__construct($timezone); |
|
150 | - } |
|
151 | - |
|
152 | - |
|
153 | - /** |
|
154 | - * @return array |
|
155 | - */ |
|
156 | - public function public_event_stati() |
|
157 | - { |
|
158 | - // @see wp-includes/post.php |
|
159 | - return get_post_stati(array('public' => true)); |
|
160 | - } |
|
161 | - |
|
162 | - |
|
163 | - /** |
|
164 | - * Searches for field on this model of type 'deleted_flag'. if it is found, |
|
165 | - * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name |
|
166 | - * |
|
167 | - * @return string |
|
168 | - * @throws EE_Error |
|
169 | - */ |
|
170 | - public function deleted_field_name() |
|
171 | - { |
|
172 | - throw new EE_Error( |
|
173 | - sprintf( |
|
174 | - __( |
|
175 | - "EEM_CPT_Base should nto call deleted_field_name! It should instead use post_status_field_name", |
|
176 | - "event_espresso" |
|
177 | - ) |
|
178 | - ) |
|
179 | - ); |
|
180 | - } |
|
181 | - |
|
182 | - |
|
183 | - /** |
|
184 | - * Gets the field's name that sets the post status |
|
185 | - * |
|
186 | - * @return string |
|
187 | - * @throws EE_Error |
|
188 | - */ |
|
189 | - public function post_status_field_name() |
|
190 | - { |
|
191 | - $field = $this->get_a_field_of_type('EE_WP_Post_Status_Field'); |
|
192 | - if ($field) { |
|
193 | - return $field->get_name(); |
|
194 | - } else { |
|
195 | - throw new EE_Error( |
|
196 | - sprintf( |
|
197 | - __( |
|
198 | - 'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?', |
|
199 | - 'event_espresso' |
|
200 | - ), |
|
201 | - get_class($this), |
|
202 | - get_class($this) |
|
203 | - ) |
|
204 | - ); |
|
205 | - } |
|
206 | - } |
|
207 | - |
|
208 | - |
|
209 | - /** |
|
210 | - * Alters the query params so that only trashed/soft-deleted items are considered |
|
211 | - * |
|
212 | - * @param array $query_params like EEM_Base::get_all's $query_params |
|
213 | - * @return array like EEM_Base::get_all's $query_params |
|
214 | - */ |
|
215 | - protected function _alter_query_params_so_only_trashed_items_included($query_params) |
|
216 | - { |
|
217 | - $post_status_field_name = $this->post_status_field_name(); |
|
218 | - $query_params[0][ $post_status_field_name ] = self::post_status_trashed; |
|
219 | - return $query_params; |
|
220 | - } |
|
221 | - |
|
222 | - |
|
223 | - /** |
|
224 | - * Alters the query params so each item's deleted status is ignored. |
|
225 | - * |
|
226 | - * @param array $query_params |
|
227 | - * @return array |
|
228 | - */ |
|
229 | - protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params) |
|
230 | - { |
|
231 | - $query_params['default_where_conditions'] = 'minimum'; |
|
232 | - return $query_params; |
|
233 | - } |
|
234 | - |
|
235 | - |
|
236 | - /** |
|
237 | - * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered. |
|
238 | - * |
|
239 | - * @param boolean $delete true to indicate deletion, false to indicate restoration |
|
240 | - * @param array $query_params like EEM_Base::get_all |
|
241 | - * @return boolean success |
|
242 | - */ |
|
243 | - public function delete_or_restore($delete = true, $query_params = array()) |
|
244 | - { |
|
245 | - $post_status_field_name = $this->post_status_field_name(); |
|
246 | - $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params); |
|
247 | - $new_status = $delete ? self::post_status_trashed : 'draft'; |
|
248 | - if ($this->update(array($post_status_field_name => $new_status), $query_params)) { |
|
249 | - return true; |
|
250 | - } else { |
|
251 | - return false; |
|
252 | - } |
|
253 | - } |
|
254 | - |
|
255 | - |
|
256 | - /** |
|
257 | - * meta_table |
|
258 | - * returns first EE_Secondary_Table table name |
|
259 | - * |
|
260 | - * @access public |
|
261 | - * @return string |
|
262 | - */ |
|
263 | - public function meta_table() |
|
264 | - { |
|
265 | - $meta_table = $this->_get_other_tables(); |
|
266 | - $meta_table = reset($meta_table); |
|
267 | - return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null; |
|
268 | - } |
|
269 | - |
|
270 | - |
|
271 | - /** |
|
272 | - * This simply returns an array of the meta table fields (useful for when we just need to update those fields) |
|
273 | - * |
|
274 | - * @param bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields. Defaults to false (no |
|
275 | - * db only fields) |
|
276 | - * @return array |
|
277 | - */ |
|
278 | - public function get_meta_table_fields($all = false) |
|
279 | - { |
|
280 | - $all_fields = $fields_to_return = array(); |
|
281 | - foreach ($this->_tables as $alias => $table_obj) { |
|
282 | - if ($table_obj instanceof EE_Secondary_Table) { |
|
283 | - $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields); |
|
284 | - } |
|
285 | - } |
|
286 | - if (! $all) { |
|
287 | - foreach ($all_fields as $name => $obj) { |
|
288 | - if ($obj instanceof EE_DB_Only_Field_Base) { |
|
289 | - continue; |
|
290 | - } |
|
291 | - $fields_to_return[] = $name; |
|
292 | - } |
|
293 | - } else { |
|
294 | - $fields_to_return = array_keys($all_fields); |
|
295 | - } |
|
296 | - return $fields_to_return; |
|
297 | - } |
|
298 | - |
|
299 | - |
|
300 | - /** |
|
301 | - * Adds an event category with the specified name and description to the specified |
|
302 | - * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary, |
|
303 | - * and adds an entry in the term_relationship if necessary. |
|
304 | - * |
|
305 | - * @param EE_CPT_Base $cpt_model_object |
|
306 | - * @param string $category_name (used to derive the term slug too) |
|
307 | - * @param string $category_description |
|
308 | - * @param int $parent_term_taxonomy_id |
|
309 | - * @return EE_Term_Taxonomy |
|
310 | - */ |
|
311 | - public function add_event_category( |
|
312 | - EE_CPT_Base $cpt_model_object, |
|
313 | - $category_name, |
|
314 | - $category_description = '', |
|
315 | - $parent_term_taxonomy_id = null |
|
316 | - ) { |
|
317 | - // create term |
|
318 | - require_once(EE_MODELS . 'EEM_Term.model.php'); |
|
319 | - // first, check for a term by the same name or slug |
|
320 | - $category_slug = sanitize_title($category_name); |
|
321 | - $term = EEM_Term::instance()->get_one( |
|
322 | - array( |
|
323 | - array( |
|
324 | - 'OR' => array( |
|
325 | - 'name' => $category_name, |
|
326 | - 'slug' => $category_slug, |
|
327 | - ), |
|
328 | - ), |
|
329 | - ) |
|
330 | - ); |
|
331 | - if (! $term) { |
|
332 | - $term = EE_Term::new_instance( |
|
333 | - array( |
|
334 | - 'name' => $category_name, |
|
335 | - 'slug' => $category_slug, |
|
336 | - ) |
|
337 | - ); |
|
338 | - $term->save(); |
|
339 | - } |
|
340 | - // make sure there's a term-taxonomy entry too |
|
341 | - require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php'); |
|
342 | - $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one( |
|
343 | - array( |
|
344 | - array( |
|
345 | - 'term_id' => $term->ID(), |
|
346 | - 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY, |
|
347 | - ), |
|
348 | - ) |
|
349 | - ); |
|
350 | - /** @var $term_taxonomy EE_Term_Taxonomy */ |
|
351 | - if (! $term_taxonomy) { |
|
352 | - $term_taxonomy = EE_Term_Taxonomy::new_instance( |
|
353 | - array( |
|
354 | - 'term_id' => $term->ID(), |
|
355 | - 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY, |
|
356 | - 'description' => $category_description, |
|
357 | - 'term_count' => 1, |
|
358 | - 'parent' => $parent_term_taxonomy_id, |
|
359 | - ) |
|
360 | - ); |
|
361 | - $term_taxonomy->save(); |
|
362 | - } else { |
|
363 | - $term_taxonomy->set_count($term_taxonomy->count() + 1); |
|
364 | - $term_taxonomy->save(); |
|
365 | - } |
|
366 | - return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy'); |
|
367 | - } |
|
368 | - |
|
369 | - |
|
370 | - /** |
|
371 | - * Removed the category specified by name as having a relation to this event. |
|
372 | - * Does not remove the term or term_taxonomy. |
|
373 | - * |
|
374 | - * @param EE_CPT_Base $cpt_model_object_event |
|
375 | - * @param string $category_name name of the event category (term) |
|
376 | - * @return bool |
|
377 | - */ |
|
378 | - public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name) |
|
379 | - { |
|
380 | - // find the term_taxonomy by that name |
|
381 | - $term_taxonomy = $this->get_first_related( |
|
382 | - $cpt_model_object_event, |
|
383 | - 'Term_Taxonomy', |
|
384 | - array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY)) |
|
385 | - ); |
|
386 | - /** @var $term_taxonomy EE_Term_Taxonomy */ |
|
387 | - if ($term_taxonomy) { |
|
388 | - $term_taxonomy->set_count($term_taxonomy->count() - 1); |
|
389 | - $term_taxonomy->save(); |
|
390 | - } |
|
391 | - return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy'); |
|
392 | - } |
|
393 | - |
|
394 | - |
|
395 | - /** |
|
396 | - * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the |
|
397 | - * given CPT ID. It accepts the same params as what get_the_post_thumbnail() accepts. |
|
398 | - * |
|
399 | - * @link http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail |
|
400 | - * @access public |
|
401 | - * @param int $id the ID for the cpt we want the feature image for |
|
402 | - * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array |
|
403 | - * representing width and height in pixels (i.e. array(32,32) ). |
|
404 | - * @param string|array $attr Optional. Query string or array of attributes. |
|
405 | - * @return string HTML image element |
|
406 | - */ |
|
407 | - public function get_feature_image($id, $size = 'thumbnail', $attr = '') |
|
408 | - { |
|
409 | - return get_the_post_thumbnail($id, $size, $attr); |
|
410 | - } |
|
411 | - |
|
412 | - |
|
413 | - /** |
|
414 | - * Just a handy way to get the list of post statuses currently registered with WP. |
|
415 | - * |
|
416 | - * @global array $wp_post_statuses set in wp core for storing all the post stati |
|
417 | - * @return array |
|
418 | - */ |
|
419 | - public function get_post_statuses() |
|
420 | - { |
|
421 | - global $wp_post_statuses; |
|
422 | - $statuses = array(); |
|
423 | - foreach ($wp_post_statuses as $post_status => $args_object) { |
|
424 | - $statuses[ $post_status ] = $args_object->label; |
|
425 | - } |
|
426 | - return $statuses; |
|
427 | - } |
|
428 | - |
|
429 | - |
|
430 | - /** |
|
431 | - * public method that can be used to retrieve the protected status array on the instantiated cpt model |
|
432 | - * |
|
433 | - * @return array array of statuses. |
|
434 | - */ |
|
435 | - public function get_status_array() |
|
436 | - { |
|
437 | - $statuses = $this->get_post_statuses(); |
|
438 | - // first the global filter |
|
439 | - $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses); |
|
440 | - // now the class specific filter |
|
441 | - $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses); |
|
442 | - return $statuses; |
|
443 | - } |
|
444 | - |
|
445 | - |
|
446 | - /** |
|
447 | - * this returns the post statuses that are NOT the default wordpress status |
|
448 | - * |
|
449 | - * @return array |
|
450 | - */ |
|
451 | - public function get_custom_post_statuses() |
|
452 | - { |
|
453 | - $new_stati = array(); |
|
454 | - foreach ($this->_custom_stati as $status => $props) { |
|
455 | - $new_stati[ $status ] = $props['label']; |
|
456 | - } |
|
457 | - return $new_stati; |
|
458 | - } |
|
459 | - |
|
460 | - |
|
461 | - /** |
|
462 | - * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which |
|
463 | - * are a row from the posts table. If we're missing any fields required for the model, |
|
464 | - * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries, |
|
465 | - * make sure you are attaching all the model's fields onto the post) |
|
466 | - * |
|
467 | - * @param WP_Post|array $post |
|
468 | - * @return EE_Base_Class|EE_Soft_Delete_Base_Class |
|
469 | - */ |
|
470 | - public function instantiate_class_from_post_object_orig($post) |
|
471 | - { |
|
472 | - $post = (array) $post; |
|
473 | - $has_all_necessary_fields_for_table = true; |
|
474 | - // check if the post has fields on the meta table already |
|
475 | - foreach ($this->_get_other_tables() as $table_obj) { |
|
476 | - $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias()); |
|
477 | - foreach ($fields_for_that_table as $field_obj) { |
|
478 | - if (! isset($post[ $field_obj->get_table_column() ]) |
|
479 | - && ! isset($post[ $field_obj->get_qualified_column() ]) |
|
480 | - ) { |
|
481 | - $has_all_necessary_fields_for_table = false; |
|
482 | - } |
|
483 | - } |
|
484 | - } |
|
485 | - // if we don't have all the fields we need, then just fetch the proper model from the DB |
|
486 | - if (! $has_all_necessary_fields_for_table) { |
|
487 | - return $this->get_one_by_ID($post['ID']); |
|
488 | - } else { |
|
489 | - return $this->instantiate_class_from_array_or_object($post); |
|
490 | - } |
|
491 | - } |
|
492 | - |
|
493 | - |
|
494 | - /** |
|
495 | - * @param null $post |
|
496 | - * @return EE_Base_Class|EE_Soft_Delete_Base_Class |
|
497 | - */ |
|
498 | - public function instantiate_class_from_post_object($post = null) |
|
499 | - { |
|
500 | - if (empty($post)) { |
|
501 | - global $post; |
|
502 | - } |
|
503 | - $post = (array) $post; |
|
504 | - $tables_needing_to_be_queried = array(); |
|
505 | - // check if the post has fields on the meta table already |
|
506 | - foreach ($this->get_tables() as $table_obj) { |
|
507 | - $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias()); |
|
508 | - foreach ($fields_for_that_table as $field_obj) { |
|
509 | - if (! isset($post[ $field_obj->get_table_column() ]) |
|
510 | - && ! isset($post[ $field_obj->get_qualified_column() ]) |
|
511 | - ) { |
|
512 | - $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj; |
|
513 | - } |
|
514 | - } |
|
515 | - } |
|
516 | - // if we don't have all the fields we need, then just fetch the proper model from the DB |
|
517 | - if ($tables_needing_to_be_queried) { |
|
518 | - if (count($tables_needing_to_be_queried) == 1 |
|
519 | - && reset($tables_needing_to_be_queried) |
|
520 | - instanceof |
|
521 | - EE_Secondary_Table |
|
522 | - ) { |
|
523 | - // so we're only missing data from a secondary table. Well that's not too hard to query for |
|
524 | - $table_to_query = reset($tables_needing_to_be_queried); |
|
525 | - $missing_data = $this->_do_wpdb_query( |
|
526 | - 'get_row', |
|
527 | - array( |
|
528 | - 'SELECT * FROM ' |
|
529 | - . $table_to_query->get_table_name() |
|
530 | - . ' WHERE ' |
|
531 | - . $table_to_query->get_fk_on_table() |
|
532 | - . ' = ' |
|
533 | - . $post['ID'], |
|
534 | - ARRAY_A, |
|
535 | - ) |
|
536 | - ); |
|
537 | - if (! empty($missing_data)) { |
|
538 | - $post = array_merge($post, $missing_data); |
|
539 | - } |
|
540 | - } else { |
|
541 | - return $this->get_one_by_ID($post['ID']); |
|
542 | - } |
|
543 | - } |
|
544 | - return $this->instantiate_class_from_array_or_object($post); |
|
545 | - } |
|
546 | - |
|
547 | - |
|
548 | - /** |
|
549 | - * Gets the post type associated with this |
|
550 | - * |
|
551 | - * @throws EE_Error |
|
552 | - * @return string |
|
553 | - */ |
|
554 | - public function post_type() |
|
555 | - { |
|
556 | - $post_type_field = null; |
|
557 | - foreach ($this->field_settings(true) as $field_obj) { |
|
558 | - if ($field_obj instanceof EE_WP_Post_Type_Field) { |
|
559 | - $post_type_field = $field_obj; |
|
560 | - break; |
|
561 | - } |
|
562 | - } |
|
563 | - if ($post_type_field == null) { |
|
564 | - throw new EE_Error( |
|
565 | - sprintf( |
|
566 | - __( |
|
567 | - "CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt", |
|
568 | - "event_espresso" |
|
569 | - ), |
|
570 | - get_class($this) |
|
571 | - ) |
|
572 | - ); |
|
573 | - } |
|
574 | - return $post_type_field->get_default_value(); |
|
575 | - } |
|
19 | + const EVENT_CATEGORY_TAXONOMY = 'espresso_event_category'; |
|
20 | + |
|
21 | + /** |
|
22 | + * @var string post_status_publish - the wp post status for published cpts |
|
23 | + */ |
|
24 | + const post_status_publish = 'publish'; |
|
25 | + |
|
26 | + /** |
|
27 | + * @var string post_status_future - the wp post status for scheduled cpts |
|
28 | + */ |
|
29 | + const post_status_future = 'future'; |
|
30 | + |
|
31 | + /** |
|
32 | + * @var string post_status_draft - the wp post status for draft cpts |
|
33 | + */ |
|
34 | + const post_status_draft = 'draft'; |
|
35 | + |
|
36 | + /** |
|
37 | + * @var string post_status_pending - the wp post status for pending cpts |
|
38 | + */ |
|
39 | + const post_status_pending = 'pending'; |
|
40 | + |
|
41 | + /** |
|
42 | + * @var string post_status_private - the wp post status for private cpts |
|
43 | + */ |
|
44 | + const post_status_private = 'private'; |
|
45 | + |
|
46 | + /** |
|
47 | + * @var string post_status_trashed - the wp post status for trashed cpts |
|
48 | + */ |
|
49 | + const post_status_trashed = 'trash'; |
|
50 | + |
|
51 | + /** |
|
52 | + * This is an array of custom statuses for the given CPT model (modified by children) |
|
53 | + * format: |
|
54 | + * array( |
|
55 | + * 'status_name' => array( |
|
56 | + * 'label' => __('Status Name', 'event_espresso'), |
|
57 | + * 'public' => TRUE //whether a public status or not. |
|
58 | + * ) |
|
59 | + * ) |
|
60 | + * |
|
61 | + * @var array |
|
62 | + */ |
|
63 | + protected $_custom_stati = array(); |
|
64 | + |
|
65 | + |
|
66 | + /** |
|
67 | + * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
68 | + * |
|
69 | + * @param string $timezone |
|
70 | + * @throws \EE_Error |
|
71 | + */ |
|
72 | + protected function __construct($timezone = null) |
|
73 | + { |
|
74 | + // adds a relationship to Term_Taxonomy for all these models. For this to work |
|
75 | + // Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly |
|
76 | + // eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry |
|
77 | + // with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value |
|
78 | + // must also be new EE_HABTM_Relation('Term_Relationship'); |
|
79 | + $this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship'); |
|
80 | + $primary_table_name = null; |
|
81 | + // add the common _status field to all CPT primary tables. |
|
82 | + foreach ($this->_tables as $alias => $table_obj) { |
|
83 | + if ($table_obj instanceof EE_Primary_Table) { |
|
84 | + $primary_table_name = $alias; |
|
85 | + } |
|
86 | + } |
|
87 | + // set default wp post statuses if child has not already set. |
|
88 | + if (! isset($this->_fields[ $primary_table_name ]['status'])) { |
|
89 | + $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field( |
|
90 | + 'post_status', |
|
91 | + __("Event Status", "event_espresso"), |
|
92 | + false, |
|
93 | + 'draft' |
|
94 | + ); |
|
95 | + } |
|
96 | + if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) { |
|
97 | + $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field( |
|
98 | + 'to_ping', |
|
99 | + __('To Ping', 'event_espresso'), |
|
100 | + false, |
|
101 | + '' |
|
102 | + ); |
|
103 | + } |
|
104 | + if (! isset($this->_fields[ $primary_table_name ]['pinged'])) { |
|
105 | + $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field( |
|
106 | + 'pinged', |
|
107 | + __('Pinged', 'event_espresso'), |
|
108 | + false, |
|
109 | + '' |
|
110 | + ); |
|
111 | + } |
|
112 | + if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) { |
|
113 | + $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field( |
|
114 | + 'comment_status', |
|
115 | + __('Comment Status', 'event_espresso'), |
|
116 | + false, |
|
117 | + 'open' |
|
118 | + ); |
|
119 | + } |
|
120 | + if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) { |
|
121 | + $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field( |
|
122 | + 'ping_status', |
|
123 | + __('Ping Status', 'event_espresso'), |
|
124 | + false, |
|
125 | + 'open' |
|
126 | + ); |
|
127 | + } |
|
128 | + if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) { |
|
129 | + $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field( |
|
130 | + 'post_content_filtered', |
|
131 | + __('Post Content Filtered', 'event_espresso'), |
|
132 | + false, |
|
133 | + '' |
|
134 | + ); |
|
135 | + } |
|
136 | + if (! isset($this->_model_relations['Post_Meta'])) { |
|
137 | + // don't block deletes though because we want to maintain the current behaviour |
|
138 | + $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false); |
|
139 | + } |
|
140 | + if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) { |
|
141 | + // nothing was set during child constructor, so set default |
|
142 | + $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type()); |
|
143 | + } |
|
144 | + if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) { |
|
145 | + // nothing was set during child constructor, so set default |
|
146 | + // it's ok for child classes to specify this, but generally this is more DRY |
|
147 | + $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type()); |
|
148 | + } |
|
149 | + parent::__construct($timezone); |
|
150 | + } |
|
151 | + |
|
152 | + |
|
153 | + /** |
|
154 | + * @return array |
|
155 | + */ |
|
156 | + public function public_event_stati() |
|
157 | + { |
|
158 | + // @see wp-includes/post.php |
|
159 | + return get_post_stati(array('public' => true)); |
|
160 | + } |
|
161 | + |
|
162 | + |
|
163 | + /** |
|
164 | + * Searches for field on this model of type 'deleted_flag'. if it is found, |
|
165 | + * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name |
|
166 | + * |
|
167 | + * @return string |
|
168 | + * @throws EE_Error |
|
169 | + */ |
|
170 | + public function deleted_field_name() |
|
171 | + { |
|
172 | + throw new EE_Error( |
|
173 | + sprintf( |
|
174 | + __( |
|
175 | + "EEM_CPT_Base should nto call deleted_field_name! It should instead use post_status_field_name", |
|
176 | + "event_espresso" |
|
177 | + ) |
|
178 | + ) |
|
179 | + ); |
|
180 | + } |
|
181 | + |
|
182 | + |
|
183 | + /** |
|
184 | + * Gets the field's name that sets the post status |
|
185 | + * |
|
186 | + * @return string |
|
187 | + * @throws EE_Error |
|
188 | + */ |
|
189 | + public function post_status_field_name() |
|
190 | + { |
|
191 | + $field = $this->get_a_field_of_type('EE_WP_Post_Status_Field'); |
|
192 | + if ($field) { |
|
193 | + return $field->get_name(); |
|
194 | + } else { |
|
195 | + throw new EE_Error( |
|
196 | + sprintf( |
|
197 | + __( |
|
198 | + 'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?', |
|
199 | + 'event_espresso' |
|
200 | + ), |
|
201 | + get_class($this), |
|
202 | + get_class($this) |
|
203 | + ) |
|
204 | + ); |
|
205 | + } |
|
206 | + } |
|
207 | + |
|
208 | + |
|
209 | + /** |
|
210 | + * Alters the query params so that only trashed/soft-deleted items are considered |
|
211 | + * |
|
212 | + * @param array $query_params like EEM_Base::get_all's $query_params |
|
213 | + * @return array like EEM_Base::get_all's $query_params |
|
214 | + */ |
|
215 | + protected function _alter_query_params_so_only_trashed_items_included($query_params) |
|
216 | + { |
|
217 | + $post_status_field_name = $this->post_status_field_name(); |
|
218 | + $query_params[0][ $post_status_field_name ] = self::post_status_trashed; |
|
219 | + return $query_params; |
|
220 | + } |
|
221 | + |
|
222 | + |
|
223 | + /** |
|
224 | + * Alters the query params so each item's deleted status is ignored. |
|
225 | + * |
|
226 | + * @param array $query_params |
|
227 | + * @return array |
|
228 | + */ |
|
229 | + protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params) |
|
230 | + { |
|
231 | + $query_params['default_where_conditions'] = 'minimum'; |
|
232 | + return $query_params; |
|
233 | + } |
|
234 | + |
|
235 | + |
|
236 | + /** |
|
237 | + * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered. |
|
238 | + * |
|
239 | + * @param boolean $delete true to indicate deletion, false to indicate restoration |
|
240 | + * @param array $query_params like EEM_Base::get_all |
|
241 | + * @return boolean success |
|
242 | + */ |
|
243 | + public function delete_or_restore($delete = true, $query_params = array()) |
|
244 | + { |
|
245 | + $post_status_field_name = $this->post_status_field_name(); |
|
246 | + $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params); |
|
247 | + $new_status = $delete ? self::post_status_trashed : 'draft'; |
|
248 | + if ($this->update(array($post_status_field_name => $new_status), $query_params)) { |
|
249 | + return true; |
|
250 | + } else { |
|
251 | + return false; |
|
252 | + } |
|
253 | + } |
|
254 | + |
|
255 | + |
|
256 | + /** |
|
257 | + * meta_table |
|
258 | + * returns first EE_Secondary_Table table name |
|
259 | + * |
|
260 | + * @access public |
|
261 | + * @return string |
|
262 | + */ |
|
263 | + public function meta_table() |
|
264 | + { |
|
265 | + $meta_table = $this->_get_other_tables(); |
|
266 | + $meta_table = reset($meta_table); |
|
267 | + return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null; |
|
268 | + } |
|
269 | + |
|
270 | + |
|
271 | + /** |
|
272 | + * This simply returns an array of the meta table fields (useful for when we just need to update those fields) |
|
273 | + * |
|
274 | + * @param bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields. Defaults to false (no |
|
275 | + * db only fields) |
|
276 | + * @return array |
|
277 | + */ |
|
278 | + public function get_meta_table_fields($all = false) |
|
279 | + { |
|
280 | + $all_fields = $fields_to_return = array(); |
|
281 | + foreach ($this->_tables as $alias => $table_obj) { |
|
282 | + if ($table_obj instanceof EE_Secondary_Table) { |
|
283 | + $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields); |
|
284 | + } |
|
285 | + } |
|
286 | + if (! $all) { |
|
287 | + foreach ($all_fields as $name => $obj) { |
|
288 | + if ($obj instanceof EE_DB_Only_Field_Base) { |
|
289 | + continue; |
|
290 | + } |
|
291 | + $fields_to_return[] = $name; |
|
292 | + } |
|
293 | + } else { |
|
294 | + $fields_to_return = array_keys($all_fields); |
|
295 | + } |
|
296 | + return $fields_to_return; |
|
297 | + } |
|
298 | + |
|
299 | + |
|
300 | + /** |
|
301 | + * Adds an event category with the specified name and description to the specified |
|
302 | + * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary, |
|
303 | + * and adds an entry in the term_relationship if necessary. |
|
304 | + * |
|
305 | + * @param EE_CPT_Base $cpt_model_object |
|
306 | + * @param string $category_name (used to derive the term slug too) |
|
307 | + * @param string $category_description |
|
308 | + * @param int $parent_term_taxonomy_id |
|
309 | + * @return EE_Term_Taxonomy |
|
310 | + */ |
|
311 | + public function add_event_category( |
|
312 | + EE_CPT_Base $cpt_model_object, |
|
313 | + $category_name, |
|
314 | + $category_description = '', |
|
315 | + $parent_term_taxonomy_id = null |
|
316 | + ) { |
|
317 | + // create term |
|
318 | + require_once(EE_MODELS . 'EEM_Term.model.php'); |
|
319 | + // first, check for a term by the same name or slug |
|
320 | + $category_slug = sanitize_title($category_name); |
|
321 | + $term = EEM_Term::instance()->get_one( |
|
322 | + array( |
|
323 | + array( |
|
324 | + 'OR' => array( |
|
325 | + 'name' => $category_name, |
|
326 | + 'slug' => $category_slug, |
|
327 | + ), |
|
328 | + ), |
|
329 | + ) |
|
330 | + ); |
|
331 | + if (! $term) { |
|
332 | + $term = EE_Term::new_instance( |
|
333 | + array( |
|
334 | + 'name' => $category_name, |
|
335 | + 'slug' => $category_slug, |
|
336 | + ) |
|
337 | + ); |
|
338 | + $term->save(); |
|
339 | + } |
|
340 | + // make sure there's a term-taxonomy entry too |
|
341 | + require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php'); |
|
342 | + $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one( |
|
343 | + array( |
|
344 | + array( |
|
345 | + 'term_id' => $term->ID(), |
|
346 | + 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY, |
|
347 | + ), |
|
348 | + ) |
|
349 | + ); |
|
350 | + /** @var $term_taxonomy EE_Term_Taxonomy */ |
|
351 | + if (! $term_taxonomy) { |
|
352 | + $term_taxonomy = EE_Term_Taxonomy::new_instance( |
|
353 | + array( |
|
354 | + 'term_id' => $term->ID(), |
|
355 | + 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY, |
|
356 | + 'description' => $category_description, |
|
357 | + 'term_count' => 1, |
|
358 | + 'parent' => $parent_term_taxonomy_id, |
|
359 | + ) |
|
360 | + ); |
|
361 | + $term_taxonomy->save(); |
|
362 | + } else { |
|
363 | + $term_taxonomy->set_count($term_taxonomy->count() + 1); |
|
364 | + $term_taxonomy->save(); |
|
365 | + } |
|
366 | + return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy'); |
|
367 | + } |
|
368 | + |
|
369 | + |
|
370 | + /** |
|
371 | + * Removed the category specified by name as having a relation to this event. |
|
372 | + * Does not remove the term or term_taxonomy. |
|
373 | + * |
|
374 | + * @param EE_CPT_Base $cpt_model_object_event |
|
375 | + * @param string $category_name name of the event category (term) |
|
376 | + * @return bool |
|
377 | + */ |
|
378 | + public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name) |
|
379 | + { |
|
380 | + // find the term_taxonomy by that name |
|
381 | + $term_taxonomy = $this->get_first_related( |
|
382 | + $cpt_model_object_event, |
|
383 | + 'Term_Taxonomy', |
|
384 | + array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY)) |
|
385 | + ); |
|
386 | + /** @var $term_taxonomy EE_Term_Taxonomy */ |
|
387 | + if ($term_taxonomy) { |
|
388 | + $term_taxonomy->set_count($term_taxonomy->count() - 1); |
|
389 | + $term_taxonomy->save(); |
|
390 | + } |
|
391 | + return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy'); |
|
392 | + } |
|
393 | + |
|
394 | + |
|
395 | + /** |
|
396 | + * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the |
|
397 | + * given CPT ID. It accepts the same params as what get_the_post_thumbnail() accepts. |
|
398 | + * |
|
399 | + * @link http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail |
|
400 | + * @access public |
|
401 | + * @param int $id the ID for the cpt we want the feature image for |
|
402 | + * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array |
|
403 | + * representing width and height in pixels (i.e. array(32,32) ). |
|
404 | + * @param string|array $attr Optional. Query string or array of attributes. |
|
405 | + * @return string HTML image element |
|
406 | + */ |
|
407 | + public function get_feature_image($id, $size = 'thumbnail', $attr = '') |
|
408 | + { |
|
409 | + return get_the_post_thumbnail($id, $size, $attr); |
|
410 | + } |
|
411 | + |
|
412 | + |
|
413 | + /** |
|
414 | + * Just a handy way to get the list of post statuses currently registered with WP. |
|
415 | + * |
|
416 | + * @global array $wp_post_statuses set in wp core for storing all the post stati |
|
417 | + * @return array |
|
418 | + */ |
|
419 | + public function get_post_statuses() |
|
420 | + { |
|
421 | + global $wp_post_statuses; |
|
422 | + $statuses = array(); |
|
423 | + foreach ($wp_post_statuses as $post_status => $args_object) { |
|
424 | + $statuses[ $post_status ] = $args_object->label; |
|
425 | + } |
|
426 | + return $statuses; |
|
427 | + } |
|
428 | + |
|
429 | + |
|
430 | + /** |
|
431 | + * public method that can be used to retrieve the protected status array on the instantiated cpt model |
|
432 | + * |
|
433 | + * @return array array of statuses. |
|
434 | + */ |
|
435 | + public function get_status_array() |
|
436 | + { |
|
437 | + $statuses = $this->get_post_statuses(); |
|
438 | + // first the global filter |
|
439 | + $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses); |
|
440 | + // now the class specific filter |
|
441 | + $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses); |
|
442 | + return $statuses; |
|
443 | + } |
|
444 | + |
|
445 | + |
|
446 | + /** |
|
447 | + * this returns the post statuses that are NOT the default wordpress status |
|
448 | + * |
|
449 | + * @return array |
|
450 | + */ |
|
451 | + public function get_custom_post_statuses() |
|
452 | + { |
|
453 | + $new_stati = array(); |
|
454 | + foreach ($this->_custom_stati as $status => $props) { |
|
455 | + $new_stati[ $status ] = $props['label']; |
|
456 | + } |
|
457 | + return $new_stati; |
|
458 | + } |
|
459 | + |
|
460 | + |
|
461 | + /** |
|
462 | + * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which |
|
463 | + * are a row from the posts table. If we're missing any fields required for the model, |
|
464 | + * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries, |
|
465 | + * make sure you are attaching all the model's fields onto the post) |
|
466 | + * |
|
467 | + * @param WP_Post|array $post |
|
468 | + * @return EE_Base_Class|EE_Soft_Delete_Base_Class |
|
469 | + */ |
|
470 | + public function instantiate_class_from_post_object_orig($post) |
|
471 | + { |
|
472 | + $post = (array) $post; |
|
473 | + $has_all_necessary_fields_for_table = true; |
|
474 | + // check if the post has fields on the meta table already |
|
475 | + foreach ($this->_get_other_tables() as $table_obj) { |
|
476 | + $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias()); |
|
477 | + foreach ($fields_for_that_table as $field_obj) { |
|
478 | + if (! isset($post[ $field_obj->get_table_column() ]) |
|
479 | + && ! isset($post[ $field_obj->get_qualified_column() ]) |
|
480 | + ) { |
|
481 | + $has_all_necessary_fields_for_table = false; |
|
482 | + } |
|
483 | + } |
|
484 | + } |
|
485 | + // if we don't have all the fields we need, then just fetch the proper model from the DB |
|
486 | + if (! $has_all_necessary_fields_for_table) { |
|
487 | + return $this->get_one_by_ID($post['ID']); |
|
488 | + } else { |
|
489 | + return $this->instantiate_class_from_array_or_object($post); |
|
490 | + } |
|
491 | + } |
|
492 | + |
|
493 | + |
|
494 | + /** |
|
495 | + * @param null $post |
|
496 | + * @return EE_Base_Class|EE_Soft_Delete_Base_Class |
|
497 | + */ |
|
498 | + public function instantiate_class_from_post_object($post = null) |
|
499 | + { |
|
500 | + if (empty($post)) { |
|
501 | + global $post; |
|
502 | + } |
|
503 | + $post = (array) $post; |
|
504 | + $tables_needing_to_be_queried = array(); |
|
505 | + // check if the post has fields on the meta table already |
|
506 | + foreach ($this->get_tables() as $table_obj) { |
|
507 | + $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias()); |
|
508 | + foreach ($fields_for_that_table as $field_obj) { |
|
509 | + if (! isset($post[ $field_obj->get_table_column() ]) |
|
510 | + && ! isset($post[ $field_obj->get_qualified_column() ]) |
|
511 | + ) { |
|
512 | + $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj; |
|
513 | + } |
|
514 | + } |
|
515 | + } |
|
516 | + // if we don't have all the fields we need, then just fetch the proper model from the DB |
|
517 | + if ($tables_needing_to_be_queried) { |
|
518 | + if (count($tables_needing_to_be_queried) == 1 |
|
519 | + && reset($tables_needing_to_be_queried) |
|
520 | + instanceof |
|
521 | + EE_Secondary_Table |
|
522 | + ) { |
|
523 | + // so we're only missing data from a secondary table. Well that's not too hard to query for |
|
524 | + $table_to_query = reset($tables_needing_to_be_queried); |
|
525 | + $missing_data = $this->_do_wpdb_query( |
|
526 | + 'get_row', |
|
527 | + array( |
|
528 | + 'SELECT * FROM ' |
|
529 | + . $table_to_query->get_table_name() |
|
530 | + . ' WHERE ' |
|
531 | + . $table_to_query->get_fk_on_table() |
|
532 | + . ' = ' |
|
533 | + . $post['ID'], |
|
534 | + ARRAY_A, |
|
535 | + ) |
|
536 | + ); |
|
537 | + if (! empty($missing_data)) { |
|
538 | + $post = array_merge($post, $missing_data); |
|
539 | + } |
|
540 | + } else { |
|
541 | + return $this->get_one_by_ID($post['ID']); |
|
542 | + } |
|
543 | + } |
|
544 | + return $this->instantiate_class_from_array_or_object($post); |
|
545 | + } |
|
546 | + |
|
547 | + |
|
548 | + /** |
|
549 | + * Gets the post type associated with this |
|
550 | + * |
|
551 | + * @throws EE_Error |
|
552 | + * @return string |
|
553 | + */ |
|
554 | + public function post_type() |
|
555 | + { |
|
556 | + $post_type_field = null; |
|
557 | + foreach ($this->field_settings(true) as $field_obj) { |
|
558 | + if ($field_obj instanceof EE_WP_Post_Type_Field) { |
|
559 | + $post_type_field = $field_obj; |
|
560 | + break; |
|
561 | + } |
|
562 | + } |
|
563 | + if ($post_type_field == null) { |
|
564 | + throw new EE_Error( |
|
565 | + sprintf( |
|
566 | + __( |
|
567 | + "CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt", |
|
568 | + "event_espresso" |
|
569 | + ), |
|
570 | + get_class($this) |
|
571 | + ) |
|
572 | + ); |
|
573 | + } |
|
574 | + return $post_type_field->get_default_value(); |
|
575 | + } |
|
576 | 576 | } |
@@ -9,233 +9,233 @@ |
||
9 | 9 | class EEM_Term_Relationship extends EEM_Base |
10 | 10 | { |
11 | 11 | |
12 | - // private instance of the Attendee object |
|
13 | - protected static $_instance = null; |
|
14 | - |
|
15 | - |
|
16 | - |
|
17 | - /** |
|
18 | - * EEM_Term_Relationship constructor. |
|
19 | - * |
|
20 | - * @param string $timezone |
|
21 | - */ |
|
22 | - protected function __construct($timezone = null) |
|
23 | - { |
|
24 | - $this->singular_item = __('Term Relationship', 'event_espresso'); |
|
25 | - $this->plural_item = __('Term Relationships', 'event_espresso'); |
|
26 | - $this->_tables = array( |
|
27 | - 'Term_Relationship' => new EE_Primary_Table('term_relationships'), |
|
28 | - ); |
|
29 | - $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models()); |
|
30 | - $this->_fields = array( |
|
31 | - 'Term_Relationship' => array( |
|
32 | - 'object_id' => new EE_Foreign_Key_Int_Field( |
|
33 | - 'object_id', |
|
34 | - __('Object(Post) ID', 'event_espresso'), |
|
35 | - false, |
|
36 | - 0, |
|
37 | - $models_this_can_attach_to |
|
38 | - ), |
|
39 | - 'term_taxonomy_id' => new EE_Foreign_Key_Int_Field( |
|
40 | - 'term_taxonomy_id', |
|
41 | - __( |
|
42 | - 'Term (in context of a taxonomy) ID', |
|
43 | - 'event_espresso' |
|
44 | - ), |
|
45 | - false, |
|
46 | - 0, |
|
47 | - 'Term_Taxonomy' |
|
48 | - ), |
|
49 | - 'term_order' => new EE_Integer_Field( |
|
50 | - 'term_order', |
|
51 | - __('Term Order', 'event_espresso'), |
|
52 | - false, |
|
53 | - 0 |
|
54 | - ), |
|
55 | - ), |
|
56 | - ); |
|
57 | - $this->_model_relations = array( |
|
58 | - 'Term_Taxonomy' => new EE_Belongs_To_Relation(), |
|
59 | - ); |
|
60 | - foreach ($models_this_can_attach_to as $model_name) { |
|
61 | - $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation(); |
|
62 | - } |
|
63 | - $this->_wp_core_model = true; |
|
64 | - $this->_indexes = array( |
|
65 | - 'PRIMARY' => new EE_Primary_Key_Index(array('object_id', 'term_taxonomy_id')), |
|
66 | - ); |
|
67 | - $path_to_event_model = 'Event.'; |
|
68 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public( |
|
69 | - $path_to_event_model |
|
70 | - ); |
|
71 | - $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = |
|
72 | - new EE_Restriction_Generator_Event_Related_Protected( |
|
73 | - $path_to_event_model |
|
74 | - ); |
|
75 | - $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected( |
|
76 | - $path_to_event_model |
|
77 | - ); |
|
78 | - $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = |
|
79 | - new EE_Restriction_Generator_Event_Related_Protected( |
|
80 | - $path_to_event_model, |
|
81 | - EEM_Base::caps_edit |
|
82 | - ); |
|
83 | - $path_to_tax_model = 'Term_Taxonomy.'; |
|
84 | - // add cap restrictions for editing term relations to the "ee_assign_*" |
|
85 | - // and for deleting term relations too |
|
86 | - $cap_contexts_affected = array(EEM_Base::caps_edit, EEM_Base::caps_delete); |
|
87 | - foreach ($cap_contexts_affected as $cap_context_affected) { |
|
88 | - $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] = |
|
89 | - new EE_Default_Where_Conditions( |
|
90 | - array( |
|
91 | - $path_to_tax_model . 'taxonomy*ee_assign_event_category' => array( |
|
92 | - '!=', |
|
93 | - 'espresso_event_categories', |
|
94 | - ), |
|
95 | - ) |
|
96 | - ); |
|
97 | - $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] = |
|
98 | - new EE_Default_Where_Conditions( |
|
99 | - array( |
|
100 | - $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => array( |
|
101 | - '!=', |
|
102 | - 'espresso_venue_categories', |
|
103 | - ), |
|
104 | - ) |
|
105 | - ); |
|
106 | - $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type'] = new EE_Default_Where_Conditions( |
|
107 | - array( |
|
108 | - $path_to_tax_model . 'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'), |
|
109 | - ) |
|
110 | - ); |
|
111 | - } |
|
112 | - parent::__construct($timezone); |
|
113 | - add_filter( |
|
114 | - 'FHEE__Read__create_model_query_params', |
|
115 | - array('EEM_Term_Relationship', 'rest_api_query_params'), |
|
116 | - 10, |
|
117 | - 3 |
|
118 | - ); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * Makes sure all term-taxonomy counts are correct |
|
124 | - * |
|
125 | - * @param int $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL |
|
126 | - * @global wpdb $wpdb |
|
127 | - * @return int the number of rows affected |
|
128 | - * @throws EE_Error |
|
129 | - */ |
|
130 | - public function update_term_taxonomy_counts($term_taxonomy_id = null) |
|
131 | - { |
|
132 | - // because this uses a subquery and sometimes assigning to column to be another column's |
|
133 | - // value, we just write the SQL directly. |
|
134 | - global $wpdb; |
|
135 | - |
|
136 | - $query = " |
|
12 | + // private instance of the Attendee object |
|
13 | + protected static $_instance = null; |
|
14 | + |
|
15 | + |
|
16 | + |
|
17 | + /** |
|
18 | + * EEM_Term_Relationship constructor. |
|
19 | + * |
|
20 | + * @param string $timezone |
|
21 | + */ |
|
22 | + protected function __construct($timezone = null) |
|
23 | + { |
|
24 | + $this->singular_item = __('Term Relationship', 'event_espresso'); |
|
25 | + $this->plural_item = __('Term Relationships', 'event_espresso'); |
|
26 | + $this->_tables = array( |
|
27 | + 'Term_Relationship' => new EE_Primary_Table('term_relationships'), |
|
28 | + ); |
|
29 | + $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models()); |
|
30 | + $this->_fields = array( |
|
31 | + 'Term_Relationship' => array( |
|
32 | + 'object_id' => new EE_Foreign_Key_Int_Field( |
|
33 | + 'object_id', |
|
34 | + __('Object(Post) ID', 'event_espresso'), |
|
35 | + false, |
|
36 | + 0, |
|
37 | + $models_this_can_attach_to |
|
38 | + ), |
|
39 | + 'term_taxonomy_id' => new EE_Foreign_Key_Int_Field( |
|
40 | + 'term_taxonomy_id', |
|
41 | + __( |
|
42 | + 'Term (in context of a taxonomy) ID', |
|
43 | + 'event_espresso' |
|
44 | + ), |
|
45 | + false, |
|
46 | + 0, |
|
47 | + 'Term_Taxonomy' |
|
48 | + ), |
|
49 | + 'term_order' => new EE_Integer_Field( |
|
50 | + 'term_order', |
|
51 | + __('Term Order', 'event_espresso'), |
|
52 | + false, |
|
53 | + 0 |
|
54 | + ), |
|
55 | + ), |
|
56 | + ); |
|
57 | + $this->_model_relations = array( |
|
58 | + 'Term_Taxonomy' => new EE_Belongs_To_Relation(), |
|
59 | + ); |
|
60 | + foreach ($models_this_can_attach_to as $model_name) { |
|
61 | + $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation(); |
|
62 | + } |
|
63 | + $this->_wp_core_model = true; |
|
64 | + $this->_indexes = array( |
|
65 | + 'PRIMARY' => new EE_Primary_Key_Index(array('object_id', 'term_taxonomy_id')), |
|
66 | + ); |
|
67 | + $path_to_event_model = 'Event.'; |
|
68 | + $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public( |
|
69 | + $path_to_event_model |
|
70 | + ); |
|
71 | + $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = |
|
72 | + new EE_Restriction_Generator_Event_Related_Protected( |
|
73 | + $path_to_event_model |
|
74 | + ); |
|
75 | + $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected( |
|
76 | + $path_to_event_model |
|
77 | + ); |
|
78 | + $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = |
|
79 | + new EE_Restriction_Generator_Event_Related_Protected( |
|
80 | + $path_to_event_model, |
|
81 | + EEM_Base::caps_edit |
|
82 | + ); |
|
83 | + $path_to_tax_model = 'Term_Taxonomy.'; |
|
84 | + // add cap restrictions for editing term relations to the "ee_assign_*" |
|
85 | + // and for deleting term relations too |
|
86 | + $cap_contexts_affected = array(EEM_Base::caps_edit, EEM_Base::caps_delete); |
|
87 | + foreach ($cap_contexts_affected as $cap_context_affected) { |
|
88 | + $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] = |
|
89 | + new EE_Default_Where_Conditions( |
|
90 | + array( |
|
91 | + $path_to_tax_model . 'taxonomy*ee_assign_event_category' => array( |
|
92 | + '!=', |
|
93 | + 'espresso_event_categories', |
|
94 | + ), |
|
95 | + ) |
|
96 | + ); |
|
97 | + $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] = |
|
98 | + new EE_Default_Where_Conditions( |
|
99 | + array( |
|
100 | + $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => array( |
|
101 | + '!=', |
|
102 | + 'espresso_venue_categories', |
|
103 | + ), |
|
104 | + ) |
|
105 | + ); |
|
106 | + $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type'] = new EE_Default_Where_Conditions( |
|
107 | + array( |
|
108 | + $path_to_tax_model . 'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'), |
|
109 | + ) |
|
110 | + ); |
|
111 | + } |
|
112 | + parent::__construct($timezone); |
|
113 | + add_filter( |
|
114 | + 'FHEE__Read__create_model_query_params', |
|
115 | + array('EEM_Term_Relationship', 'rest_api_query_params'), |
|
116 | + 10, |
|
117 | + 3 |
|
118 | + ); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * Makes sure all term-taxonomy counts are correct |
|
124 | + * |
|
125 | + * @param int $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL |
|
126 | + * @global wpdb $wpdb |
|
127 | + * @return int the number of rows affected |
|
128 | + * @throws EE_Error |
|
129 | + */ |
|
130 | + public function update_term_taxonomy_counts($term_taxonomy_id = null) |
|
131 | + { |
|
132 | + // because this uses a subquery and sometimes assigning to column to be another column's |
|
133 | + // value, we just write the SQL directly. |
|
134 | + global $wpdb; |
|
135 | + |
|
136 | + $query = " |
|
137 | 137 | UPDATE {$wpdb->term_taxonomy} AS tt |
138 | 138 | SET count = ( |
139 | 139 | select count(*) as proper_count from {$wpdb->term_relationships} AS tr |
140 | 140 | WHERE tt.term_taxonomy_id = tr.term_taxonomy_id |
141 | 141 | )"; |
142 | 142 | |
143 | - if ($term_taxonomy_id) { |
|
144 | - $query .= ' WHERE tt.term_taxonomy_id = %d'; |
|
145 | - $query = $wpdb->prepare( |
|
146 | - $query, |
|
147 | - $term_taxonomy_id |
|
148 | - ); |
|
149 | - } |
|
150 | - $rows_affected = $this->_do_wpdb_query( |
|
151 | - 'query', |
|
152 | - array( |
|
153 | - $query, |
|
154 | - ) |
|
155 | - ); |
|
156 | - return $rows_affected; |
|
157 | - } |
|
158 | - |
|
159 | - |
|
160 | - |
|
161 | - /** |
|
162 | - * Overrides the parent to also make sure term-taxonomy counts are up-to-date after |
|
163 | - * inserting |
|
164 | - * |
|
165 | - * @param array $field_n_values @see EEM_Base::insert |
|
166 | - * @return boolean |
|
167 | - */ |
|
168 | - public function insert($field_n_values) |
|
169 | - { |
|
170 | - $return = parent::insert($field_n_values); |
|
171 | - if (isset($field_n_values['term_taxonomy_id'])) { |
|
172 | - $this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']); |
|
173 | - } |
|
174 | - return $return; |
|
175 | - } |
|
176 | - |
|
177 | - |
|
178 | - |
|
179 | - /** |
|
180 | - * Overrides parent so that after an update, we also check the term_taxonomy_counts are |
|
181 | - * all ok |
|
182 | - * |
|
183 | - * @param array $fields_n_values see EEM_Base::update |
|
184 | - * @param array $query_params @see EEM_Base::get_all |
|
185 | - * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects |
|
186 | - * in this model's entity map according to $fields_n_values that match |
|
187 | - * $query_params. This obviously has some overhead, so you can disable it |
|
188 | - * by setting this to FALSE, but be aware that model objects being used |
|
189 | - * could get out-of-sync with the database |
|
190 | - * @return int |
|
191 | - */ |
|
192 | - public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true) |
|
193 | - { |
|
194 | - $count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync); |
|
195 | - if ($count) { |
|
196 | - $this->update_term_taxonomy_counts(); |
|
197 | - } |
|
198 | - return $count; |
|
199 | - } |
|
200 | - |
|
201 | - |
|
202 | - |
|
203 | - /** |
|
204 | - * Overrides parent so that after running this, we also double-check |
|
205 | - * the term taxonomy counts are up-to-date |
|
206 | - * |
|
207 | - * @param array $query_params @see EEM_Base::get_all |
|
208 | - * @param boolean $allow_blocking |
|
209 | - * @return int @see EEM_Base::delete |
|
210 | - */ |
|
211 | - public function delete($query_params, $allow_blocking = true) |
|
212 | - { |
|
213 | - $count = parent::delete($query_params, $allow_blocking); |
|
214 | - if ($count) { |
|
215 | - $this->update_term_taxonomy_counts(); |
|
216 | - } |
|
217 | - return $count; |
|
218 | - } |
|
219 | - |
|
220 | - |
|
221 | - |
|
222 | - /** |
|
223 | - * Makes sure that during REST API queries, we only return term relationships |
|
224 | - * for term taxonomies which should be shown in the rest api |
|
225 | - * |
|
226 | - * @param array $model_query_params |
|
227 | - * @param array $querystring_query_params |
|
228 | - * @param EEM_Base $model |
|
229 | - * @return array |
|
230 | - */ |
|
231 | - public static function rest_api_query_params($model_query_params, $querystring_query_params, $model) |
|
232 | - { |
|
233 | - if ($model === EEM_Term_Relationship::instance()) { |
|
234 | - $taxonomies = get_taxonomies(array('show_in_rest' => true)); |
|
235 | - if (! empty($taxonomies)) { |
|
236 | - $model_query_params[0]['Term_Taxonomy.taxonomy'] = array('IN', $taxonomies); |
|
237 | - } |
|
238 | - } |
|
239 | - return $model_query_params; |
|
240 | - } |
|
143 | + if ($term_taxonomy_id) { |
|
144 | + $query .= ' WHERE tt.term_taxonomy_id = %d'; |
|
145 | + $query = $wpdb->prepare( |
|
146 | + $query, |
|
147 | + $term_taxonomy_id |
|
148 | + ); |
|
149 | + } |
|
150 | + $rows_affected = $this->_do_wpdb_query( |
|
151 | + 'query', |
|
152 | + array( |
|
153 | + $query, |
|
154 | + ) |
|
155 | + ); |
|
156 | + return $rows_affected; |
|
157 | + } |
|
158 | + |
|
159 | + |
|
160 | + |
|
161 | + /** |
|
162 | + * Overrides the parent to also make sure term-taxonomy counts are up-to-date after |
|
163 | + * inserting |
|
164 | + * |
|
165 | + * @param array $field_n_values @see EEM_Base::insert |
|
166 | + * @return boolean |
|
167 | + */ |
|
168 | + public function insert($field_n_values) |
|
169 | + { |
|
170 | + $return = parent::insert($field_n_values); |
|
171 | + if (isset($field_n_values['term_taxonomy_id'])) { |
|
172 | + $this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']); |
|
173 | + } |
|
174 | + return $return; |
|
175 | + } |
|
176 | + |
|
177 | + |
|
178 | + |
|
179 | + /** |
|
180 | + * Overrides parent so that after an update, we also check the term_taxonomy_counts are |
|
181 | + * all ok |
|
182 | + * |
|
183 | + * @param array $fields_n_values see EEM_Base::update |
|
184 | + * @param array $query_params @see EEM_Base::get_all |
|
185 | + * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects |
|
186 | + * in this model's entity map according to $fields_n_values that match |
|
187 | + * $query_params. This obviously has some overhead, so you can disable it |
|
188 | + * by setting this to FALSE, but be aware that model objects being used |
|
189 | + * could get out-of-sync with the database |
|
190 | + * @return int |
|
191 | + */ |
|
192 | + public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true) |
|
193 | + { |
|
194 | + $count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync); |
|
195 | + if ($count) { |
|
196 | + $this->update_term_taxonomy_counts(); |
|
197 | + } |
|
198 | + return $count; |
|
199 | + } |
|
200 | + |
|
201 | + |
|
202 | + |
|
203 | + /** |
|
204 | + * Overrides parent so that after running this, we also double-check |
|
205 | + * the term taxonomy counts are up-to-date |
|
206 | + * |
|
207 | + * @param array $query_params @see EEM_Base::get_all |
|
208 | + * @param boolean $allow_blocking |
|
209 | + * @return int @see EEM_Base::delete |
|
210 | + */ |
|
211 | + public function delete($query_params, $allow_blocking = true) |
|
212 | + { |
|
213 | + $count = parent::delete($query_params, $allow_blocking); |
|
214 | + if ($count) { |
|
215 | + $this->update_term_taxonomy_counts(); |
|
216 | + } |
|
217 | + return $count; |
|
218 | + } |
|
219 | + |
|
220 | + |
|
221 | + |
|
222 | + /** |
|
223 | + * Makes sure that during REST API queries, we only return term relationships |
|
224 | + * for term taxonomies which should be shown in the rest api |
|
225 | + * |
|
226 | + * @param array $model_query_params |
|
227 | + * @param array $querystring_query_params |
|
228 | + * @param EEM_Base $model |
|
229 | + * @return array |
|
230 | + */ |
|
231 | + public static function rest_api_query_params($model_query_params, $querystring_query_params, $model) |
|
232 | + { |
|
233 | + if ($model === EEM_Term_Relationship::instance()) { |
|
234 | + $taxonomies = get_taxonomies(array('show_in_rest' => true)); |
|
235 | + if (! empty($taxonomies)) { |
|
236 | + $model_query_params[0]['Term_Taxonomy.taxonomy'] = array('IN', $taxonomies); |
|
237 | + } |
|
238 | + } |
|
239 | + return $model_query_params; |
|
240 | + } |
|
241 | 241 | } |
@@ -12,240 +12,240 @@ |
||
12 | 12 | class EE_SPCO_Reg_Step_Finalize_Registration extends EE_SPCO_Reg_Step |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * class constructor |
|
17 | - * |
|
18 | - * @access public |
|
19 | - * @param EE_Checkout $checkout |
|
20 | - */ |
|
21 | - public function __construct(EE_Checkout $checkout) |
|
22 | - { |
|
23 | - $this->_slug = 'finalize_registration'; |
|
24 | - $this->_name = __('Finalize Registration', 'event_espresso'); |
|
25 | - $this->_submit_button_text = $this->_name; |
|
26 | - $this->_template = ''; |
|
27 | - $this->checkout = $checkout; |
|
28 | - } |
|
29 | - |
|
30 | - |
|
31 | - public function translate_js_strings() |
|
32 | - { |
|
33 | - } |
|
34 | - |
|
35 | - |
|
36 | - public function enqueue_styles_and_scripts() |
|
37 | - { |
|
38 | - } |
|
39 | - |
|
40 | - |
|
41 | - /** |
|
42 | - * @return boolean |
|
43 | - */ |
|
44 | - public function initialize_reg_step() |
|
45 | - { |
|
46 | - // there's actually no reg form to process if this is the final step |
|
47 | - if ($this->is_current_step()) { |
|
48 | - $this->checkout->step = $_REQUEST['step'] = $this->slug(); |
|
49 | - $this->checkout->action = $_REQUEST['action'] = 'process_reg_step'; |
|
50 | - $this->checkout->generate_reg_form = false; |
|
51 | - } |
|
52 | - return true; |
|
53 | - } |
|
54 | - |
|
55 | - |
|
56 | - /** |
|
57 | - * @return string |
|
58 | - * @throws \EE_Error |
|
59 | - */ |
|
60 | - public function generate_reg_form() |
|
61 | - { |
|
62 | - // create empty form so that things don't break |
|
63 | - $this->reg_form = new EE_Form_Section_Proper(); |
|
64 | - return ''; |
|
65 | - } |
|
66 | - |
|
67 | - |
|
68 | - /** |
|
69 | - * @return boolean |
|
70 | - * @throws \RuntimeException |
|
71 | - * @throws \EE_Error |
|
72 | - */ |
|
73 | - public function process_reg_step() |
|
74 | - { |
|
75 | - // ensure all data gets refreshed from the db |
|
76 | - $this->checkout->refresh_all_entities(true); |
|
77 | - // ensures that all details and statuses for transaction, registration, and payments are updated |
|
78 | - $txn_update_params = $this->_finalize_transaction(); |
|
79 | - // maybe send messages |
|
80 | - $this->_set_notification_triggers(); |
|
81 | - // send messages |
|
82 | - /** @type EE_Registration_Processor $registration_processor */ |
|
83 | - $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
84 | - $registration_processor->trigger_registration_update_notifications( |
|
85 | - $this->checkout->transaction->primary_registration(), |
|
86 | - $txn_update_params |
|
87 | - ); |
|
88 | - // set a hook point |
|
89 | - do_action( |
|
90 | - 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', |
|
91 | - $this->checkout, |
|
92 | - $txn_update_params |
|
93 | - ); |
|
94 | - // check if transaction has a primary registrant and that it has a related Attendee object |
|
95 | - if (! $this->_validate_primary_registrant()) { |
|
96 | - return false; |
|
97 | - } |
|
98 | - // you don't have to go home but you can't stay here ! |
|
99 | - $this->checkout->redirect = true; |
|
100 | - $this->checkout->continue_reg = true; |
|
101 | - $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url); |
|
102 | - if (! ( |
|
103 | - $this->checkout->payment_method instanceof EE_Payment_Method |
|
104 | - && $this->checkout->payment_method->is_off_site() |
|
105 | - )) { |
|
106 | - // mark this reg step as completed |
|
107 | - $this->set_completed(); |
|
108 | - } |
|
109 | - $this->checkout->set_exit_spco(); |
|
110 | - return true; |
|
111 | - } |
|
112 | - |
|
113 | - |
|
114 | - /** |
|
115 | - * _finalize_transaction |
|
116 | - * ensures that all details and statuses for transaction, registration, and payments are updated |
|
117 | - * |
|
118 | - * @return array |
|
119 | - * @throws \RuntimeException |
|
120 | - * @throws \EE_Error |
|
121 | - */ |
|
122 | - protected function _finalize_transaction() |
|
123 | - { |
|
124 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
125 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
126 | - // set revisit flag in txn processor |
|
127 | - $transaction_processor->set_revisit($this->checkout->revisit); |
|
128 | - // at this point we'll consider a TXN to not have been abandoned |
|
129 | - $this->checkout->transaction->toggle_abandoned_transaction_status(); |
|
130 | - if ($this->checkout->cart instanceof EE_Cart) { |
|
131 | - // save TXN data to the cart |
|
132 | - $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn( |
|
133 | - $this->checkout->transaction->ID() |
|
134 | - ); |
|
135 | - } |
|
136 | - // maybe update status, but don't save transaction just yet |
|
137 | - $this->checkout->transaction->update_status_based_on_total_paid(false); |
|
138 | - // this will result in the base session properties getting saved to the TXN_Session_data field |
|
139 | - $session_data = EE_Registry::instance()->SSN->get_session_data(null, true); |
|
140 | - // anonymize the last part of the IP address, now that the transaction is complete (we won't be using the IP address |
|
141 | - // for spam or bot detection now) |
|
142 | - if (function_exists('wp_privacy_anonymize_ip') && isset($session_data['ip_address'])) { |
|
143 | - $session_data['ip_address'] = wp_privacy_anonymize_ip($session_data['ip_address']); |
|
144 | - } |
|
145 | - $this->checkout->transaction->set_txn_session_data($session_data); |
|
146 | - // update the TXN if payment conditions have changed, but do NOT trigger notifications, |
|
147 | - // because we will do that in process_reg_step() after setting some more triggers |
|
148 | - return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment( |
|
149 | - $this->checkout->transaction, |
|
150 | - $this->checkout->payment, |
|
151 | - $this->checkout->reg_cache_where_params, |
|
152 | - false |
|
153 | - ); |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * If request is not a revisit, and an Off-Site gateway using IPNs has NOT been selected... |
|
159 | - * OR |
|
160 | - * if it IS a revisit and the TXN and/or one or more REG statuses have changed... |
|
161 | - * then trigger notifications |
|
162 | - * |
|
163 | - * @return void |
|
164 | - * @throws \EE_Error |
|
165 | - */ |
|
166 | - protected function _set_notification_triggers() |
|
167 | - { |
|
168 | - |
|
169 | - if ($this->checkout->payment_method instanceof EE_Payment_Method) { |
|
170 | - // let's start with the assumption that we need to trigger notifications |
|
171 | - // then toggle this to false for conditions where we know we don't need to |
|
172 | - $deliver_notifications = true; |
|
173 | - if (// if SPCO revisit |
|
174 | - filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN) |
|
175 | - // and TXN or REG statuses have NOT changed due to a payment |
|
176 | - && ! ( |
|
177 | - $this->checkout->transaction->txn_status_updated() |
|
178 | - || $this->checkout->any_reg_status_updated() |
|
179 | - ) |
|
180 | - ) { |
|
181 | - $deliver_notifications = false; |
|
182 | - } |
|
183 | - if ($this->checkout->payment_method->is_off_site()) { |
|
184 | - /** @var EE_Gateway $gateway */ |
|
185 | - $gateway = $this->checkout->payment_method->type_obj()->get_gateway(); |
|
186 | - // and the gateway uses a separate request to process the IPN |
|
187 | - if ($gateway instanceof EE_Offsite_Gateway |
|
188 | - && $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true) |
|
189 | - ) { |
|
190 | - // IPN request will handle triggering notifications |
|
191 | - $deliver_notifications = false; |
|
192 | - // no really... don't send any notices in this request |
|
193 | - remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications'); |
|
194 | - add_filter( |
|
195 | - 'FHEE__EED_Messages___maybe_registration__deliver_notifications', |
|
196 | - '__return_false', |
|
197 | - 15 |
|
198 | - ); |
|
199 | - } |
|
200 | - } |
|
201 | - if ($deliver_notifications) { |
|
202 | - // send out notifications |
|
203 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
204 | - } |
|
205 | - } |
|
206 | - } |
|
207 | - |
|
208 | - |
|
209 | - /** |
|
210 | - * check if transaction has a primary registrant and that it has a related Attendee object |
|
211 | - * |
|
212 | - * @return boolean |
|
213 | - * @throws \EE_Error |
|
214 | - */ |
|
215 | - protected function _validate_primary_registrant() |
|
216 | - { |
|
217 | - if (! $this->checkout->transaction_has_primary_registrant()) { |
|
218 | - EE_Error::add_error( |
|
219 | - __('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'), |
|
220 | - __FILE__, |
|
221 | - __FUNCTION__, |
|
222 | - __LINE__ |
|
223 | - ); |
|
224 | - $this->checkout->redirect = false; |
|
225 | - $this->checkout->continue_reg = false; |
|
226 | - return false; |
|
227 | - } |
|
228 | - // setup URL for redirect |
|
229 | - $this->checkout->redirect_url = add_query_arg( |
|
230 | - array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()), |
|
231 | - $this->checkout->thank_you_page_url |
|
232 | - ); |
|
233 | - return true; |
|
234 | - } |
|
235 | - |
|
236 | - |
|
237 | - /** |
|
238 | - * @return void |
|
239 | - */ |
|
240 | - public function update_reg_step() |
|
241 | - { |
|
242 | - EE_Error::doing_it_wrong( |
|
243 | - __CLASS__ . '::' . __FILE__, |
|
244 | - __( |
|
245 | - 'Can not call update_reg_step() on the Finalize Registration reg step.', |
|
246 | - 'event_espresso' |
|
247 | - ), |
|
248 | - '4.6.0' |
|
249 | - ); |
|
250 | - } |
|
15 | + /** |
|
16 | + * class constructor |
|
17 | + * |
|
18 | + * @access public |
|
19 | + * @param EE_Checkout $checkout |
|
20 | + */ |
|
21 | + public function __construct(EE_Checkout $checkout) |
|
22 | + { |
|
23 | + $this->_slug = 'finalize_registration'; |
|
24 | + $this->_name = __('Finalize Registration', 'event_espresso'); |
|
25 | + $this->_submit_button_text = $this->_name; |
|
26 | + $this->_template = ''; |
|
27 | + $this->checkout = $checkout; |
|
28 | + } |
|
29 | + |
|
30 | + |
|
31 | + public function translate_js_strings() |
|
32 | + { |
|
33 | + } |
|
34 | + |
|
35 | + |
|
36 | + public function enqueue_styles_and_scripts() |
|
37 | + { |
|
38 | + } |
|
39 | + |
|
40 | + |
|
41 | + /** |
|
42 | + * @return boolean |
|
43 | + */ |
|
44 | + public function initialize_reg_step() |
|
45 | + { |
|
46 | + // there's actually no reg form to process if this is the final step |
|
47 | + if ($this->is_current_step()) { |
|
48 | + $this->checkout->step = $_REQUEST['step'] = $this->slug(); |
|
49 | + $this->checkout->action = $_REQUEST['action'] = 'process_reg_step'; |
|
50 | + $this->checkout->generate_reg_form = false; |
|
51 | + } |
|
52 | + return true; |
|
53 | + } |
|
54 | + |
|
55 | + |
|
56 | + /** |
|
57 | + * @return string |
|
58 | + * @throws \EE_Error |
|
59 | + */ |
|
60 | + public function generate_reg_form() |
|
61 | + { |
|
62 | + // create empty form so that things don't break |
|
63 | + $this->reg_form = new EE_Form_Section_Proper(); |
|
64 | + return ''; |
|
65 | + } |
|
66 | + |
|
67 | + |
|
68 | + /** |
|
69 | + * @return boolean |
|
70 | + * @throws \RuntimeException |
|
71 | + * @throws \EE_Error |
|
72 | + */ |
|
73 | + public function process_reg_step() |
|
74 | + { |
|
75 | + // ensure all data gets refreshed from the db |
|
76 | + $this->checkout->refresh_all_entities(true); |
|
77 | + // ensures that all details and statuses for transaction, registration, and payments are updated |
|
78 | + $txn_update_params = $this->_finalize_transaction(); |
|
79 | + // maybe send messages |
|
80 | + $this->_set_notification_triggers(); |
|
81 | + // send messages |
|
82 | + /** @type EE_Registration_Processor $registration_processor */ |
|
83 | + $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
84 | + $registration_processor->trigger_registration_update_notifications( |
|
85 | + $this->checkout->transaction->primary_registration(), |
|
86 | + $txn_update_params |
|
87 | + ); |
|
88 | + // set a hook point |
|
89 | + do_action( |
|
90 | + 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', |
|
91 | + $this->checkout, |
|
92 | + $txn_update_params |
|
93 | + ); |
|
94 | + // check if transaction has a primary registrant and that it has a related Attendee object |
|
95 | + if (! $this->_validate_primary_registrant()) { |
|
96 | + return false; |
|
97 | + } |
|
98 | + // you don't have to go home but you can't stay here ! |
|
99 | + $this->checkout->redirect = true; |
|
100 | + $this->checkout->continue_reg = true; |
|
101 | + $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url); |
|
102 | + if (! ( |
|
103 | + $this->checkout->payment_method instanceof EE_Payment_Method |
|
104 | + && $this->checkout->payment_method->is_off_site() |
|
105 | + )) { |
|
106 | + // mark this reg step as completed |
|
107 | + $this->set_completed(); |
|
108 | + } |
|
109 | + $this->checkout->set_exit_spco(); |
|
110 | + return true; |
|
111 | + } |
|
112 | + |
|
113 | + |
|
114 | + /** |
|
115 | + * _finalize_transaction |
|
116 | + * ensures that all details and statuses for transaction, registration, and payments are updated |
|
117 | + * |
|
118 | + * @return array |
|
119 | + * @throws \RuntimeException |
|
120 | + * @throws \EE_Error |
|
121 | + */ |
|
122 | + protected function _finalize_transaction() |
|
123 | + { |
|
124 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
125 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
126 | + // set revisit flag in txn processor |
|
127 | + $transaction_processor->set_revisit($this->checkout->revisit); |
|
128 | + // at this point we'll consider a TXN to not have been abandoned |
|
129 | + $this->checkout->transaction->toggle_abandoned_transaction_status(); |
|
130 | + if ($this->checkout->cart instanceof EE_Cart) { |
|
131 | + // save TXN data to the cart |
|
132 | + $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn( |
|
133 | + $this->checkout->transaction->ID() |
|
134 | + ); |
|
135 | + } |
|
136 | + // maybe update status, but don't save transaction just yet |
|
137 | + $this->checkout->transaction->update_status_based_on_total_paid(false); |
|
138 | + // this will result in the base session properties getting saved to the TXN_Session_data field |
|
139 | + $session_data = EE_Registry::instance()->SSN->get_session_data(null, true); |
|
140 | + // anonymize the last part of the IP address, now that the transaction is complete (we won't be using the IP address |
|
141 | + // for spam or bot detection now) |
|
142 | + if (function_exists('wp_privacy_anonymize_ip') && isset($session_data['ip_address'])) { |
|
143 | + $session_data['ip_address'] = wp_privacy_anonymize_ip($session_data['ip_address']); |
|
144 | + } |
|
145 | + $this->checkout->transaction->set_txn_session_data($session_data); |
|
146 | + // update the TXN if payment conditions have changed, but do NOT trigger notifications, |
|
147 | + // because we will do that in process_reg_step() after setting some more triggers |
|
148 | + return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment( |
|
149 | + $this->checkout->transaction, |
|
150 | + $this->checkout->payment, |
|
151 | + $this->checkout->reg_cache_where_params, |
|
152 | + false |
|
153 | + ); |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * If request is not a revisit, and an Off-Site gateway using IPNs has NOT been selected... |
|
159 | + * OR |
|
160 | + * if it IS a revisit and the TXN and/or one or more REG statuses have changed... |
|
161 | + * then trigger notifications |
|
162 | + * |
|
163 | + * @return void |
|
164 | + * @throws \EE_Error |
|
165 | + */ |
|
166 | + protected function _set_notification_triggers() |
|
167 | + { |
|
168 | + |
|
169 | + if ($this->checkout->payment_method instanceof EE_Payment_Method) { |
|
170 | + // let's start with the assumption that we need to trigger notifications |
|
171 | + // then toggle this to false for conditions where we know we don't need to |
|
172 | + $deliver_notifications = true; |
|
173 | + if (// if SPCO revisit |
|
174 | + filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN) |
|
175 | + // and TXN or REG statuses have NOT changed due to a payment |
|
176 | + && ! ( |
|
177 | + $this->checkout->transaction->txn_status_updated() |
|
178 | + || $this->checkout->any_reg_status_updated() |
|
179 | + ) |
|
180 | + ) { |
|
181 | + $deliver_notifications = false; |
|
182 | + } |
|
183 | + if ($this->checkout->payment_method->is_off_site()) { |
|
184 | + /** @var EE_Gateway $gateway */ |
|
185 | + $gateway = $this->checkout->payment_method->type_obj()->get_gateway(); |
|
186 | + // and the gateway uses a separate request to process the IPN |
|
187 | + if ($gateway instanceof EE_Offsite_Gateway |
|
188 | + && $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true) |
|
189 | + ) { |
|
190 | + // IPN request will handle triggering notifications |
|
191 | + $deliver_notifications = false; |
|
192 | + // no really... don't send any notices in this request |
|
193 | + remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications'); |
|
194 | + add_filter( |
|
195 | + 'FHEE__EED_Messages___maybe_registration__deliver_notifications', |
|
196 | + '__return_false', |
|
197 | + 15 |
|
198 | + ); |
|
199 | + } |
|
200 | + } |
|
201 | + if ($deliver_notifications) { |
|
202 | + // send out notifications |
|
203 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
204 | + } |
|
205 | + } |
|
206 | + } |
|
207 | + |
|
208 | + |
|
209 | + /** |
|
210 | + * check if transaction has a primary registrant and that it has a related Attendee object |
|
211 | + * |
|
212 | + * @return boolean |
|
213 | + * @throws \EE_Error |
|
214 | + */ |
|
215 | + protected function _validate_primary_registrant() |
|
216 | + { |
|
217 | + if (! $this->checkout->transaction_has_primary_registrant()) { |
|
218 | + EE_Error::add_error( |
|
219 | + __('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'), |
|
220 | + __FILE__, |
|
221 | + __FUNCTION__, |
|
222 | + __LINE__ |
|
223 | + ); |
|
224 | + $this->checkout->redirect = false; |
|
225 | + $this->checkout->continue_reg = false; |
|
226 | + return false; |
|
227 | + } |
|
228 | + // setup URL for redirect |
|
229 | + $this->checkout->redirect_url = add_query_arg( |
|
230 | + array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()), |
|
231 | + $this->checkout->thank_you_page_url |
|
232 | + ); |
|
233 | + return true; |
|
234 | + } |
|
235 | + |
|
236 | + |
|
237 | + /** |
|
238 | + * @return void |
|
239 | + */ |
|
240 | + public function update_reg_step() |
|
241 | + { |
|
242 | + EE_Error::doing_it_wrong( |
|
243 | + __CLASS__ . '::' . __FILE__, |
|
244 | + __( |
|
245 | + 'Can not call update_reg_step() on the Finalize Registration reg step.', |
|
246 | + 'event_espresso' |
|
247 | + ), |
|
248 | + '4.6.0' |
|
249 | + ); |
|
250 | + } |
|
251 | 251 | } |
@@ -7,10 +7,10 @@ discard block |
||
7 | 7 | ?> |
8 | 8 | <h2><?php esc_html_e('Event Registration Data', 'event_espresso'); ?></h2> |
9 | 9 | <p><?php |
10 | - esc_html_e( |
|
11 | - 'We collect information about you during event registration. This information may include but is not limited to:', |
|
12 | - 'event_espresso' |
|
13 | - ); ?></p> |
|
10 | + esc_html_e( |
|
11 | + 'We collect information about you during event registration. This information may include but is not limited to:', |
|
12 | + 'event_espresso' |
|
13 | + ); ?></p> |
|
14 | 14 | <ul> |
15 | 15 | <li><?php esc_html_e('Your names', 'event_espresso'); ?></li> |
16 | 16 | <li><?php esc_html_e('Billing address', 'event_espresso'); ?></li> |
@@ -19,10 +19,10 @@ discard block |
||
19 | 19 | <li><?php esc_html_e('Phone number', 'event_espresso'); ?></li> |
20 | 20 | <li><?php esc_html_e('Location and traffic data (including partial IP address and browser type)', 'event_espresso'); ?></li> |
21 | 21 | <li><?php |
22 | - esc_html_e( |
|
23 | - 'Any other details that might be requested from you for the purpose of processing your registration or ticket purchase', |
|
24 | - 'event_espresso' |
|
25 | - ); ?></li> |
|
22 | + esc_html_e( |
|
23 | + 'Any other details that might be requested from you for the purpose of processing your registration or ticket purchase', |
|
24 | + 'event_espresso' |
|
25 | + ); ?></li> |
|
26 | 26 | </ul> |
27 | 27 | |
28 | 28 | <p><?php esc_html_e('Handling this data also allows us to:', 'event_espresso'); ?></p> |
@@ -30,102 +30,102 @@ discard block |
||
30 | 30 | <li><?php esc_html_e('Send you important account/purchase/service information.', 'event_espresso'); ?></li> |
31 | 31 | <li><?php esc_html_e('Respond to your queries, refund requests, or complaints.', 'event_espresso'); ?></li> |
32 | 32 | <li><?php |
33 | - esc_html_e( |
|
34 | - 'Process payments and prevent fraudulent transactions. We do this on the basis of our legitimate business interests.', |
|
35 | - 'event_espresso' |
|
36 | - ); ?></li> |
|
33 | + esc_html_e( |
|
34 | + 'Process payments and prevent fraudulent transactions. We do this on the basis of our legitimate business interests.', |
|
35 | + 'event_espresso' |
|
36 | + ); ?></li> |
|
37 | 37 | <li><?php |
38 | - esc_html_e( |
|
39 | - 'Set up and administer your account, provide technical and customer support, and to verify your identity.', |
|
40 | - 'event_espresso' |
|
41 | - ); ?></li> |
|
38 | + esc_html_e( |
|
39 | + 'Set up and administer your account, provide technical and customer support, and to verify your identity.', |
|
40 | + 'event_espresso' |
|
41 | + ); ?></li> |
|
42 | 42 | </ul> |
43 | 43 | |
44 | 44 | <?php if (! empty($active_onsite_payment_methods) || ! empty($active_offsite_payment_methods)) { ?> |
45 | 45 | <h2><?php esc_html_e('Billing Information', 'event_espresso'); ?> </h2> |
46 | 46 | <?php |
47 | 47 | // if onsite or offsite payment methods are active |
48 | - if (! empty($active_onsite_payment_methods)) { ?> |
|
48 | + if (! empty($active_onsite_payment_methods)) { ?> |
|
49 | 49 | <p><?php |
50 | - esc_html_e( |
|
51 | - 'In order to process payments, we collect billing information on-site. Sensitive billing information is not stored on our server, but may be handled while in-transit to the payment processing server.', |
|
52 | - 'event_espresso' |
|
53 | - ); ?></p> |
|
50 | + esc_html_e( |
|
51 | + 'In order to process payments, we collect billing information on-site. Sensitive billing information is not stored on our server, but may be handled while in-transit to the payment processing server.', |
|
52 | + 'event_espresso' |
|
53 | + ); ?></p> |
|
54 | 54 | <p><?php |
55 | - printf( |
|
56 | - esc_html_x( |
|
57 | - 'Please see the privacy policy of %1$s.', |
|
58 | - 'Please see the privacy policy of PayPal Pro', |
|
59 | - 'event_espresso' |
|
60 | - ), |
|
61 | - implode( |
|
62 | - ', ', |
|
63 | - array_merge( |
|
64 | - $active_onsite_payment_methods, |
|
65 | - $active_offsite_payment_methods |
|
66 | - ) |
|
67 | - ) |
|
68 | - ); ?></p> |
|
55 | + printf( |
|
56 | + esc_html_x( |
|
57 | + 'Please see the privacy policy of %1$s.', |
|
58 | + 'Please see the privacy policy of PayPal Pro', |
|
59 | + 'event_espresso' |
|
60 | + ), |
|
61 | + implode( |
|
62 | + ', ', |
|
63 | + array_merge( |
|
64 | + $active_onsite_payment_methods, |
|
65 | + $active_offsite_payment_methods |
|
66 | + ) |
|
67 | + ) |
|
68 | + ); ?></p> |
|
69 | 69 | <p><?php |
70 | - esc_html_e( |
|
71 | - 'Masked billing information may be stored on our servers (eg only the last 4 digits of credit card numbers are stored: **** **** **** 1234).', |
|
72 | - 'event_espresso' |
|
73 | - ); ?></p> |
|
70 | + esc_html_e( |
|
71 | + 'Masked billing information may be stored on our servers (eg only the last 4 digits of credit card numbers are stored: **** **** **** 1234).', |
|
72 | + 'event_espresso' |
|
73 | + ); ?></p> |
|
74 | 74 | <?php } // IF OFFSITE PAYMENT METHOD ACTIVE |
75 | - elseif (! empty($active_onsite_payment_methods)) { ?> |
|
75 | + elseif (! empty($active_onsite_payment_methods)) { ?> |
|
76 | 76 | <p><?php |
77 | - printf( |
|
78 | - esc_html_x( |
|
79 | - 'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of %1$s.', |
|
80 | - 'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of PayPal Pro.', |
|
81 | - 'event_espresso' |
|
82 | - ), |
|
83 | - implode(', ', $active_offsite_payment_methods) |
|
84 | - ); ?></p> |
|
77 | + printf( |
|
78 | + esc_html_x( |
|
79 | + 'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of %1$s.', |
|
80 | + 'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of PayPal Pro.', |
|
81 | + 'event_espresso' |
|
82 | + ), |
|
83 | + implode(', ', $active_offsite_payment_methods) |
|
84 | + ); ?></p> |
|
85 | 85 | <?php } ?> |
86 | 86 | <h2><?php esc_html_e('Payment Logging', 'event_espresso'); ?></h2> |
87 | 87 | <p><?php |
88 | - esc_html_e( |
|
89 | - 'Site administrators may keep a log of communications with the payment processors in order to verify payments are being processed correctly. These logs are automatically deleted after a week.', |
|
90 | - 'event_espresso' |
|
91 | - ); ?></p> |
|
88 | + esc_html_e( |
|
89 | + 'Site administrators may keep a log of communications with the payment processors in order to verify payments are being processed correctly. These logs are automatically deleted after a week.', |
|
90 | + 'event_espresso' |
|
91 | + ); ?></p> |
|
92 | 92 | <?php } ?> |
93 | 93 | |
94 | 94 | <h2><?php esc_html_e('Event Registration Cookies', 'event_espresso'); ?></h2> |
95 | 95 | <p><?php |
96 | - printf( |
|
97 | - esc_html_x( |
|
98 | - 'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts %1$s.', |
|
99 | - 'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts 2 hours.', |
|
100 | - 'event_espresso' |
|
101 | - ), |
|
102 | - $session_lifespan |
|
103 | - ); ?></p> |
|
96 | + printf( |
|
97 | + esc_html_x( |
|
98 | + 'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts %1$s.', |
|
99 | + 'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts 2 hours.', |
|
100 | + 'event_espresso' |
|
101 | + ), |
|
102 | + $session_lifespan |
|
103 | + ); ?></p> |
|
104 | 104 | |
105 | 105 | <h2><?php esc_html_e('Email History Data', 'event_espresso'); ?></h2> |
106 | 106 | <p><?php |
107 | - esc_html_e( |
|
108 | - 'We keep a record of the emails sent to you. This is to ensure communication is successfully sent and its information is accurate.', |
|
109 | - 'event_espresso' |
|
110 | - ); ?></p> |
|
107 | + esc_html_e( |
|
108 | + 'We keep a record of the emails sent to you. This is to ensure communication is successfully sent and its information is accurate.', |
|
109 | + 'event_espresso' |
|
110 | + ); ?></p> |
|
111 | 111 | |
112 | 112 | <h2><?php esc_html_e('Event Check-In Record', 'event_espresso'); ?></h2> |
113 | 113 | <p><?php |
114 | - esc_html_e( |
|
115 | - 'When you attend an event, an event manager may record the time you check in or out of the event.', |
|
116 | - 'event_espresso' |
|
117 | - ); ?></p> |
|
114 | + esc_html_e( |
|
115 | + 'When you attend an event, an event manager may record the time you check in or out of the event.', |
|
116 | + 'event_espresso' |
|
117 | + ); ?></p> |
|
118 | 118 | |
119 | 119 | <h2><?php esc_html_e('Event Registration Data Retention', 'event_espresso'); ?></h2> |
120 | 120 | <p><?php |
121 | - esc_html_e( |
|
122 | - 'Personal data is stored at least until the date of the event, and may be kept indefinitely in case of future registrations.', |
|
123 | - 'event_espresso' |
|
124 | - ); ?></p> |
|
121 | + esc_html_e( |
|
122 | + 'Personal data is stored at least until the date of the event, and may be kept indefinitely in case of future registrations.', |
|
123 | + 'event_espresso' |
|
124 | + ); ?></p> |
|
125 | 125 | |
126 | 126 | <h2><?php esc_html_e('Event Registration Data Erasure and Export', 'event_espresso'); ?></h2> |
127 | 127 | <p><?php |
128 | - esc_html_e( |
|
129 | - 'You have the right to request your personal data be sent to you electronically, and the right to request your registration data be erased after the event. To do so, please contact the event manager or site administrator.', |
|
130 | - 'event_espresso' |
|
131 | - ); ?></p> |
|
128 | + esc_html_e( |
|
129 | + 'You have the right to request your personal data be sent to you electronically, and the right to request your registration data be erased after the event. To do so, please contact the event manager or site administrator.', |
|
130 | + 'event_espresso' |
|
131 | + ); ?></p> |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | $this->removeAlreadyRegisteredDataForScriptHandles(); |
207 | 207 | wp_add_inline_script( |
208 | 208 | 'eejs-core', |
209 | - 'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)), |
|
209 | + 'var eejsdata='.wp_json_encode(array('data' => $this->jsdata)), |
|
210 | 210 | 'before' |
211 | 211 | ); |
212 | 212 | $scripts = $this->assets->getJavascriptAssetsWithData(); |
@@ -236,7 +236,7 @@ discard block |
||
236 | 236 | public function addData($key, $value) |
237 | 237 | { |
238 | 238 | if ($this->verifyDataNotExisting($key)) { |
239 | - $this->jsdata[ $key ] = $value; |
|
239 | + $this->jsdata[$key] = $value; |
|
240 | 240 | } |
241 | 241 | } |
242 | 242 | |
@@ -257,8 +257,8 @@ discard block |
||
257 | 257 | */ |
258 | 258 | public function pushData($key, $value) |
259 | 259 | { |
260 | - if (isset($this->jsdata[ $key ]) |
|
261 | - && ! is_array($this->jsdata[ $key ]) |
|
260 | + if (isset($this->jsdata[$key]) |
|
261 | + && ! is_array($this->jsdata[$key]) |
|
262 | 262 | ) { |
263 | 263 | throw new InvalidArgumentException( |
264 | 264 | sprintf( |
@@ -272,7 +272,7 @@ discard block |
||
272 | 272 | ) |
273 | 273 | ); |
274 | 274 | } |
275 | - $this->jsdata[ $key ][] = $value; |
|
275 | + $this->jsdata[$key][] = $value; |
|
276 | 276 | } |
277 | 277 | |
278 | 278 | |
@@ -286,11 +286,11 @@ discard block |
||
286 | 286 | */ |
287 | 287 | public function addTemplate($template_reference, $template_content) |
288 | 288 | { |
289 | - if (! isset($this->jsdata['templates'])) { |
|
289 | + if ( ! isset($this->jsdata['templates'])) { |
|
290 | 290 | $this->jsdata['templates'] = array(); |
291 | 291 | } |
292 | 292 | //no overrides allowed. |
293 | - if (isset($this->jsdata['templates'][ $template_reference ])) { |
|
293 | + if (isset($this->jsdata['templates'][$template_reference])) { |
|
294 | 294 | throw new InvalidArgumentException( |
295 | 295 | sprintf( |
296 | 296 | __( |
@@ -301,7 +301,7 @@ discard block |
||
301 | 301 | ) |
302 | 302 | ); |
303 | 303 | } |
304 | - $this->jsdata['templates'][ $template_reference ] = $template_content; |
|
304 | + $this->jsdata['templates'][$template_reference] = $template_content; |
|
305 | 305 | } |
306 | 306 | |
307 | 307 | |
@@ -313,8 +313,8 @@ discard block |
||
313 | 313 | */ |
314 | 314 | public function getTemplate($template_reference) |
315 | 315 | { |
316 | - return isset($this->jsdata['templates'][ $template_reference ]) |
|
317 | - ? $this->jsdata['templates'][ $template_reference ] |
|
316 | + return isset($this->jsdata['templates'][$template_reference]) |
|
317 | + ? $this->jsdata['templates'][$template_reference] |
|
318 | 318 | : ''; |
319 | 319 | } |
320 | 320 | |
@@ -327,8 +327,8 @@ discard block |
||
327 | 327 | */ |
328 | 328 | public function getData($key) |
329 | 329 | { |
330 | - return isset($this->jsdata[ $key ]) |
|
331 | - ? $this->jsdata[ $key ] |
|
330 | + return isset($this->jsdata[$key]) |
|
331 | + ? $this->jsdata[$key] |
|
332 | 332 | : false; |
333 | 333 | } |
334 | 334 | |
@@ -343,8 +343,8 @@ discard block |
||
343 | 343 | */ |
344 | 344 | protected function verifyDataNotExisting($key) |
345 | 345 | { |
346 | - if (isset($this->jsdata[ $key ])) { |
|
347 | - if (is_array($this->jsdata[ $key ])) { |
|
346 | + if (isset($this->jsdata[$key])) { |
|
347 | + if (is_array($this->jsdata[$key])) { |
|
348 | 348 | throw new InvalidArgumentException( |
349 | 349 | sprintf( |
350 | 350 | __( |
@@ -387,11 +387,11 @@ discard block |
||
387 | 387 | public function getAssetUrl($namespace, $chunk_name, $asset_type) |
388 | 388 | { |
389 | 389 | $url = isset( |
390 | - $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ], |
|
391 | - $this->manifest_data[ $namespace ]['url_base'] |
|
390 | + $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type], |
|
391 | + $this->manifest_data[$namespace]['url_base'] |
|
392 | 392 | ) |
393 | - ? $this->manifest_data[ $namespace ]['url_base'] |
|
394 | - . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ] |
|
393 | + ? $this->manifest_data[$namespace]['url_base'] |
|
394 | + . $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type] |
|
395 | 395 | : $chunk_name; |
396 | 396 | return apply_filters( |
397 | 397 | 'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl', |
@@ -441,7 +441,7 @@ discard block |
||
441 | 441 | $this->registerManifestFile( |
442 | 442 | $manifest_file->assetNamespace(), |
443 | 443 | $manifest_file->urlBase(), |
444 | - $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST |
|
444 | + $manifest_file->filepath().Registry::FILE_NAME_BUILD_MANIFEST |
|
445 | 445 | ); |
446 | 446 | } |
447 | 447 | } |
@@ -459,7 +459,7 @@ discard block |
||
459 | 459 | */ |
460 | 460 | public function registerManifestFile($namespace, $url_base, $manifest_file) |
461 | 461 | { |
462 | - if (isset($this->manifest_data[ $namespace ])) { |
|
462 | + if (isset($this->manifest_data[$namespace])) { |
|
463 | 463 | throw new InvalidArgumentException( |
464 | 464 | sprintf( |
465 | 465 | esc_html__( |
@@ -490,9 +490,9 @@ discard block |
||
490 | 490 | } |
491 | 491 | return; |
492 | 492 | } |
493 | - $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file); |
|
494 | - if (! isset($this->manifest_data[ $namespace ]['url_base'])) { |
|
495 | - $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base); |
|
493 | + $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file); |
|
494 | + if ( ! isset($this->manifest_data[$namespace]['url_base'])) { |
|
495 | + $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base); |
|
496 | 496 | } |
497 | 497 | } |
498 | 498 | |
@@ -507,7 +507,7 @@ discard block |
||
507 | 507 | */ |
508 | 508 | private function decodeManifestFile($manifest_file) |
509 | 509 | { |
510 | - if (! file_exists($manifest_file)) { |
|
510 | + if ( ! file_exists($manifest_file)) { |
|
511 | 511 | throw new InvalidFilePathException($manifest_file); |
512 | 512 | } |
513 | 513 | return json_decode(file_get_contents($manifest_file), true); |
@@ -521,7 +521,7 @@ discard block |
||
521 | 521 | */ |
522 | 522 | private function addRegisteredScriptHandlesWithData($script_handle) |
523 | 523 | { |
524 | - $this->script_handles_with_data[ $script_handle ] = $script_handle; |
|
524 | + $this->script_handles_with_data[$script_handle] = $script_handle; |
|
525 | 525 | } |
526 | 526 | |
527 | 527 | |
@@ -547,23 +547,23 @@ discard block |
||
547 | 547 | */ |
548 | 548 | private function removeAlreadyRegisteredDataForScriptHandle($script_handle) |
549 | 549 | { |
550 | - if (isset($this->script_handles_with_data[ $script_handle ])) { |
|
550 | + if (isset($this->script_handles_with_data[$script_handle])) { |
|
551 | 551 | global $wp_scripts; |
552 | 552 | $unset_handle = false; |
553 | 553 | if ($wp_scripts->get_data($script_handle, 'data')) { |
554 | - unset($wp_scripts->registered[ $script_handle ]->extra['data']); |
|
554 | + unset($wp_scripts->registered[$script_handle]->extra['data']); |
|
555 | 555 | $unset_handle = true; |
556 | 556 | } |
557 | 557 | //deal with inline_scripts |
558 | 558 | if ($wp_scripts->get_data($script_handle, 'before')) { |
559 | - unset($wp_scripts->registered[ $script_handle ]->extra['before']); |
|
559 | + unset($wp_scripts->registered[$script_handle]->extra['before']); |
|
560 | 560 | $unset_handle = true; |
561 | 561 | } |
562 | 562 | if ($wp_scripts->get_data($script_handle, 'after')) { |
563 | - unset($wp_scripts->registered[ $script_handle ]->extra['after']); |
|
563 | + unset($wp_scripts->registered[$script_handle]->extra['after']); |
|
564 | 564 | } |
565 | 565 | if ($unset_handle) { |
566 | - unset($this->script_handles_with_data[ $script_handle ]); |
|
566 | + unset($this->script_handles_with_data[$script_handle]); |
|
567 | 567 | } |
568 | 568 | } |
569 | 569 | } |
@@ -23,559 +23,559 @@ |
||
23 | 23 | class Registry |
24 | 24 | { |
25 | 25 | |
26 | - const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json'; |
|
27 | - |
|
28 | - /** |
|
29 | - * @var AssetCollection $assets |
|
30 | - */ |
|
31 | - protected $assets; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var I18nRegistry |
|
35 | - */ |
|
36 | - private $i18n_registry; |
|
37 | - |
|
38 | - /** |
|
39 | - * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script. |
|
40 | - * |
|
41 | - * @var array |
|
42 | - */ |
|
43 | - protected $jsdata = array(); |
|
44 | - |
|
45 | - /** |
|
46 | - * This keeps track of all scripts with registered data. It is used to prevent duplicate data objects setup in the |
|
47 | - * page source. |
|
48 | - * |
|
49 | - * @var array |
|
50 | - */ |
|
51 | - private $script_handles_with_data = array(); |
|
52 | - |
|
53 | - /** |
|
54 | - * Holds the manifest data obtained from registered manifest files. |
|
55 | - * Manifests are maps of asset chunk name to actual built asset file names. |
|
56 | - * Shape of this array is: |
|
57 | - * array( |
|
58 | - * 'some_namespace_slug' => array( |
|
59 | - * 'some_chunk_name' => array( |
|
60 | - * 'js' => 'filename.js' |
|
61 | - * 'css' => 'filename.js' |
|
62 | - * ), |
|
63 | - * 'url_base' => 'https://baseurl.com/to/assets |
|
64 | - * ) |
|
65 | - * ) |
|
66 | - * |
|
67 | - * @var array |
|
68 | - */ |
|
69 | - private $manifest_data = array(); |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * Registry constructor. |
|
74 | - * Hooking into WP actions for script registry. |
|
75 | - * |
|
76 | - * @param AssetCollection $assets |
|
77 | - * @param I18nRegistry $i18n_registry |
|
78 | - */ |
|
79 | - public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry) |
|
80 | - { |
|
81 | - $this->assets = $assets; |
|
82 | - $this->i18n_registry = $i18n_registry; |
|
83 | - add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1); |
|
84 | - add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1); |
|
85 | - add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3); |
|
86 | - add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3); |
|
87 | - add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4); |
|
88 | - add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4); |
|
89 | - add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
90 | - add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - /** |
|
95 | - * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n |
|
96 | - * translation handling. |
|
97 | - * |
|
98 | - * @return I18nRegistry |
|
99 | - */ |
|
100 | - public function getI18nRegistry() |
|
101 | - { |
|
102 | - return $this->i18n_registry; |
|
103 | - } |
|
104 | - |
|
105 | - |
|
106 | - /** |
|
107 | - * Callback for the wp_enqueue_scripts actions used to register assets. |
|
108 | - * |
|
109 | - * @since 4.9.62.p |
|
110 | - * @throws Exception |
|
111 | - */ |
|
112 | - public function registerScriptsAndStyles() |
|
113 | - { |
|
114 | - try { |
|
115 | - $this->registerScripts($this->assets->getJavascriptAssets()); |
|
116 | - $this->registerStyles($this->assets->getStylesheetAssets()); |
|
117 | - } catch (Exception $exception) { |
|
118 | - new ExceptionStackTraceDisplay($exception); |
|
119 | - } |
|
120 | - } |
|
121 | - |
|
122 | - |
|
123 | - /** |
|
124 | - * Registers JS assets with WP core |
|
125 | - * |
|
126 | - * @since 4.9.62.p |
|
127 | - * @param JavascriptAsset[] $scripts |
|
128 | - * @throws AssetRegistrationException |
|
129 | - * @throws InvalidDataTypeException |
|
130 | - */ |
|
131 | - public function registerScripts(array $scripts) |
|
132 | - { |
|
133 | - foreach ($scripts as $script) { |
|
134 | - // skip to next script if this has already been done |
|
135 | - if ($script->isRegistered()) { |
|
136 | - continue; |
|
137 | - } |
|
138 | - do_action( |
|
139 | - 'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script', |
|
140 | - $script |
|
141 | - ); |
|
142 | - $registered = wp_register_script( |
|
143 | - $script->handle(), |
|
144 | - $script->source(), |
|
145 | - $script->dependencies(), |
|
146 | - $script->version(), |
|
147 | - $script->loadInFooter() |
|
148 | - ); |
|
149 | - if (defined('EE_DEBUG') && EE_DEBUG && ! $registered) { |
|
150 | - throw new AssetRegistrationException($script->handle()); |
|
151 | - } |
|
152 | - $script->setRegistered($registered); |
|
153 | - if ($script->requiresTranslation()) { |
|
154 | - $this->registerTranslation($script->handle()); |
|
155 | - } |
|
156 | - do_action( |
|
157 | - 'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script', |
|
158 | - $script |
|
159 | - ); |
|
160 | - } |
|
161 | - } |
|
162 | - |
|
163 | - |
|
164 | - /** |
|
165 | - * Registers CSS assets with WP core |
|
166 | - * |
|
167 | - * @since 4.9.62.p |
|
168 | - * @param StylesheetAsset[] $styles |
|
169 | - * @throws InvalidDataTypeException |
|
170 | - */ |
|
171 | - public function registerStyles(array $styles) |
|
172 | - { |
|
173 | - foreach ($styles as $style) { |
|
174 | - // skip to next style if this has already been done |
|
175 | - if ($style->isRegistered()) { |
|
176 | - continue; |
|
177 | - } |
|
178 | - do_action( |
|
179 | - 'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style', |
|
180 | - $style |
|
181 | - ); |
|
182 | - wp_enqueue_style( |
|
183 | - $style->handle(), |
|
184 | - $style->source(), |
|
185 | - $style->dependencies(), |
|
186 | - $style->version(), |
|
187 | - $style->media() |
|
188 | - ); |
|
189 | - $style->setRegistered(); |
|
190 | - do_action( |
|
191 | - 'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style', |
|
192 | - $style |
|
193 | - ); |
|
194 | - } |
|
195 | - } |
|
196 | - |
|
197 | - |
|
198 | - /** |
|
199 | - * Call back for the script print in frontend and backend. |
|
200 | - * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point. |
|
201 | - * |
|
202 | - * @since 4.9.31.rc.015 |
|
203 | - */ |
|
204 | - public function enqueueData() |
|
205 | - { |
|
206 | - $this->removeAlreadyRegisteredDataForScriptHandles(); |
|
207 | - wp_add_inline_script( |
|
208 | - 'eejs-core', |
|
209 | - 'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)), |
|
210 | - 'before' |
|
211 | - ); |
|
212 | - $scripts = $this->assets->getJavascriptAssetsWithData(); |
|
213 | - foreach ($scripts as $script) { |
|
214 | - $this->addRegisteredScriptHandlesWithData($script->handle()); |
|
215 | - if ($script->hasLocalizationCallback()) { |
|
216 | - $localize = $script->localizationCallback(); |
|
217 | - $localize(); |
|
218 | - } |
|
219 | - } |
|
220 | - } |
|
221 | - |
|
222 | - |
|
223 | - /** |
|
224 | - * Used to add data to eejs.data object. |
|
225 | - * Note: Overriding existing data is not allowed. |
|
226 | - * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript. |
|
227 | - * If the data you add is something like this: |
|
228 | - * $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) ); |
|
229 | - * It will be exposed in the page source as: |
|
230 | - * eejs.data.my_plugin_data.foo == gar |
|
231 | - * |
|
232 | - * @param string $key Key used to access your data |
|
233 | - * @param string|array $value Value to attach to key |
|
234 | - * @throws InvalidArgumentException |
|
235 | - */ |
|
236 | - public function addData($key, $value) |
|
237 | - { |
|
238 | - if ($this->verifyDataNotExisting($key)) { |
|
239 | - $this->jsdata[ $key ] = $value; |
|
240 | - } |
|
241 | - } |
|
242 | - |
|
243 | - |
|
244 | - /** |
|
245 | - * Similar to addData except this allows for users to push values to an existing key where the values on key are |
|
246 | - * elements in an array. |
|
247 | - * When you use this method, the value you include will be appended to the end of an array on $key. |
|
248 | - * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript |
|
249 | - * object like this, eejs.data.test = [ my_data, |
|
250 | - * ] |
|
251 | - * If there has already been a scalar value attached to the data object given key, then |
|
252 | - * this will throw an exception. |
|
253 | - * |
|
254 | - * @param string $key Key to attach data to. |
|
255 | - * @param string|array $value Value being registered. |
|
256 | - * @throws InvalidArgumentException |
|
257 | - */ |
|
258 | - public function pushData($key, $value) |
|
259 | - { |
|
260 | - if (isset($this->jsdata[ $key ]) |
|
261 | - && ! is_array($this->jsdata[ $key ]) |
|
262 | - ) { |
|
263 | - throw new InvalidArgumentException( |
|
264 | - sprintf( |
|
265 | - __( |
|
266 | - 'The value for %1$s is already set and it is not an array. The %2$s method can only be used to |
|
26 | + const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json'; |
|
27 | + |
|
28 | + /** |
|
29 | + * @var AssetCollection $assets |
|
30 | + */ |
|
31 | + protected $assets; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var I18nRegistry |
|
35 | + */ |
|
36 | + private $i18n_registry; |
|
37 | + |
|
38 | + /** |
|
39 | + * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script. |
|
40 | + * |
|
41 | + * @var array |
|
42 | + */ |
|
43 | + protected $jsdata = array(); |
|
44 | + |
|
45 | + /** |
|
46 | + * This keeps track of all scripts with registered data. It is used to prevent duplicate data objects setup in the |
|
47 | + * page source. |
|
48 | + * |
|
49 | + * @var array |
|
50 | + */ |
|
51 | + private $script_handles_with_data = array(); |
|
52 | + |
|
53 | + /** |
|
54 | + * Holds the manifest data obtained from registered manifest files. |
|
55 | + * Manifests are maps of asset chunk name to actual built asset file names. |
|
56 | + * Shape of this array is: |
|
57 | + * array( |
|
58 | + * 'some_namespace_slug' => array( |
|
59 | + * 'some_chunk_name' => array( |
|
60 | + * 'js' => 'filename.js' |
|
61 | + * 'css' => 'filename.js' |
|
62 | + * ), |
|
63 | + * 'url_base' => 'https://baseurl.com/to/assets |
|
64 | + * ) |
|
65 | + * ) |
|
66 | + * |
|
67 | + * @var array |
|
68 | + */ |
|
69 | + private $manifest_data = array(); |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * Registry constructor. |
|
74 | + * Hooking into WP actions for script registry. |
|
75 | + * |
|
76 | + * @param AssetCollection $assets |
|
77 | + * @param I18nRegistry $i18n_registry |
|
78 | + */ |
|
79 | + public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry) |
|
80 | + { |
|
81 | + $this->assets = $assets; |
|
82 | + $this->i18n_registry = $i18n_registry; |
|
83 | + add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1); |
|
84 | + add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1); |
|
85 | + add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3); |
|
86 | + add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3); |
|
87 | + add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4); |
|
88 | + add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4); |
|
89 | + add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
90 | + add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + /** |
|
95 | + * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n |
|
96 | + * translation handling. |
|
97 | + * |
|
98 | + * @return I18nRegistry |
|
99 | + */ |
|
100 | + public function getI18nRegistry() |
|
101 | + { |
|
102 | + return $this->i18n_registry; |
|
103 | + } |
|
104 | + |
|
105 | + |
|
106 | + /** |
|
107 | + * Callback for the wp_enqueue_scripts actions used to register assets. |
|
108 | + * |
|
109 | + * @since 4.9.62.p |
|
110 | + * @throws Exception |
|
111 | + */ |
|
112 | + public function registerScriptsAndStyles() |
|
113 | + { |
|
114 | + try { |
|
115 | + $this->registerScripts($this->assets->getJavascriptAssets()); |
|
116 | + $this->registerStyles($this->assets->getStylesheetAssets()); |
|
117 | + } catch (Exception $exception) { |
|
118 | + new ExceptionStackTraceDisplay($exception); |
|
119 | + } |
|
120 | + } |
|
121 | + |
|
122 | + |
|
123 | + /** |
|
124 | + * Registers JS assets with WP core |
|
125 | + * |
|
126 | + * @since 4.9.62.p |
|
127 | + * @param JavascriptAsset[] $scripts |
|
128 | + * @throws AssetRegistrationException |
|
129 | + * @throws InvalidDataTypeException |
|
130 | + */ |
|
131 | + public function registerScripts(array $scripts) |
|
132 | + { |
|
133 | + foreach ($scripts as $script) { |
|
134 | + // skip to next script if this has already been done |
|
135 | + if ($script->isRegistered()) { |
|
136 | + continue; |
|
137 | + } |
|
138 | + do_action( |
|
139 | + 'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script', |
|
140 | + $script |
|
141 | + ); |
|
142 | + $registered = wp_register_script( |
|
143 | + $script->handle(), |
|
144 | + $script->source(), |
|
145 | + $script->dependencies(), |
|
146 | + $script->version(), |
|
147 | + $script->loadInFooter() |
|
148 | + ); |
|
149 | + if (defined('EE_DEBUG') && EE_DEBUG && ! $registered) { |
|
150 | + throw new AssetRegistrationException($script->handle()); |
|
151 | + } |
|
152 | + $script->setRegistered($registered); |
|
153 | + if ($script->requiresTranslation()) { |
|
154 | + $this->registerTranslation($script->handle()); |
|
155 | + } |
|
156 | + do_action( |
|
157 | + 'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script', |
|
158 | + $script |
|
159 | + ); |
|
160 | + } |
|
161 | + } |
|
162 | + |
|
163 | + |
|
164 | + /** |
|
165 | + * Registers CSS assets with WP core |
|
166 | + * |
|
167 | + * @since 4.9.62.p |
|
168 | + * @param StylesheetAsset[] $styles |
|
169 | + * @throws InvalidDataTypeException |
|
170 | + */ |
|
171 | + public function registerStyles(array $styles) |
|
172 | + { |
|
173 | + foreach ($styles as $style) { |
|
174 | + // skip to next style if this has already been done |
|
175 | + if ($style->isRegistered()) { |
|
176 | + continue; |
|
177 | + } |
|
178 | + do_action( |
|
179 | + 'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style', |
|
180 | + $style |
|
181 | + ); |
|
182 | + wp_enqueue_style( |
|
183 | + $style->handle(), |
|
184 | + $style->source(), |
|
185 | + $style->dependencies(), |
|
186 | + $style->version(), |
|
187 | + $style->media() |
|
188 | + ); |
|
189 | + $style->setRegistered(); |
|
190 | + do_action( |
|
191 | + 'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style', |
|
192 | + $style |
|
193 | + ); |
|
194 | + } |
|
195 | + } |
|
196 | + |
|
197 | + |
|
198 | + /** |
|
199 | + * Call back for the script print in frontend and backend. |
|
200 | + * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point. |
|
201 | + * |
|
202 | + * @since 4.9.31.rc.015 |
|
203 | + */ |
|
204 | + public function enqueueData() |
|
205 | + { |
|
206 | + $this->removeAlreadyRegisteredDataForScriptHandles(); |
|
207 | + wp_add_inline_script( |
|
208 | + 'eejs-core', |
|
209 | + 'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)), |
|
210 | + 'before' |
|
211 | + ); |
|
212 | + $scripts = $this->assets->getJavascriptAssetsWithData(); |
|
213 | + foreach ($scripts as $script) { |
|
214 | + $this->addRegisteredScriptHandlesWithData($script->handle()); |
|
215 | + if ($script->hasLocalizationCallback()) { |
|
216 | + $localize = $script->localizationCallback(); |
|
217 | + $localize(); |
|
218 | + } |
|
219 | + } |
|
220 | + } |
|
221 | + |
|
222 | + |
|
223 | + /** |
|
224 | + * Used to add data to eejs.data object. |
|
225 | + * Note: Overriding existing data is not allowed. |
|
226 | + * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript. |
|
227 | + * If the data you add is something like this: |
|
228 | + * $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) ); |
|
229 | + * It will be exposed in the page source as: |
|
230 | + * eejs.data.my_plugin_data.foo == gar |
|
231 | + * |
|
232 | + * @param string $key Key used to access your data |
|
233 | + * @param string|array $value Value to attach to key |
|
234 | + * @throws InvalidArgumentException |
|
235 | + */ |
|
236 | + public function addData($key, $value) |
|
237 | + { |
|
238 | + if ($this->verifyDataNotExisting($key)) { |
|
239 | + $this->jsdata[ $key ] = $value; |
|
240 | + } |
|
241 | + } |
|
242 | + |
|
243 | + |
|
244 | + /** |
|
245 | + * Similar to addData except this allows for users to push values to an existing key where the values on key are |
|
246 | + * elements in an array. |
|
247 | + * When you use this method, the value you include will be appended to the end of an array on $key. |
|
248 | + * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript |
|
249 | + * object like this, eejs.data.test = [ my_data, |
|
250 | + * ] |
|
251 | + * If there has already been a scalar value attached to the data object given key, then |
|
252 | + * this will throw an exception. |
|
253 | + * |
|
254 | + * @param string $key Key to attach data to. |
|
255 | + * @param string|array $value Value being registered. |
|
256 | + * @throws InvalidArgumentException |
|
257 | + */ |
|
258 | + public function pushData($key, $value) |
|
259 | + { |
|
260 | + if (isset($this->jsdata[ $key ]) |
|
261 | + && ! is_array($this->jsdata[ $key ]) |
|
262 | + ) { |
|
263 | + throw new InvalidArgumentException( |
|
264 | + sprintf( |
|
265 | + __( |
|
266 | + 'The value for %1$s is already set and it is not an array. The %2$s method can only be used to |
|
267 | 267 | push values to this data element when it is an array.', |
268 | - 'event_espresso' |
|
269 | - ), |
|
270 | - $key, |
|
271 | - __METHOD__ |
|
272 | - ) |
|
273 | - ); |
|
274 | - } |
|
275 | - $this->jsdata[ $key ][] = $value; |
|
276 | - } |
|
277 | - |
|
278 | - |
|
279 | - /** |
|
280 | - * Used to set content used by javascript for a template. |
|
281 | - * Note: Overrides of existing registered templates are not allowed. |
|
282 | - * |
|
283 | - * @param string $template_reference |
|
284 | - * @param string $template_content |
|
285 | - * @throws InvalidArgumentException |
|
286 | - */ |
|
287 | - public function addTemplate($template_reference, $template_content) |
|
288 | - { |
|
289 | - if (! isset($this->jsdata['templates'])) { |
|
290 | - $this->jsdata['templates'] = array(); |
|
291 | - } |
|
292 | - //no overrides allowed. |
|
293 | - if (isset($this->jsdata['templates'][ $template_reference ])) { |
|
294 | - throw new InvalidArgumentException( |
|
295 | - sprintf( |
|
296 | - __( |
|
297 | - 'The %1$s key already exists for the templates array in the js data array. No overrides are allowed.', |
|
298 | - 'event_espresso' |
|
299 | - ), |
|
300 | - $template_reference |
|
301 | - ) |
|
302 | - ); |
|
303 | - } |
|
304 | - $this->jsdata['templates'][ $template_reference ] = $template_content; |
|
305 | - } |
|
306 | - |
|
307 | - |
|
308 | - /** |
|
309 | - * Retrieve the template content already registered for the given reference. |
|
310 | - * |
|
311 | - * @param string $template_reference |
|
312 | - * @return string |
|
313 | - */ |
|
314 | - public function getTemplate($template_reference) |
|
315 | - { |
|
316 | - return isset($this->jsdata['templates'][ $template_reference ]) |
|
317 | - ? $this->jsdata['templates'][ $template_reference ] |
|
318 | - : ''; |
|
319 | - } |
|
320 | - |
|
321 | - |
|
322 | - /** |
|
323 | - * Retrieve registered data. |
|
324 | - * |
|
325 | - * @param string $key Name of key to attach data to. |
|
326 | - * @return mixed If there is no for the given key, then false is returned. |
|
327 | - */ |
|
328 | - public function getData($key) |
|
329 | - { |
|
330 | - return isset($this->jsdata[ $key ]) |
|
331 | - ? $this->jsdata[ $key ] |
|
332 | - : false; |
|
333 | - } |
|
334 | - |
|
335 | - |
|
336 | - /** |
|
337 | - * Verifies whether the given data exists already on the jsdata array. |
|
338 | - * Overriding data is not allowed. |
|
339 | - * |
|
340 | - * @param string $key Index for data. |
|
341 | - * @return bool If valid then return true. |
|
342 | - * @throws InvalidArgumentException if data already exists. |
|
343 | - */ |
|
344 | - protected function verifyDataNotExisting($key) |
|
345 | - { |
|
346 | - if (isset($this->jsdata[ $key ])) { |
|
347 | - if (is_array($this->jsdata[ $key ])) { |
|
348 | - throw new InvalidArgumentException( |
|
349 | - sprintf( |
|
350 | - __( |
|
351 | - 'The value for %1$s already exists in the Registry::eejs object. |
|
268 | + 'event_espresso' |
|
269 | + ), |
|
270 | + $key, |
|
271 | + __METHOD__ |
|
272 | + ) |
|
273 | + ); |
|
274 | + } |
|
275 | + $this->jsdata[ $key ][] = $value; |
|
276 | + } |
|
277 | + |
|
278 | + |
|
279 | + /** |
|
280 | + * Used to set content used by javascript for a template. |
|
281 | + * Note: Overrides of existing registered templates are not allowed. |
|
282 | + * |
|
283 | + * @param string $template_reference |
|
284 | + * @param string $template_content |
|
285 | + * @throws InvalidArgumentException |
|
286 | + */ |
|
287 | + public function addTemplate($template_reference, $template_content) |
|
288 | + { |
|
289 | + if (! isset($this->jsdata['templates'])) { |
|
290 | + $this->jsdata['templates'] = array(); |
|
291 | + } |
|
292 | + //no overrides allowed. |
|
293 | + if (isset($this->jsdata['templates'][ $template_reference ])) { |
|
294 | + throw new InvalidArgumentException( |
|
295 | + sprintf( |
|
296 | + __( |
|
297 | + 'The %1$s key already exists for the templates array in the js data array. No overrides are allowed.', |
|
298 | + 'event_espresso' |
|
299 | + ), |
|
300 | + $template_reference |
|
301 | + ) |
|
302 | + ); |
|
303 | + } |
|
304 | + $this->jsdata['templates'][ $template_reference ] = $template_content; |
|
305 | + } |
|
306 | + |
|
307 | + |
|
308 | + /** |
|
309 | + * Retrieve the template content already registered for the given reference. |
|
310 | + * |
|
311 | + * @param string $template_reference |
|
312 | + * @return string |
|
313 | + */ |
|
314 | + public function getTemplate($template_reference) |
|
315 | + { |
|
316 | + return isset($this->jsdata['templates'][ $template_reference ]) |
|
317 | + ? $this->jsdata['templates'][ $template_reference ] |
|
318 | + : ''; |
|
319 | + } |
|
320 | + |
|
321 | + |
|
322 | + /** |
|
323 | + * Retrieve registered data. |
|
324 | + * |
|
325 | + * @param string $key Name of key to attach data to. |
|
326 | + * @return mixed If there is no for the given key, then false is returned. |
|
327 | + */ |
|
328 | + public function getData($key) |
|
329 | + { |
|
330 | + return isset($this->jsdata[ $key ]) |
|
331 | + ? $this->jsdata[ $key ] |
|
332 | + : false; |
|
333 | + } |
|
334 | + |
|
335 | + |
|
336 | + /** |
|
337 | + * Verifies whether the given data exists already on the jsdata array. |
|
338 | + * Overriding data is not allowed. |
|
339 | + * |
|
340 | + * @param string $key Index for data. |
|
341 | + * @return bool If valid then return true. |
|
342 | + * @throws InvalidArgumentException if data already exists. |
|
343 | + */ |
|
344 | + protected function verifyDataNotExisting($key) |
|
345 | + { |
|
346 | + if (isset($this->jsdata[ $key ])) { |
|
347 | + if (is_array($this->jsdata[ $key ])) { |
|
348 | + throw new InvalidArgumentException( |
|
349 | + sprintf( |
|
350 | + __( |
|
351 | + 'The value for %1$s already exists in the Registry::eejs object. |
|
352 | 352 | Overrides are not allowed. Since the value of this data is an array, you may want to use the |
353 | 353 | %2$s method to push your value to the array.', |
354 | - 'event_espresso' |
|
355 | - ), |
|
356 | - $key, |
|
357 | - 'pushData()' |
|
358 | - ) |
|
359 | - ); |
|
360 | - } |
|
361 | - throw new InvalidArgumentException( |
|
362 | - sprintf( |
|
363 | - __( |
|
364 | - 'The value for %1$s already exists in the Registry::eejs object. Overrides are not |
|
354 | + 'event_espresso' |
|
355 | + ), |
|
356 | + $key, |
|
357 | + 'pushData()' |
|
358 | + ) |
|
359 | + ); |
|
360 | + } |
|
361 | + throw new InvalidArgumentException( |
|
362 | + sprintf( |
|
363 | + __( |
|
364 | + 'The value for %1$s already exists in the Registry::eejs object. Overrides are not |
|
365 | 365 | allowed. Consider attaching your value to a different key', |
366 | - 'event_espresso' |
|
367 | - ), |
|
368 | - $key |
|
369 | - ) |
|
370 | - ); |
|
371 | - } |
|
372 | - return true; |
|
373 | - } |
|
374 | - |
|
375 | - |
|
376 | - /** |
|
377 | - * Get the actual asset path for asset manifests. |
|
378 | - * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned. |
|
379 | - * |
|
380 | - * @param string $namespace The namespace associated with the manifest file hosting the map of chunk_name to actual |
|
381 | - * asset file location. |
|
382 | - * @param string $chunk_name |
|
383 | - * @param string $asset_type |
|
384 | - * @return string |
|
385 | - * @since 4.9.59.p |
|
386 | - */ |
|
387 | - public function getAssetUrl($namespace, $chunk_name, $asset_type) |
|
388 | - { |
|
389 | - $url = isset( |
|
390 | - $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ], |
|
391 | - $this->manifest_data[ $namespace ]['url_base'] |
|
392 | - ) |
|
393 | - ? $this->manifest_data[ $namespace ]['url_base'] |
|
394 | - . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ] |
|
395 | - : $chunk_name; |
|
396 | - return apply_filters( |
|
397 | - 'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl', |
|
398 | - $url, |
|
399 | - $namespace, |
|
400 | - $chunk_name, |
|
401 | - $asset_type |
|
402 | - ); |
|
403 | - } |
|
404 | - |
|
405 | - |
|
406 | - /** |
|
407 | - * Return the url to a js file for the given namespace and chunk name. |
|
408 | - * |
|
409 | - * @param string $namespace |
|
410 | - * @param string $chunk_name |
|
411 | - * @return string |
|
412 | - */ |
|
413 | - public function getJsUrl($namespace, $chunk_name) |
|
414 | - { |
|
415 | - return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS); |
|
416 | - } |
|
417 | - |
|
418 | - |
|
419 | - /** |
|
420 | - * Return the url to a css file for the given namespace and chunk name. |
|
421 | - * |
|
422 | - * @param string $namespace |
|
423 | - * @param string $chunk_name |
|
424 | - * @return string |
|
425 | - */ |
|
426 | - public function getCssUrl($namespace, $chunk_name) |
|
427 | - { |
|
428 | - return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS); |
|
429 | - } |
|
430 | - |
|
431 | - |
|
432 | - /** |
|
433 | - * @since 4.9.62.p |
|
434 | - * @throws InvalidArgumentException |
|
435 | - * @throws InvalidFilePathException |
|
436 | - */ |
|
437 | - public function registerManifestFiles() |
|
438 | - { |
|
439 | - $manifest_files = $this->assets->getManifestFiles(); |
|
440 | - foreach ($manifest_files as $manifest_file) { |
|
441 | - $this->registerManifestFile( |
|
442 | - $manifest_file->assetNamespace(), |
|
443 | - $manifest_file->urlBase(), |
|
444 | - $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST |
|
445 | - ); |
|
446 | - } |
|
447 | - } |
|
448 | - |
|
449 | - |
|
450 | - /** |
|
451 | - * Used to register a js/css manifest file with the registered_manifest_files property. |
|
452 | - * |
|
453 | - * @param string $namespace Provided to associate the manifest file with a specific namespace. |
|
454 | - * @param string $url_base The url base for the manifest file location. |
|
455 | - * @param string $manifest_file The absolute path to the manifest file. |
|
456 | - * @throws InvalidArgumentException |
|
457 | - * @throws InvalidFilePathException |
|
458 | - * @since 4.9.59.p |
|
459 | - */ |
|
460 | - public function registerManifestFile($namespace, $url_base, $manifest_file) |
|
461 | - { |
|
462 | - if (isset($this->manifest_data[ $namespace ])) { |
|
463 | - throw new InvalidArgumentException( |
|
464 | - sprintf( |
|
465 | - esc_html__( |
|
466 | - 'The namespace for this manifest file has already been registered, choose a namespace other than %s', |
|
467 | - 'event_espresso' |
|
468 | - ), |
|
469 | - $namespace |
|
470 | - ) |
|
471 | - ); |
|
472 | - } |
|
473 | - if (filter_var($url_base, FILTER_VALIDATE_URL) === false) { |
|
474 | - if (is_admin()) { |
|
475 | - EE_Error::add_error( |
|
476 | - sprintf( |
|
477 | - esc_html__( |
|
478 | - 'The url given for %1$s assets is invalid. The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant', |
|
479 | - 'event_espresso' |
|
480 | - ), |
|
481 | - 'Event Espresso', |
|
482 | - $url_base, |
|
483 | - 'plugins_url', |
|
484 | - 'WP_PLUGIN_URL' |
|
485 | - ), |
|
486 | - __FILE__, |
|
487 | - __FUNCTION__, |
|
488 | - __LINE__ |
|
489 | - ); |
|
490 | - } |
|
491 | - return; |
|
492 | - } |
|
493 | - $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file); |
|
494 | - if (! isset($this->manifest_data[ $namespace ]['url_base'])) { |
|
495 | - $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base); |
|
496 | - } |
|
497 | - } |
|
498 | - |
|
499 | - |
|
500 | - /** |
|
501 | - * Decodes json from the provided manifest file. |
|
502 | - * |
|
503 | - * @since 4.9.59.p |
|
504 | - * @param string $manifest_file Path to manifest file. |
|
505 | - * @return array |
|
506 | - * @throws InvalidFilePathException |
|
507 | - */ |
|
508 | - private function decodeManifestFile($manifest_file) |
|
509 | - { |
|
510 | - if (! file_exists($manifest_file)) { |
|
511 | - throw new InvalidFilePathException($manifest_file); |
|
512 | - } |
|
513 | - return json_decode(file_get_contents($manifest_file), true); |
|
514 | - } |
|
515 | - |
|
516 | - |
|
517 | - /** |
|
518 | - * This is used to set registered script handles that have data. |
|
519 | - * |
|
520 | - * @param string $script_handle |
|
521 | - */ |
|
522 | - private function addRegisteredScriptHandlesWithData($script_handle) |
|
523 | - { |
|
524 | - $this->script_handles_with_data[ $script_handle ] = $script_handle; |
|
525 | - } |
|
526 | - |
|
527 | - |
|
528 | - /**i |
|
366 | + 'event_espresso' |
|
367 | + ), |
|
368 | + $key |
|
369 | + ) |
|
370 | + ); |
|
371 | + } |
|
372 | + return true; |
|
373 | + } |
|
374 | + |
|
375 | + |
|
376 | + /** |
|
377 | + * Get the actual asset path for asset manifests. |
|
378 | + * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned. |
|
379 | + * |
|
380 | + * @param string $namespace The namespace associated with the manifest file hosting the map of chunk_name to actual |
|
381 | + * asset file location. |
|
382 | + * @param string $chunk_name |
|
383 | + * @param string $asset_type |
|
384 | + * @return string |
|
385 | + * @since 4.9.59.p |
|
386 | + */ |
|
387 | + public function getAssetUrl($namespace, $chunk_name, $asset_type) |
|
388 | + { |
|
389 | + $url = isset( |
|
390 | + $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ], |
|
391 | + $this->manifest_data[ $namespace ]['url_base'] |
|
392 | + ) |
|
393 | + ? $this->manifest_data[ $namespace ]['url_base'] |
|
394 | + . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ] |
|
395 | + : $chunk_name; |
|
396 | + return apply_filters( |
|
397 | + 'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl', |
|
398 | + $url, |
|
399 | + $namespace, |
|
400 | + $chunk_name, |
|
401 | + $asset_type |
|
402 | + ); |
|
403 | + } |
|
404 | + |
|
405 | + |
|
406 | + /** |
|
407 | + * Return the url to a js file for the given namespace and chunk name. |
|
408 | + * |
|
409 | + * @param string $namespace |
|
410 | + * @param string $chunk_name |
|
411 | + * @return string |
|
412 | + */ |
|
413 | + public function getJsUrl($namespace, $chunk_name) |
|
414 | + { |
|
415 | + return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS); |
|
416 | + } |
|
417 | + |
|
418 | + |
|
419 | + /** |
|
420 | + * Return the url to a css file for the given namespace and chunk name. |
|
421 | + * |
|
422 | + * @param string $namespace |
|
423 | + * @param string $chunk_name |
|
424 | + * @return string |
|
425 | + */ |
|
426 | + public function getCssUrl($namespace, $chunk_name) |
|
427 | + { |
|
428 | + return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS); |
|
429 | + } |
|
430 | + |
|
431 | + |
|
432 | + /** |
|
433 | + * @since 4.9.62.p |
|
434 | + * @throws InvalidArgumentException |
|
435 | + * @throws InvalidFilePathException |
|
436 | + */ |
|
437 | + public function registerManifestFiles() |
|
438 | + { |
|
439 | + $manifest_files = $this->assets->getManifestFiles(); |
|
440 | + foreach ($manifest_files as $manifest_file) { |
|
441 | + $this->registerManifestFile( |
|
442 | + $manifest_file->assetNamespace(), |
|
443 | + $manifest_file->urlBase(), |
|
444 | + $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST |
|
445 | + ); |
|
446 | + } |
|
447 | + } |
|
448 | + |
|
449 | + |
|
450 | + /** |
|
451 | + * Used to register a js/css manifest file with the registered_manifest_files property. |
|
452 | + * |
|
453 | + * @param string $namespace Provided to associate the manifest file with a specific namespace. |
|
454 | + * @param string $url_base The url base for the manifest file location. |
|
455 | + * @param string $manifest_file The absolute path to the manifest file. |
|
456 | + * @throws InvalidArgumentException |
|
457 | + * @throws InvalidFilePathException |
|
458 | + * @since 4.9.59.p |
|
459 | + */ |
|
460 | + public function registerManifestFile($namespace, $url_base, $manifest_file) |
|
461 | + { |
|
462 | + if (isset($this->manifest_data[ $namespace ])) { |
|
463 | + throw new InvalidArgumentException( |
|
464 | + sprintf( |
|
465 | + esc_html__( |
|
466 | + 'The namespace for this manifest file has already been registered, choose a namespace other than %s', |
|
467 | + 'event_espresso' |
|
468 | + ), |
|
469 | + $namespace |
|
470 | + ) |
|
471 | + ); |
|
472 | + } |
|
473 | + if (filter_var($url_base, FILTER_VALIDATE_URL) === false) { |
|
474 | + if (is_admin()) { |
|
475 | + EE_Error::add_error( |
|
476 | + sprintf( |
|
477 | + esc_html__( |
|
478 | + 'The url given for %1$s assets is invalid. The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant', |
|
479 | + 'event_espresso' |
|
480 | + ), |
|
481 | + 'Event Espresso', |
|
482 | + $url_base, |
|
483 | + 'plugins_url', |
|
484 | + 'WP_PLUGIN_URL' |
|
485 | + ), |
|
486 | + __FILE__, |
|
487 | + __FUNCTION__, |
|
488 | + __LINE__ |
|
489 | + ); |
|
490 | + } |
|
491 | + return; |
|
492 | + } |
|
493 | + $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file); |
|
494 | + if (! isset($this->manifest_data[ $namespace ]['url_base'])) { |
|
495 | + $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base); |
|
496 | + } |
|
497 | + } |
|
498 | + |
|
499 | + |
|
500 | + /** |
|
501 | + * Decodes json from the provided manifest file. |
|
502 | + * |
|
503 | + * @since 4.9.59.p |
|
504 | + * @param string $manifest_file Path to manifest file. |
|
505 | + * @return array |
|
506 | + * @throws InvalidFilePathException |
|
507 | + */ |
|
508 | + private function decodeManifestFile($manifest_file) |
|
509 | + { |
|
510 | + if (! file_exists($manifest_file)) { |
|
511 | + throw new InvalidFilePathException($manifest_file); |
|
512 | + } |
|
513 | + return json_decode(file_get_contents($manifest_file), true); |
|
514 | + } |
|
515 | + |
|
516 | + |
|
517 | + /** |
|
518 | + * This is used to set registered script handles that have data. |
|
519 | + * |
|
520 | + * @param string $script_handle |
|
521 | + */ |
|
522 | + private function addRegisteredScriptHandlesWithData($script_handle) |
|
523 | + { |
|
524 | + $this->script_handles_with_data[ $script_handle ] = $script_handle; |
|
525 | + } |
|
526 | + |
|
527 | + |
|
528 | + /**i |
|
529 | 529 | * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the |
530 | 530 | * Dependency stored in WP_Scripts if its set. |
531 | 531 | */ |
532 | - private function removeAlreadyRegisteredDataForScriptHandles() |
|
533 | - { |
|
534 | - if (empty($this->script_handles_with_data)) { |
|
535 | - return; |
|
536 | - } |
|
537 | - foreach ($this->script_handles_with_data as $script_handle) { |
|
538 | - $this->removeAlreadyRegisteredDataForScriptHandle($script_handle); |
|
539 | - } |
|
540 | - } |
|
541 | - |
|
542 | - |
|
543 | - /** |
|
544 | - * Removes any data dependency registered in WP_Scripts if its set. |
|
545 | - * |
|
546 | - * @param string $script_handle |
|
547 | - */ |
|
548 | - private function removeAlreadyRegisteredDataForScriptHandle($script_handle) |
|
549 | - { |
|
550 | - if (isset($this->script_handles_with_data[ $script_handle ])) { |
|
551 | - global $wp_scripts; |
|
552 | - $unset_handle = false; |
|
553 | - if ($wp_scripts->get_data($script_handle, 'data')) { |
|
554 | - unset($wp_scripts->registered[ $script_handle ]->extra['data']); |
|
555 | - $unset_handle = true; |
|
556 | - } |
|
557 | - //deal with inline_scripts |
|
558 | - if ($wp_scripts->get_data($script_handle, 'before')) { |
|
559 | - unset($wp_scripts->registered[ $script_handle ]->extra['before']); |
|
560 | - $unset_handle = true; |
|
561 | - } |
|
562 | - if ($wp_scripts->get_data($script_handle, 'after')) { |
|
563 | - unset($wp_scripts->registered[ $script_handle ]->extra['after']); |
|
564 | - } |
|
565 | - if ($unset_handle) { |
|
566 | - unset($this->script_handles_with_data[ $script_handle ]); |
|
567 | - } |
|
568 | - } |
|
569 | - } |
|
570 | - |
|
571 | - |
|
572 | - /** |
|
573 | - * register translations for a registered script |
|
574 | - * |
|
575 | - * @param string $handle |
|
576 | - */ |
|
577 | - public function registerTranslation($handle) |
|
578 | - { |
|
579 | - $this->i18n_registry->registerScriptI18n($handle); |
|
580 | - } |
|
532 | + private function removeAlreadyRegisteredDataForScriptHandles() |
|
533 | + { |
|
534 | + if (empty($this->script_handles_with_data)) { |
|
535 | + return; |
|
536 | + } |
|
537 | + foreach ($this->script_handles_with_data as $script_handle) { |
|
538 | + $this->removeAlreadyRegisteredDataForScriptHandle($script_handle); |
|
539 | + } |
|
540 | + } |
|
541 | + |
|
542 | + |
|
543 | + /** |
|
544 | + * Removes any data dependency registered in WP_Scripts if its set. |
|
545 | + * |
|
546 | + * @param string $script_handle |
|
547 | + */ |
|
548 | + private function removeAlreadyRegisteredDataForScriptHandle($script_handle) |
|
549 | + { |
|
550 | + if (isset($this->script_handles_with_data[ $script_handle ])) { |
|
551 | + global $wp_scripts; |
|
552 | + $unset_handle = false; |
|
553 | + if ($wp_scripts->get_data($script_handle, 'data')) { |
|
554 | + unset($wp_scripts->registered[ $script_handle ]->extra['data']); |
|
555 | + $unset_handle = true; |
|
556 | + } |
|
557 | + //deal with inline_scripts |
|
558 | + if ($wp_scripts->get_data($script_handle, 'before')) { |
|
559 | + unset($wp_scripts->registered[ $script_handle ]->extra['before']); |
|
560 | + $unset_handle = true; |
|
561 | + } |
|
562 | + if ($wp_scripts->get_data($script_handle, 'after')) { |
|
563 | + unset($wp_scripts->registered[ $script_handle ]->extra['after']); |
|
564 | + } |
|
565 | + if ($unset_handle) { |
|
566 | + unset($this->script_handles_with_data[ $script_handle ]); |
|
567 | + } |
|
568 | + } |
|
569 | + } |
|
570 | + |
|
571 | + |
|
572 | + /** |
|
573 | + * register translations for a registered script |
|
574 | + * |
|
575 | + * @param string $handle |
|
576 | + */ |
|
577 | + public function registerTranslation($handle) |
|
578 | + { |
|
579 | + $this->i18n_registry->registerScriptI18n($handle); |
|
580 | + } |
|
581 | 581 | } |
@@ -13,257 +13,257 @@ |
||
13 | 13 | class EE_Register_CPT implements EEI_Plugin_API |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * Holds values for registered variations |
|
18 | - * |
|
19 | - * @since 4.5.0 |
|
20 | - * |
|
21 | - * @var array[][][] |
|
22 | - */ |
|
23 | - protected static $_registry = array(); |
|
16 | + /** |
|
17 | + * Holds values for registered variations |
|
18 | + * |
|
19 | + * @since 4.5.0 |
|
20 | + * |
|
21 | + * @var array[][][] |
|
22 | + */ |
|
23 | + protected static $_registry = array(); |
|
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * Used to register new CPTs and Taxonomies. |
|
28 | - * |
|
29 | - * @param string $cpt_ref reference used for the addon registering cpts and cts |
|
30 | - * @param array $setup_args { |
|
31 | - * An array of required values for registering the cpts and taxonomies |
|
32 | - * @type array $cpts { |
|
33 | - * An array of cpts and their arguments.(short example below) |
|
34 | - * @see CustomPostTypeDefinitions::setDefinitions for a more complete example. |
|
35 | - * 'people' => array( |
|
36 | - * 'singular_name' => __('People', 'event_espresso'), |
|
37 | - * 'plural_name' => __('People', 'event_espresso'), |
|
38 | - * 'singular_slug' => __('people', 'event_espresso'), |
|
39 | - * 'plural_slug' => __('peoples', 'event_espresso'), |
|
40 | - * 'class_name' => 'EE_People' |
|
41 | - * ) |
|
42 | - * }, |
|
43 | - * @type array $cts { |
|
44 | - * An array of custom taxonomies and their arguments (short example below). |
|
45 | - * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example. |
|
46 | - * 'espresso_people_type' => array( |
|
47 | - * 'singular_name' => __('People Type', 'event_espresso'), |
|
48 | - * 'plural_name' => __('People Types', 'event_espresso'), |
|
49 | - * 'args' => array() |
|
50 | - * ) |
|
51 | - * }, |
|
52 | - * @type array $default_terms { |
|
53 | - * An array of terms to set as the default for a given taxonomy and the |
|
54 | - * custom post types applied to. |
|
55 | - * 'taxonomy_name' => array( |
|
56 | - * 'term' => array( 'cpt_a_name', 'cpt_b_name' ) |
|
57 | - * ) |
|
58 | - * } |
|
59 | - * } |
|
60 | - * @throws EE_Error |
|
61 | - * @return void |
|
62 | - */ |
|
63 | - public static function register($cpt_ref = null, $setup_args = array()) |
|
64 | - { |
|
26 | + /** |
|
27 | + * Used to register new CPTs and Taxonomies. |
|
28 | + * |
|
29 | + * @param string $cpt_ref reference used for the addon registering cpts and cts |
|
30 | + * @param array $setup_args { |
|
31 | + * An array of required values for registering the cpts and taxonomies |
|
32 | + * @type array $cpts { |
|
33 | + * An array of cpts and their arguments.(short example below) |
|
34 | + * @see CustomPostTypeDefinitions::setDefinitions for a more complete example. |
|
35 | + * 'people' => array( |
|
36 | + * 'singular_name' => __('People', 'event_espresso'), |
|
37 | + * 'plural_name' => __('People', 'event_espresso'), |
|
38 | + * 'singular_slug' => __('people', 'event_espresso'), |
|
39 | + * 'plural_slug' => __('peoples', 'event_espresso'), |
|
40 | + * 'class_name' => 'EE_People' |
|
41 | + * ) |
|
42 | + * }, |
|
43 | + * @type array $cts { |
|
44 | + * An array of custom taxonomies and their arguments (short example below). |
|
45 | + * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example. |
|
46 | + * 'espresso_people_type' => array( |
|
47 | + * 'singular_name' => __('People Type', 'event_espresso'), |
|
48 | + * 'plural_name' => __('People Types', 'event_espresso'), |
|
49 | + * 'args' => array() |
|
50 | + * ) |
|
51 | + * }, |
|
52 | + * @type array $default_terms { |
|
53 | + * An array of terms to set as the default for a given taxonomy and the |
|
54 | + * custom post types applied to. |
|
55 | + * 'taxonomy_name' => array( |
|
56 | + * 'term' => array( 'cpt_a_name', 'cpt_b_name' ) |
|
57 | + * ) |
|
58 | + * } |
|
59 | + * } |
|
60 | + * @throws EE_Error |
|
61 | + * @return void |
|
62 | + */ |
|
63 | + public static function register($cpt_ref = null, $setup_args = array()) |
|
64 | + { |
|
65 | 65 | |
66 | - // check for required params |
|
67 | - if (empty($cpt_ref)) { |
|
68 | - throw new EE_Error( |
|
69 | - __( |
|
70 | - 'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered', |
|
71 | - 'event_espresso' |
|
72 | - ) |
|
73 | - ); |
|
74 | - } |
|
66 | + // check for required params |
|
67 | + if (empty($cpt_ref)) { |
|
68 | + throw new EE_Error( |
|
69 | + __( |
|
70 | + 'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered', |
|
71 | + 'event_espresso' |
|
72 | + ) |
|
73 | + ); |
|
74 | + } |
|
75 | 75 | |
76 | - if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) { |
|
77 | - throw new EE_Error( |
|
78 | - __( |
|
79 | - 'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.', |
|
80 | - 'event_espresso' |
|
81 | - ) |
|
82 | - ); |
|
83 | - } |
|
76 | + if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) { |
|
77 | + throw new EE_Error( |
|
78 | + __( |
|
79 | + 'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.', |
|
80 | + 'event_espresso' |
|
81 | + ) |
|
82 | + ); |
|
83 | + } |
|
84 | 84 | |
85 | - // make sure we don't register twice |
|
86 | - if (isset(self::$_registry[ $cpt_ref ])) { |
|
87 | - return; |
|
88 | - } |
|
85 | + // make sure we don't register twice |
|
86 | + if (isset(self::$_registry[ $cpt_ref ])) { |
|
87 | + return; |
|
88 | + } |
|
89 | 89 | |
90 | - // make sure cpt ref is unique. |
|
91 | - if (isset(self::$_registry[ $cpt_ref ])) { |
|
92 | - $cpt_ref = uniqid() . '_' . $cpt_ref; |
|
93 | - } |
|
90 | + // make sure cpt ref is unique. |
|
91 | + if (isset(self::$_registry[ $cpt_ref ])) { |
|
92 | + $cpt_ref = uniqid() . '_' . $cpt_ref; |
|
93 | + } |
|
94 | 94 | |
95 | - // make sure this was called in the right place! |
|
96 | - if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) { |
|
97 | - EE_Error::doing_it_wrong( |
|
98 | - __METHOD__, |
|
99 | - sprintf( |
|
100 | - __( |
|
101 | - 'EE_Register_CPT has been called and given a reference of "%s". It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.', |
|
102 | - 'event_espresso' |
|
103 | - ), |
|
104 | - $cpt_ref |
|
105 | - ), |
|
106 | - '4.5.0' |
|
107 | - ); |
|
108 | - } |
|
109 | - // validate incoming args |
|
110 | - $validated = array( |
|
111 | - 'cpts' => isset($setup_args['cpts']) |
|
112 | - ? (array) $setup_args['cpts'] |
|
113 | - : array(), |
|
114 | - 'cts' => isset($setup_args['cts']) |
|
115 | - ? (array) $setup_args['cts'] |
|
116 | - : array(), |
|
117 | - 'default_terms' => isset($setup_args['default_terms']) |
|
118 | - ? (array) $setup_args['default_terms'] |
|
119 | - : array(), |
|
120 | - ); |
|
95 | + // make sure this was called in the right place! |
|
96 | + if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) { |
|
97 | + EE_Error::doing_it_wrong( |
|
98 | + __METHOD__, |
|
99 | + sprintf( |
|
100 | + __( |
|
101 | + 'EE_Register_CPT has been called and given a reference of "%s". It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.', |
|
102 | + 'event_espresso' |
|
103 | + ), |
|
104 | + $cpt_ref |
|
105 | + ), |
|
106 | + '4.5.0' |
|
107 | + ); |
|
108 | + } |
|
109 | + // validate incoming args |
|
110 | + $validated = array( |
|
111 | + 'cpts' => isset($setup_args['cpts']) |
|
112 | + ? (array) $setup_args['cpts'] |
|
113 | + : array(), |
|
114 | + 'cts' => isset($setup_args['cts']) |
|
115 | + ? (array) $setup_args['cts'] |
|
116 | + : array(), |
|
117 | + 'default_terms' => isset($setup_args['default_terms']) |
|
118 | + ? (array) $setup_args['default_terms'] |
|
119 | + : array(), |
|
120 | + ); |
|
121 | 121 | |
122 | - self::$_registry[ $cpt_ref ] = $validated; |
|
122 | + self::$_registry[ $cpt_ref ] = $validated; |
|
123 | 123 | |
124 | - // hook into to cpt system |
|
125 | - add_filter( |
|
126 | - 'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes', |
|
127 | - array(__CLASS__, 'filterCustomPostTypeDefinitions'), |
|
128 | - 5 |
|
129 | - ); |
|
130 | - add_filter( |
|
131 | - 'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies', |
|
132 | - array(__CLASS__, 'filterCustomTaxonomyDefinitions'), |
|
133 | - 5 |
|
134 | - ); |
|
135 | - add_action( |
|
136 | - 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
137 | - array(__CLASS__, 'registerCustomTaxonomyTerm'), |
|
138 | - 5 |
|
139 | - ); |
|
140 | - } |
|
124 | + // hook into to cpt system |
|
125 | + add_filter( |
|
126 | + 'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes', |
|
127 | + array(__CLASS__, 'filterCustomPostTypeDefinitions'), |
|
128 | + 5 |
|
129 | + ); |
|
130 | + add_filter( |
|
131 | + 'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies', |
|
132 | + array(__CLASS__, 'filterCustomTaxonomyDefinitions'), |
|
133 | + 5 |
|
134 | + ); |
|
135 | + add_action( |
|
136 | + 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
137 | + array(__CLASS__, 'registerCustomTaxonomyTerm'), |
|
138 | + 5 |
|
139 | + ); |
|
140 | + } |
|
141 | 141 | |
142 | 142 | |
143 | - /** |
|
144 | - * Callback for |
|
145 | - * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes |
|
146 | - * that adds additional custom post types to be registered. |
|
147 | - * |
|
148 | - * @param array $custom_post_type_definitions array of cpts that are already set |
|
149 | - * @return array new array of cpts and their registration information |
|
150 | - */ |
|
151 | - public static function filterCustomPostTypeDefinitions($custom_post_type_definitions) |
|
152 | - { |
|
153 | - foreach (self::$_registry as $registries) { |
|
154 | - foreach ($registries['cpts'] as $cpt_name => $cpt_settings) { |
|
155 | - $custom_post_type_definitions[ $cpt_name ] = $cpt_settings; |
|
156 | - } |
|
157 | - } |
|
158 | - return $custom_post_type_definitions; |
|
159 | - } |
|
143 | + /** |
|
144 | + * Callback for |
|
145 | + * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes |
|
146 | + * that adds additional custom post types to be registered. |
|
147 | + * |
|
148 | + * @param array $custom_post_type_definitions array of cpts that are already set |
|
149 | + * @return array new array of cpts and their registration information |
|
150 | + */ |
|
151 | + public static function filterCustomPostTypeDefinitions($custom_post_type_definitions) |
|
152 | + { |
|
153 | + foreach (self::$_registry as $registries) { |
|
154 | + foreach ($registries['cpts'] as $cpt_name => $cpt_settings) { |
|
155 | + $custom_post_type_definitions[ $cpt_name ] = $cpt_settings; |
|
156 | + } |
|
157 | + } |
|
158 | + return $custom_post_type_definitions; |
|
159 | + } |
|
160 | 160 | |
161 | 161 | |
162 | - /** |
|
163 | - * Callback for |
|
164 | - * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies |
|
165 | - * that adds additional custom taxonomies to be registered. |
|
166 | - * |
|
167 | - * @param array $custom_taxonomy_definitions array of cts that are already set. |
|
168 | - * @return array new array of cts and their registration information. |
|
169 | - */ |
|
170 | - public static function filterCustomTaxonomyDefinitions($custom_taxonomy_definitions) |
|
171 | - { |
|
172 | - foreach (self::$_registry as $registries) { |
|
173 | - foreach ($registries['cts'] as $ct_name => $ct_settings) { |
|
174 | - $custom_taxonomy_definitions[ $ct_name ] = $ct_settings; |
|
175 | - } |
|
176 | - } |
|
177 | - return $custom_taxonomy_definitions; |
|
178 | - } |
|
162 | + /** |
|
163 | + * Callback for |
|
164 | + * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies |
|
165 | + * that adds additional custom taxonomies to be registered. |
|
166 | + * |
|
167 | + * @param array $custom_taxonomy_definitions array of cts that are already set. |
|
168 | + * @return array new array of cts and their registration information. |
|
169 | + */ |
|
170 | + public static function filterCustomTaxonomyDefinitions($custom_taxonomy_definitions) |
|
171 | + { |
|
172 | + foreach (self::$_registry as $registries) { |
|
173 | + foreach ($registries['cts'] as $ct_name => $ct_settings) { |
|
174 | + $custom_taxonomy_definitions[ $ct_name ] = $ct_settings; |
|
175 | + } |
|
176 | + } |
|
177 | + return $custom_taxonomy_definitions; |
|
178 | + } |
|
179 | 179 | |
180 | 180 | |
181 | - /** |
|
182 | - * Callback for |
|
183 | - * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end |
|
184 | - * which is used to set the default terms |
|
185 | - * |
|
186 | - * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms |
|
187 | - * @return void |
|
188 | - */ |
|
189 | - public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms) |
|
190 | - { |
|
191 | - foreach (self::$_registry as $registries) { |
|
192 | - foreach ($registries['default_terms'] as $taxonomy => $terms) { |
|
193 | - foreach ($terms as $term => $cpts) { |
|
194 | - $register_custom_taxonomy_terms->registerCustomTaxonomyTerm( |
|
195 | - $taxonomy, |
|
196 | - $term, |
|
197 | - $cpts |
|
198 | - ); |
|
199 | - } |
|
200 | - } |
|
201 | - } |
|
202 | - } |
|
181 | + /** |
|
182 | + * Callback for |
|
183 | + * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end |
|
184 | + * which is used to set the default terms |
|
185 | + * |
|
186 | + * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms |
|
187 | + * @return void |
|
188 | + */ |
|
189 | + public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms) |
|
190 | + { |
|
191 | + foreach (self::$_registry as $registries) { |
|
192 | + foreach ($registries['default_terms'] as $taxonomy => $terms) { |
|
193 | + foreach ($terms as $term => $cpts) { |
|
194 | + $register_custom_taxonomy_terms->registerCustomTaxonomyTerm( |
|
195 | + $taxonomy, |
|
196 | + $term, |
|
197 | + $cpts |
|
198 | + ); |
|
199 | + } |
|
200 | + } |
|
201 | + } |
|
202 | + } |
|
203 | 203 | |
204 | 204 | |
205 | - /** |
|
206 | - * @deprecated 4.9.62.p |
|
207 | - * @param array $cpts array of cpts that are already set |
|
208 | - * @return array new array of cpts and their registration information |
|
209 | - */ |
|
210 | - public static function filter_cpts($cpts) |
|
211 | - { |
|
212 | - foreach (self::$_registry as $registries) { |
|
213 | - foreach ($registries['cpts'] as $cpt_name => $cpt_settings) { |
|
214 | - $cpts[ $cpt_name ] = $cpt_settings; |
|
215 | - } |
|
216 | - } |
|
217 | - return $cpts; |
|
218 | - } |
|
205 | + /** |
|
206 | + * @deprecated 4.9.62.p |
|
207 | + * @param array $cpts array of cpts that are already set |
|
208 | + * @return array new array of cpts and their registration information |
|
209 | + */ |
|
210 | + public static function filter_cpts($cpts) |
|
211 | + { |
|
212 | + foreach (self::$_registry as $registries) { |
|
213 | + foreach ($registries['cpts'] as $cpt_name => $cpt_settings) { |
|
214 | + $cpts[ $cpt_name ] = $cpt_settings; |
|
215 | + } |
|
216 | + } |
|
217 | + return $cpts; |
|
218 | + } |
|
219 | 219 | |
220 | 220 | |
221 | - /** |
|
222 | - * @deprecated 4.9.62.p |
|
223 | - * @param array $cts array of cts that are already set. |
|
224 | - * @return array new array of cts and their registration information. |
|
225 | - */ |
|
226 | - public static function filter_cts($cts) |
|
227 | - { |
|
228 | - foreach (self::$_registry as $registries) { |
|
229 | - foreach ($registries['cts'] as $ct_name => $ct_settings) { |
|
230 | - $cts[ $ct_name ] = $ct_settings; |
|
231 | - } |
|
232 | - } |
|
233 | - return $cts; |
|
234 | - } |
|
221 | + /** |
|
222 | + * @deprecated 4.9.62.p |
|
223 | + * @param array $cts array of cts that are already set. |
|
224 | + * @return array new array of cts and their registration information. |
|
225 | + */ |
|
226 | + public static function filter_cts($cts) |
|
227 | + { |
|
228 | + foreach (self::$_registry as $registries) { |
|
229 | + foreach ($registries['cts'] as $ct_name => $ct_settings) { |
|
230 | + $cts[ $ct_name ] = $ct_settings; |
|
231 | + } |
|
232 | + } |
|
233 | + return $cts; |
|
234 | + } |
|
235 | 235 | |
236 | 236 | |
237 | - /** |
|
238 | - * @deprecated 4.9.62.p |
|
239 | - * @param EE_Register_CPTs $cpt_class |
|
240 | - * @return void |
|
241 | - */ |
|
242 | - public static function default_terms(EE_Register_CPTs $cpt_class) |
|
243 | - { |
|
244 | - foreach (self::$_registry as $registries) { |
|
245 | - foreach ($registries['default_terms'] as $taxonomy => $terms) { |
|
246 | - foreach ($terms as $term => $cpts) { |
|
247 | - $cpt_class->set_default_term($taxonomy, $term, $cpts); |
|
248 | - } |
|
249 | - } |
|
250 | - } |
|
251 | - } |
|
237 | + /** |
|
238 | + * @deprecated 4.9.62.p |
|
239 | + * @param EE_Register_CPTs $cpt_class |
|
240 | + * @return void |
|
241 | + */ |
|
242 | + public static function default_terms(EE_Register_CPTs $cpt_class) |
|
243 | + { |
|
244 | + foreach (self::$_registry as $registries) { |
|
245 | + foreach ($registries['default_terms'] as $taxonomy => $terms) { |
|
246 | + foreach ($terms as $term => $cpts) { |
|
247 | + $cpt_class->set_default_term($taxonomy, $term, $cpts); |
|
248 | + } |
|
249 | + } |
|
250 | + } |
|
251 | + } |
|
252 | 252 | |
253 | 253 | |
254 | - /** |
|
255 | - * This deregisters whats been registered on this class (for the given slug). |
|
256 | - * |
|
257 | - * @since 4.5.0 |
|
258 | - * |
|
259 | - * @param string $cpt_ref The reference for the item registered to be removed. |
|
260 | - * |
|
261 | - * @return void |
|
262 | - */ |
|
263 | - public static function deregister($cpt_ref = null) |
|
264 | - { |
|
265 | - if (! empty(self::$_registry[ $cpt_ref ])) { |
|
266 | - unset(self::$_registry[ $cpt_ref ]); |
|
267 | - } |
|
268 | - } |
|
254 | + /** |
|
255 | + * This deregisters whats been registered on this class (for the given slug). |
|
256 | + * |
|
257 | + * @since 4.5.0 |
|
258 | + * |
|
259 | + * @param string $cpt_ref The reference for the item registered to be removed. |
|
260 | + * |
|
261 | + * @return void |
|
262 | + */ |
|
263 | + public static function deregister($cpt_ref = null) |
|
264 | + { |
|
265 | + if (! empty(self::$_registry[ $cpt_ref ])) { |
|
266 | + unset(self::$_registry[ $cpt_ref ]); |
|
267 | + } |
|
268 | + } |
|
269 | 269 | } |
@@ -23,1664 +23,1664 @@ |
||
23 | 23 | class EE_Registry implements ResettableInterface |
24 | 24 | { |
25 | 25 | |
26 | - /** |
|
27 | - * @var EE_Registry $_instance |
|
28 | - */ |
|
29 | - private static $_instance; |
|
30 | - |
|
31 | - /** |
|
32 | - * @var EE_Dependency_Map $_dependency_map |
|
33 | - */ |
|
34 | - protected $_dependency_map; |
|
35 | - |
|
36 | - /** |
|
37 | - * @var Mirror |
|
38 | - */ |
|
39 | - private $mirror; |
|
40 | - |
|
41 | - /** |
|
42 | - * @var ClassInterfaceCache $class_cache |
|
43 | - */ |
|
44 | - private $class_cache; |
|
45 | - |
|
46 | - /** |
|
47 | - * @var array $_class_abbreviations |
|
48 | - */ |
|
49 | - protected $_class_abbreviations = array(); |
|
50 | - |
|
51 | - /** |
|
52 | - * @var CommandBusInterface $BUS |
|
53 | - */ |
|
54 | - public $BUS; |
|
55 | - |
|
56 | - /** |
|
57 | - * @var EE_Cart $CART |
|
58 | - */ |
|
59 | - public $CART; |
|
60 | - |
|
61 | - /** |
|
62 | - * @var EE_Config $CFG |
|
63 | - */ |
|
64 | - public $CFG; |
|
65 | - |
|
66 | - /** |
|
67 | - * @var EE_Network_Config $NET_CFG |
|
68 | - */ |
|
69 | - public $NET_CFG; |
|
70 | - |
|
71 | - /** |
|
72 | - * StdClass object for storing library classes in |
|
73 | - * |
|
74 | - * @var RegistryContainer $LIB |
|
75 | - */ |
|
76 | - public $LIB; |
|
77 | - |
|
78 | - /** |
|
79 | - * @var EE_Request_Handler $REQ |
|
80 | - */ |
|
81 | - public $REQ; |
|
82 | - |
|
83 | - /** |
|
84 | - * @var EE_Session $SSN |
|
85 | - */ |
|
86 | - public $SSN; |
|
87 | - |
|
88 | - /** |
|
89 | - * @since 4.5.0 |
|
90 | - * @var EE_Capabilities $CAP |
|
91 | - */ |
|
92 | - public $CAP; |
|
93 | - |
|
94 | - /** |
|
95 | - * @since 4.9.0 |
|
96 | - * @var EE_Message_Resource_Manager $MRM |
|
97 | - */ |
|
98 | - public $MRM; |
|
99 | - |
|
100 | - /** |
|
101 | - * @var Registry $AssetsRegistry |
|
102 | - */ |
|
103 | - public $AssetsRegistry; |
|
104 | - |
|
105 | - /** |
|
106 | - * StdClass object for holding addons which have registered themselves to work with EE core |
|
107 | - * |
|
108 | - * @var EE_Addon[] $addons |
|
109 | - */ |
|
110 | - public $addons; |
|
111 | - |
|
112 | - /** |
|
113 | - * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event') |
|
114 | - * |
|
115 | - * @var EEM_Base[] $models |
|
116 | - */ |
|
117 | - public $models = array(); |
|
118 | - |
|
119 | - /** |
|
120 | - * @var EED_Module[] $modules |
|
121 | - */ |
|
122 | - public $modules; |
|
123 | - |
|
124 | - /** |
|
125 | - * @var EES_Shortcode[] $shortcodes |
|
126 | - */ |
|
127 | - public $shortcodes; |
|
128 | - |
|
129 | - /** |
|
130 | - * @var WP_Widget[] $widgets |
|
131 | - */ |
|
132 | - public $widgets; |
|
133 | - |
|
134 | - /** |
|
135 | - * this is an array of all implemented model names (i.e. not the parent abstract models, or models |
|
136 | - * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)). |
|
137 | - * Keys are model "short names" (eg "Event") as used in model relations, and values are |
|
138 | - * classnames (eg "EEM_Event") |
|
139 | - * |
|
140 | - * @var array $non_abstract_db_models |
|
141 | - */ |
|
142 | - public $non_abstract_db_models = array(); |
|
143 | - |
|
144 | - /** |
|
145 | - * internationalization for JS strings |
|
146 | - * usage: EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' ); |
|
147 | - * in js file: var translatedString = eei18n.string_key; |
|
148 | - * |
|
149 | - * @var array $i18n_js_strings |
|
150 | - */ |
|
151 | - public static $i18n_js_strings = array(); |
|
152 | - |
|
153 | - /** |
|
154 | - * $main_file - path to espresso.php |
|
155 | - * |
|
156 | - * @var array $main_file |
|
157 | - */ |
|
158 | - public $main_file; |
|
159 | - |
|
160 | - /** |
|
161 | - * array of ReflectionClass objects where the key is the class name |
|
162 | - * |
|
163 | - * @deprecated 4.9.62.p |
|
164 | - * @var ReflectionClass[] $_reflectors |
|
165 | - */ |
|
166 | - public $_reflectors; |
|
167 | - |
|
168 | - /** |
|
169 | - * boolean flag to indicate whether or not to load/save dependencies from/to the cache |
|
170 | - * |
|
171 | - * @var boolean $_cache_on |
|
172 | - */ |
|
173 | - protected $_cache_on = true; |
|
174 | - |
|
175 | - /** |
|
176 | - * @var ObjectIdentifier |
|
177 | - */ |
|
178 | - private $object_identifier; |
|
179 | - |
|
180 | - |
|
181 | - /** |
|
182 | - * @singleton method used to instantiate class object |
|
183 | - * @param EE_Dependency_Map|null $dependency_map |
|
184 | - * @param Mirror|null $mirror |
|
185 | - * @param ClassInterfaceCache|null $class_cache |
|
186 | - * @param ObjectIdentifier|null $object_identifier |
|
187 | - * @return EE_Registry instance |
|
188 | - */ |
|
189 | - public static function instance( |
|
190 | - EE_Dependency_Map $dependency_map = null, |
|
191 | - Mirror $mirror = null, |
|
192 | - ClassInterfaceCache $class_cache = null, |
|
193 | - ObjectIdentifier $object_identifier = null |
|
194 | - ) { |
|
195 | - // check if class object is instantiated |
|
196 | - if (! self::$_instance instanceof EE_Registry |
|
197 | - && $dependency_map instanceof EE_Dependency_Map |
|
198 | - && $mirror instanceof Mirror |
|
199 | - && $class_cache instanceof ClassInterfaceCache |
|
200 | - && $object_identifier instanceof ObjectIdentifier |
|
201 | - ) { |
|
202 | - self::$_instance = new self( |
|
203 | - $dependency_map, |
|
204 | - $mirror, |
|
205 | - $class_cache, |
|
206 | - $object_identifier |
|
207 | - ); |
|
208 | - } |
|
209 | - return self::$_instance; |
|
210 | - } |
|
211 | - |
|
212 | - |
|
213 | - /** |
|
214 | - * protected constructor to prevent direct creation |
|
215 | - * |
|
216 | - * @Constructor |
|
217 | - * @param EE_Dependency_Map $dependency_map |
|
218 | - * @param Mirror $mirror |
|
219 | - * @param ClassInterfaceCache $class_cache |
|
220 | - * @param ObjectIdentifier $object_identifier |
|
221 | - */ |
|
222 | - protected function __construct( |
|
223 | - EE_Dependency_Map $dependency_map, |
|
224 | - Mirror $mirror, |
|
225 | - ClassInterfaceCache $class_cache, |
|
226 | - ObjectIdentifier $object_identifier |
|
227 | - ) { |
|
228 | - $this->_dependency_map = $dependency_map; |
|
229 | - $this->mirror = $mirror; |
|
230 | - $this->class_cache = $class_cache; |
|
231 | - $this->object_identifier = $object_identifier; |
|
232 | - // $registry_container = new RegistryContainer(); |
|
233 | - $this->LIB = new RegistryContainer(); |
|
234 | - $this->addons = new RegistryContainer(); |
|
235 | - $this->modules = new RegistryContainer(); |
|
236 | - $this->shortcodes = new RegistryContainer(); |
|
237 | - $this->widgets = new RegistryContainer(); |
|
238 | - add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
239 | - } |
|
240 | - |
|
241 | - |
|
242 | - /** |
|
243 | - * initialize |
|
244 | - * |
|
245 | - * @throws OutOfBoundsException |
|
246 | - * @throws InvalidArgumentException |
|
247 | - * @throws InvalidInterfaceException |
|
248 | - * @throws InvalidDataTypeException |
|
249 | - * @throws EE_Error |
|
250 | - * @throws ReflectionException |
|
251 | - */ |
|
252 | - public function initialize() |
|
253 | - { |
|
254 | - $this->_class_abbreviations = apply_filters( |
|
255 | - 'FHEE__EE_Registry____construct___class_abbreviations', |
|
256 | - array( |
|
257 | - 'EE_Config' => 'CFG', |
|
258 | - 'EE_Session' => 'SSN', |
|
259 | - 'EE_Capabilities' => 'CAP', |
|
260 | - 'EE_Cart' => 'CART', |
|
261 | - 'EE_Network_Config' => 'NET_CFG', |
|
262 | - 'EE_Request_Handler' => 'REQ', |
|
263 | - 'EE_Message_Resource_Manager' => 'MRM', |
|
264 | - 'EventEspresso\core\services\commands\CommandBus' => 'BUS', |
|
265 | - 'EventEspresso\core\services\assets\Registry' => 'AssetsRegistry', |
|
266 | - ) |
|
267 | - ); |
|
268 | - $this->load_core('Base', array(), true); |
|
269 | - // add our request and response objects to the cache |
|
270 | - $request_loader = $this->_dependency_map->class_loader( |
|
271 | - 'EventEspresso\core\services\request\Request' |
|
272 | - ); |
|
273 | - $this->_set_cached_class( |
|
274 | - $request_loader(), |
|
275 | - 'EventEspresso\core\services\request\Request' |
|
276 | - ); |
|
277 | - $response_loader = $this->_dependency_map->class_loader( |
|
278 | - 'EventEspresso\core\services\request\Response' |
|
279 | - ); |
|
280 | - $this->_set_cached_class( |
|
281 | - $response_loader(), |
|
282 | - 'EventEspresso\core\services\request\Response' |
|
283 | - ); |
|
284 | - add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init')); |
|
285 | - } |
|
286 | - |
|
287 | - |
|
288 | - /** |
|
289 | - * @return void |
|
290 | - */ |
|
291 | - public function init() |
|
292 | - { |
|
293 | - // Get current page protocol |
|
294 | - $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; |
|
295 | - // Output admin-ajax.php URL with same protocol as current page |
|
296 | - self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol); |
|
297 | - self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false; |
|
298 | - } |
|
299 | - |
|
300 | - |
|
301 | - /** |
|
302 | - * localize_i18n_js_strings |
|
303 | - * |
|
304 | - * @return string |
|
305 | - */ |
|
306 | - public static function localize_i18n_js_strings() |
|
307 | - { |
|
308 | - $i18n_js_strings = (array) self::$i18n_js_strings; |
|
309 | - foreach ($i18n_js_strings as $key => $value) { |
|
310 | - if (is_scalar($value)) { |
|
311 | - $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8'); |
|
312 | - } |
|
313 | - } |
|
314 | - return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
315 | - } |
|
316 | - |
|
317 | - |
|
318 | - /** |
|
319 | - * @param mixed string | EED_Module $module |
|
320 | - * @throws OutOfBoundsException |
|
321 | - * @throws InvalidArgumentException |
|
322 | - * @throws InvalidInterfaceException |
|
323 | - * @throws InvalidDataTypeException |
|
324 | - * @throws EE_Error |
|
325 | - * @throws ReflectionException |
|
326 | - */ |
|
327 | - public function add_module($module) |
|
328 | - { |
|
329 | - if ($module instanceof EED_Module) { |
|
330 | - $module_class = get_class($module); |
|
331 | - $this->modules->{$module_class} = $module; |
|
332 | - } else { |
|
333 | - if (! class_exists('EE_Module_Request_Router', false)) { |
|
334 | - $this->load_core('Module_Request_Router'); |
|
335 | - } |
|
336 | - EE_Module_Request_Router::module_factory($module); |
|
337 | - } |
|
338 | - } |
|
339 | - |
|
340 | - |
|
341 | - /** |
|
342 | - * @param string $module_name |
|
343 | - * @return mixed EED_Module | NULL |
|
344 | - */ |
|
345 | - public function get_module($module_name = '') |
|
346 | - { |
|
347 | - return isset($this->modules->{$module_name}) |
|
348 | - ? $this->modules->{$module_name} |
|
349 | - : null; |
|
350 | - } |
|
351 | - |
|
352 | - |
|
353 | - /** |
|
354 | - * loads core classes - must be singletons |
|
355 | - * |
|
356 | - * @param string $class_name - simple class name ie: session |
|
357 | - * @param mixed $arguments |
|
358 | - * @param bool $load_only |
|
359 | - * @return mixed |
|
360 | - * @throws InvalidInterfaceException |
|
361 | - * @throws InvalidDataTypeException |
|
362 | - * @throws EE_Error |
|
363 | - * @throws ReflectionException |
|
364 | - * @throws InvalidArgumentException |
|
365 | - */ |
|
366 | - public function load_core($class_name, $arguments = array(), $load_only = false) |
|
367 | - { |
|
368 | - $core_paths = apply_filters( |
|
369 | - 'FHEE__EE_Registry__load_core__core_paths', |
|
370 | - array( |
|
371 | - EE_CORE, |
|
372 | - EE_ADMIN, |
|
373 | - EE_CPTS, |
|
374 | - EE_CORE . 'data_migration_scripts' . DS, |
|
375 | - EE_CORE . 'capabilities' . DS, |
|
376 | - EE_CORE . 'request_stack' . DS, |
|
377 | - EE_CORE . 'middleware' . DS, |
|
378 | - ) |
|
379 | - ); |
|
380 | - // retrieve instantiated class |
|
381 | - return $this->_load( |
|
382 | - $core_paths, |
|
383 | - 'EE_', |
|
384 | - $class_name, |
|
385 | - 'core', |
|
386 | - $arguments, |
|
387 | - false, |
|
388 | - true, |
|
389 | - $load_only |
|
390 | - ); |
|
391 | - } |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * loads service classes |
|
396 | - * |
|
397 | - * @param string $class_name - simple class name ie: session |
|
398 | - * @param mixed $arguments |
|
399 | - * @param bool $load_only |
|
400 | - * @return mixed |
|
401 | - * @throws InvalidInterfaceException |
|
402 | - * @throws InvalidDataTypeException |
|
403 | - * @throws EE_Error |
|
404 | - * @throws ReflectionException |
|
405 | - * @throws InvalidArgumentException |
|
406 | - */ |
|
407 | - public function load_service($class_name, $arguments = array(), $load_only = false) |
|
408 | - { |
|
409 | - $service_paths = apply_filters( |
|
410 | - 'FHEE__EE_Registry__load_service__service_paths', |
|
411 | - array( |
|
412 | - EE_CORE . 'services' . DS, |
|
413 | - ) |
|
414 | - ); |
|
415 | - // retrieve instantiated class |
|
416 | - return $this->_load( |
|
417 | - $service_paths, |
|
418 | - 'EE_', |
|
419 | - $class_name, |
|
420 | - 'class', |
|
421 | - $arguments, |
|
422 | - false, |
|
423 | - true, |
|
424 | - $load_only |
|
425 | - ); |
|
426 | - } |
|
427 | - |
|
428 | - |
|
429 | - /** |
|
430 | - * loads data_migration_scripts |
|
431 | - * |
|
432 | - * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0 |
|
433 | - * @param mixed $arguments |
|
434 | - * @return EE_Data_Migration_Script_Base|mixed |
|
435 | - * @throws InvalidInterfaceException |
|
436 | - * @throws InvalidDataTypeException |
|
437 | - * @throws EE_Error |
|
438 | - * @throws ReflectionException |
|
439 | - * @throws InvalidArgumentException |
|
440 | - */ |
|
441 | - public function load_dms($class_name, $arguments = array()) |
|
442 | - { |
|
443 | - // retrieve instantiated class |
|
444 | - return $this->_load( |
|
445 | - EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), |
|
446 | - 'EE_DMS_', |
|
447 | - $class_name, |
|
448 | - 'dms', |
|
449 | - $arguments, |
|
450 | - false, |
|
451 | - false |
|
452 | - ); |
|
453 | - } |
|
454 | - |
|
455 | - |
|
456 | - /** |
|
457 | - * loads object creating classes - must be singletons |
|
458 | - * |
|
459 | - * @param string $class_name - simple class name ie: attendee |
|
460 | - * @param mixed $arguments - an array of arguments to pass to the class |
|
461 | - * @param bool $from_db - some classes are instantiated from the db and thus call a different method to |
|
462 | - * instantiate |
|
463 | - * @param bool $cache if you don't want the class to be stored in the internal cache (non-persistent) then |
|
464 | - * set this to FALSE (ie. when instantiating model objects from client in a loop) |
|
465 | - * @param bool $load_only whether or not to just load the file and NOT instantiate, or load AND instantiate |
|
466 | - * (default) |
|
467 | - * @return EE_Base_Class | bool |
|
468 | - * @throws InvalidInterfaceException |
|
469 | - * @throws InvalidDataTypeException |
|
470 | - * @throws EE_Error |
|
471 | - * @throws ReflectionException |
|
472 | - * @throws InvalidArgumentException |
|
473 | - */ |
|
474 | - public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false) |
|
475 | - { |
|
476 | - $paths = apply_filters( |
|
477 | - 'FHEE__EE_Registry__load_class__paths', |
|
478 | - array( |
|
479 | - EE_CORE, |
|
480 | - EE_CLASSES, |
|
481 | - EE_BUSINESS, |
|
482 | - ) |
|
483 | - ); |
|
484 | - // retrieve instantiated class |
|
485 | - return $this->_load( |
|
486 | - $paths, |
|
487 | - 'EE_', |
|
488 | - $class_name, |
|
489 | - 'class', |
|
490 | - $arguments, |
|
491 | - $from_db, |
|
492 | - $cache, |
|
493 | - $load_only |
|
494 | - ); |
|
495 | - } |
|
496 | - |
|
497 | - |
|
498 | - /** |
|
499 | - * loads helper classes - must be singletons |
|
500 | - * |
|
501 | - * @param string $class_name - simple class name ie: price |
|
502 | - * @param mixed $arguments |
|
503 | - * @param bool $load_only |
|
504 | - * @return EEH_Base | bool |
|
505 | - * @throws InvalidInterfaceException |
|
506 | - * @throws InvalidDataTypeException |
|
507 | - * @throws EE_Error |
|
508 | - * @throws ReflectionException |
|
509 | - * @throws InvalidArgumentException |
|
510 | - */ |
|
511 | - public function load_helper($class_name, $arguments = array(), $load_only = true) |
|
512 | - { |
|
513 | - // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed |
|
514 | - $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS)); |
|
515 | - // retrieve instantiated class |
|
516 | - return $this->_load( |
|
517 | - $helper_paths, |
|
518 | - 'EEH_', |
|
519 | - $class_name, |
|
520 | - 'helper', |
|
521 | - $arguments, |
|
522 | - false, |
|
523 | - true, |
|
524 | - $load_only |
|
525 | - ); |
|
526 | - } |
|
527 | - |
|
528 | - |
|
529 | - /** |
|
530 | - * loads core classes - must be singletons |
|
531 | - * |
|
532 | - * @param string $class_name - simple class name ie: session |
|
533 | - * @param mixed $arguments |
|
534 | - * @param bool $load_only |
|
535 | - * @param bool $cache whether to cache the object or not. |
|
536 | - * @return mixed |
|
537 | - * @throws InvalidInterfaceException |
|
538 | - * @throws InvalidDataTypeException |
|
539 | - * @throws EE_Error |
|
540 | - * @throws ReflectionException |
|
541 | - * @throws InvalidArgumentException |
|
542 | - */ |
|
543 | - public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true) |
|
544 | - { |
|
545 | - $paths = array( |
|
546 | - EE_LIBRARIES, |
|
547 | - EE_LIBRARIES . 'messages' . DS, |
|
548 | - EE_LIBRARIES . 'shortcodes' . DS, |
|
549 | - EE_LIBRARIES . 'qtips' . DS, |
|
550 | - EE_LIBRARIES . 'payment_methods' . DS, |
|
551 | - ); |
|
552 | - // retrieve instantiated class |
|
553 | - return $this->_load( |
|
554 | - $paths, |
|
555 | - 'EE_', |
|
556 | - $class_name, |
|
557 | - 'lib', |
|
558 | - $arguments, |
|
559 | - false, |
|
560 | - $cache, |
|
561 | - $load_only |
|
562 | - ); |
|
563 | - } |
|
564 | - |
|
565 | - |
|
566 | - /** |
|
567 | - * loads model classes - must be singletons |
|
568 | - * |
|
569 | - * @param string $class_name - simple class name ie: price |
|
570 | - * @param mixed $arguments |
|
571 | - * @param bool $load_only |
|
572 | - * @return EEM_Base | bool |
|
573 | - * @throws InvalidInterfaceException |
|
574 | - * @throws InvalidDataTypeException |
|
575 | - * @throws EE_Error |
|
576 | - * @throws ReflectionException |
|
577 | - * @throws InvalidArgumentException |
|
578 | - */ |
|
579 | - public function load_model($class_name, $arguments = array(), $load_only = false) |
|
580 | - { |
|
581 | - $paths = apply_filters( |
|
582 | - 'FHEE__EE_Registry__load_model__paths', |
|
583 | - array( |
|
584 | - EE_MODELS, |
|
585 | - EE_CORE, |
|
586 | - ) |
|
587 | - ); |
|
588 | - // retrieve instantiated class |
|
589 | - return $this->_load( |
|
590 | - $paths, |
|
591 | - 'EEM_', |
|
592 | - $class_name, |
|
593 | - 'model', |
|
594 | - $arguments, |
|
595 | - false, |
|
596 | - true, |
|
597 | - $load_only |
|
598 | - ); |
|
599 | - } |
|
600 | - |
|
601 | - |
|
602 | - /** |
|
603 | - * loads model classes - must be singletons |
|
604 | - * |
|
605 | - * @param string $class_name - simple class name ie: price |
|
606 | - * @param mixed $arguments |
|
607 | - * @param bool $load_only |
|
608 | - * @return mixed | bool |
|
609 | - * @throws InvalidInterfaceException |
|
610 | - * @throws InvalidDataTypeException |
|
611 | - * @throws EE_Error |
|
612 | - * @throws ReflectionException |
|
613 | - * @throws InvalidArgumentException |
|
614 | - */ |
|
615 | - public function load_model_class($class_name, $arguments = array(), $load_only = true) |
|
616 | - { |
|
617 | - $paths = array( |
|
618 | - EE_MODELS . 'fields' . DS, |
|
619 | - EE_MODELS . 'helpers' . DS, |
|
620 | - EE_MODELS . 'relations' . DS, |
|
621 | - EE_MODELS . 'strategies' . DS, |
|
622 | - ); |
|
623 | - // retrieve instantiated class |
|
624 | - return $this->_load( |
|
625 | - $paths, |
|
626 | - 'EE_', |
|
627 | - $class_name, |
|
628 | - '', |
|
629 | - $arguments, |
|
630 | - false, |
|
631 | - true, |
|
632 | - $load_only |
|
633 | - ); |
|
634 | - } |
|
635 | - |
|
636 | - |
|
637 | - /** |
|
638 | - * Determines if $model_name is the name of an actual EE model. |
|
639 | - * |
|
640 | - * @param string $model_name like Event, Attendee, Question_Group_Question, etc. |
|
641 | - * @return boolean |
|
642 | - */ |
|
643 | - public function is_model_name($model_name) |
|
644 | - { |
|
645 | - return isset($this->models[ $model_name ]); |
|
646 | - } |
|
647 | - |
|
648 | - |
|
649 | - /** |
|
650 | - * generic class loader |
|
651 | - * |
|
652 | - * @param string $path_to_file - directory path to file location, not including filename |
|
653 | - * @param string $file_name - file name ie: my_file.php, including extension |
|
654 | - * @param string $type - file type - core? class? helper? model? |
|
655 | - * @param mixed $arguments |
|
656 | - * @param bool $load_only |
|
657 | - * @return mixed |
|
658 | - * @throws InvalidInterfaceException |
|
659 | - * @throws InvalidDataTypeException |
|
660 | - * @throws EE_Error |
|
661 | - * @throws ReflectionException |
|
662 | - * @throws InvalidArgumentException |
|
663 | - */ |
|
664 | - public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true) |
|
665 | - { |
|
666 | - // retrieve instantiated class |
|
667 | - return $this->_load( |
|
668 | - $path_to_file, |
|
669 | - '', |
|
670 | - $file_name, |
|
671 | - $type, |
|
672 | - $arguments, |
|
673 | - false, |
|
674 | - true, |
|
675 | - $load_only |
|
676 | - ); |
|
677 | - } |
|
678 | - |
|
679 | - |
|
680 | - /** |
|
681 | - * @param string $path_to_file - directory path to file location, not including filename |
|
682 | - * @param string $class_name - full class name ie: My_Class |
|
683 | - * @param string $type - file type - core? class? helper? model? |
|
684 | - * @param mixed $arguments |
|
685 | - * @param bool $load_only |
|
686 | - * @return bool|EE_Addon|object |
|
687 | - * @throws InvalidInterfaceException |
|
688 | - * @throws InvalidDataTypeException |
|
689 | - * @throws EE_Error |
|
690 | - * @throws ReflectionException |
|
691 | - * @throws InvalidArgumentException |
|
692 | - */ |
|
693 | - public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false) |
|
694 | - { |
|
695 | - // retrieve instantiated class |
|
696 | - return $this->_load( |
|
697 | - $path_to_file, |
|
698 | - 'addon', |
|
699 | - $class_name, |
|
700 | - $type, |
|
701 | - $arguments, |
|
702 | - false, |
|
703 | - true, |
|
704 | - $load_only |
|
705 | - ); |
|
706 | - } |
|
707 | - |
|
708 | - |
|
709 | - /** |
|
710 | - * instantiates, caches, and automatically resolves dependencies |
|
711 | - * for classes that use a Fully Qualified Class Name. |
|
712 | - * if the class is not capable of being loaded using PSR-4 autoloading, |
|
713 | - * then you need to use one of the existing load_*() methods |
|
714 | - * which can resolve the classname and filepath from the passed arguments |
|
715 | - * |
|
716 | - * @param bool|string $class_name Fully Qualified Class Name |
|
717 | - * @param array $arguments an argument, or array of arguments to pass to the class upon instantiation |
|
718 | - * @param bool $cache whether to cache the instantiated object for reuse |
|
719 | - * @param bool $from_db some classes are instantiated from the db |
|
720 | - * and thus call a different method to instantiate |
|
721 | - * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
722 | - * @param bool|string $addon if true, will cache the object in the EE_Registry->$addons array |
|
723 | - * @return bool|null|mixed null = failure to load or instantiate class object. |
|
724 | - * object = class loaded and instantiated successfully. |
|
725 | - * bool = fail or success when $load_only is true |
|
726 | - * @throws InvalidInterfaceException |
|
727 | - * @throws InvalidDataTypeException |
|
728 | - * @throws EE_Error |
|
729 | - * @throws ReflectionException |
|
730 | - * @throws InvalidArgumentException |
|
731 | - */ |
|
732 | - public function create( |
|
733 | - $class_name = false, |
|
734 | - $arguments = array(), |
|
735 | - $cache = false, |
|
736 | - $from_db = false, |
|
737 | - $load_only = false, |
|
738 | - $addon = false |
|
739 | - ) { |
|
740 | - $class_name = ltrim($class_name, '\\'); |
|
741 | - $class_name = $this->class_cache->getFqnForAlias($class_name); |
|
742 | - $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments); |
|
743 | - // if a non-FQCN was passed, then |
|
744 | - // verifyClassExists() might return an object |
|
745 | - // or it could return null if the class just could not be found anywhere |
|
746 | - if ($class_exists instanceof $class_name || $class_exists === null) { |
|
747 | - // either way, return the results |
|
748 | - return $class_exists; |
|
749 | - } |
|
750 | - $class_name = $class_exists; |
|
751 | - // if we're only loading the class and it already exists, then let's just return true immediately |
|
752 | - if ($load_only) { |
|
753 | - return true; |
|
754 | - } |
|
755 | - $addon = $addon ? 'addon' : ''; |
|
756 | - // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
757 | - // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
758 | - // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
759 | - if ($this->_cache_on && $cache && ! $load_only) { |
|
760 | - // return object if it's already cached |
|
761 | - $cached_class = $this->_get_cached_class($class_name, $addon, $arguments); |
|
762 | - if ($cached_class !== null) { |
|
763 | - return $cached_class; |
|
764 | - } |
|
765 | - }// obtain the loader method from the dependency map |
|
766 | - $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object |
|
767 | - if ($loader instanceof Closure) { |
|
768 | - $class_obj = $loader($arguments); |
|
769 | - } else { |
|
770 | - if ($loader && method_exists($this, $loader)) { |
|
771 | - $class_obj = $this->{$loader}($class_name, $arguments); |
|
772 | - } else { |
|
773 | - $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db); |
|
774 | - } |
|
775 | - } |
|
776 | - if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) { |
|
777 | - // save it for later... kinda like gum { : $ |
|
778 | - $this->_set_cached_class( |
|
779 | - $class_obj, |
|
780 | - $class_name, |
|
781 | - $addon, |
|
782 | - $from_db, |
|
783 | - $arguments |
|
784 | - ); |
|
785 | - } |
|
786 | - $this->_cache_on = true; |
|
787 | - return $class_obj; |
|
788 | - } |
|
789 | - |
|
790 | - |
|
791 | - /** |
|
792 | - * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs |
|
793 | - * |
|
794 | - * @param string|object $class_name |
|
795 | - * @param array $arguments |
|
796 | - * @param int $attempt |
|
797 | - * @return mixed |
|
798 | - */ |
|
799 | - private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1) |
|
800 | - { |
|
801 | - if (is_object($class_name) || class_exists($class_name)) { |
|
802 | - return $class_name; |
|
803 | - } |
|
804 | - switch ($attempt) { |
|
805 | - case 1: |
|
806 | - // if it's a FQCN then maybe the class is registered with a preceding \ |
|
807 | - $class_name = strpos($class_name, '\\') !== false |
|
808 | - ? '\\' . ltrim($class_name, '\\') |
|
809 | - : $class_name; |
|
810 | - break; |
|
811 | - case 2: |
|
812 | - // |
|
813 | - $loader = $this->_dependency_map->class_loader($class_name); |
|
814 | - if ($loader && method_exists($this, $loader)) { |
|
815 | - return $this->{$loader}($class_name, $arguments); |
|
816 | - } |
|
817 | - break; |
|
818 | - case 3: |
|
819 | - default: |
|
820 | - return null; |
|
821 | - } |
|
822 | - $attempt++; |
|
823 | - return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt); |
|
824 | - } |
|
825 | - |
|
826 | - |
|
827 | - /** |
|
828 | - * instantiates, caches, and injects dependencies for classes |
|
829 | - * |
|
830 | - * @param array $file_paths an array of paths to folders to look in |
|
831 | - * @param string $class_prefix EE or EEM or... ??? |
|
832 | - * @param bool|string $class_name $class name |
|
833 | - * @param string $type file type - core? class? helper? model? |
|
834 | - * @param mixed $arguments an argument or array of arguments to pass to the class upon instantiation |
|
835 | - * @param bool $from_db some classes are instantiated from the db |
|
836 | - * and thus call a different method to instantiate |
|
837 | - * @param bool $cache whether to cache the instantiated object for reuse |
|
838 | - * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
839 | - * @return bool|null|object null = failure to load or instantiate class object. |
|
840 | - * object = class loaded and instantiated successfully. |
|
841 | - * bool = fail or success when $load_only is true |
|
842 | - * @throws EE_Error |
|
843 | - * @throws ReflectionException |
|
844 | - * @throws InvalidInterfaceException |
|
845 | - * @throws InvalidDataTypeException |
|
846 | - * @throws InvalidArgumentException |
|
847 | - */ |
|
848 | - protected function _load( |
|
849 | - $file_paths = array(), |
|
850 | - $class_prefix = 'EE_', |
|
851 | - $class_name = false, |
|
852 | - $type = 'class', |
|
853 | - $arguments = array(), |
|
854 | - $from_db = false, |
|
855 | - $cache = true, |
|
856 | - $load_only = false |
|
857 | - ) { |
|
858 | - $class_name = ltrim($class_name, '\\'); |
|
859 | - // strip php file extension |
|
860 | - $class_name = str_replace('.php', '', trim($class_name)); |
|
861 | - // does the class have a prefix ? |
|
862 | - if (! empty($class_prefix) && $class_prefix !== 'addon') { |
|
863 | - // make sure $class_prefix is uppercase |
|
864 | - $class_prefix = strtoupper(trim($class_prefix)); |
|
865 | - // add class prefix ONCE!!! |
|
866 | - $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
867 | - } |
|
868 | - $class_name = $this->class_cache->getFqnForAlias($class_name); |
|
869 | - $class_exists = class_exists($class_name, false); |
|
870 | - // if we're only loading the class and it already exists, then let's just return true immediately |
|
871 | - if ($load_only && $class_exists) { |
|
872 | - return true; |
|
873 | - } |
|
874 | - $arguments = is_array($arguments) ? $arguments : array($arguments); |
|
875 | - // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
876 | - // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
877 | - // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
878 | - if ($this->_cache_on && $cache && ! $load_only) { |
|
879 | - // return object if it's already cached |
|
880 | - $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments); |
|
881 | - if ($cached_class !== null) { |
|
882 | - return $cached_class; |
|
883 | - } |
|
884 | - } |
|
885 | - // if the class doesn't already exist.. then we need to try and find the file and load it |
|
886 | - if (! $class_exists) { |
|
887 | - // get full path to file |
|
888 | - $path = $this->_resolve_path($class_name, $type, $file_paths); |
|
889 | - // load the file |
|
890 | - $loaded = $this->_require_file($path, $class_name, $type, $file_paths); |
|
891 | - // if we are only loading a file but NOT instantiating an object |
|
892 | - // then return boolean for whether class was loaded or not |
|
893 | - if ($load_only) { |
|
894 | - return $loaded; |
|
895 | - } |
|
896 | - // if an object was expected but loading failed, then return nothing |
|
897 | - if (! $loaded) { |
|
898 | - return null; |
|
899 | - } |
|
900 | - } |
|
901 | - // instantiate the requested object |
|
902 | - $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db); |
|
903 | - if ($this->_cache_on && $cache) { |
|
904 | - // save it for later... kinda like gum { : $ |
|
905 | - $this->_set_cached_class( |
|
906 | - $class_obj, |
|
907 | - $class_name, |
|
908 | - $class_prefix, |
|
909 | - $from_db, |
|
910 | - $arguments |
|
911 | - ); |
|
912 | - } |
|
913 | - $this->_cache_on = true; |
|
914 | - return $class_obj; |
|
915 | - } |
|
916 | - |
|
917 | - |
|
918 | - /** |
|
919 | - * @param string $class_name |
|
920 | - * @param string $default have to specify something, but not anything that will conflict |
|
921 | - * @return mixed|string |
|
922 | - */ |
|
923 | - protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS') |
|
924 | - { |
|
925 | - return isset($this->_class_abbreviations[ $class_name ]) |
|
926 | - ? $this->_class_abbreviations[ $class_name ] |
|
927 | - : $default; |
|
928 | - } |
|
929 | - |
|
930 | - |
|
931 | - /** |
|
932 | - * attempts to find a cached version of the requested class |
|
933 | - * by looking in the following places: |
|
934 | - * $this->{$class_abbreviation} ie: $this->CART |
|
935 | - * $this->{$class_name} ie: $this->Some_Class |
|
936 | - * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
937 | - * $this->addon->{$class_name} ie: $this->addon->Some_Addon_Class |
|
938 | - * |
|
939 | - * @param string $class_name |
|
940 | - * @param string $class_prefix |
|
941 | - * @param array $arguments |
|
942 | - * @return mixed |
|
943 | - */ |
|
944 | - protected function _get_cached_class( |
|
945 | - $class_name, |
|
946 | - $class_prefix = '', |
|
947 | - $arguments = array() |
|
948 | - ) { |
|
949 | - if ($class_name === 'EE_Registry') { |
|
950 | - return $this; |
|
951 | - } |
|
952 | - $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
953 | - // check if class has already been loaded, and return it if it has been |
|
954 | - if (isset($this->{$class_abbreviation})) { |
|
955 | - return $this->{$class_abbreviation}; |
|
956 | - } |
|
957 | - $class_name = str_replace('\\', '_', $class_name); |
|
958 | - if (isset($this->{$class_name})) { |
|
959 | - return $this->{$class_name}; |
|
960 | - } |
|
961 | - if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) { |
|
962 | - return $this->addons->{$class_name}; |
|
963 | - } |
|
964 | - $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments); |
|
965 | - if (isset($this->LIB->{$object_identifier})) { |
|
966 | - return $this->LIB->{$object_identifier}; |
|
967 | - } |
|
968 | - foreach ($this->LIB as $key => $object) { |
|
969 | - if (// request does not contain new arguments and therefore no args identifier |
|
970 | - ! $this->object_identifier->hasArguments($object_identifier) |
|
971 | - // but previously cached class with args was found |
|
972 | - && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key) |
|
973 | - ) { |
|
974 | - return $object; |
|
975 | - } |
|
976 | - } |
|
977 | - return null; |
|
978 | - } |
|
979 | - |
|
980 | - |
|
981 | - /** |
|
982 | - * removes a cached version of the requested class |
|
983 | - * |
|
984 | - * @param string $class_name |
|
985 | - * @param boolean $addon |
|
986 | - * @param array $arguments |
|
987 | - * @return boolean |
|
988 | - */ |
|
989 | - public function clear_cached_class( |
|
990 | - $class_name, |
|
991 | - $addon = false, |
|
992 | - $arguments = array() |
|
993 | - ) { |
|
994 | - $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
995 | - // check if class has already been loaded, and return it if it has been |
|
996 | - if (isset($this->{$class_abbreviation})) { |
|
997 | - $this->{$class_abbreviation} = null; |
|
998 | - return true; |
|
999 | - } |
|
1000 | - $class_name = str_replace('\\', '_', $class_name); |
|
1001 | - if (isset($this->{$class_name})) { |
|
1002 | - $this->{$class_name} = null; |
|
1003 | - return true; |
|
1004 | - } |
|
1005 | - if ($addon && isset($this->addons->{$class_name})) { |
|
1006 | - unset($this->addons->{$class_name}); |
|
1007 | - return true; |
|
1008 | - } |
|
1009 | - $class_name = $this->object_identifier->getIdentifier($class_name, $arguments); |
|
1010 | - if (isset($this->LIB->{$class_name})) { |
|
1011 | - unset($this->LIB->{$class_name}); |
|
1012 | - return true; |
|
1013 | - } |
|
1014 | - return false; |
|
1015 | - } |
|
1016 | - |
|
1017 | - |
|
1018 | - /** |
|
1019 | - * _set_cached_class |
|
1020 | - * attempts to cache the instantiated class locally |
|
1021 | - * in one of the following places, in the following order: |
|
1022 | - * $this->{class_abbreviation} ie: $this->CART |
|
1023 | - * $this->{$class_name} ie: $this->Some_Class |
|
1024 | - * $this->addon->{$$class_name} ie: $this->addon->Some_Addon_Class |
|
1025 | - * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
1026 | - * |
|
1027 | - * @param object $class_obj |
|
1028 | - * @param string $class_name |
|
1029 | - * @param string $class_prefix |
|
1030 | - * @param bool $from_db |
|
1031 | - * @param array $arguments |
|
1032 | - * @return void |
|
1033 | - */ |
|
1034 | - protected function _set_cached_class( |
|
1035 | - $class_obj, |
|
1036 | - $class_name, |
|
1037 | - $class_prefix = '', |
|
1038 | - $from_db = false, |
|
1039 | - $arguments = array() |
|
1040 | - ) { |
|
1041 | - if ($class_name === 'EE_Registry' || empty($class_obj)) { |
|
1042 | - return; |
|
1043 | - } |
|
1044 | - // return newly instantiated class |
|
1045 | - $class_abbreviation = $this->get_class_abbreviation($class_name, ''); |
|
1046 | - if ($class_abbreviation) { |
|
1047 | - $this->{$class_abbreviation} = $class_obj; |
|
1048 | - return; |
|
1049 | - } |
|
1050 | - $class_name = str_replace('\\', '_', $class_name); |
|
1051 | - if (property_exists($this, $class_name)) { |
|
1052 | - $this->{$class_name} = $class_obj; |
|
1053 | - return; |
|
1054 | - } |
|
1055 | - if ($class_prefix === 'addon') { |
|
1056 | - $this->addons->{$class_name} = $class_obj; |
|
1057 | - return; |
|
1058 | - } |
|
1059 | - if (! $from_db) { |
|
1060 | - $class_name = $this->object_identifier->getIdentifier($class_name, $arguments); |
|
1061 | - $this->LIB->{$class_name} = $class_obj; |
|
1062 | - } |
|
1063 | - } |
|
1064 | - |
|
1065 | - |
|
1066 | - /** |
|
1067 | - * attempts to find a full valid filepath for the requested class. |
|
1068 | - * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php" |
|
1069 | - * then returns that path if the target file has been found and is readable |
|
1070 | - * |
|
1071 | - * @param string $class_name |
|
1072 | - * @param string $type |
|
1073 | - * @param array $file_paths |
|
1074 | - * @return string | bool |
|
1075 | - */ |
|
1076 | - protected function _resolve_path($class_name, $type = '', $file_paths = array()) |
|
1077 | - { |
|
1078 | - // make sure $file_paths is an array |
|
1079 | - $file_paths = is_array($file_paths) |
|
1080 | - ? $file_paths |
|
1081 | - : array($file_paths); |
|
1082 | - // cycle thru paths |
|
1083 | - foreach ($file_paths as $key => $file_path) { |
|
1084 | - // convert all separators to proper DS, if no filepath, then use EE_CLASSES |
|
1085 | - $file_path = $file_path |
|
1086 | - ? str_replace(array('/', '\\'), DS, $file_path) |
|
1087 | - : EE_CLASSES; |
|
1088 | - // prep file type |
|
1089 | - $type = ! empty($type) |
|
1090 | - ? trim($type, '.') . '.' |
|
1091 | - : ''; |
|
1092 | - // build full file path |
|
1093 | - $file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
1094 | - // does the file exist and can be read ? |
|
1095 | - if (is_readable($file_paths[ $key ])) { |
|
1096 | - return $file_paths[ $key ]; |
|
1097 | - } |
|
1098 | - } |
|
1099 | - return false; |
|
1100 | - } |
|
1101 | - |
|
1102 | - |
|
1103 | - /** |
|
1104 | - * basically just performs a require_once() |
|
1105 | - * but with some error handling |
|
1106 | - * |
|
1107 | - * @param string $path |
|
1108 | - * @param string $class_name |
|
1109 | - * @param string $type |
|
1110 | - * @param array $file_paths |
|
1111 | - * @return bool |
|
1112 | - * @throws EE_Error |
|
1113 | - * @throws ReflectionException |
|
1114 | - */ |
|
1115 | - protected function _require_file($path, $class_name, $type = '', $file_paths = array()) |
|
1116 | - { |
|
1117 | - $this->resolve_legacy_class_parent($class_name); |
|
1118 | - // don't give up! you gotta... |
|
1119 | - try { |
|
1120 | - // does the file exist and can it be read ? |
|
1121 | - if (! $path) { |
|
1122 | - // just in case the file has already been autoloaded, |
|
1123 | - // but discrepancies in the naming schema are preventing it from |
|
1124 | - // being loaded via one of the EE_Registry::load_*() methods, |
|
1125 | - // then let's try one last hail mary before throwing an exception |
|
1126 | - // and call class_exists() again, but with autoloading turned ON |
|
1127 | - if (class_exists($class_name)) { |
|
1128 | - return true; |
|
1129 | - } |
|
1130 | - // so sorry, can't find the file |
|
1131 | - throw new EE_Error( |
|
1132 | - sprintf( |
|
1133 | - esc_html__( |
|
1134 | - 'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', |
|
1135 | - 'event_espresso' |
|
1136 | - ), |
|
1137 | - trim($type, '.'), |
|
1138 | - $class_name, |
|
1139 | - '<br />' . implode(',<br />', $file_paths) |
|
1140 | - ) |
|
1141 | - ); |
|
1142 | - } |
|
1143 | - // get the file |
|
1144 | - require_once($path); |
|
1145 | - // if the class isn't already declared somewhere |
|
1146 | - if (class_exists($class_name, false) === false) { |
|
1147 | - // so sorry, not a class |
|
1148 | - throw new EE_Error( |
|
1149 | - sprintf( |
|
1150 | - esc_html__( |
|
1151 | - 'The %s file %s does not appear to contain the %s Class.', |
|
1152 | - 'event_espresso' |
|
1153 | - ), |
|
1154 | - $type, |
|
1155 | - $path, |
|
1156 | - $class_name |
|
1157 | - ) |
|
1158 | - ); |
|
1159 | - } |
|
1160 | - } catch (EE_Error $e) { |
|
1161 | - $e->get_error(); |
|
1162 | - return false; |
|
1163 | - } |
|
1164 | - return true; |
|
1165 | - } |
|
1166 | - |
|
1167 | - |
|
1168 | - /** |
|
1169 | - * Some of our legacy classes that extended a parent class would simply use a require() statement |
|
1170 | - * before their class declaration in order to ensure that the parent class was loaded. |
|
1171 | - * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class, |
|
1172 | - * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist. |
|
1173 | - * |
|
1174 | - * @param string $class_name |
|
1175 | - */ |
|
1176 | - protected function resolve_legacy_class_parent($class_name = '') |
|
1177 | - { |
|
1178 | - try { |
|
1179 | - $legacy_parent_class_map = array( |
|
1180 | - 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php', |
|
1181 | - ); |
|
1182 | - if (isset($legacy_parent_class_map[ $class_name ])) { |
|
1183 | - require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ]; |
|
1184 | - } |
|
1185 | - } catch (Exception $exception) { |
|
1186 | - } |
|
1187 | - } |
|
1188 | - |
|
1189 | - |
|
1190 | - /** |
|
1191 | - * _create_object |
|
1192 | - * Attempts to instantiate the requested class via any of the |
|
1193 | - * commonly used instantiation methods employed throughout EE. |
|
1194 | - * The priority for instantiation is as follows: |
|
1195 | - * - abstract classes or any class flagged as "load only" (no instantiation occurs) |
|
1196 | - * - model objects via their 'new_instance_from_db' method |
|
1197 | - * - model objects via their 'new_instance' method |
|
1198 | - * - "singleton" classes" via their 'instance' method |
|
1199 | - * - standard instantiable classes via their __constructor |
|
1200 | - * Prior to instantiation, if the classname exists in the dependency_map, |
|
1201 | - * then the constructor for the requested class will be examined to determine |
|
1202 | - * if any dependencies exist, and if they can be injected. |
|
1203 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
1204 | - * |
|
1205 | - * @param string $class_name |
|
1206 | - * @param array $arguments |
|
1207 | - * @param string $type |
|
1208 | - * @param bool $from_db |
|
1209 | - * @return null|object|bool |
|
1210 | - * @throws InvalidArgumentException |
|
1211 | - * @throws InvalidInterfaceException |
|
1212 | - * @throws EE_Error |
|
1213 | - * @throws ReflectionException |
|
1214 | - * @throws InvalidDataTypeException |
|
1215 | - */ |
|
1216 | - protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false) |
|
1217 | - { |
|
1218 | - // create reflection |
|
1219 | - $reflector = $this->mirror->getReflectionClass($class_name); |
|
1220 | - // make sure arguments are an array |
|
1221 | - $arguments = is_array($arguments) |
|
1222 | - ? $arguments |
|
1223 | - : array($arguments); |
|
1224 | - // and if arguments array is numerically and sequentially indexed, then we want it to remain as is, |
|
1225 | - // else wrap it in an additional array so that it doesn't get split into multiple parameters |
|
1226 | - $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments) |
|
1227 | - ? $arguments |
|
1228 | - : array($arguments); |
|
1229 | - // attempt to inject dependencies ? |
|
1230 | - if ($this->_dependency_map->has($class_name)) { |
|
1231 | - $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments); |
|
1232 | - } |
|
1233 | - // instantiate the class if possible |
|
1234 | - if ($reflector->isAbstract()) { |
|
1235 | - // nothing to instantiate, loading file was enough |
|
1236 | - // does not throw an exception so $instantiation_mode is unused |
|
1237 | - // $instantiation_mode = "1) no constructor abstract class"; |
|
1238 | - return true; |
|
1239 | - } |
|
1240 | - if (empty($arguments) |
|
1241 | - && $this->mirror->getConstructorFromReflection($reflector) === null |
|
1242 | - && $reflector->isInstantiable() |
|
1243 | - ) { |
|
1244 | - // no constructor = static methods only... nothing to instantiate, loading file was enough |
|
1245 | - // $instantiation_mode = "2) no constructor but instantiable"; |
|
1246 | - return $reflector->newInstance(); |
|
1247 | - } |
|
1248 | - if ($from_db && method_exists($class_name, 'new_instance_from_db')) { |
|
1249 | - // $instantiation_mode = "3) new_instance_from_db()"; |
|
1250 | - return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments); |
|
1251 | - } |
|
1252 | - if (method_exists($class_name, 'new_instance')) { |
|
1253 | - // $instantiation_mode = "4) new_instance()"; |
|
1254 | - return call_user_func_array(array($class_name, 'new_instance'), $arguments); |
|
1255 | - } |
|
1256 | - if (method_exists($class_name, 'instance')) { |
|
1257 | - // $instantiation_mode = "5) instance()"; |
|
1258 | - return call_user_func_array(array($class_name, 'instance'), $arguments); |
|
1259 | - } |
|
1260 | - if ($reflector->isInstantiable()) { |
|
1261 | - // $instantiation_mode = "6) constructor"; |
|
1262 | - return $reflector->newInstanceArgs($arguments); |
|
1263 | - } |
|
1264 | - // heh ? something's not right ! |
|
1265 | - throw new EE_Error( |
|
1266 | - sprintf( |
|
1267 | - __('The %s file %s could not be instantiated.', 'event_espresso'), |
|
1268 | - $type, |
|
1269 | - $class_name |
|
1270 | - ) |
|
1271 | - ); |
|
1272 | - } |
|
1273 | - |
|
1274 | - |
|
1275 | - /** |
|
1276 | - * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential |
|
1277 | - * @param array $array |
|
1278 | - * @return bool |
|
1279 | - */ |
|
1280 | - protected function _array_is_numerically_and_sequentially_indexed(array $array) |
|
1281 | - { |
|
1282 | - return ! empty($array) |
|
1283 | - ? array_keys($array) === range(0, count($array) - 1) |
|
1284 | - : true; |
|
1285 | - } |
|
1286 | - |
|
1287 | - |
|
1288 | - /** |
|
1289 | - * _resolve_dependencies |
|
1290 | - * examines the constructor for the requested class to determine |
|
1291 | - * if any dependencies exist, and if they can be injected. |
|
1292 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
1293 | - * PLZ NOTE: this is achieved by type hinting the constructor params |
|
1294 | - * For example: |
|
1295 | - * if attempting to load a class "Foo" with the following constructor: |
|
1296 | - * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
1297 | - * then $bar_class and $grohl_class will be added to the $arguments array, |
|
1298 | - * but only IF they are NOT already present in the incoming arguments array, |
|
1299 | - * and the correct classes can be loaded |
|
1300 | - * |
|
1301 | - * @param ReflectionClass $reflector |
|
1302 | - * @param string $class_name |
|
1303 | - * @param array $arguments |
|
1304 | - * @return array |
|
1305 | - * @throws InvalidArgumentException |
|
1306 | - * @throws InvalidDataTypeException |
|
1307 | - * @throws InvalidInterfaceException |
|
1308 | - * @throws ReflectionException |
|
1309 | - */ |
|
1310 | - protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array()) |
|
1311 | - { |
|
1312 | - // let's examine the constructor |
|
1313 | - $constructor = $this->mirror->getConstructorFromReflection($reflector); |
|
1314 | - // whu? huh? nothing? |
|
1315 | - if (! $constructor) { |
|
1316 | - return $arguments; |
|
1317 | - } |
|
1318 | - // get constructor parameters |
|
1319 | - $params = $this->mirror->getParametersFromReflection($reflector); |
|
1320 | - // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected |
|
1321 | - $argument_keys = array_keys($arguments); |
|
1322 | - // now loop thru all of the constructors expected parameters |
|
1323 | - foreach ($params as $index => $param) { |
|
1324 | - // is this a dependency for a specific class ? |
|
1325 | - $param_class = $this->mirror->getParameterClassName($param, $class_name, $index); |
|
1326 | - // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime) |
|
1327 | - $param_class = $this->class_cache->isAlias($param_class, $class_name) |
|
1328 | - ? $this->class_cache->getFqnForAlias($param_class, $class_name) |
|
1329 | - : $param_class; |
|
1330 | - if (// param is not even a class |
|
1331 | - $param_class === null |
|
1332 | - // and something already exists in the incoming arguments for this param |
|
1333 | - && array_key_exists($index, $argument_keys) |
|
1334 | - && array_key_exists($argument_keys[ $index ], $arguments) |
|
1335 | - ) { |
|
1336 | - // so let's skip this argument and move on to the next |
|
1337 | - continue; |
|
1338 | - } |
|
1339 | - if (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class |
|
1340 | - $param_class !== null |
|
1341 | - && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ]) |
|
1342 | - && $arguments[ $argument_keys[ $index ] ] instanceof $param_class |
|
1343 | - ) { |
|
1344 | - // skip this argument and move on to the next |
|
1345 | - continue; |
|
1346 | - } |
|
1347 | - if (// parameter is type hinted as a class, and should be injected |
|
1348 | - $param_class !== null |
|
1349 | - && $this->_dependency_map->has_dependency_for_class($class_name, $param_class) |
|
1350 | - ) { |
|
1351 | - $arguments = $this->_resolve_dependency( |
|
1352 | - $class_name, |
|
1353 | - $param_class, |
|
1354 | - $arguments, |
|
1355 | - $index |
|
1356 | - ); |
|
1357 | - } else { |
|
1358 | - $arguments[ $index ] = $this->mirror->getParameterDefaultValue( |
|
1359 | - $param, |
|
1360 | - $class_name, |
|
1361 | - $index |
|
1362 | - ); |
|
1363 | - } |
|
1364 | - } |
|
1365 | - return $arguments; |
|
1366 | - } |
|
1367 | - |
|
1368 | - |
|
1369 | - /** |
|
1370 | - * @param string $class_name |
|
1371 | - * @param string $param_class |
|
1372 | - * @param array $arguments |
|
1373 | - * @param mixed $index |
|
1374 | - * @return array |
|
1375 | - * @throws InvalidArgumentException |
|
1376 | - * @throws InvalidInterfaceException |
|
1377 | - * @throws InvalidDataTypeException |
|
1378 | - */ |
|
1379 | - protected function _resolve_dependency($class_name, $param_class, $arguments, $index) |
|
1380 | - { |
|
1381 | - $dependency = null; |
|
1382 | - // should dependency be loaded from cache ? |
|
1383 | - $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency( |
|
1384 | - $class_name, |
|
1385 | - $param_class |
|
1386 | - ); |
|
1387 | - $cache_on = $cache_on !== EE_Dependency_Map::load_new_object; |
|
1388 | - // we might have a dependency... |
|
1389 | - // let's MAYBE try and find it in our cache if that's what's been requested |
|
1390 | - $cached_class = $cache_on |
|
1391 | - ? $this->_get_cached_class($param_class) |
|
1392 | - : null; |
|
1393 | - // and grab it if it exists |
|
1394 | - if ($cached_class instanceof $param_class) { |
|
1395 | - $dependency = $cached_class; |
|
1396 | - } elseif ($param_class !== $class_name) { |
|
1397 | - // obtain the loader method from the dependency map |
|
1398 | - $loader = $this->_dependency_map->class_loader($param_class); |
|
1399 | - // is loader a custom closure ? |
|
1400 | - if ($loader instanceof Closure) { |
|
1401 | - $dependency = $loader($arguments); |
|
1402 | - } else { |
|
1403 | - // set the cache on property for the recursive loading call |
|
1404 | - $this->_cache_on = $cache_on; |
|
1405 | - // if not, then let's try and load it via the registry |
|
1406 | - if ($loader && method_exists($this, $loader)) { |
|
1407 | - $dependency = $this->{$loader}($param_class); |
|
1408 | - } else { |
|
1409 | - $dependency = LoaderFactory::getLoader()->load( |
|
1410 | - $param_class, |
|
1411 | - array(), |
|
1412 | - $cache_on |
|
1413 | - ); |
|
1414 | - } |
|
1415 | - } |
|
1416 | - } |
|
1417 | - // did we successfully find the correct dependency ? |
|
1418 | - if ($dependency instanceof $param_class) { |
|
1419 | - // then let's inject it into the incoming array of arguments at the correct location |
|
1420 | - $arguments[ $index ] = $dependency; |
|
1421 | - } |
|
1422 | - return $arguments; |
|
1423 | - } |
|
1424 | - |
|
1425 | - |
|
1426 | - /** |
|
1427 | - * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array |
|
1428 | - * |
|
1429 | - * @param string $classname PLEASE NOTE: the class name needs to match what's registered |
|
1430 | - * in the EE_Dependency_Map::$_class_loaders array, |
|
1431 | - * including the class prefix, ie: "EE_", "EEM_", "EEH_", etc |
|
1432 | - * @param array $arguments |
|
1433 | - * @return object |
|
1434 | - */ |
|
1435 | - public static function factory($classname, $arguments = array()) |
|
1436 | - { |
|
1437 | - $loader = self::instance()->_dependency_map->class_loader($classname); |
|
1438 | - if ($loader instanceof Closure) { |
|
1439 | - return $loader($arguments); |
|
1440 | - } |
|
1441 | - if (method_exists(self::instance(), $loader)) { |
|
1442 | - return self::instance()->{$loader}($classname, $arguments); |
|
1443 | - } |
|
1444 | - return null; |
|
1445 | - } |
|
1446 | - |
|
1447 | - |
|
1448 | - /** |
|
1449 | - * Gets the addon by its class name |
|
1450 | - * |
|
1451 | - * @param string $class_name |
|
1452 | - * @return EE_Addon |
|
1453 | - */ |
|
1454 | - public function getAddon($class_name) |
|
1455 | - { |
|
1456 | - $class_name = str_replace('\\', '_', $class_name); |
|
1457 | - return $this->addons->{$class_name}; |
|
1458 | - } |
|
1459 | - |
|
1460 | - |
|
1461 | - /** |
|
1462 | - * removes the addon from the internal cache |
|
1463 | - * |
|
1464 | - * @param string $class_name |
|
1465 | - * @return void |
|
1466 | - */ |
|
1467 | - public function removeAddon($class_name) |
|
1468 | - { |
|
1469 | - $class_name = str_replace('\\', '_', $class_name); |
|
1470 | - unset($this->addons->{$class_name}); |
|
1471 | - } |
|
1472 | - |
|
1473 | - |
|
1474 | - /** |
|
1475 | - * Gets the addon by its name/slug (not classname. For that, just |
|
1476 | - * use the get_addon() method above |
|
1477 | - * |
|
1478 | - * @param string $name |
|
1479 | - * @return EE_Addon |
|
1480 | - */ |
|
1481 | - public function get_addon_by_name($name) |
|
1482 | - { |
|
1483 | - foreach ($this->addons as $addon) { |
|
1484 | - if ($addon->name() === $name) { |
|
1485 | - return $addon; |
|
1486 | - } |
|
1487 | - } |
|
1488 | - return null; |
|
1489 | - } |
|
1490 | - |
|
1491 | - |
|
1492 | - /** |
|
1493 | - * Gets an array of all the registered addons, where the keys are their names. |
|
1494 | - * (ie, what each returns for their name() function) |
|
1495 | - * They're already available on EE_Registry::instance()->addons as properties, |
|
1496 | - * where each property's name is the addon's classname, |
|
1497 | - * So if you just want to get the addon by classname, |
|
1498 | - * OR use the get_addon() method above. |
|
1499 | - * PLEASE NOTE: |
|
1500 | - * addons with Fully Qualified Class Names |
|
1501 | - * have had the namespace separators converted to underscores, |
|
1502 | - * so a classname like Fully\Qualified\ClassName |
|
1503 | - * would have been converted to Fully_Qualified_ClassName |
|
1504 | - * |
|
1505 | - * @return EE_Addon[] where the KEYS are the addon's name() |
|
1506 | - */ |
|
1507 | - public function get_addons_by_name() |
|
1508 | - { |
|
1509 | - $addons = array(); |
|
1510 | - foreach ($this->addons as $addon) { |
|
1511 | - $addons[ $addon->name() ] = $addon; |
|
1512 | - } |
|
1513 | - return $addons; |
|
1514 | - } |
|
1515 | - |
|
1516 | - |
|
1517 | - /** |
|
1518 | - * Resets the specified model's instance AND makes sure EE_Registry doesn't keep |
|
1519 | - * a stale copy of it around |
|
1520 | - * |
|
1521 | - * @param string $model_name |
|
1522 | - * @return \EEM_Base |
|
1523 | - * @throws \EE_Error |
|
1524 | - */ |
|
1525 | - public function reset_model($model_name) |
|
1526 | - { |
|
1527 | - $model_class_name = strpos($model_name, 'EEM_') !== 0 |
|
1528 | - ? "EEM_{$model_name}" |
|
1529 | - : $model_name; |
|
1530 | - if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
1531 | - return null; |
|
1532 | - } |
|
1533 | - // get that model reset it and make sure we nuke the old reference to it |
|
1534 | - if ($this->LIB->{$model_class_name} instanceof $model_class_name |
|
1535 | - && is_callable( |
|
1536 | - array($model_class_name, 'reset') |
|
1537 | - )) { |
|
1538 | - $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset(); |
|
1539 | - } else { |
|
1540 | - throw new EE_Error( |
|
1541 | - sprintf( |
|
1542 | - esc_html__('Model %s does not have a method "reset"', 'event_espresso'), |
|
1543 | - $model_name |
|
1544 | - ) |
|
1545 | - ); |
|
1546 | - } |
|
1547 | - return $this->LIB->{$model_class_name}; |
|
1548 | - } |
|
1549 | - |
|
1550 | - |
|
1551 | - /** |
|
1552 | - * Resets the registry. |
|
1553 | - * The criteria for what gets reset is based on what can be shared between sites on the same request when |
|
1554 | - * switch_to_blog is used in a multisite install. Here is a list of things that are NOT reset. |
|
1555 | - * - $_dependency_map |
|
1556 | - * - $_class_abbreviations |
|
1557 | - * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset. |
|
1558 | - * - $REQ: Still on the same request so no need to change. |
|
1559 | - * - $CAP: There is no site specific state in the EE_Capability class. |
|
1560 | - * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only |
|
1561 | - * one Session can be active in a single request. Resetting could resolve in "headers already sent" errors. |
|
1562 | - * - $addons: In multisite, the state of the addons is something controlled via hooks etc in a normal request. So |
|
1563 | - * for now, we won't reset the addons because it could break calls to an add-ons class/methods in the |
|
1564 | - * switch or on the restore. |
|
1565 | - * - $modules |
|
1566 | - * - $shortcodes |
|
1567 | - * - $widgets |
|
1568 | - * |
|
1569 | - * @param boolean $hard [deprecated] |
|
1570 | - * @param boolean $reinstantiate whether to create new instances of EE_Registry's singletons too, |
|
1571 | - * or just reset without re-instantiating (handy to set to FALSE if you're not |
|
1572 | - * sure if you CAN currently reinstantiate the singletons at the moment) |
|
1573 | - * @param bool $reset_models Defaults to true. When false, then the models are not reset. This is so |
|
1574 | - * client |
|
1575 | - * code instead can just change the model context to a different blog id if |
|
1576 | - * necessary |
|
1577 | - * @return EE_Registry |
|
1578 | - * @throws InvalidInterfaceException |
|
1579 | - * @throws InvalidDataTypeException |
|
1580 | - * @throws EE_Error |
|
1581 | - * @throws ReflectionException |
|
1582 | - * @throws InvalidArgumentException |
|
1583 | - */ |
|
1584 | - public static function reset($hard = false, $reinstantiate = true, $reset_models = true) |
|
1585 | - { |
|
1586 | - $instance = self::instance(); |
|
1587 | - $instance->_cache_on = true; |
|
1588 | - // reset some "special" classes |
|
1589 | - EEH_Activation::reset(); |
|
1590 | - $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard); |
|
1591 | - $instance->CFG = EE_Config::reset($hard, $reinstantiate); |
|
1592 | - $instance->CART = null; |
|
1593 | - $instance->MRM = null; |
|
1594 | - $instance->AssetsRegistry = LoaderFactory::getLoader()->getShared( |
|
1595 | - 'EventEspresso\core\services\assets\Registry' |
|
1596 | - ); |
|
1597 | - // messages reset |
|
1598 | - EED_Messages::reset(); |
|
1599 | - // handle of objects cached on LIB |
|
1600 | - foreach (array('LIB', 'modules') as $cache) { |
|
1601 | - foreach ($instance->{$cache} as $class_name => $class) { |
|
1602 | - if (self::_reset_and_unset_object($class, $reset_models)) { |
|
1603 | - unset($instance->{$cache}->{$class_name}); |
|
1604 | - } |
|
1605 | - } |
|
1606 | - } |
|
1607 | - return $instance; |
|
1608 | - } |
|
1609 | - |
|
1610 | - |
|
1611 | - /** |
|
1612 | - * if passed object implements ResettableInterface, then call it's reset() method |
|
1613 | - * if passed object implements InterminableInterface, then return false, |
|
1614 | - * to indicate that it should NOT be cleared from the Registry cache |
|
1615 | - * |
|
1616 | - * @param $object |
|
1617 | - * @param bool $reset_models |
|
1618 | - * @return bool returns true if cached object should be unset |
|
1619 | - */ |
|
1620 | - private static function _reset_and_unset_object($object, $reset_models) |
|
1621 | - { |
|
1622 | - if (! is_object($object)) { |
|
1623 | - // don't unset anything that's not an object |
|
1624 | - return false; |
|
1625 | - } |
|
1626 | - if ($object instanceof EED_Module) { |
|
1627 | - $object::reset(); |
|
1628 | - // don't unset modules |
|
1629 | - return false; |
|
1630 | - } |
|
1631 | - if ($object instanceof ResettableInterface) { |
|
1632 | - if ($object instanceof EEM_Base) { |
|
1633 | - if ($reset_models) { |
|
1634 | - $object->reset(); |
|
1635 | - return true; |
|
1636 | - } |
|
1637 | - return false; |
|
1638 | - } |
|
1639 | - $object->reset(); |
|
1640 | - return true; |
|
1641 | - } |
|
1642 | - if (! $object instanceof InterminableInterface) { |
|
1643 | - return true; |
|
1644 | - } |
|
1645 | - return false; |
|
1646 | - } |
|
1647 | - |
|
1648 | - |
|
1649 | - /** |
|
1650 | - * Gets all the custom post type models defined |
|
1651 | - * |
|
1652 | - * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event") |
|
1653 | - */ |
|
1654 | - public function cpt_models() |
|
1655 | - { |
|
1656 | - $cpt_models = array(); |
|
1657 | - foreach ($this->non_abstract_db_models as $short_name => $classname) { |
|
1658 | - if (is_subclass_of($classname, 'EEM_CPT_Base')) { |
|
1659 | - $cpt_models[ $short_name ] = $classname; |
|
1660 | - } |
|
1661 | - } |
|
1662 | - return $cpt_models; |
|
1663 | - } |
|
1664 | - |
|
1665 | - |
|
1666 | - /** |
|
1667 | - * @return \EE_Config |
|
1668 | - */ |
|
1669 | - public static function CFG() |
|
1670 | - { |
|
1671 | - return self::instance()->CFG; |
|
1672 | - } |
|
1673 | - |
|
1674 | - |
|
1675 | - /** |
|
1676 | - * @deprecated 4.9.62.p |
|
1677 | - * @param string $class_name |
|
1678 | - * @return ReflectionClass |
|
1679 | - * @throws ReflectionException |
|
1680 | - * @throws InvalidDataTypeException |
|
1681 | - */ |
|
1682 | - public function get_ReflectionClass($class_name) |
|
1683 | - { |
|
1684 | - return $this->mirror->getReflectionClass($class_name); |
|
1685 | - } |
|
26 | + /** |
|
27 | + * @var EE_Registry $_instance |
|
28 | + */ |
|
29 | + private static $_instance; |
|
30 | + |
|
31 | + /** |
|
32 | + * @var EE_Dependency_Map $_dependency_map |
|
33 | + */ |
|
34 | + protected $_dependency_map; |
|
35 | + |
|
36 | + /** |
|
37 | + * @var Mirror |
|
38 | + */ |
|
39 | + private $mirror; |
|
40 | + |
|
41 | + /** |
|
42 | + * @var ClassInterfaceCache $class_cache |
|
43 | + */ |
|
44 | + private $class_cache; |
|
45 | + |
|
46 | + /** |
|
47 | + * @var array $_class_abbreviations |
|
48 | + */ |
|
49 | + protected $_class_abbreviations = array(); |
|
50 | + |
|
51 | + /** |
|
52 | + * @var CommandBusInterface $BUS |
|
53 | + */ |
|
54 | + public $BUS; |
|
55 | + |
|
56 | + /** |
|
57 | + * @var EE_Cart $CART |
|
58 | + */ |
|
59 | + public $CART; |
|
60 | + |
|
61 | + /** |
|
62 | + * @var EE_Config $CFG |
|
63 | + */ |
|
64 | + public $CFG; |
|
65 | + |
|
66 | + /** |
|
67 | + * @var EE_Network_Config $NET_CFG |
|
68 | + */ |
|
69 | + public $NET_CFG; |
|
70 | + |
|
71 | + /** |
|
72 | + * StdClass object for storing library classes in |
|
73 | + * |
|
74 | + * @var RegistryContainer $LIB |
|
75 | + */ |
|
76 | + public $LIB; |
|
77 | + |
|
78 | + /** |
|
79 | + * @var EE_Request_Handler $REQ |
|
80 | + */ |
|
81 | + public $REQ; |
|
82 | + |
|
83 | + /** |
|
84 | + * @var EE_Session $SSN |
|
85 | + */ |
|
86 | + public $SSN; |
|
87 | + |
|
88 | + /** |
|
89 | + * @since 4.5.0 |
|
90 | + * @var EE_Capabilities $CAP |
|
91 | + */ |
|
92 | + public $CAP; |
|
93 | + |
|
94 | + /** |
|
95 | + * @since 4.9.0 |
|
96 | + * @var EE_Message_Resource_Manager $MRM |
|
97 | + */ |
|
98 | + public $MRM; |
|
99 | + |
|
100 | + /** |
|
101 | + * @var Registry $AssetsRegistry |
|
102 | + */ |
|
103 | + public $AssetsRegistry; |
|
104 | + |
|
105 | + /** |
|
106 | + * StdClass object for holding addons which have registered themselves to work with EE core |
|
107 | + * |
|
108 | + * @var EE_Addon[] $addons |
|
109 | + */ |
|
110 | + public $addons; |
|
111 | + |
|
112 | + /** |
|
113 | + * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event') |
|
114 | + * |
|
115 | + * @var EEM_Base[] $models |
|
116 | + */ |
|
117 | + public $models = array(); |
|
118 | + |
|
119 | + /** |
|
120 | + * @var EED_Module[] $modules |
|
121 | + */ |
|
122 | + public $modules; |
|
123 | + |
|
124 | + /** |
|
125 | + * @var EES_Shortcode[] $shortcodes |
|
126 | + */ |
|
127 | + public $shortcodes; |
|
128 | + |
|
129 | + /** |
|
130 | + * @var WP_Widget[] $widgets |
|
131 | + */ |
|
132 | + public $widgets; |
|
133 | + |
|
134 | + /** |
|
135 | + * this is an array of all implemented model names (i.e. not the parent abstract models, or models |
|
136 | + * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)). |
|
137 | + * Keys are model "short names" (eg "Event") as used in model relations, and values are |
|
138 | + * classnames (eg "EEM_Event") |
|
139 | + * |
|
140 | + * @var array $non_abstract_db_models |
|
141 | + */ |
|
142 | + public $non_abstract_db_models = array(); |
|
143 | + |
|
144 | + /** |
|
145 | + * internationalization for JS strings |
|
146 | + * usage: EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' ); |
|
147 | + * in js file: var translatedString = eei18n.string_key; |
|
148 | + * |
|
149 | + * @var array $i18n_js_strings |
|
150 | + */ |
|
151 | + public static $i18n_js_strings = array(); |
|
152 | + |
|
153 | + /** |
|
154 | + * $main_file - path to espresso.php |
|
155 | + * |
|
156 | + * @var array $main_file |
|
157 | + */ |
|
158 | + public $main_file; |
|
159 | + |
|
160 | + /** |
|
161 | + * array of ReflectionClass objects where the key is the class name |
|
162 | + * |
|
163 | + * @deprecated 4.9.62.p |
|
164 | + * @var ReflectionClass[] $_reflectors |
|
165 | + */ |
|
166 | + public $_reflectors; |
|
167 | + |
|
168 | + /** |
|
169 | + * boolean flag to indicate whether or not to load/save dependencies from/to the cache |
|
170 | + * |
|
171 | + * @var boolean $_cache_on |
|
172 | + */ |
|
173 | + protected $_cache_on = true; |
|
174 | + |
|
175 | + /** |
|
176 | + * @var ObjectIdentifier |
|
177 | + */ |
|
178 | + private $object_identifier; |
|
179 | + |
|
180 | + |
|
181 | + /** |
|
182 | + * @singleton method used to instantiate class object |
|
183 | + * @param EE_Dependency_Map|null $dependency_map |
|
184 | + * @param Mirror|null $mirror |
|
185 | + * @param ClassInterfaceCache|null $class_cache |
|
186 | + * @param ObjectIdentifier|null $object_identifier |
|
187 | + * @return EE_Registry instance |
|
188 | + */ |
|
189 | + public static function instance( |
|
190 | + EE_Dependency_Map $dependency_map = null, |
|
191 | + Mirror $mirror = null, |
|
192 | + ClassInterfaceCache $class_cache = null, |
|
193 | + ObjectIdentifier $object_identifier = null |
|
194 | + ) { |
|
195 | + // check if class object is instantiated |
|
196 | + if (! self::$_instance instanceof EE_Registry |
|
197 | + && $dependency_map instanceof EE_Dependency_Map |
|
198 | + && $mirror instanceof Mirror |
|
199 | + && $class_cache instanceof ClassInterfaceCache |
|
200 | + && $object_identifier instanceof ObjectIdentifier |
|
201 | + ) { |
|
202 | + self::$_instance = new self( |
|
203 | + $dependency_map, |
|
204 | + $mirror, |
|
205 | + $class_cache, |
|
206 | + $object_identifier |
|
207 | + ); |
|
208 | + } |
|
209 | + return self::$_instance; |
|
210 | + } |
|
211 | + |
|
212 | + |
|
213 | + /** |
|
214 | + * protected constructor to prevent direct creation |
|
215 | + * |
|
216 | + * @Constructor |
|
217 | + * @param EE_Dependency_Map $dependency_map |
|
218 | + * @param Mirror $mirror |
|
219 | + * @param ClassInterfaceCache $class_cache |
|
220 | + * @param ObjectIdentifier $object_identifier |
|
221 | + */ |
|
222 | + protected function __construct( |
|
223 | + EE_Dependency_Map $dependency_map, |
|
224 | + Mirror $mirror, |
|
225 | + ClassInterfaceCache $class_cache, |
|
226 | + ObjectIdentifier $object_identifier |
|
227 | + ) { |
|
228 | + $this->_dependency_map = $dependency_map; |
|
229 | + $this->mirror = $mirror; |
|
230 | + $this->class_cache = $class_cache; |
|
231 | + $this->object_identifier = $object_identifier; |
|
232 | + // $registry_container = new RegistryContainer(); |
|
233 | + $this->LIB = new RegistryContainer(); |
|
234 | + $this->addons = new RegistryContainer(); |
|
235 | + $this->modules = new RegistryContainer(); |
|
236 | + $this->shortcodes = new RegistryContainer(); |
|
237 | + $this->widgets = new RegistryContainer(); |
|
238 | + add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
239 | + } |
|
240 | + |
|
241 | + |
|
242 | + /** |
|
243 | + * initialize |
|
244 | + * |
|
245 | + * @throws OutOfBoundsException |
|
246 | + * @throws InvalidArgumentException |
|
247 | + * @throws InvalidInterfaceException |
|
248 | + * @throws InvalidDataTypeException |
|
249 | + * @throws EE_Error |
|
250 | + * @throws ReflectionException |
|
251 | + */ |
|
252 | + public function initialize() |
|
253 | + { |
|
254 | + $this->_class_abbreviations = apply_filters( |
|
255 | + 'FHEE__EE_Registry____construct___class_abbreviations', |
|
256 | + array( |
|
257 | + 'EE_Config' => 'CFG', |
|
258 | + 'EE_Session' => 'SSN', |
|
259 | + 'EE_Capabilities' => 'CAP', |
|
260 | + 'EE_Cart' => 'CART', |
|
261 | + 'EE_Network_Config' => 'NET_CFG', |
|
262 | + 'EE_Request_Handler' => 'REQ', |
|
263 | + 'EE_Message_Resource_Manager' => 'MRM', |
|
264 | + 'EventEspresso\core\services\commands\CommandBus' => 'BUS', |
|
265 | + 'EventEspresso\core\services\assets\Registry' => 'AssetsRegistry', |
|
266 | + ) |
|
267 | + ); |
|
268 | + $this->load_core('Base', array(), true); |
|
269 | + // add our request and response objects to the cache |
|
270 | + $request_loader = $this->_dependency_map->class_loader( |
|
271 | + 'EventEspresso\core\services\request\Request' |
|
272 | + ); |
|
273 | + $this->_set_cached_class( |
|
274 | + $request_loader(), |
|
275 | + 'EventEspresso\core\services\request\Request' |
|
276 | + ); |
|
277 | + $response_loader = $this->_dependency_map->class_loader( |
|
278 | + 'EventEspresso\core\services\request\Response' |
|
279 | + ); |
|
280 | + $this->_set_cached_class( |
|
281 | + $response_loader(), |
|
282 | + 'EventEspresso\core\services\request\Response' |
|
283 | + ); |
|
284 | + add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init')); |
|
285 | + } |
|
286 | + |
|
287 | + |
|
288 | + /** |
|
289 | + * @return void |
|
290 | + */ |
|
291 | + public function init() |
|
292 | + { |
|
293 | + // Get current page protocol |
|
294 | + $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; |
|
295 | + // Output admin-ajax.php URL with same protocol as current page |
|
296 | + self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol); |
|
297 | + self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false; |
|
298 | + } |
|
299 | + |
|
300 | + |
|
301 | + /** |
|
302 | + * localize_i18n_js_strings |
|
303 | + * |
|
304 | + * @return string |
|
305 | + */ |
|
306 | + public static function localize_i18n_js_strings() |
|
307 | + { |
|
308 | + $i18n_js_strings = (array) self::$i18n_js_strings; |
|
309 | + foreach ($i18n_js_strings as $key => $value) { |
|
310 | + if (is_scalar($value)) { |
|
311 | + $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8'); |
|
312 | + } |
|
313 | + } |
|
314 | + return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
315 | + } |
|
316 | + |
|
317 | + |
|
318 | + /** |
|
319 | + * @param mixed string | EED_Module $module |
|
320 | + * @throws OutOfBoundsException |
|
321 | + * @throws InvalidArgumentException |
|
322 | + * @throws InvalidInterfaceException |
|
323 | + * @throws InvalidDataTypeException |
|
324 | + * @throws EE_Error |
|
325 | + * @throws ReflectionException |
|
326 | + */ |
|
327 | + public function add_module($module) |
|
328 | + { |
|
329 | + if ($module instanceof EED_Module) { |
|
330 | + $module_class = get_class($module); |
|
331 | + $this->modules->{$module_class} = $module; |
|
332 | + } else { |
|
333 | + if (! class_exists('EE_Module_Request_Router', false)) { |
|
334 | + $this->load_core('Module_Request_Router'); |
|
335 | + } |
|
336 | + EE_Module_Request_Router::module_factory($module); |
|
337 | + } |
|
338 | + } |
|
339 | + |
|
340 | + |
|
341 | + /** |
|
342 | + * @param string $module_name |
|
343 | + * @return mixed EED_Module | NULL |
|
344 | + */ |
|
345 | + public function get_module($module_name = '') |
|
346 | + { |
|
347 | + return isset($this->modules->{$module_name}) |
|
348 | + ? $this->modules->{$module_name} |
|
349 | + : null; |
|
350 | + } |
|
351 | + |
|
352 | + |
|
353 | + /** |
|
354 | + * loads core classes - must be singletons |
|
355 | + * |
|
356 | + * @param string $class_name - simple class name ie: session |
|
357 | + * @param mixed $arguments |
|
358 | + * @param bool $load_only |
|
359 | + * @return mixed |
|
360 | + * @throws InvalidInterfaceException |
|
361 | + * @throws InvalidDataTypeException |
|
362 | + * @throws EE_Error |
|
363 | + * @throws ReflectionException |
|
364 | + * @throws InvalidArgumentException |
|
365 | + */ |
|
366 | + public function load_core($class_name, $arguments = array(), $load_only = false) |
|
367 | + { |
|
368 | + $core_paths = apply_filters( |
|
369 | + 'FHEE__EE_Registry__load_core__core_paths', |
|
370 | + array( |
|
371 | + EE_CORE, |
|
372 | + EE_ADMIN, |
|
373 | + EE_CPTS, |
|
374 | + EE_CORE . 'data_migration_scripts' . DS, |
|
375 | + EE_CORE . 'capabilities' . DS, |
|
376 | + EE_CORE . 'request_stack' . DS, |
|
377 | + EE_CORE . 'middleware' . DS, |
|
378 | + ) |
|
379 | + ); |
|
380 | + // retrieve instantiated class |
|
381 | + return $this->_load( |
|
382 | + $core_paths, |
|
383 | + 'EE_', |
|
384 | + $class_name, |
|
385 | + 'core', |
|
386 | + $arguments, |
|
387 | + false, |
|
388 | + true, |
|
389 | + $load_only |
|
390 | + ); |
|
391 | + } |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * loads service classes |
|
396 | + * |
|
397 | + * @param string $class_name - simple class name ie: session |
|
398 | + * @param mixed $arguments |
|
399 | + * @param bool $load_only |
|
400 | + * @return mixed |
|
401 | + * @throws InvalidInterfaceException |
|
402 | + * @throws InvalidDataTypeException |
|
403 | + * @throws EE_Error |
|
404 | + * @throws ReflectionException |
|
405 | + * @throws InvalidArgumentException |
|
406 | + */ |
|
407 | + public function load_service($class_name, $arguments = array(), $load_only = false) |
|
408 | + { |
|
409 | + $service_paths = apply_filters( |
|
410 | + 'FHEE__EE_Registry__load_service__service_paths', |
|
411 | + array( |
|
412 | + EE_CORE . 'services' . DS, |
|
413 | + ) |
|
414 | + ); |
|
415 | + // retrieve instantiated class |
|
416 | + return $this->_load( |
|
417 | + $service_paths, |
|
418 | + 'EE_', |
|
419 | + $class_name, |
|
420 | + 'class', |
|
421 | + $arguments, |
|
422 | + false, |
|
423 | + true, |
|
424 | + $load_only |
|
425 | + ); |
|
426 | + } |
|
427 | + |
|
428 | + |
|
429 | + /** |
|
430 | + * loads data_migration_scripts |
|
431 | + * |
|
432 | + * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0 |
|
433 | + * @param mixed $arguments |
|
434 | + * @return EE_Data_Migration_Script_Base|mixed |
|
435 | + * @throws InvalidInterfaceException |
|
436 | + * @throws InvalidDataTypeException |
|
437 | + * @throws EE_Error |
|
438 | + * @throws ReflectionException |
|
439 | + * @throws InvalidArgumentException |
|
440 | + */ |
|
441 | + public function load_dms($class_name, $arguments = array()) |
|
442 | + { |
|
443 | + // retrieve instantiated class |
|
444 | + return $this->_load( |
|
445 | + EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), |
|
446 | + 'EE_DMS_', |
|
447 | + $class_name, |
|
448 | + 'dms', |
|
449 | + $arguments, |
|
450 | + false, |
|
451 | + false |
|
452 | + ); |
|
453 | + } |
|
454 | + |
|
455 | + |
|
456 | + /** |
|
457 | + * loads object creating classes - must be singletons |
|
458 | + * |
|
459 | + * @param string $class_name - simple class name ie: attendee |
|
460 | + * @param mixed $arguments - an array of arguments to pass to the class |
|
461 | + * @param bool $from_db - some classes are instantiated from the db and thus call a different method to |
|
462 | + * instantiate |
|
463 | + * @param bool $cache if you don't want the class to be stored in the internal cache (non-persistent) then |
|
464 | + * set this to FALSE (ie. when instantiating model objects from client in a loop) |
|
465 | + * @param bool $load_only whether or not to just load the file and NOT instantiate, or load AND instantiate |
|
466 | + * (default) |
|
467 | + * @return EE_Base_Class | bool |
|
468 | + * @throws InvalidInterfaceException |
|
469 | + * @throws InvalidDataTypeException |
|
470 | + * @throws EE_Error |
|
471 | + * @throws ReflectionException |
|
472 | + * @throws InvalidArgumentException |
|
473 | + */ |
|
474 | + public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false) |
|
475 | + { |
|
476 | + $paths = apply_filters( |
|
477 | + 'FHEE__EE_Registry__load_class__paths', |
|
478 | + array( |
|
479 | + EE_CORE, |
|
480 | + EE_CLASSES, |
|
481 | + EE_BUSINESS, |
|
482 | + ) |
|
483 | + ); |
|
484 | + // retrieve instantiated class |
|
485 | + return $this->_load( |
|
486 | + $paths, |
|
487 | + 'EE_', |
|
488 | + $class_name, |
|
489 | + 'class', |
|
490 | + $arguments, |
|
491 | + $from_db, |
|
492 | + $cache, |
|
493 | + $load_only |
|
494 | + ); |
|
495 | + } |
|
496 | + |
|
497 | + |
|
498 | + /** |
|
499 | + * loads helper classes - must be singletons |
|
500 | + * |
|
501 | + * @param string $class_name - simple class name ie: price |
|
502 | + * @param mixed $arguments |
|
503 | + * @param bool $load_only |
|
504 | + * @return EEH_Base | bool |
|
505 | + * @throws InvalidInterfaceException |
|
506 | + * @throws InvalidDataTypeException |
|
507 | + * @throws EE_Error |
|
508 | + * @throws ReflectionException |
|
509 | + * @throws InvalidArgumentException |
|
510 | + */ |
|
511 | + public function load_helper($class_name, $arguments = array(), $load_only = true) |
|
512 | + { |
|
513 | + // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed |
|
514 | + $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS)); |
|
515 | + // retrieve instantiated class |
|
516 | + return $this->_load( |
|
517 | + $helper_paths, |
|
518 | + 'EEH_', |
|
519 | + $class_name, |
|
520 | + 'helper', |
|
521 | + $arguments, |
|
522 | + false, |
|
523 | + true, |
|
524 | + $load_only |
|
525 | + ); |
|
526 | + } |
|
527 | + |
|
528 | + |
|
529 | + /** |
|
530 | + * loads core classes - must be singletons |
|
531 | + * |
|
532 | + * @param string $class_name - simple class name ie: session |
|
533 | + * @param mixed $arguments |
|
534 | + * @param bool $load_only |
|
535 | + * @param bool $cache whether to cache the object or not. |
|
536 | + * @return mixed |
|
537 | + * @throws InvalidInterfaceException |
|
538 | + * @throws InvalidDataTypeException |
|
539 | + * @throws EE_Error |
|
540 | + * @throws ReflectionException |
|
541 | + * @throws InvalidArgumentException |
|
542 | + */ |
|
543 | + public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true) |
|
544 | + { |
|
545 | + $paths = array( |
|
546 | + EE_LIBRARIES, |
|
547 | + EE_LIBRARIES . 'messages' . DS, |
|
548 | + EE_LIBRARIES . 'shortcodes' . DS, |
|
549 | + EE_LIBRARIES . 'qtips' . DS, |
|
550 | + EE_LIBRARIES . 'payment_methods' . DS, |
|
551 | + ); |
|
552 | + // retrieve instantiated class |
|
553 | + return $this->_load( |
|
554 | + $paths, |
|
555 | + 'EE_', |
|
556 | + $class_name, |
|
557 | + 'lib', |
|
558 | + $arguments, |
|
559 | + false, |
|
560 | + $cache, |
|
561 | + $load_only |
|
562 | + ); |
|
563 | + } |
|
564 | + |
|
565 | + |
|
566 | + /** |
|
567 | + * loads model classes - must be singletons |
|
568 | + * |
|
569 | + * @param string $class_name - simple class name ie: price |
|
570 | + * @param mixed $arguments |
|
571 | + * @param bool $load_only |
|
572 | + * @return EEM_Base | bool |
|
573 | + * @throws InvalidInterfaceException |
|
574 | + * @throws InvalidDataTypeException |
|
575 | + * @throws EE_Error |
|
576 | + * @throws ReflectionException |
|
577 | + * @throws InvalidArgumentException |
|
578 | + */ |
|
579 | + public function load_model($class_name, $arguments = array(), $load_only = false) |
|
580 | + { |
|
581 | + $paths = apply_filters( |
|
582 | + 'FHEE__EE_Registry__load_model__paths', |
|
583 | + array( |
|
584 | + EE_MODELS, |
|
585 | + EE_CORE, |
|
586 | + ) |
|
587 | + ); |
|
588 | + // retrieve instantiated class |
|
589 | + return $this->_load( |
|
590 | + $paths, |
|
591 | + 'EEM_', |
|
592 | + $class_name, |
|
593 | + 'model', |
|
594 | + $arguments, |
|
595 | + false, |
|
596 | + true, |
|
597 | + $load_only |
|
598 | + ); |
|
599 | + } |
|
600 | + |
|
601 | + |
|
602 | + /** |
|
603 | + * loads model classes - must be singletons |
|
604 | + * |
|
605 | + * @param string $class_name - simple class name ie: price |
|
606 | + * @param mixed $arguments |
|
607 | + * @param bool $load_only |
|
608 | + * @return mixed | bool |
|
609 | + * @throws InvalidInterfaceException |
|
610 | + * @throws InvalidDataTypeException |
|
611 | + * @throws EE_Error |
|
612 | + * @throws ReflectionException |
|
613 | + * @throws InvalidArgumentException |
|
614 | + */ |
|
615 | + public function load_model_class($class_name, $arguments = array(), $load_only = true) |
|
616 | + { |
|
617 | + $paths = array( |
|
618 | + EE_MODELS . 'fields' . DS, |
|
619 | + EE_MODELS . 'helpers' . DS, |
|
620 | + EE_MODELS . 'relations' . DS, |
|
621 | + EE_MODELS . 'strategies' . DS, |
|
622 | + ); |
|
623 | + // retrieve instantiated class |
|
624 | + return $this->_load( |
|
625 | + $paths, |
|
626 | + 'EE_', |
|
627 | + $class_name, |
|
628 | + '', |
|
629 | + $arguments, |
|
630 | + false, |
|
631 | + true, |
|
632 | + $load_only |
|
633 | + ); |
|
634 | + } |
|
635 | + |
|
636 | + |
|
637 | + /** |
|
638 | + * Determines if $model_name is the name of an actual EE model. |
|
639 | + * |
|
640 | + * @param string $model_name like Event, Attendee, Question_Group_Question, etc. |
|
641 | + * @return boolean |
|
642 | + */ |
|
643 | + public function is_model_name($model_name) |
|
644 | + { |
|
645 | + return isset($this->models[ $model_name ]); |
|
646 | + } |
|
647 | + |
|
648 | + |
|
649 | + /** |
|
650 | + * generic class loader |
|
651 | + * |
|
652 | + * @param string $path_to_file - directory path to file location, not including filename |
|
653 | + * @param string $file_name - file name ie: my_file.php, including extension |
|
654 | + * @param string $type - file type - core? class? helper? model? |
|
655 | + * @param mixed $arguments |
|
656 | + * @param bool $load_only |
|
657 | + * @return mixed |
|
658 | + * @throws InvalidInterfaceException |
|
659 | + * @throws InvalidDataTypeException |
|
660 | + * @throws EE_Error |
|
661 | + * @throws ReflectionException |
|
662 | + * @throws InvalidArgumentException |
|
663 | + */ |
|
664 | + public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true) |
|
665 | + { |
|
666 | + // retrieve instantiated class |
|
667 | + return $this->_load( |
|
668 | + $path_to_file, |
|
669 | + '', |
|
670 | + $file_name, |
|
671 | + $type, |
|
672 | + $arguments, |
|
673 | + false, |
|
674 | + true, |
|
675 | + $load_only |
|
676 | + ); |
|
677 | + } |
|
678 | + |
|
679 | + |
|
680 | + /** |
|
681 | + * @param string $path_to_file - directory path to file location, not including filename |
|
682 | + * @param string $class_name - full class name ie: My_Class |
|
683 | + * @param string $type - file type - core? class? helper? model? |
|
684 | + * @param mixed $arguments |
|
685 | + * @param bool $load_only |
|
686 | + * @return bool|EE_Addon|object |
|
687 | + * @throws InvalidInterfaceException |
|
688 | + * @throws InvalidDataTypeException |
|
689 | + * @throws EE_Error |
|
690 | + * @throws ReflectionException |
|
691 | + * @throws InvalidArgumentException |
|
692 | + */ |
|
693 | + public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false) |
|
694 | + { |
|
695 | + // retrieve instantiated class |
|
696 | + return $this->_load( |
|
697 | + $path_to_file, |
|
698 | + 'addon', |
|
699 | + $class_name, |
|
700 | + $type, |
|
701 | + $arguments, |
|
702 | + false, |
|
703 | + true, |
|
704 | + $load_only |
|
705 | + ); |
|
706 | + } |
|
707 | + |
|
708 | + |
|
709 | + /** |
|
710 | + * instantiates, caches, and automatically resolves dependencies |
|
711 | + * for classes that use a Fully Qualified Class Name. |
|
712 | + * if the class is not capable of being loaded using PSR-4 autoloading, |
|
713 | + * then you need to use one of the existing load_*() methods |
|
714 | + * which can resolve the classname and filepath from the passed arguments |
|
715 | + * |
|
716 | + * @param bool|string $class_name Fully Qualified Class Name |
|
717 | + * @param array $arguments an argument, or array of arguments to pass to the class upon instantiation |
|
718 | + * @param bool $cache whether to cache the instantiated object for reuse |
|
719 | + * @param bool $from_db some classes are instantiated from the db |
|
720 | + * and thus call a different method to instantiate |
|
721 | + * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
722 | + * @param bool|string $addon if true, will cache the object in the EE_Registry->$addons array |
|
723 | + * @return bool|null|mixed null = failure to load or instantiate class object. |
|
724 | + * object = class loaded and instantiated successfully. |
|
725 | + * bool = fail or success when $load_only is true |
|
726 | + * @throws InvalidInterfaceException |
|
727 | + * @throws InvalidDataTypeException |
|
728 | + * @throws EE_Error |
|
729 | + * @throws ReflectionException |
|
730 | + * @throws InvalidArgumentException |
|
731 | + */ |
|
732 | + public function create( |
|
733 | + $class_name = false, |
|
734 | + $arguments = array(), |
|
735 | + $cache = false, |
|
736 | + $from_db = false, |
|
737 | + $load_only = false, |
|
738 | + $addon = false |
|
739 | + ) { |
|
740 | + $class_name = ltrim($class_name, '\\'); |
|
741 | + $class_name = $this->class_cache->getFqnForAlias($class_name); |
|
742 | + $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments); |
|
743 | + // if a non-FQCN was passed, then |
|
744 | + // verifyClassExists() might return an object |
|
745 | + // or it could return null if the class just could not be found anywhere |
|
746 | + if ($class_exists instanceof $class_name || $class_exists === null) { |
|
747 | + // either way, return the results |
|
748 | + return $class_exists; |
|
749 | + } |
|
750 | + $class_name = $class_exists; |
|
751 | + // if we're only loading the class and it already exists, then let's just return true immediately |
|
752 | + if ($load_only) { |
|
753 | + return true; |
|
754 | + } |
|
755 | + $addon = $addon ? 'addon' : ''; |
|
756 | + // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
757 | + // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
758 | + // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
759 | + if ($this->_cache_on && $cache && ! $load_only) { |
|
760 | + // return object if it's already cached |
|
761 | + $cached_class = $this->_get_cached_class($class_name, $addon, $arguments); |
|
762 | + if ($cached_class !== null) { |
|
763 | + return $cached_class; |
|
764 | + } |
|
765 | + }// obtain the loader method from the dependency map |
|
766 | + $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object |
|
767 | + if ($loader instanceof Closure) { |
|
768 | + $class_obj = $loader($arguments); |
|
769 | + } else { |
|
770 | + if ($loader && method_exists($this, $loader)) { |
|
771 | + $class_obj = $this->{$loader}($class_name, $arguments); |
|
772 | + } else { |
|
773 | + $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db); |
|
774 | + } |
|
775 | + } |
|
776 | + if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) { |
|
777 | + // save it for later... kinda like gum { : $ |
|
778 | + $this->_set_cached_class( |
|
779 | + $class_obj, |
|
780 | + $class_name, |
|
781 | + $addon, |
|
782 | + $from_db, |
|
783 | + $arguments |
|
784 | + ); |
|
785 | + } |
|
786 | + $this->_cache_on = true; |
|
787 | + return $class_obj; |
|
788 | + } |
|
789 | + |
|
790 | + |
|
791 | + /** |
|
792 | + * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs |
|
793 | + * |
|
794 | + * @param string|object $class_name |
|
795 | + * @param array $arguments |
|
796 | + * @param int $attempt |
|
797 | + * @return mixed |
|
798 | + */ |
|
799 | + private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1) |
|
800 | + { |
|
801 | + if (is_object($class_name) || class_exists($class_name)) { |
|
802 | + return $class_name; |
|
803 | + } |
|
804 | + switch ($attempt) { |
|
805 | + case 1: |
|
806 | + // if it's a FQCN then maybe the class is registered with a preceding \ |
|
807 | + $class_name = strpos($class_name, '\\') !== false |
|
808 | + ? '\\' . ltrim($class_name, '\\') |
|
809 | + : $class_name; |
|
810 | + break; |
|
811 | + case 2: |
|
812 | + // |
|
813 | + $loader = $this->_dependency_map->class_loader($class_name); |
|
814 | + if ($loader && method_exists($this, $loader)) { |
|
815 | + return $this->{$loader}($class_name, $arguments); |
|
816 | + } |
|
817 | + break; |
|
818 | + case 3: |
|
819 | + default: |
|
820 | + return null; |
|
821 | + } |
|
822 | + $attempt++; |
|
823 | + return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt); |
|
824 | + } |
|
825 | + |
|
826 | + |
|
827 | + /** |
|
828 | + * instantiates, caches, and injects dependencies for classes |
|
829 | + * |
|
830 | + * @param array $file_paths an array of paths to folders to look in |
|
831 | + * @param string $class_prefix EE or EEM or... ??? |
|
832 | + * @param bool|string $class_name $class name |
|
833 | + * @param string $type file type - core? class? helper? model? |
|
834 | + * @param mixed $arguments an argument or array of arguments to pass to the class upon instantiation |
|
835 | + * @param bool $from_db some classes are instantiated from the db |
|
836 | + * and thus call a different method to instantiate |
|
837 | + * @param bool $cache whether to cache the instantiated object for reuse |
|
838 | + * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
839 | + * @return bool|null|object null = failure to load or instantiate class object. |
|
840 | + * object = class loaded and instantiated successfully. |
|
841 | + * bool = fail or success when $load_only is true |
|
842 | + * @throws EE_Error |
|
843 | + * @throws ReflectionException |
|
844 | + * @throws InvalidInterfaceException |
|
845 | + * @throws InvalidDataTypeException |
|
846 | + * @throws InvalidArgumentException |
|
847 | + */ |
|
848 | + protected function _load( |
|
849 | + $file_paths = array(), |
|
850 | + $class_prefix = 'EE_', |
|
851 | + $class_name = false, |
|
852 | + $type = 'class', |
|
853 | + $arguments = array(), |
|
854 | + $from_db = false, |
|
855 | + $cache = true, |
|
856 | + $load_only = false |
|
857 | + ) { |
|
858 | + $class_name = ltrim($class_name, '\\'); |
|
859 | + // strip php file extension |
|
860 | + $class_name = str_replace('.php', '', trim($class_name)); |
|
861 | + // does the class have a prefix ? |
|
862 | + if (! empty($class_prefix) && $class_prefix !== 'addon') { |
|
863 | + // make sure $class_prefix is uppercase |
|
864 | + $class_prefix = strtoupper(trim($class_prefix)); |
|
865 | + // add class prefix ONCE!!! |
|
866 | + $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
867 | + } |
|
868 | + $class_name = $this->class_cache->getFqnForAlias($class_name); |
|
869 | + $class_exists = class_exists($class_name, false); |
|
870 | + // if we're only loading the class and it already exists, then let's just return true immediately |
|
871 | + if ($load_only && $class_exists) { |
|
872 | + return true; |
|
873 | + } |
|
874 | + $arguments = is_array($arguments) ? $arguments : array($arguments); |
|
875 | + // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
876 | + // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
877 | + // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
878 | + if ($this->_cache_on && $cache && ! $load_only) { |
|
879 | + // return object if it's already cached |
|
880 | + $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments); |
|
881 | + if ($cached_class !== null) { |
|
882 | + return $cached_class; |
|
883 | + } |
|
884 | + } |
|
885 | + // if the class doesn't already exist.. then we need to try and find the file and load it |
|
886 | + if (! $class_exists) { |
|
887 | + // get full path to file |
|
888 | + $path = $this->_resolve_path($class_name, $type, $file_paths); |
|
889 | + // load the file |
|
890 | + $loaded = $this->_require_file($path, $class_name, $type, $file_paths); |
|
891 | + // if we are only loading a file but NOT instantiating an object |
|
892 | + // then return boolean for whether class was loaded or not |
|
893 | + if ($load_only) { |
|
894 | + return $loaded; |
|
895 | + } |
|
896 | + // if an object was expected but loading failed, then return nothing |
|
897 | + if (! $loaded) { |
|
898 | + return null; |
|
899 | + } |
|
900 | + } |
|
901 | + // instantiate the requested object |
|
902 | + $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db); |
|
903 | + if ($this->_cache_on && $cache) { |
|
904 | + // save it for later... kinda like gum { : $ |
|
905 | + $this->_set_cached_class( |
|
906 | + $class_obj, |
|
907 | + $class_name, |
|
908 | + $class_prefix, |
|
909 | + $from_db, |
|
910 | + $arguments |
|
911 | + ); |
|
912 | + } |
|
913 | + $this->_cache_on = true; |
|
914 | + return $class_obj; |
|
915 | + } |
|
916 | + |
|
917 | + |
|
918 | + /** |
|
919 | + * @param string $class_name |
|
920 | + * @param string $default have to specify something, but not anything that will conflict |
|
921 | + * @return mixed|string |
|
922 | + */ |
|
923 | + protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS') |
|
924 | + { |
|
925 | + return isset($this->_class_abbreviations[ $class_name ]) |
|
926 | + ? $this->_class_abbreviations[ $class_name ] |
|
927 | + : $default; |
|
928 | + } |
|
929 | + |
|
930 | + |
|
931 | + /** |
|
932 | + * attempts to find a cached version of the requested class |
|
933 | + * by looking in the following places: |
|
934 | + * $this->{$class_abbreviation} ie: $this->CART |
|
935 | + * $this->{$class_name} ie: $this->Some_Class |
|
936 | + * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
937 | + * $this->addon->{$class_name} ie: $this->addon->Some_Addon_Class |
|
938 | + * |
|
939 | + * @param string $class_name |
|
940 | + * @param string $class_prefix |
|
941 | + * @param array $arguments |
|
942 | + * @return mixed |
|
943 | + */ |
|
944 | + protected function _get_cached_class( |
|
945 | + $class_name, |
|
946 | + $class_prefix = '', |
|
947 | + $arguments = array() |
|
948 | + ) { |
|
949 | + if ($class_name === 'EE_Registry') { |
|
950 | + return $this; |
|
951 | + } |
|
952 | + $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
953 | + // check if class has already been loaded, and return it if it has been |
|
954 | + if (isset($this->{$class_abbreviation})) { |
|
955 | + return $this->{$class_abbreviation}; |
|
956 | + } |
|
957 | + $class_name = str_replace('\\', '_', $class_name); |
|
958 | + if (isset($this->{$class_name})) { |
|
959 | + return $this->{$class_name}; |
|
960 | + } |
|
961 | + if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) { |
|
962 | + return $this->addons->{$class_name}; |
|
963 | + } |
|
964 | + $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments); |
|
965 | + if (isset($this->LIB->{$object_identifier})) { |
|
966 | + return $this->LIB->{$object_identifier}; |
|
967 | + } |
|
968 | + foreach ($this->LIB as $key => $object) { |
|
969 | + if (// request does not contain new arguments and therefore no args identifier |
|
970 | + ! $this->object_identifier->hasArguments($object_identifier) |
|
971 | + // but previously cached class with args was found |
|
972 | + && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key) |
|
973 | + ) { |
|
974 | + return $object; |
|
975 | + } |
|
976 | + } |
|
977 | + return null; |
|
978 | + } |
|
979 | + |
|
980 | + |
|
981 | + /** |
|
982 | + * removes a cached version of the requested class |
|
983 | + * |
|
984 | + * @param string $class_name |
|
985 | + * @param boolean $addon |
|
986 | + * @param array $arguments |
|
987 | + * @return boolean |
|
988 | + */ |
|
989 | + public function clear_cached_class( |
|
990 | + $class_name, |
|
991 | + $addon = false, |
|
992 | + $arguments = array() |
|
993 | + ) { |
|
994 | + $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
995 | + // check if class has already been loaded, and return it if it has been |
|
996 | + if (isset($this->{$class_abbreviation})) { |
|
997 | + $this->{$class_abbreviation} = null; |
|
998 | + return true; |
|
999 | + } |
|
1000 | + $class_name = str_replace('\\', '_', $class_name); |
|
1001 | + if (isset($this->{$class_name})) { |
|
1002 | + $this->{$class_name} = null; |
|
1003 | + return true; |
|
1004 | + } |
|
1005 | + if ($addon && isset($this->addons->{$class_name})) { |
|
1006 | + unset($this->addons->{$class_name}); |
|
1007 | + return true; |
|
1008 | + } |
|
1009 | + $class_name = $this->object_identifier->getIdentifier($class_name, $arguments); |
|
1010 | + if (isset($this->LIB->{$class_name})) { |
|
1011 | + unset($this->LIB->{$class_name}); |
|
1012 | + return true; |
|
1013 | + } |
|
1014 | + return false; |
|
1015 | + } |
|
1016 | + |
|
1017 | + |
|
1018 | + /** |
|
1019 | + * _set_cached_class |
|
1020 | + * attempts to cache the instantiated class locally |
|
1021 | + * in one of the following places, in the following order: |
|
1022 | + * $this->{class_abbreviation} ie: $this->CART |
|
1023 | + * $this->{$class_name} ie: $this->Some_Class |
|
1024 | + * $this->addon->{$$class_name} ie: $this->addon->Some_Addon_Class |
|
1025 | + * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
1026 | + * |
|
1027 | + * @param object $class_obj |
|
1028 | + * @param string $class_name |
|
1029 | + * @param string $class_prefix |
|
1030 | + * @param bool $from_db |
|
1031 | + * @param array $arguments |
|
1032 | + * @return void |
|
1033 | + */ |
|
1034 | + protected function _set_cached_class( |
|
1035 | + $class_obj, |
|
1036 | + $class_name, |
|
1037 | + $class_prefix = '', |
|
1038 | + $from_db = false, |
|
1039 | + $arguments = array() |
|
1040 | + ) { |
|
1041 | + if ($class_name === 'EE_Registry' || empty($class_obj)) { |
|
1042 | + return; |
|
1043 | + } |
|
1044 | + // return newly instantiated class |
|
1045 | + $class_abbreviation = $this->get_class_abbreviation($class_name, ''); |
|
1046 | + if ($class_abbreviation) { |
|
1047 | + $this->{$class_abbreviation} = $class_obj; |
|
1048 | + return; |
|
1049 | + } |
|
1050 | + $class_name = str_replace('\\', '_', $class_name); |
|
1051 | + if (property_exists($this, $class_name)) { |
|
1052 | + $this->{$class_name} = $class_obj; |
|
1053 | + return; |
|
1054 | + } |
|
1055 | + if ($class_prefix === 'addon') { |
|
1056 | + $this->addons->{$class_name} = $class_obj; |
|
1057 | + return; |
|
1058 | + } |
|
1059 | + if (! $from_db) { |
|
1060 | + $class_name = $this->object_identifier->getIdentifier($class_name, $arguments); |
|
1061 | + $this->LIB->{$class_name} = $class_obj; |
|
1062 | + } |
|
1063 | + } |
|
1064 | + |
|
1065 | + |
|
1066 | + /** |
|
1067 | + * attempts to find a full valid filepath for the requested class. |
|
1068 | + * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php" |
|
1069 | + * then returns that path if the target file has been found and is readable |
|
1070 | + * |
|
1071 | + * @param string $class_name |
|
1072 | + * @param string $type |
|
1073 | + * @param array $file_paths |
|
1074 | + * @return string | bool |
|
1075 | + */ |
|
1076 | + protected function _resolve_path($class_name, $type = '', $file_paths = array()) |
|
1077 | + { |
|
1078 | + // make sure $file_paths is an array |
|
1079 | + $file_paths = is_array($file_paths) |
|
1080 | + ? $file_paths |
|
1081 | + : array($file_paths); |
|
1082 | + // cycle thru paths |
|
1083 | + foreach ($file_paths as $key => $file_path) { |
|
1084 | + // convert all separators to proper DS, if no filepath, then use EE_CLASSES |
|
1085 | + $file_path = $file_path |
|
1086 | + ? str_replace(array('/', '\\'), DS, $file_path) |
|
1087 | + : EE_CLASSES; |
|
1088 | + // prep file type |
|
1089 | + $type = ! empty($type) |
|
1090 | + ? trim($type, '.') . '.' |
|
1091 | + : ''; |
|
1092 | + // build full file path |
|
1093 | + $file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
1094 | + // does the file exist and can be read ? |
|
1095 | + if (is_readable($file_paths[ $key ])) { |
|
1096 | + return $file_paths[ $key ]; |
|
1097 | + } |
|
1098 | + } |
|
1099 | + return false; |
|
1100 | + } |
|
1101 | + |
|
1102 | + |
|
1103 | + /** |
|
1104 | + * basically just performs a require_once() |
|
1105 | + * but with some error handling |
|
1106 | + * |
|
1107 | + * @param string $path |
|
1108 | + * @param string $class_name |
|
1109 | + * @param string $type |
|
1110 | + * @param array $file_paths |
|
1111 | + * @return bool |
|
1112 | + * @throws EE_Error |
|
1113 | + * @throws ReflectionException |
|
1114 | + */ |
|
1115 | + protected function _require_file($path, $class_name, $type = '', $file_paths = array()) |
|
1116 | + { |
|
1117 | + $this->resolve_legacy_class_parent($class_name); |
|
1118 | + // don't give up! you gotta... |
|
1119 | + try { |
|
1120 | + // does the file exist and can it be read ? |
|
1121 | + if (! $path) { |
|
1122 | + // just in case the file has already been autoloaded, |
|
1123 | + // but discrepancies in the naming schema are preventing it from |
|
1124 | + // being loaded via one of the EE_Registry::load_*() methods, |
|
1125 | + // then let's try one last hail mary before throwing an exception |
|
1126 | + // and call class_exists() again, but with autoloading turned ON |
|
1127 | + if (class_exists($class_name)) { |
|
1128 | + return true; |
|
1129 | + } |
|
1130 | + // so sorry, can't find the file |
|
1131 | + throw new EE_Error( |
|
1132 | + sprintf( |
|
1133 | + esc_html__( |
|
1134 | + 'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', |
|
1135 | + 'event_espresso' |
|
1136 | + ), |
|
1137 | + trim($type, '.'), |
|
1138 | + $class_name, |
|
1139 | + '<br />' . implode(',<br />', $file_paths) |
|
1140 | + ) |
|
1141 | + ); |
|
1142 | + } |
|
1143 | + // get the file |
|
1144 | + require_once($path); |
|
1145 | + // if the class isn't already declared somewhere |
|
1146 | + if (class_exists($class_name, false) === false) { |
|
1147 | + // so sorry, not a class |
|
1148 | + throw new EE_Error( |
|
1149 | + sprintf( |
|
1150 | + esc_html__( |
|
1151 | + 'The %s file %s does not appear to contain the %s Class.', |
|
1152 | + 'event_espresso' |
|
1153 | + ), |
|
1154 | + $type, |
|
1155 | + $path, |
|
1156 | + $class_name |
|
1157 | + ) |
|
1158 | + ); |
|
1159 | + } |
|
1160 | + } catch (EE_Error $e) { |
|
1161 | + $e->get_error(); |
|
1162 | + return false; |
|
1163 | + } |
|
1164 | + return true; |
|
1165 | + } |
|
1166 | + |
|
1167 | + |
|
1168 | + /** |
|
1169 | + * Some of our legacy classes that extended a parent class would simply use a require() statement |
|
1170 | + * before their class declaration in order to ensure that the parent class was loaded. |
|
1171 | + * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class, |
|
1172 | + * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist. |
|
1173 | + * |
|
1174 | + * @param string $class_name |
|
1175 | + */ |
|
1176 | + protected function resolve_legacy_class_parent($class_name = '') |
|
1177 | + { |
|
1178 | + try { |
|
1179 | + $legacy_parent_class_map = array( |
|
1180 | + 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php', |
|
1181 | + ); |
|
1182 | + if (isset($legacy_parent_class_map[ $class_name ])) { |
|
1183 | + require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ]; |
|
1184 | + } |
|
1185 | + } catch (Exception $exception) { |
|
1186 | + } |
|
1187 | + } |
|
1188 | + |
|
1189 | + |
|
1190 | + /** |
|
1191 | + * _create_object |
|
1192 | + * Attempts to instantiate the requested class via any of the |
|
1193 | + * commonly used instantiation methods employed throughout EE. |
|
1194 | + * The priority for instantiation is as follows: |
|
1195 | + * - abstract classes or any class flagged as "load only" (no instantiation occurs) |
|
1196 | + * - model objects via their 'new_instance_from_db' method |
|
1197 | + * - model objects via their 'new_instance' method |
|
1198 | + * - "singleton" classes" via their 'instance' method |
|
1199 | + * - standard instantiable classes via their __constructor |
|
1200 | + * Prior to instantiation, if the classname exists in the dependency_map, |
|
1201 | + * then the constructor for the requested class will be examined to determine |
|
1202 | + * if any dependencies exist, and if they can be injected. |
|
1203 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
1204 | + * |
|
1205 | + * @param string $class_name |
|
1206 | + * @param array $arguments |
|
1207 | + * @param string $type |
|
1208 | + * @param bool $from_db |
|
1209 | + * @return null|object|bool |
|
1210 | + * @throws InvalidArgumentException |
|
1211 | + * @throws InvalidInterfaceException |
|
1212 | + * @throws EE_Error |
|
1213 | + * @throws ReflectionException |
|
1214 | + * @throws InvalidDataTypeException |
|
1215 | + */ |
|
1216 | + protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false) |
|
1217 | + { |
|
1218 | + // create reflection |
|
1219 | + $reflector = $this->mirror->getReflectionClass($class_name); |
|
1220 | + // make sure arguments are an array |
|
1221 | + $arguments = is_array($arguments) |
|
1222 | + ? $arguments |
|
1223 | + : array($arguments); |
|
1224 | + // and if arguments array is numerically and sequentially indexed, then we want it to remain as is, |
|
1225 | + // else wrap it in an additional array so that it doesn't get split into multiple parameters |
|
1226 | + $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments) |
|
1227 | + ? $arguments |
|
1228 | + : array($arguments); |
|
1229 | + // attempt to inject dependencies ? |
|
1230 | + if ($this->_dependency_map->has($class_name)) { |
|
1231 | + $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments); |
|
1232 | + } |
|
1233 | + // instantiate the class if possible |
|
1234 | + if ($reflector->isAbstract()) { |
|
1235 | + // nothing to instantiate, loading file was enough |
|
1236 | + // does not throw an exception so $instantiation_mode is unused |
|
1237 | + // $instantiation_mode = "1) no constructor abstract class"; |
|
1238 | + return true; |
|
1239 | + } |
|
1240 | + if (empty($arguments) |
|
1241 | + && $this->mirror->getConstructorFromReflection($reflector) === null |
|
1242 | + && $reflector->isInstantiable() |
|
1243 | + ) { |
|
1244 | + // no constructor = static methods only... nothing to instantiate, loading file was enough |
|
1245 | + // $instantiation_mode = "2) no constructor but instantiable"; |
|
1246 | + return $reflector->newInstance(); |
|
1247 | + } |
|
1248 | + if ($from_db && method_exists($class_name, 'new_instance_from_db')) { |
|
1249 | + // $instantiation_mode = "3) new_instance_from_db()"; |
|
1250 | + return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments); |
|
1251 | + } |
|
1252 | + if (method_exists($class_name, 'new_instance')) { |
|
1253 | + // $instantiation_mode = "4) new_instance()"; |
|
1254 | + return call_user_func_array(array($class_name, 'new_instance'), $arguments); |
|
1255 | + } |
|
1256 | + if (method_exists($class_name, 'instance')) { |
|
1257 | + // $instantiation_mode = "5) instance()"; |
|
1258 | + return call_user_func_array(array($class_name, 'instance'), $arguments); |
|
1259 | + } |
|
1260 | + if ($reflector->isInstantiable()) { |
|
1261 | + // $instantiation_mode = "6) constructor"; |
|
1262 | + return $reflector->newInstanceArgs($arguments); |
|
1263 | + } |
|
1264 | + // heh ? something's not right ! |
|
1265 | + throw new EE_Error( |
|
1266 | + sprintf( |
|
1267 | + __('The %s file %s could not be instantiated.', 'event_espresso'), |
|
1268 | + $type, |
|
1269 | + $class_name |
|
1270 | + ) |
|
1271 | + ); |
|
1272 | + } |
|
1273 | + |
|
1274 | + |
|
1275 | + /** |
|
1276 | + * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential |
|
1277 | + * @param array $array |
|
1278 | + * @return bool |
|
1279 | + */ |
|
1280 | + protected function _array_is_numerically_and_sequentially_indexed(array $array) |
|
1281 | + { |
|
1282 | + return ! empty($array) |
|
1283 | + ? array_keys($array) === range(0, count($array) - 1) |
|
1284 | + : true; |
|
1285 | + } |
|
1286 | + |
|
1287 | + |
|
1288 | + /** |
|
1289 | + * _resolve_dependencies |
|
1290 | + * examines the constructor for the requested class to determine |
|
1291 | + * if any dependencies exist, and if they can be injected. |
|
1292 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
1293 | + * PLZ NOTE: this is achieved by type hinting the constructor params |
|
1294 | + * For example: |
|
1295 | + * if attempting to load a class "Foo" with the following constructor: |
|
1296 | + * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
1297 | + * then $bar_class and $grohl_class will be added to the $arguments array, |
|
1298 | + * but only IF they are NOT already present in the incoming arguments array, |
|
1299 | + * and the correct classes can be loaded |
|
1300 | + * |
|
1301 | + * @param ReflectionClass $reflector |
|
1302 | + * @param string $class_name |
|
1303 | + * @param array $arguments |
|
1304 | + * @return array |
|
1305 | + * @throws InvalidArgumentException |
|
1306 | + * @throws InvalidDataTypeException |
|
1307 | + * @throws InvalidInterfaceException |
|
1308 | + * @throws ReflectionException |
|
1309 | + */ |
|
1310 | + protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array()) |
|
1311 | + { |
|
1312 | + // let's examine the constructor |
|
1313 | + $constructor = $this->mirror->getConstructorFromReflection($reflector); |
|
1314 | + // whu? huh? nothing? |
|
1315 | + if (! $constructor) { |
|
1316 | + return $arguments; |
|
1317 | + } |
|
1318 | + // get constructor parameters |
|
1319 | + $params = $this->mirror->getParametersFromReflection($reflector); |
|
1320 | + // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected |
|
1321 | + $argument_keys = array_keys($arguments); |
|
1322 | + // now loop thru all of the constructors expected parameters |
|
1323 | + foreach ($params as $index => $param) { |
|
1324 | + // is this a dependency for a specific class ? |
|
1325 | + $param_class = $this->mirror->getParameterClassName($param, $class_name, $index); |
|
1326 | + // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime) |
|
1327 | + $param_class = $this->class_cache->isAlias($param_class, $class_name) |
|
1328 | + ? $this->class_cache->getFqnForAlias($param_class, $class_name) |
|
1329 | + : $param_class; |
|
1330 | + if (// param is not even a class |
|
1331 | + $param_class === null |
|
1332 | + // and something already exists in the incoming arguments for this param |
|
1333 | + && array_key_exists($index, $argument_keys) |
|
1334 | + && array_key_exists($argument_keys[ $index ], $arguments) |
|
1335 | + ) { |
|
1336 | + // so let's skip this argument and move on to the next |
|
1337 | + continue; |
|
1338 | + } |
|
1339 | + if (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class |
|
1340 | + $param_class !== null |
|
1341 | + && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ]) |
|
1342 | + && $arguments[ $argument_keys[ $index ] ] instanceof $param_class |
|
1343 | + ) { |
|
1344 | + // skip this argument and move on to the next |
|
1345 | + continue; |
|
1346 | + } |
|
1347 | + if (// parameter is type hinted as a class, and should be injected |
|
1348 | + $param_class !== null |
|
1349 | + && $this->_dependency_map->has_dependency_for_class($class_name, $param_class) |
|
1350 | + ) { |
|
1351 | + $arguments = $this->_resolve_dependency( |
|
1352 | + $class_name, |
|
1353 | + $param_class, |
|
1354 | + $arguments, |
|
1355 | + $index |
|
1356 | + ); |
|
1357 | + } else { |
|
1358 | + $arguments[ $index ] = $this->mirror->getParameterDefaultValue( |
|
1359 | + $param, |
|
1360 | + $class_name, |
|
1361 | + $index |
|
1362 | + ); |
|
1363 | + } |
|
1364 | + } |
|
1365 | + return $arguments; |
|
1366 | + } |
|
1367 | + |
|
1368 | + |
|
1369 | + /** |
|
1370 | + * @param string $class_name |
|
1371 | + * @param string $param_class |
|
1372 | + * @param array $arguments |
|
1373 | + * @param mixed $index |
|
1374 | + * @return array |
|
1375 | + * @throws InvalidArgumentException |
|
1376 | + * @throws InvalidInterfaceException |
|
1377 | + * @throws InvalidDataTypeException |
|
1378 | + */ |
|
1379 | + protected function _resolve_dependency($class_name, $param_class, $arguments, $index) |
|
1380 | + { |
|
1381 | + $dependency = null; |
|
1382 | + // should dependency be loaded from cache ? |
|
1383 | + $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency( |
|
1384 | + $class_name, |
|
1385 | + $param_class |
|
1386 | + ); |
|
1387 | + $cache_on = $cache_on !== EE_Dependency_Map::load_new_object; |
|
1388 | + // we might have a dependency... |
|
1389 | + // let's MAYBE try and find it in our cache if that's what's been requested |
|
1390 | + $cached_class = $cache_on |
|
1391 | + ? $this->_get_cached_class($param_class) |
|
1392 | + : null; |
|
1393 | + // and grab it if it exists |
|
1394 | + if ($cached_class instanceof $param_class) { |
|
1395 | + $dependency = $cached_class; |
|
1396 | + } elseif ($param_class !== $class_name) { |
|
1397 | + // obtain the loader method from the dependency map |
|
1398 | + $loader = $this->_dependency_map->class_loader($param_class); |
|
1399 | + // is loader a custom closure ? |
|
1400 | + if ($loader instanceof Closure) { |
|
1401 | + $dependency = $loader($arguments); |
|
1402 | + } else { |
|
1403 | + // set the cache on property for the recursive loading call |
|
1404 | + $this->_cache_on = $cache_on; |
|
1405 | + // if not, then let's try and load it via the registry |
|
1406 | + if ($loader && method_exists($this, $loader)) { |
|
1407 | + $dependency = $this->{$loader}($param_class); |
|
1408 | + } else { |
|
1409 | + $dependency = LoaderFactory::getLoader()->load( |
|
1410 | + $param_class, |
|
1411 | + array(), |
|
1412 | + $cache_on |
|
1413 | + ); |
|
1414 | + } |
|
1415 | + } |
|
1416 | + } |
|
1417 | + // did we successfully find the correct dependency ? |
|
1418 | + if ($dependency instanceof $param_class) { |
|
1419 | + // then let's inject it into the incoming array of arguments at the correct location |
|
1420 | + $arguments[ $index ] = $dependency; |
|
1421 | + } |
|
1422 | + return $arguments; |
|
1423 | + } |
|
1424 | + |
|
1425 | + |
|
1426 | + /** |
|
1427 | + * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array |
|
1428 | + * |
|
1429 | + * @param string $classname PLEASE NOTE: the class name needs to match what's registered |
|
1430 | + * in the EE_Dependency_Map::$_class_loaders array, |
|
1431 | + * including the class prefix, ie: "EE_", "EEM_", "EEH_", etc |
|
1432 | + * @param array $arguments |
|
1433 | + * @return object |
|
1434 | + */ |
|
1435 | + public static function factory($classname, $arguments = array()) |
|
1436 | + { |
|
1437 | + $loader = self::instance()->_dependency_map->class_loader($classname); |
|
1438 | + if ($loader instanceof Closure) { |
|
1439 | + return $loader($arguments); |
|
1440 | + } |
|
1441 | + if (method_exists(self::instance(), $loader)) { |
|
1442 | + return self::instance()->{$loader}($classname, $arguments); |
|
1443 | + } |
|
1444 | + return null; |
|
1445 | + } |
|
1446 | + |
|
1447 | + |
|
1448 | + /** |
|
1449 | + * Gets the addon by its class name |
|
1450 | + * |
|
1451 | + * @param string $class_name |
|
1452 | + * @return EE_Addon |
|
1453 | + */ |
|
1454 | + public function getAddon($class_name) |
|
1455 | + { |
|
1456 | + $class_name = str_replace('\\', '_', $class_name); |
|
1457 | + return $this->addons->{$class_name}; |
|
1458 | + } |
|
1459 | + |
|
1460 | + |
|
1461 | + /** |
|
1462 | + * removes the addon from the internal cache |
|
1463 | + * |
|
1464 | + * @param string $class_name |
|
1465 | + * @return void |
|
1466 | + */ |
|
1467 | + public function removeAddon($class_name) |
|
1468 | + { |
|
1469 | + $class_name = str_replace('\\', '_', $class_name); |
|
1470 | + unset($this->addons->{$class_name}); |
|
1471 | + } |
|
1472 | + |
|
1473 | + |
|
1474 | + /** |
|
1475 | + * Gets the addon by its name/slug (not classname. For that, just |
|
1476 | + * use the get_addon() method above |
|
1477 | + * |
|
1478 | + * @param string $name |
|
1479 | + * @return EE_Addon |
|
1480 | + */ |
|
1481 | + public function get_addon_by_name($name) |
|
1482 | + { |
|
1483 | + foreach ($this->addons as $addon) { |
|
1484 | + if ($addon->name() === $name) { |
|
1485 | + return $addon; |
|
1486 | + } |
|
1487 | + } |
|
1488 | + return null; |
|
1489 | + } |
|
1490 | + |
|
1491 | + |
|
1492 | + /** |
|
1493 | + * Gets an array of all the registered addons, where the keys are their names. |
|
1494 | + * (ie, what each returns for their name() function) |
|
1495 | + * They're already available on EE_Registry::instance()->addons as properties, |
|
1496 | + * where each property's name is the addon's classname, |
|
1497 | + * So if you just want to get the addon by classname, |
|
1498 | + * OR use the get_addon() method above. |
|
1499 | + * PLEASE NOTE: |
|
1500 | + * addons with Fully Qualified Class Names |
|
1501 | + * have had the namespace separators converted to underscores, |
|
1502 | + * so a classname like Fully\Qualified\ClassName |
|
1503 | + * would have been converted to Fully_Qualified_ClassName |
|
1504 | + * |
|
1505 | + * @return EE_Addon[] where the KEYS are the addon's name() |
|
1506 | + */ |
|
1507 | + public function get_addons_by_name() |
|
1508 | + { |
|
1509 | + $addons = array(); |
|
1510 | + foreach ($this->addons as $addon) { |
|
1511 | + $addons[ $addon->name() ] = $addon; |
|
1512 | + } |
|
1513 | + return $addons; |
|
1514 | + } |
|
1515 | + |
|
1516 | + |
|
1517 | + /** |
|
1518 | + * Resets the specified model's instance AND makes sure EE_Registry doesn't keep |
|
1519 | + * a stale copy of it around |
|
1520 | + * |
|
1521 | + * @param string $model_name |
|
1522 | + * @return \EEM_Base |
|
1523 | + * @throws \EE_Error |
|
1524 | + */ |
|
1525 | + public function reset_model($model_name) |
|
1526 | + { |
|
1527 | + $model_class_name = strpos($model_name, 'EEM_') !== 0 |
|
1528 | + ? "EEM_{$model_name}" |
|
1529 | + : $model_name; |
|
1530 | + if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
1531 | + return null; |
|
1532 | + } |
|
1533 | + // get that model reset it and make sure we nuke the old reference to it |
|
1534 | + if ($this->LIB->{$model_class_name} instanceof $model_class_name |
|
1535 | + && is_callable( |
|
1536 | + array($model_class_name, 'reset') |
|
1537 | + )) { |
|
1538 | + $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset(); |
|
1539 | + } else { |
|
1540 | + throw new EE_Error( |
|
1541 | + sprintf( |
|
1542 | + esc_html__('Model %s does not have a method "reset"', 'event_espresso'), |
|
1543 | + $model_name |
|
1544 | + ) |
|
1545 | + ); |
|
1546 | + } |
|
1547 | + return $this->LIB->{$model_class_name}; |
|
1548 | + } |
|
1549 | + |
|
1550 | + |
|
1551 | + /** |
|
1552 | + * Resets the registry. |
|
1553 | + * The criteria for what gets reset is based on what can be shared between sites on the same request when |
|
1554 | + * switch_to_blog is used in a multisite install. Here is a list of things that are NOT reset. |
|
1555 | + * - $_dependency_map |
|
1556 | + * - $_class_abbreviations |
|
1557 | + * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset. |
|
1558 | + * - $REQ: Still on the same request so no need to change. |
|
1559 | + * - $CAP: There is no site specific state in the EE_Capability class. |
|
1560 | + * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only |
|
1561 | + * one Session can be active in a single request. Resetting could resolve in "headers already sent" errors. |
|
1562 | + * - $addons: In multisite, the state of the addons is something controlled via hooks etc in a normal request. So |
|
1563 | + * for now, we won't reset the addons because it could break calls to an add-ons class/methods in the |
|
1564 | + * switch or on the restore. |
|
1565 | + * - $modules |
|
1566 | + * - $shortcodes |
|
1567 | + * - $widgets |
|
1568 | + * |
|
1569 | + * @param boolean $hard [deprecated] |
|
1570 | + * @param boolean $reinstantiate whether to create new instances of EE_Registry's singletons too, |
|
1571 | + * or just reset without re-instantiating (handy to set to FALSE if you're not |
|
1572 | + * sure if you CAN currently reinstantiate the singletons at the moment) |
|
1573 | + * @param bool $reset_models Defaults to true. When false, then the models are not reset. This is so |
|
1574 | + * client |
|
1575 | + * code instead can just change the model context to a different blog id if |
|
1576 | + * necessary |
|
1577 | + * @return EE_Registry |
|
1578 | + * @throws InvalidInterfaceException |
|
1579 | + * @throws InvalidDataTypeException |
|
1580 | + * @throws EE_Error |
|
1581 | + * @throws ReflectionException |
|
1582 | + * @throws InvalidArgumentException |
|
1583 | + */ |
|
1584 | + public static function reset($hard = false, $reinstantiate = true, $reset_models = true) |
|
1585 | + { |
|
1586 | + $instance = self::instance(); |
|
1587 | + $instance->_cache_on = true; |
|
1588 | + // reset some "special" classes |
|
1589 | + EEH_Activation::reset(); |
|
1590 | + $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard); |
|
1591 | + $instance->CFG = EE_Config::reset($hard, $reinstantiate); |
|
1592 | + $instance->CART = null; |
|
1593 | + $instance->MRM = null; |
|
1594 | + $instance->AssetsRegistry = LoaderFactory::getLoader()->getShared( |
|
1595 | + 'EventEspresso\core\services\assets\Registry' |
|
1596 | + ); |
|
1597 | + // messages reset |
|
1598 | + EED_Messages::reset(); |
|
1599 | + // handle of objects cached on LIB |
|
1600 | + foreach (array('LIB', 'modules') as $cache) { |
|
1601 | + foreach ($instance->{$cache} as $class_name => $class) { |
|
1602 | + if (self::_reset_and_unset_object($class, $reset_models)) { |
|
1603 | + unset($instance->{$cache}->{$class_name}); |
|
1604 | + } |
|
1605 | + } |
|
1606 | + } |
|
1607 | + return $instance; |
|
1608 | + } |
|
1609 | + |
|
1610 | + |
|
1611 | + /** |
|
1612 | + * if passed object implements ResettableInterface, then call it's reset() method |
|
1613 | + * if passed object implements InterminableInterface, then return false, |
|
1614 | + * to indicate that it should NOT be cleared from the Registry cache |
|
1615 | + * |
|
1616 | + * @param $object |
|
1617 | + * @param bool $reset_models |
|
1618 | + * @return bool returns true if cached object should be unset |
|
1619 | + */ |
|
1620 | + private static function _reset_and_unset_object($object, $reset_models) |
|
1621 | + { |
|
1622 | + if (! is_object($object)) { |
|
1623 | + // don't unset anything that's not an object |
|
1624 | + return false; |
|
1625 | + } |
|
1626 | + if ($object instanceof EED_Module) { |
|
1627 | + $object::reset(); |
|
1628 | + // don't unset modules |
|
1629 | + return false; |
|
1630 | + } |
|
1631 | + if ($object instanceof ResettableInterface) { |
|
1632 | + if ($object instanceof EEM_Base) { |
|
1633 | + if ($reset_models) { |
|
1634 | + $object->reset(); |
|
1635 | + return true; |
|
1636 | + } |
|
1637 | + return false; |
|
1638 | + } |
|
1639 | + $object->reset(); |
|
1640 | + return true; |
|
1641 | + } |
|
1642 | + if (! $object instanceof InterminableInterface) { |
|
1643 | + return true; |
|
1644 | + } |
|
1645 | + return false; |
|
1646 | + } |
|
1647 | + |
|
1648 | + |
|
1649 | + /** |
|
1650 | + * Gets all the custom post type models defined |
|
1651 | + * |
|
1652 | + * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event") |
|
1653 | + */ |
|
1654 | + public function cpt_models() |
|
1655 | + { |
|
1656 | + $cpt_models = array(); |
|
1657 | + foreach ($this->non_abstract_db_models as $short_name => $classname) { |
|
1658 | + if (is_subclass_of($classname, 'EEM_CPT_Base')) { |
|
1659 | + $cpt_models[ $short_name ] = $classname; |
|
1660 | + } |
|
1661 | + } |
|
1662 | + return $cpt_models; |
|
1663 | + } |
|
1664 | + |
|
1665 | + |
|
1666 | + /** |
|
1667 | + * @return \EE_Config |
|
1668 | + */ |
|
1669 | + public static function CFG() |
|
1670 | + { |
|
1671 | + return self::instance()->CFG; |
|
1672 | + } |
|
1673 | + |
|
1674 | + |
|
1675 | + /** |
|
1676 | + * @deprecated 4.9.62.p |
|
1677 | + * @param string $class_name |
|
1678 | + * @return ReflectionClass |
|
1679 | + * @throws ReflectionException |
|
1680 | + * @throws InvalidDataTypeException |
|
1681 | + */ |
|
1682 | + public function get_ReflectionClass($class_name) |
|
1683 | + { |
|
1684 | + return $this->mirror->getReflectionClass($class_name); |
|
1685 | + } |
|
1686 | 1686 | } |