@@ -22,30 +22,30 @@ |
||
22 | 22 | |
23 | 23 | interface JobHandlerInterface |
24 | 24 | { |
25 | - /** |
|
26 | - * Performs any necessary setup for starting the job. This is also a good |
|
27 | - * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
28 | - * when continue_job will be called |
|
29 | - * @param JobParameters $job_parameters |
|
30 | - * @throws BatchRequestException |
|
31 | - * @return JobStepResponse |
|
32 | - */ |
|
33 | - public function create_job(JobParameters $job_parameters); |
|
25 | + /** |
|
26 | + * Performs any necessary setup for starting the job. This is also a good |
|
27 | + * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
28 | + * when continue_job will be called |
|
29 | + * @param JobParameters $job_parameters |
|
30 | + * @throws BatchRequestException |
|
31 | + * @return JobStepResponse |
|
32 | + */ |
|
33 | + public function create_job(JobParameters $job_parameters); |
|
34 | 34 | |
35 | - /** |
|
36 | - * Performs another step of the job |
|
37 | - * @param JobParameters $job_parameters |
|
38 | - * @param int $batch_size |
|
39 | - * @return JobStepResponse |
|
40 | - * @throws BatchRequestException |
|
41 | - */ |
|
42 | - public function continue_job(JobParameters $job_parameters, $batch_size = 50); |
|
35 | + /** |
|
36 | + * Performs another step of the job |
|
37 | + * @param JobParameters $job_parameters |
|
38 | + * @param int $batch_size |
|
39 | + * @return JobStepResponse |
|
40 | + * @throws BatchRequestException |
|
41 | + */ |
|
42 | + public function continue_job(JobParameters $job_parameters, $batch_size = 50); |
|
43 | 43 | |
44 | - /** |
|
45 | - * Performs any clean-up logic when we know the job is completed |
|
46 | - * @param JobParameters $job_parameters |
|
47 | - * @return JobStepResponse |
|
48 | - * @throws BatchRequestException |
|
49 | - */ |
|
50 | - public function cleanup_job(JobParameters $job_parameters); |
|
44 | + /** |
|
45 | + * Performs any clean-up logic when we know the job is completed |
|
46 | + * @param JobParameters $job_parameters |
|
47 | + * @return JobStepResponse |
|
48 | + * @throws BatchRequestException |
|
49 | + */ |
|
50 | + public function cleanup_job(JobParameters $job_parameters); |
|
51 | 51 | } |
@@ -71,7 +71,7 @@ discard block |
||
71 | 71 | */ |
72 | 72 | public function set_notice($key, $value) |
73 | 73 | { |
74 | - $this->_notice[ $key ] = $value; |
|
74 | + $this->_notice[$key] = $value; |
|
75 | 75 | } |
76 | 76 | |
77 | 77 | |
@@ -82,7 +82,7 @@ discard block |
||
82 | 82 | */ |
83 | 83 | public function get_notice($key) |
84 | 84 | { |
85 | - return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null; |
|
85 | + return isset($this->_notice[$key]) ? $this->_notice[$key] : null; |
|
86 | 86 | } |
87 | 87 | |
88 | 88 | |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | */ |
104 | 104 | public function add_output($string, $append = true) |
105 | 105 | { |
106 | - $this->_output = $append ? $this->_output . $string : $string . $this->_output; |
|
106 | + $this->_output = $append ? $this->_output.$string : $string.$this->_output; |
|
107 | 107 | } |
108 | 108 | |
109 | 109 |
@@ -12,146 +12,146 @@ |
||
12 | 12 | */ |
13 | 13 | class EE_Response |
14 | 14 | { |
15 | - /** |
|
16 | - * @access protected |
|
17 | - * @type array $_notice |
|
18 | - */ |
|
19 | - protected $_notice = array(); |
|
20 | - |
|
21 | - /** |
|
22 | - * rendered output to be returned to WP |
|
23 | - * |
|
24 | - * @access protected |
|
25 | - * @type string |
|
26 | - */ |
|
27 | - protected $_output = ''; |
|
28 | - |
|
29 | - /** |
|
30 | - * @access protected |
|
31 | - * @type bool |
|
32 | - */ |
|
33 | - protected $request_terminated = false; |
|
34 | - |
|
35 | - /** |
|
36 | - * @access protected |
|
37 | - * @type bool |
|
38 | - */ |
|
39 | - protected $deactivate_plugin = false; |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * @deprecated 4.9.53 |
|
44 | - * @return \EE_Response |
|
45 | - */ |
|
46 | - public function __construct() |
|
47 | - { |
|
48 | - $this->terminate_request(false); |
|
49 | - EE_Error::doing_it_wrong( |
|
50 | - __METHOD__, |
|
51 | - sprintf( |
|
52 | - esc_html__( |
|
53 | - 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
54 | - 'event_espresso' |
|
55 | - ), |
|
56 | - 'EventEspresso\core\services\request\Response', |
|
57 | - '\core\services\request', |
|
58 | - 'EventEspresso\core\services\request' |
|
59 | - ), |
|
60 | - '4.9.53' |
|
61 | - ); |
|
62 | - } |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * @deprecated 4.9.53 |
|
67 | - * @param $key |
|
68 | - * @param $value |
|
69 | - * @return void |
|
70 | - */ |
|
71 | - public function set_notice($key, $value) |
|
72 | - { |
|
73 | - $this->_notice[ $key ] = $value; |
|
74 | - } |
|
75 | - |
|
76 | - |
|
77 | - /** |
|
78 | - * @deprecated 4.9.53 |
|
79 | - * @param $key |
|
80 | - * @return mixed |
|
81 | - */ |
|
82 | - public function get_notice($key) |
|
83 | - { |
|
84 | - return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null; |
|
85 | - } |
|
86 | - |
|
87 | - |
|
88 | - /** |
|
89 | - * @deprecated 4.9.53 |
|
90 | - * @return array |
|
91 | - */ |
|
92 | - public function get_notices() |
|
93 | - { |
|
94 | - return $this->_notice; |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * @deprecated 4.9.53 |
|
100 | - * @param $string |
|
101 | - * @param bool $append |
|
102 | - */ |
|
103 | - public function add_output($string, $append = true) |
|
104 | - { |
|
105 | - $this->_output = $append ? $this->_output . $string : $string . $this->_output; |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @deprecated 4.9.53 |
|
111 | - * @return string |
|
112 | - */ |
|
113 | - public function get_output() |
|
114 | - { |
|
115 | - return $this->_output; |
|
116 | - } |
|
117 | - |
|
118 | - |
|
119 | - /** |
|
120 | - * @deprecated 4.9.53 |
|
121 | - * @return boolean |
|
122 | - */ |
|
123 | - public function request_terminated() |
|
124 | - { |
|
125 | - return $this->request_terminated; |
|
126 | - } |
|
127 | - |
|
128 | - |
|
129 | - /** |
|
130 | - * @deprecated 4.9.53 |
|
131 | - * @param boolean $request_terminated |
|
132 | - */ |
|
133 | - public function terminate_request($request_terminated = true) |
|
134 | - { |
|
135 | - $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN); |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @deprecated 4.9.53 |
|
141 | - * @return boolean |
|
142 | - */ |
|
143 | - public function plugin_deactivated() |
|
144 | - { |
|
145 | - return $this->deactivate_plugin; |
|
146 | - } |
|
147 | - |
|
148 | - |
|
149 | - /** |
|
150 | - * @deprecated 4.9.53 |
|
151 | - * sets $deactivate_plugin to true |
|
152 | - */ |
|
153 | - public function deactivate_plugin() |
|
154 | - { |
|
155 | - $this->deactivate_plugin = true; |
|
156 | - } |
|
15 | + /** |
|
16 | + * @access protected |
|
17 | + * @type array $_notice |
|
18 | + */ |
|
19 | + protected $_notice = array(); |
|
20 | + |
|
21 | + /** |
|
22 | + * rendered output to be returned to WP |
|
23 | + * |
|
24 | + * @access protected |
|
25 | + * @type string |
|
26 | + */ |
|
27 | + protected $_output = ''; |
|
28 | + |
|
29 | + /** |
|
30 | + * @access protected |
|
31 | + * @type bool |
|
32 | + */ |
|
33 | + protected $request_terminated = false; |
|
34 | + |
|
35 | + /** |
|
36 | + * @access protected |
|
37 | + * @type bool |
|
38 | + */ |
|
39 | + protected $deactivate_plugin = false; |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * @deprecated 4.9.53 |
|
44 | + * @return \EE_Response |
|
45 | + */ |
|
46 | + public function __construct() |
|
47 | + { |
|
48 | + $this->terminate_request(false); |
|
49 | + EE_Error::doing_it_wrong( |
|
50 | + __METHOD__, |
|
51 | + sprintf( |
|
52 | + esc_html__( |
|
53 | + 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
54 | + 'event_espresso' |
|
55 | + ), |
|
56 | + 'EventEspresso\core\services\request\Response', |
|
57 | + '\core\services\request', |
|
58 | + 'EventEspresso\core\services\request' |
|
59 | + ), |
|
60 | + '4.9.53' |
|
61 | + ); |
|
62 | + } |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * @deprecated 4.9.53 |
|
67 | + * @param $key |
|
68 | + * @param $value |
|
69 | + * @return void |
|
70 | + */ |
|
71 | + public function set_notice($key, $value) |
|
72 | + { |
|
73 | + $this->_notice[ $key ] = $value; |
|
74 | + } |
|
75 | + |
|
76 | + |
|
77 | + /** |
|
78 | + * @deprecated 4.9.53 |
|
79 | + * @param $key |
|
80 | + * @return mixed |
|
81 | + */ |
|
82 | + public function get_notice($key) |
|
83 | + { |
|
84 | + return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null; |
|
85 | + } |
|
86 | + |
|
87 | + |
|
88 | + /** |
|
89 | + * @deprecated 4.9.53 |
|
90 | + * @return array |
|
91 | + */ |
|
92 | + public function get_notices() |
|
93 | + { |
|
94 | + return $this->_notice; |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * @deprecated 4.9.53 |
|
100 | + * @param $string |
|
101 | + * @param bool $append |
|
102 | + */ |
|
103 | + public function add_output($string, $append = true) |
|
104 | + { |
|
105 | + $this->_output = $append ? $this->_output . $string : $string . $this->_output; |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @deprecated 4.9.53 |
|
111 | + * @return string |
|
112 | + */ |
|
113 | + public function get_output() |
|
114 | + { |
|
115 | + return $this->_output; |
|
116 | + } |
|
117 | + |
|
118 | + |
|
119 | + /** |
|
120 | + * @deprecated 4.9.53 |
|
121 | + * @return boolean |
|
122 | + */ |
|
123 | + public function request_terminated() |
|
124 | + { |
|
125 | + return $this->request_terminated; |
|
126 | + } |
|
127 | + |
|
128 | + |
|
129 | + /** |
|
130 | + * @deprecated 4.9.53 |
|
131 | + * @param boolean $request_terminated |
|
132 | + */ |
|
133 | + public function terminate_request($request_terminated = true) |
|
134 | + { |
|
135 | + $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN); |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @deprecated 4.9.53 |
|
141 | + * @return boolean |
|
142 | + */ |
|
143 | + public function plugin_deactivated() |
|
144 | + { |
|
145 | + return $this->deactivate_plugin; |
|
146 | + } |
|
147 | + |
|
148 | + |
|
149 | + /** |
|
150 | + * @deprecated 4.9.53 |
|
151 | + * sets $deactivate_plugin to true |
|
152 | + */ |
|
153 | + public function deactivate_plugin() |
|
154 | + { |
|
155 | + $this->deactivate_plugin = true; |
|
156 | + } |
|
157 | 157 | } |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | // what shortcode was actually parsed ? |
105 | 105 | $shortcode_class = get_called_class(); |
106 | 106 | // notify rest of system that fallback processor was triggered |
107 | - add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true'); |
|
107 | + add_filter('FHEE__fallback_shortcode_processor__'.$shortcode_class, '__return_true'); |
|
108 | 108 | // get instance of actual shortcode |
109 | 109 | $shortcode_obj = self::instance($shortcode_class); |
110 | 110 | // verify class |
@@ -159,13 +159,13 @@ discard block |
||
159 | 159 | { |
160 | 160 | foreach ($attributes as $key => $value) { |
161 | 161 | // is a custom sanitization callback specified ? |
162 | - if (isset($custom_sanitization[ $key ])) { |
|
163 | - $callback = $custom_sanitization[ $key ]; |
|
162 | + if (isset($custom_sanitization[$key])) { |
|
163 | + $callback = $custom_sanitization[$key]; |
|
164 | 164 | if ($callback === 'skip_sanitization') { |
165 | - $attributes[ $key ] = $value; |
|
165 | + $attributes[$key] = $value; |
|
166 | 166 | continue; |
167 | 167 | } elseif (function_exists($callback)) { |
168 | - $attributes[ $key ] = $callback($value); |
|
168 | + $attributes[$key] = $callback($value); |
|
169 | 169 | continue; |
170 | 170 | } |
171 | 171 | } |
@@ -175,18 +175,18 @@ discard block |
||
175 | 175 | case is_float($value): |
176 | 176 | // typical booleans |
177 | 177 | case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true): |
178 | - $attributes[ $key ] = $value; |
|
178 | + $attributes[$key] = $value; |
|
179 | 179 | break; |
180 | 180 | case is_string($value): |
181 | - $attributes[ $key ] = sanitize_text_field($value); |
|
181 | + $attributes[$key] = sanitize_text_field($value); |
|
182 | 182 | break; |
183 | 183 | case is_array($value): |
184 | - $attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value); |
|
184 | + $attributes[$key] = \EES_Shortcode::sanitize_attributes($value); |
|
185 | 185 | break; |
186 | 186 | default: |
187 | 187 | // only remaining data types are Object and Resource |
188 | 188 | // which are not allowed as shortcode attributes |
189 | - $attributes[ $key ] = null; |
|
189 | + $attributes[$key] = null; |
|
190 | 190 | break; |
191 | 191 | } |
192 | 192 | } |
@@ -14,186 +14,186 @@ |
||
14 | 14 | */ |
15 | 15 | abstract class EES_Shortcode extends EE_Base |
16 | 16 | { |
17 | - /** |
|
18 | - * @protected public |
|
19 | - * @var array $_attributes |
|
20 | - */ |
|
21 | - protected $_attributes = array(); |
|
22 | - |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * class constructor - should ONLY be instantiated by EE_Front_Controller |
|
27 | - */ |
|
28 | - final public function __construct() |
|
29 | - { |
|
30 | - $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this)); |
|
31 | - // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier |
|
32 | - add_shortcode($shortcode, array($this, 'process_shortcode')); |
|
33 | - // make sure system knows this is an EE page |
|
34 | - /** @var CurrentPage $current_page */ |
|
35 | - $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class); |
|
36 | - $current_page->setEspressoPage(true); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - |
|
41 | - /** |
|
42 | - * run - initial shortcode module setup called during "parse_request" hook by |
|
43 | - * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request ! |
|
44 | - * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented |
|
45 | - * by a theme or plugin in a non-standard way. |
|
46 | - * Basically this method is primarily used for loading resources and assets like CSS or JS |
|
47 | - * that will be required by the shortcode when it is actually processed. |
|
48 | - * Please note that assets may not load if the fallback_shortcode_processor() is being used. |
|
49 | - * |
|
50 | - * @access public |
|
51 | - * @param WP $WP |
|
52 | - * @return void |
|
53 | - */ |
|
54 | - abstract public function run(WP $WP); |
|
55 | - |
|
56 | - |
|
57 | - |
|
58 | - /** |
|
59 | - * process_shortcode |
|
60 | - * this method is the callback function for the actual shortcode, and is what runs when WP encounters the shortcode within the_content |
|
61 | - * |
|
62 | - * @access public |
|
63 | - * @param array $attributes |
|
64 | - * @return mixed |
|
65 | - */ |
|
66 | - abstract public function process_shortcode($attributes = array()); |
|
67 | - |
|
68 | - |
|
69 | - |
|
70 | - /** |
|
71 | - * instance - returns instance of child class object |
|
72 | - * |
|
73 | - * @access public |
|
74 | - * @param string $shortcode_class |
|
75 | - * @return \EES_Shortcode |
|
76 | - */ |
|
77 | - final public static function instance($shortcode_class = null) |
|
78 | - { |
|
79 | - $shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class(); |
|
80 | - if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) { |
|
81 | - return null; |
|
82 | - } |
|
83 | - $shortcode = str_replace('EES_', '', strtoupper($shortcode_class)); |
|
84 | - $shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode}) |
|
85 | - ? EE_Registry::instance()->shortcodes->{$shortcode} |
|
86 | - : null; |
|
87 | - return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self' |
|
88 | - ? $shortcode_obj |
|
89 | - : new $shortcode_class(); |
|
90 | - } |
|
91 | - |
|
92 | - |
|
93 | - |
|
94 | - |
|
95 | - /** |
|
96 | - * fallback_shortcode_processor - create instance and call process_shortcode |
|
97 | - * NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things work at all |
|
98 | - * |
|
99 | - * @access public |
|
100 | - * @param $attributes |
|
101 | - * @return mixed |
|
102 | - */ |
|
103 | - final public static function fallback_shortcode_processor($attributes) |
|
104 | - { |
|
105 | - if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) { |
|
106 | - return null; |
|
107 | - } |
|
108 | - // what shortcode was actually parsed ? |
|
109 | - $shortcode_class = get_called_class(); |
|
110 | - // notify rest of system that fallback processor was triggered |
|
111 | - add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true'); |
|
112 | - // get instance of actual shortcode |
|
113 | - $shortcode_obj = self::instance($shortcode_class); |
|
114 | - // verify class |
|
115 | - if ($shortcode_obj instanceof EES_Shortcode) { |
|
116 | - global $wp; |
|
117 | - $shortcode_obj->run($wp); |
|
118 | - // set attributes and run the shortcode |
|
119 | - $shortcode_obj->_attributes = (array) $attributes; |
|
120 | - return $shortcode_obj->process_shortcode($shortcode_obj->_attributes); |
|
121 | - } else { |
|
122 | - return null; |
|
123 | - } |
|
124 | - } |
|
125 | - |
|
126 | - |
|
127 | - |
|
128 | - |
|
129 | - /** |
|
130 | - * invalid_shortcode_processor - used in cases where we know the shortcode is invalid, most likely due to a deactivated addon, and simply returns an empty string |
|
131 | - * |
|
132 | - * @access public |
|
133 | - * @param $attributes |
|
134 | - * @return string |
|
135 | - */ |
|
136 | - final public static function invalid_shortcode_processor($attributes) |
|
137 | - { |
|
138 | - return ''; |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - |
|
143 | - |
|
144 | - |
|
145 | - /** |
|
146 | - * Performs basic sanitization on shortcode attributes |
|
147 | - * Since incoming attributes from the shortcode usage in the WP editor will all be strings, |
|
148 | - * most attributes will by default be sanitized using the sanitize_text_field() function. |
|
149 | - * This can be overridden by supplying an array for the $custom_sanitization param, |
|
150 | - * where keys match keys in your attributes array, |
|
151 | - * and values represent the sanitization function you wish to be applied to that attribute. |
|
152 | - * So for example, if you had an integer attribute named "event_id" |
|
153 | - * that you wanted to be sanitized using absint(), |
|
154 | - * then you would pass the following for your $custom_sanitization array: |
|
155 | - * array('event_id' => 'absint') |
|
156 | - * all other attributes would be sanitized using the defaults in the switch statement below |
|
157 | - * |
|
158 | - * @param array $attributes |
|
159 | - * @param array $custom_sanitization |
|
160 | - * @return array |
|
161 | - */ |
|
162 | - public static function sanitize_attributes(array $attributes, $custom_sanitization = array()) |
|
163 | - { |
|
164 | - foreach ($attributes as $key => $value) { |
|
165 | - // is a custom sanitization callback specified ? |
|
166 | - if (isset($custom_sanitization[ $key ])) { |
|
167 | - $callback = $custom_sanitization[ $key ]; |
|
168 | - if ($callback === 'skip_sanitization') { |
|
169 | - $attributes[ $key ] = $value; |
|
170 | - continue; |
|
171 | - } elseif (function_exists($callback)) { |
|
172 | - $attributes[ $key ] = $callback($value); |
|
173 | - continue; |
|
174 | - } |
|
175 | - } |
|
176 | - switch (true) { |
|
177 | - case $value === null: |
|
178 | - case is_int($value): |
|
179 | - case is_float($value): |
|
180 | - // typical booleans |
|
181 | - case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true): |
|
182 | - $attributes[ $key ] = $value; |
|
183 | - break; |
|
184 | - case is_string($value): |
|
185 | - $attributes[ $key ] = sanitize_text_field($value); |
|
186 | - break; |
|
187 | - case is_array($value): |
|
188 | - $attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value); |
|
189 | - break; |
|
190 | - default: |
|
191 | - // only remaining data types are Object and Resource |
|
192 | - // which are not allowed as shortcode attributes |
|
193 | - $attributes[ $key ] = null; |
|
194 | - break; |
|
195 | - } |
|
196 | - } |
|
197 | - return $attributes; |
|
198 | - } |
|
17 | + /** |
|
18 | + * @protected public |
|
19 | + * @var array $_attributes |
|
20 | + */ |
|
21 | + protected $_attributes = array(); |
|
22 | + |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * class constructor - should ONLY be instantiated by EE_Front_Controller |
|
27 | + */ |
|
28 | + final public function __construct() |
|
29 | + { |
|
30 | + $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this)); |
|
31 | + // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier |
|
32 | + add_shortcode($shortcode, array($this, 'process_shortcode')); |
|
33 | + // make sure system knows this is an EE page |
|
34 | + /** @var CurrentPage $current_page */ |
|
35 | + $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class); |
|
36 | + $current_page->setEspressoPage(true); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + |
|
41 | + /** |
|
42 | + * run - initial shortcode module setup called during "parse_request" hook by |
|
43 | + * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request ! |
|
44 | + * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented |
|
45 | + * by a theme or plugin in a non-standard way. |
|
46 | + * Basically this method is primarily used for loading resources and assets like CSS or JS |
|
47 | + * that will be required by the shortcode when it is actually processed. |
|
48 | + * Please note that assets may not load if the fallback_shortcode_processor() is being used. |
|
49 | + * |
|
50 | + * @access public |
|
51 | + * @param WP $WP |
|
52 | + * @return void |
|
53 | + */ |
|
54 | + abstract public function run(WP $WP); |
|
55 | + |
|
56 | + |
|
57 | + |
|
58 | + /** |
|
59 | + * process_shortcode |
|
60 | + * this method is the callback function for the actual shortcode, and is what runs when WP encounters the shortcode within the_content |
|
61 | + * |
|
62 | + * @access public |
|
63 | + * @param array $attributes |
|
64 | + * @return mixed |
|
65 | + */ |
|
66 | + abstract public function process_shortcode($attributes = array()); |
|
67 | + |
|
68 | + |
|
69 | + |
|
70 | + /** |
|
71 | + * instance - returns instance of child class object |
|
72 | + * |
|
73 | + * @access public |
|
74 | + * @param string $shortcode_class |
|
75 | + * @return \EES_Shortcode |
|
76 | + */ |
|
77 | + final public static function instance($shortcode_class = null) |
|
78 | + { |
|
79 | + $shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class(); |
|
80 | + if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) { |
|
81 | + return null; |
|
82 | + } |
|
83 | + $shortcode = str_replace('EES_', '', strtoupper($shortcode_class)); |
|
84 | + $shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode}) |
|
85 | + ? EE_Registry::instance()->shortcodes->{$shortcode} |
|
86 | + : null; |
|
87 | + return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self' |
|
88 | + ? $shortcode_obj |
|
89 | + : new $shortcode_class(); |
|
90 | + } |
|
91 | + |
|
92 | + |
|
93 | + |
|
94 | + |
|
95 | + /** |
|
96 | + * fallback_shortcode_processor - create instance and call process_shortcode |
|
97 | + * NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things work at all |
|
98 | + * |
|
99 | + * @access public |
|
100 | + * @param $attributes |
|
101 | + * @return mixed |
|
102 | + */ |
|
103 | + final public static function fallback_shortcode_processor($attributes) |
|
104 | + { |
|
105 | + if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) { |
|
106 | + return null; |
|
107 | + } |
|
108 | + // what shortcode was actually parsed ? |
|
109 | + $shortcode_class = get_called_class(); |
|
110 | + // notify rest of system that fallback processor was triggered |
|
111 | + add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true'); |
|
112 | + // get instance of actual shortcode |
|
113 | + $shortcode_obj = self::instance($shortcode_class); |
|
114 | + // verify class |
|
115 | + if ($shortcode_obj instanceof EES_Shortcode) { |
|
116 | + global $wp; |
|
117 | + $shortcode_obj->run($wp); |
|
118 | + // set attributes and run the shortcode |
|
119 | + $shortcode_obj->_attributes = (array) $attributes; |
|
120 | + return $shortcode_obj->process_shortcode($shortcode_obj->_attributes); |
|
121 | + } else { |
|
122 | + return null; |
|
123 | + } |
|
124 | + } |
|
125 | + |
|
126 | + |
|
127 | + |
|
128 | + |
|
129 | + /** |
|
130 | + * invalid_shortcode_processor - used in cases where we know the shortcode is invalid, most likely due to a deactivated addon, and simply returns an empty string |
|
131 | + * |
|
132 | + * @access public |
|
133 | + * @param $attributes |
|
134 | + * @return string |
|
135 | + */ |
|
136 | + final public static function invalid_shortcode_processor($attributes) |
|
137 | + { |
|
138 | + return ''; |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + |
|
143 | + |
|
144 | + |
|
145 | + /** |
|
146 | + * Performs basic sanitization on shortcode attributes |
|
147 | + * Since incoming attributes from the shortcode usage in the WP editor will all be strings, |
|
148 | + * most attributes will by default be sanitized using the sanitize_text_field() function. |
|
149 | + * This can be overridden by supplying an array for the $custom_sanitization param, |
|
150 | + * where keys match keys in your attributes array, |
|
151 | + * and values represent the sanitization function you wish to be applied to that attribute. |
|
152 | + * So for example, if you had an integer attribute named "event_id" |
|
153 | + * that you wanted to be sanitized using absint(), |
|
154 | + * then you would pass the following for your $custom_sanitization array: |
|
155 | + * array('event_id' => 'absint') |
|
156 | + * all other attributes would be sanitized using the defaults in the switch statement below |
|
157 | + * |
|
158 | + * @param array $attributes |
|
159 | + * @param array $custom_sanitization |
|
160 | + * @return array |
|
161 | + */ |
|
162 | + public static function sanitize_attributes(array $attributes, $custom_sanitization = array()) |
|
163 | + { |
|
164 | + foreach ($attributes as $key => $value) { |
|
165 | + // is a custom sanitization callback specified ? |
|
166 | + if (isset($custom_sanitization[ $key ])) { |
|
167 | + $callback = $custom_sanitization[ $key ]; |
|
168 | + if ($callback === 'skip_sanitization') { |
|
169 | + $attributes[ $key ] = $value; |
|
170 | + continue; |
|
171 | + } elseif (function_exists($callback)) { |
|
172 | + $attributes[ $key ] = $callback($value); |
|
173 | + continue; |
|
174 | + } |
|
175 | + } |
|
176 | + switch (true) { |
|
177 | + case $value === null: |
|
178 | + case is_int($value): |
|
179 | + case is_float($value): |
|
180 | + // typical booleans |
|
181 | + case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true): |
|
182 | + $attributes[ $key ] = $value; |
|
183 | + break; |
|
184 | + case is_string($value): |
|
185 | + $attributes[ $key ] = sanitize_text_field($value); |
|
186 | + break; |
|
187 | + case is_array($value): |
|
188 | + $attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value); |
|
189 | + break; |
|
190 | + default: |
|
191 | + // only remaining data types are Object and Resource |
|
192 | + // which are not allowed as shortcode attributes |
|
193 | + $attributes[ $key ] = null; |
|
194 | + break; |
|
195 | + } |
|
196 | + } |
|
197 | + return $attributes; |
|
198 | + } |
|
199 | 199 | } |
@@ -62,49 +62,49 @@ discard block |
||
62 | 62 | ); |
63 | 63 | $cpt_models = array_keys(EE_Registry::instance()->cpt_models()); |
64 | 64 | foreach ($cpt_models as $model_name) { |
65 | - $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship'); |
|
65 | + $this->_model_relations[$model_name] = new EE_HABTM_Relation('Term_Relationship'); |
|
66 | 66 | } |
67 | 67 | $this->_wp_core_model = true; |
68 | 68 | $this->_indexes = array( |
69 | 69 | 'term_id_taxonomy' => new EE_Unique_Index(array('term_id', 'taxonomy')), |
70 | 70 | ); |
71 | 71 | $path_to_tax_model = ''; |
72 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
73 | - $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Taxonomy_Protected( |
|
72 | + $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public(); |
|
73 | + $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Taxonomy_Protected( |
|
74 | 74 | $path_to_tax_model |
75 | 75 | ); |
76 | - $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = false; |
|
77 | - $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false; |
|
76 | + $this->_cap_restriction_generators[EEM_Base::caps_edit] = false; |
|
77 | + $this->_cap_restriction_generators[EEM_Base::caps_delete] = false; |
|
78 | 78 | // add cap restrictions for editing relating to the "ee_edit_*" |
79 | - $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions( |
|
79 | + $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_category'] = new EE_Default_Where_Conditions( |
|
80 | 80 | array( |
81 | - $path_to_tax_model . 'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'), |
|
81 | + $path_to_tax_model.'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'), |
|
82 | 82 | ) |
83 | 83 | ); |
84 | - $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions( |
|
84 | + $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_venue_category'] = new EE_Default_Where_Conditions( |
|
85 | 85 | array( |
86 | - $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'), |
|
86 | + $path_to_tax_model.'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'), |
|
87 | 87 | ) |
88 | 88 | ); |
89 | - $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type'] = new EE_Default_Where_Conditions( |
|
89 | + $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_type'] = new EE_Default_Where_Conditions( |
|
90 | 90 | array( |
91 | - $path_to_tax_model . 'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'), |
|
91 | + $path_to_tax_model.'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'), |
|
92 | 92 | ) |
93 | 93 | ); |
94 | 94 | // add cap restrictions for deleting relating to the "ee_deleting_*" |
95 | - $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions( |
|
95 | + $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_category'] = new EE_Default_Where_Conditions( |
|
96 | 96 | array( |
97 | - $path_to_tax_model . 'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'), |
|
97 | + $path_to_tax_model.'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'), |
|
98 | 98 | ) |
99 | 99 | ); |
100 | - $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions( |
|
100 | + $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_venue_category'] = new EE_Default_Where_Conditions( |
|
101 | 101 | array( |
102 | - $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'), |
|
102 | + $path_to_tax_model.'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'), |
|
103 | 103 | ) |
104 | 104 | ); |
105 | - $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type'] = new EE_Default_Where_Conditions( |
|
105 | + $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_type'] = new EE_Default_Where_Conditions( |
|
106 | 106 | array( |
107 | - $path_to_tax_model . 'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'), |
|
107 | + $path_to_tax_model.'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'), |
|
108 | 108 | ) |
109 | 109 | ); |
110 | 110 | parent::__construct($timezone); |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | { |
127 | 127 | if ($model === EEM_Term_Taxonomy::instance()) { |
128 | 128 | $taxonomies = get_taxonomies(array('show_in_rest' => true)); |
129 | - if (! empty($taxonomies)) { |
|
129 | + if ( ! empty($taxonomies)) { |
|
130 | 130 | $model_query_params[0]['taxonomy'] = array('IN', $taxonomies); |
131 | 131 | } |
132 | 132 | } |
@@ -10,128 +10,128 @@ |
||
10 | 10 | */ |
11 | 11 | class EEM_Term_Taxonomy extends EEM_Base |
12 | 12 | { |
13 | - // private instance of the Attendee object |
|
14 | - protected static $_instance = null; |
|
13 | + // private instance of the Attendee object |
|
14 | + protected static $_instance = null; |
|
15 | 15 | |
16 | 16 | |
17 | 17 | |
18 | - protected function __construct($timezone = null) |
|
19 | - { |
|
20 | - $this->singular_item = esc_html__('Term Taxonomy', 'event_espresso'); |
|
21 | - $this->plural_item = esc_html__('Term Taxonomy', 'event_espresso'); |
|
22 | - $this->_tables = array( |
|
23 | - 'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'), |
|
24 | - ); |
|
25 | - $this->_fields = array( |
|
26 | - 'Term_Taxonomy' => array( |
|
27 | - 'term_taxonomy_id' => new EE_Primary_Key_Int_Field( |
|
28 | - 'term_taxonomy_id', |
|
29 | - esc_html__('Term-Taxonomy ID', 'event_espresso') |
|
30 | - ), |
|
31 | - 'term_id' => new EE_Foreign_Key_Int_Field( |
|
32 | - 'term_id', |
|
33 | - esc_html__("Term Id", "event_espresso"), |
|
34 | - false, |
|
35 | - 0, |
|
36 | - 'Term' |
|
37 | - ), |
|
38 | - 'taxonomy' => new EE_Plain_Text_Field( |
|
39 | - 'taxonomy', |
|
40 | - esc_html__('Taxonomy Name', 'event_espresso'), |
|
41 | - false, |
|
42 | - 'category' |
|
43 | - ), |
|
44 | - 'description' => new EE_Post_Content_Field( |
|
45 | - 'description', |
|
46 | - esc_html__("Description of Term", "event_espresso"), |
|
47 | - false, |
|
48 | - '' |
|
49 | - ), |
|
50 | - 'parent' => new EE_Integer_Field('parent', esc_html__("Parent Term ID", "event_espresso"), false, 0), |
|
51 | - 'term_count' => new EE_Integer_Field( |
|
52 | - 'count', |
|
53 | - esc_html__("Count of Objects attached", 'event_espresso'), |
|
54 | - false, |
|
55 | - 0 |
|
56 | - ), |
|
57 | - ), |
|
58 | - ); |
|
59 | - $this->_model_relations = array( |
|
60 | - 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
61 | - 'Term' => new EE_Belongs_To_Relation(), |
|
62 | - ); |
|
63 | - $cpt_models = array_keys(EE_Registry::instance()->cpt_models()); |
|
64 | - foreach ($cpt_models as $model_name) { |
|
65 | - $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship'); |
|
66 | - } |
|
67 | - $this->_wp_core_model = true; |
|
68 | - $this->_indexes = array( |
|
69 | - 'term_id_taxonomy' => new EE_Unique_Index(array('term_id', 'taxonomy')), |
|
70 | - ); |
|
71 | - $path_to_tax_model = ''; |
|
72 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
73 | - $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Taxonomy_Protected( |
|
74 | - $path_to_tax_model |
|
75 | - ); |
|
76 | - $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = false; |
|
77 | - $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false; |
|
78 | - // add cap restrictions for editing relating to the "ee_edit_*" |
|
79 | - $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions( |
|
80 | - array( |
|
81 | - $path_to_tax_model . 'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'), |
|
82 | - ) |
|
83 | - ); |
|
84 | - $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions( |
|
85 | - array( |
|
86 | - $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'), |
|
87 | - ) |
|
88 | - ); |
|
89 | - $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type'] = new EE_Default_Where_Conditions( |
|
90 | - array( |
|
91 | - $path_to_tax_model . 'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'), |
|
92 | - ) |
|
93 | - ); |
|
94 | - // add cap restrictions for deleting relating to the "ee_deleting_*" |
|
95 | - $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions( |
|
96 | - array( |
|
97 | - $path_to_tax_model . 'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'), |
|
98 | - ) |
|
99 | - ); |
|
100 | - $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions( |
|
101 | - array( |
|
102 | - $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'), |
|
103 | - ) |
|
104 | - ); |
|
105 | - $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type'] = new EE_Default_Where_Conditions( |
|
106 | - array( |
|
107 | - $path_to_tax_model . 'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'), |
|
108 | - ) |
|
109 | - ); |
|
110 | - parent::__construct($timezone); |
|
111 | - add_filter('FHEE__Read__create_model_query_params', array('EEM_Term_Taxonomy', 'rest_api_query_params'), 10, 3); |
|
112 | - } |
|
18 | + protected function __construct($timezone = null) |
|
19 | + { |
|
20 | + $this->singular_item = esc_html__('Term Taxonomy', 'event_espresso'); |
|
21 | + $this->plural_item = esc_html__('Term Taxonomy', 'event_espresso'); |
|
22 | + $this->_tables = array( |
|
23 | + 'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'), |
|
24 | + ); |
|
25 | + $this->_fields = array( |
|
26 | + 'Term_Taxonomy' => array( |
|
27 | + 'term_taxonomy_id' => new EE_Primary_Key_Int_Field( |
|
28 | + 'term_taxonomy_id', |
|
29 | + esc_html__('Term-Taxonomy ID', 'event_espresso') |
|
30 | + ), |
|
31 | + 'term_id' => new EE_Foreign_Key_Int_Field( |
|
32 | + 'term_id', |
|
33 | + esc_html__("Term Id", "event_espresso"), |
|
34 | + false, |
|
35 | + 0, |
|
36 | + 'Term' |
|
37 | + ), |
|
38 | + 'taxonomy' => new EE_Plain_Text_Field( |
|
39 | + 'taxonomy', |
|
40 | + esc_html__('Taxonomy Name', 'event_espresso'), |
|
41 | + false, |
|
42 | + 'category' |
|
43 | + ), |
|
44 | + 'description' => new EE_Post_Content_Field( |
|
45 | + 'description', |
|
46 | + esc_html__("Description of Term", "event_espresso"), |
|
47 | + false, |
|
48 | + '' |
|
49 | + ), |
|
50 | + 'parent' => new EE_Integer_Field('parent', esc_html__("Parent Term ID", "event_espresso"), false, 0), |
|
51 | + 'term_count' => new EE_Integer_Field( |
|
52 | + 'count', |
|
53 | + esc_html__("Count of Objects attached", 'event_espresso'), |
|
54 | + false, |
|
55 | + 0 |
|
56 | + ), |
|
57 | + ), |
|
58 | + ); |
|
59 | + $this->_model_relations = array( |
|
60 | + 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
61 | + 'Term' => new EE_Belongs_To_Relation(), |
|
62 | + ); |
|
63 | + $cpt_models = array_keys(EE_Registry::instance()->cpt_models()); |
|
64 | + foreach ($cpt_models as $model_name) { |
|
65 | + $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship'); |
|
66 | + } |
|
67 | + $this->_wp_core_model = true; |
|
68 | + $this->_indexes = array( |
|
69 | + 'term_id_taxonomy' => new EE_Unique_Index(array('term_id', 'taxonomy')), |
|
70 | + ); |
|
71 | + $path_to_tax_model = ''; |
|
72 | + $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
73 | + $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Taxonomy_Protected( |
|
74 | + $path_to_tax_model |
|
75 | + ); |
|
76 | + $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = false; |
|
77 | + $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false; |
|
78 | + // add cap restrictions for editing relating to the "ee_edit_*" |
|
79 | + $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions( |
|
80 | + array( |
|
81 | + $path_to_tax_model . 'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'), |
|
82 | + ) |
|
83 | + ); |
|
84 | + $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions( |
|
85 | + array( |
|
86 | + $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'), |
|
87 | + ) |
|
88 | + ); |
|
89 | + $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type'] = new EE_Default_Where_Conditions( |
|
90 | + array( |
|
91 | + $path_to_tax_model . 'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'), |
|
92 | + ) |
|
93 | + ); |
|
94 | + // add cap restrictions for deleting relating to the "ee_deleting_*" |
|
95 | + $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions( |
|
96 | + array( |
|
97 | + $path_to_tax_model . 'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'), |
|
98 | + ) |
|
99 | + ); |
|
100 | + $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions( |
|
101 | + array( |
|
102 | + $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'), |
|
103 | + ) |
|
104 | + ); |
|
105 | + $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type'] = new EE_Default_Where_Conditions( |
|
106 | + array( |
|
107 | + $path_to_tax_model . 'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'), |
|
108 | + ) |
|
109 | + ); |
|
110 | + parent::__construct($timezone); |
|
111 | + add_filter('FHEE__Read__create_model_query_params', array('EEM_Term_Taxonomy', 'rest_api_query_params'), 10, 3); |
|
112 | + } |
|
113 | 113 | |
114 | 114 | |
115 | 115 | |
116 | - /** |
|
117 | - * Makes sure that during REST API queries, we only return term-taxonomies |
|
118 | - * for term taxonomies which should be shown in the rest api |
|
119 | - * |
|
120 | - * @param array $model_query_params |
|
121 | - * @param array $querystring_query_params |
|
122 | - * @param EEM_Base $model |
|
123 | - * @return array |
|
124 | - */ |
|
125 | - public static function rest_api_query_params($model_query_params, $querystring_query_params, $model) |
|
126 | - { |
|
127 | - if ($model === EEM_Term_Taxonomy::instance()) { |
|
128 | - $taxonomies = get_taxonomies(array('show_in_rest' => true)); |
|
129 | - if (! empty($taxonomies)) { |
|
130 | - $model_query_params[0]['taxonomy'] = array('IN', $taxonomies); |
|
131 | - } |
|
132 | - } |
|
133 | - return $model_query_params; |
|
134 | - } |
|
116 | + /** |
|
117 | + * Makes sure that during REST API queries, we only return term-taxonomies |
|
118 | + * for term taxonomies which should be shown in the rest api |
|
119 | + * |
|
120 | + * @param array $model_query_params |
|
121 | + * @param array $querystring_query_params |
|
122 | + * @param EEM_Base $model |
|
123 | + * @return array |
|
124 | + */ |
|
125 | + public static function rest_api_query_params($model_query_params, $querystring_query_params, $model) |
|
126 | + { |
|
127 | + if ($model === EEM_Term_Taxonomy::instance()) { |
|
128 | + $taxonomies = get_taxonomies(array('show_in_rest' => true)); |
|
129 | + if (! empty($taxonomies)) { |
|
130 | + $model_query_params[0]['taxonomy'] = array('IN', $taxonomies); |
|
131 | + } |
|
132 | + } |
|
133 | + return $model_query_params; |
|
134 | + } |
|
135 | 135 | } |
136 | 136 | // End of file EEM_Term_Taxonomy.model.php |
137 | 137 | // Location: /includes/models/EEM_Term_Taxonomy.model.php |
@@ -113,17 +113,17 @@ discard block |
||
113 | 113 | ), |
114 | 114 | ), |
115 | 115 | ); |
116 | - $this->_model_relations = array(); |
|
116 | + $this->_model_relations = array(); |
|
117 | 117 | foreach ($models_this_can_attach_to as $model) { |
118 | 118 | if ($model != 'Change_Log') { |
119 | - $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation(); |
|
119 | + $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation(); |
|
120 | 120 | } |
121 | 121 | } |
122 | 122 | // use completely custom caps for this |
123 | 123 | $this->_cap_restriction_generators = false; |
124 | 124 | // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing |
125 | 125 | foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) { |
126 | - $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ] |
|
126 | + $this->_cap_restrictions[$cap_context][EE_Restriction_Generator_Base::get_default_restrictions_cap()] |
|
127 | 127 | = new EE_Return_None_Where_Conditions(); |
128 | 128 | } |
129 | 129 | parent::__construct($timezone); |
@@ -168,7 +168,7 @@ discard block |
||
168 | 168 | */ |
169 | 169 | public function gateway_log($message, $related_obj_id, $related_obj_type) |
170 | 170 | { |
171 | - if (! EE_Registry::instance()->is_model_name($related_obj_type)) { |
|
171 | + if ( ! EE_Registry::instance()->is_model_name($related_obj_type)) { |
|
172 | 172 | throw new EE_Error( |
173 | 173 | sprintf( |
174 | 174 | esc_html__( |
@@ -217,7 +217,7 @@ discard block |
||
217 | 217 | global $wpdb; |
218 | 218 | return $wpdb->query( |
219 | 219 | $wpdb->prepare( |
220 | - 'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s', |
|
220 | + 'DELETE FROM '.$this->table().' WHERE LOG_type = %s AND LOG_time < %s', |
|
221 | 221 | EEM_Change_Log::type_gateway, |
222 | 222 | $datetime->format(EE_Datetime_Field::mysql_timestamp_format) |
223 | 223 | ) |
@@ -256,8 +256,8 @@ discard block |
||
256 | 256 | { |
257 | 257 | $type_identifier_map = self::get_pretty_label_map_for_registered_types(); |
258 | 258 | // we fallback to the incoming type identifier if there is no localized label for it. |
259 | - return isset($type_identifier_map[ $type_identifier ]) |
|
260 | - ? $type_identifier_map[ $type_identifier ] |
|
259 | + return isset($type_identifier_map[$type_identifier]) |
|
260 | + ? $type_identifier_map[$type_identifier] |
|
261 | 261 | : $type_identifier; |
262 | 262 | } |
263 | 263 | } |
@@ -10,93 +10,93 @@ discard block |
||
10 | 10 | */ |
11 | 11 | class EEM_Change_Log extends EEM_Base |
12 | 12 | { |
13 | - /** |
|
14 | - * the related object was created log type |
|
15 | - */ |
|
16 | - const type_create = 'create'; |
|
17 | - /** |
|
18 | - * the related object was updated (changed, or soft-deleted) |
|
19 | - */ |
|
20 | - const type_update = 'update'; |
|
21 | - /** |
|
22 | - * the related object was deleted permanently |
|
23 | - */ |
|
24 | - const type_delete = 'delete'; |
|
25 | - /** |
|
26 | - * the related item had something worth noting happen on it, but |
|
27 | - * only for the purposes of debugging problems |
|
28 | - */ |
|
29 | - const type_debug = 'debug'; |
|
30 | - /** |
|
31 | - * the related item had an error occur on it |
|
32 | - */ |
|
33 | - const type_error = 'error'; |
|
34 | - /** |
|
35 | - * the related item is regarding some gateway interaction, like an IPN |
|
36 | - * or request to process a payment |
|
37 | - */ |
|
38 | - const type_gateway = 'gateway'; |
|
13 | + /** |
|
14 | + * the related object was created log type |
|
15 | + */ |
|
16 | + const type_create = 'create'; |
|
17 | + /** |
|
18 | + * the related object was updated (changed, or soft-deleted) |
|
19 | + */ |
|
20 | + const type_update = 'update'; |
|
21 | + /** |
|
22 | + * the related object was deleted permanently |
|
23 | + */ |
|
24 | + const type_delete = 'delete'; |
|
25 | + /** |
|
26 | + * the related item had something worth noting happen on it, but |
|
27 | + * only for the purposes of debugging problems |
|
28 | + */ |
|
29 | + const type_debug = 'debug'; |
|
30 | + /** |
|
31 | + * the related item had an error occur on it |
|
32 | + */ |
|
33 | + const type_error = 'error'; |
|
34 | + /** |
|
35 | + * the related item is regarding some gateway interaction, like an IPN |
|
36 | + * or request to process a payment |
|
37 | + */ |
|
38 | + const type_gateway = 'gateway'; |
|
39 | 39 | |
40 | - /** |
|
41 | - * private instance of the EEM_Change_Log object |
|
42 | - * |
|
43 | - * @access private |
|
44 | - * @var EEM_Change_Log $_instance |
|
45 | - */ |
|
46 | - protected static $_instance = null; |
|
40 | + /** |
|
41 | + * private instance of the EEM_Change_Log object |
|
42 | + * |
|
43 | + * @access private |
|
44 | + * @var EEM_Change_Log $_instance |
|
45 | + */ |
|
46 | + protected static $_instance = null; |
|
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * constructor |
|
51 | - * |
|
52 | - * @access protected |
|
53 | - * @param null $timezone |
|
54 | - * @throws EE_Error |
|
55 | - */ |
|
56 | - protected function __construct($timezone = null) |
|
57 | - { |
|
58 | - global $current_user; |
|
59 | - $this->singular_item = esc_html__('Log', 'event_espresso'); |
|
60 | - $this->plural_item = esc_html__('Logs', 'event_espresso'); |
|
61 | - $this->_tables = array( |
|
62 | - 'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'), |
|
63 | - ); |
|
64 | - $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models); |
|
65 | - $this->_fields = array( |
|
66 | - 'Log' => array( |
|
67 | - 'LOG_ID' => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')), |
|
68 | - 'LOG_time' => new EE_Datetime_Field( |
|
69 | - 'LOG_time', |
|
70 | - esc_html__("Log Time", 'event_espresso'), |
|
71 | - false, |
|
72 | - EE_Datetime_Field::now |
|
73 | - ), |
|
74 | - 'OBJ_ID' => new EE_Foreign_Key_String_Field( |
|
75 | - 'OBJ_ID', |
|
76 | - esc_html__("Object ID (int or string)", 'event_espresso'), |
|
77 | - true, |
|
78 | - null, |
|
79 | - $models_this_can_attach_to |
|
80 | - ), |
|
81 | - 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
82 | - 'OBJ_type', |
|
83 | - esc_html__("Object Type", 'event_espresso'), |
|
84 | - true, |
|
85 | - null, |
|
86 | - $models_this_can_attach_to |
|
87 | - ), |
|
88 | - 'LOG_type' => new EE_Plain_Text_Field( |
|
89 | - 'LOG_type', |
|
90 | - esc_html__("Type of log entry", "event_espresso"), |
|
91 | - false, |
|
92 | - self::type_debug |
|
93 | - ), |
|
94 | - 'LOG_message' => new EE_Maybe_Serialized_Text_Field( |
|
95 | - 'LOG_message', |
|
96 | - esc_html__("Log Message (body)", 'event_espresso'), |
|
97 | - true |
|
98 | - ), |
|
99 | - /* |
|
49 | + /** |
|
50 | + * constructor |
|
51 | + * |
|
52 | + * @access protected |
|
53 | + * @param null $timezone |
|
54 | + * @throws EE_Error |
|
55 | + */ |
|
56 | + protected function __construct($timezone = null) |
|
57 | + { |
|
58 | + global $current_user; |
|
59 | + $this->singular_item = esc_html__('Log', 'event_espresso'); |
|
60 | + $this->plural_item = esc_html__('Logs', 'event_espresso'); |
|
61 | + $this->_tables = array( |
|
62 | + 'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'), |
|
63 | + ); |
|
64 | + $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models); |
|
65 | + $this->_fields = array( |
|
66 | + 'Log' => array( |
|
67 | + 'LOG_ID' => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')), |
|
68 | + 'LOG_time' => new EE_Datetime_Field( |
|
69 | + 'LOG_time', |
|
70 | + esc_html__("Log Time", 'event_espresso'), |
|
71 | + false, |
|
72 | + EE_Datetime_Field::now |
|
73 | + ), |
|
74 | + 'OBJ_ID' => new EE_Foreign_Key_String_Field( |
|
75 | + 'OBJ_ID', |
|
76 | + esc_html__("Object ID (int or string)", 'event_espresso'), |
|
77 | + true, |
|
78 | + null, |
|
79 | + $models_this_can_attach_to |
|
80 | + ), |
|
81 | + 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
82 | + 'OBJ_type', |
|
83 | + esc_html__("Object Type", 'event_espresso'), |
|
84 | + true, |
|
85 | + null, |
|
86 | + $models_this_can_attach_to |
|
87 | + ), |
|
88 | + 'LOG_type' => new EE_Plain_Text_Field( |
|
89 | + 'LOG_type', |
|
90 | + esc_html__("Type of log entry", "event_espresso"), |
|
91 | + false, |
|
92 | + self::type_debug |
|
93 | + ), |
|
94 | + 'LOG_message' => new EE_Maybe_Serialized_Text_Field( |
|
95 | + 'LOG_message', |
|
96 | + esc_html__("Log Message (body)", 'event_espresso'), |
|
97 | + true |
|
98 | + ), |
|
99 | + /* |
|
100 | 100 | * Note: when querying for a change log's user, the OBJ_ID and OBJ_type fields are used, |
101 | 101 | * not the LOG_wp_user field. E.g., |
102 | 102 | * `EEM_Change_Log::instance()->get_all(array(array('WP_User.ID'=>1)))` will actually return |
@@ -105,158 +105,158 @@ discard block |
||
105 | 105 | * If you want the latter, you can't use the model's magic joining. E.g, you would need to do |
106 | 106 | * `EEM_Change_Log::instance()->get_all(array(array('LOG_wp_user' => 1)))`. |
107 | 107 | */ |
108 | - 'LOG_wp_user' => new EE_WP_User_Field( |
|
109 | - 'LOG_wp_user', |
|
110 | - esc_html__("User who was logged in while this occurred", 'event_espresso'), |
|
111 | - true |
|
112 | - ), |
|
113 | - ), |
|
114 | - ); |
|
115 | - $this->_model_relations = array(); |
|
116 | - foreach ($models_this_can_attach_to as $model) { |
|
117 | - if ($model != 'Change_Log') { |
|
118 | - $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation(); |
|
119 | - } |
|
120 | - } |
|
121 | - // use completely custom caps for this |
|
122 | - $this->_cap_restriction_generators = false; |
|
123 | - // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing |
|
124 | - foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) { |
|
125 | - $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ] |
|
126 | - = new EE_Return_None_Where_Conditions(); |
|
127 | - } |
|
128 | - parent::__construct($timezone); |
|
129 | - } |
|
108 | + 'LOG_wp_user' => new EE_WP_User_Field( |
|
109 | + 'LOG_wp_user', |
|
110 | + esc_html__("User who was logged in while this occurred", 'event_espresso'), |
|
111 | + true |
|
112 | + ), |
|
113 | + ), |
|
114 | + ); |
|
115 | + $this->_model_relations = array(); |
|
116 | + foreach ($models_this_can_attach_to as $model) { |
|
117 | + if ($model != 'Change_Log') { |
|
118 | + $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation(); |
|
119 | + } |
|
120 | + } |
|
121 | + // use completely custom caps for this |
|
122 | + $this->_cap_restriction_generators = false; |
|
123 | + // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing |
|
124 | + foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) { |
|
125 | + $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ] |
|
126 | + = new EE_Return_None_Where_Conditions(); |
|
127 | + } |
|
128 | + parent::__construct($timezone); |
|
129 | + } |
|
130 | 130 | |
131 | - /** |
|
132 | - * @param string $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct |
|
133 | - * @param mixed $message array|string of the message you want to record |
|
134 | - * @param EE_Base_Class $related_model_obj |
|
135 | - * @return EE_Change_Log |
|
136 | - * @throws EE_Error |
|
137 | - */ |
|
138 | - public function log($log_type, $message, $related_model_obj) |
|
139 | - { |
|
140 | - if ($related_model_obj instanceof EE_Base_Class) { |
|
141 | - $obj_id = $related_model_obj->ID(); |
|
142 | - $obj_type = $related_model_obj->get_model()->get_this_model_name(); |
|
143 | - } else { |
|
144 | - $obj_id = null; |
|
145 | - $obj_type = null; |
|
146 | - } |
|
147 | - /** @var EE_Change_Log $log */ |
|
148 | - $log = EE_Change_Log::new_instance(array( |
|
149 | - 'LOG_type' => $log_type, |
|
150 | - 'LOG_message' => $message, |
|
151 | - 'OBJ_ID' => $obj_id, |
|
152 | - 'OBJ_type' => $obj_type, |
|
153 | - )); |
|
154 | - $log->save(); |
|
155 | - return $log; |
|
156 | - } |
|
131 | + /** |
|
132 | + * @param string $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct |
|
133 | + * @param mixed $message array|string of the message you want to record |
|
134 | + * @param EE_Base_Class $related_model_obj |
|
135 | + * @return EE_Change_Log |
|
136 | + * @throws EE_Error |
|
137 | + */ |
|
138 | + public function log($log_type, $message, $related_model_obj) |
|
139 | + { |
|
140 | + if ($related_model_obj instanceof EE_Base_Class) { |
|
141 | + $obj_id = $related_model_obj->ID(); |
|
142 | + $obj_type = $related_model_obj->get_model()->get_this_model_name(); |
|
143 | + } else { |
|
144 | + $obj_id = null; |
|
145 | + $obj_type = null; |
|
146 | + } |
|
147 | + /** @var EE_Change_Log $log */ |
|
148 | + $log = EE_Change_Log::new_instance(array( |
|
149 | + 'LOG_type' => $log_type, |
|
150 | + 'LOG_message' => $message, |
|
151 | + 'OBJ_ID' => $obj_id, |
|
152 | + 'OBJ_type' => $obj_type, |
|
153 | + )); |
|
154 | + $log->save(); |
|
155 | + return $log; |
|
156 | + } |
|
157 | 157 | |
158 | 158 | |
159 | - /** |
|
160 | - * Adds a gateway log for the specified object, given its ID and type |
|
161 | - * |
|
162 | - * @param string $message |
|
163 | - * @param mixed $related_obj_id |
|
164 | - * @param string $related_obj_type |
|
165 | - * @throws EE_Error |
|
166 | - * @return EE_Change_Log |
|
167 | - */ |
|
168 | - public function gateway_log($message, $related_obj_id, $related_obj_type) |
|
169 | - { |
|
170 | - if (! EE_Registry::instance()->is_model_name($related_obj_type)) { |
|
171 | - throw new EE_Error( |
|
172 | - sprintf( |
|
173 | - esc_html__( |
|
174 | - "'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc", |
|
175 | - "event_espresso" |
|
176 | - ), |
|
177 | - $related_obj_type |
|
178 | - ) |
|
179 | - ); |
|
180 | - } |
|
181 | - /** @var EE_Change_Log $log */ |
|
182 | - $log = EE_Change_Log::new_instance(array( |
|
183 | - 'LOG_type' => EEM_Change_Log::type_gateway, |
|
184 | - 'LOG_message' => $message, |
|
185 | - 'OBJ_ID' => $related_obj_id, |
|
186 | - 'OBJ_type' => $related_obj_type, |
|
187 | - )); |
|
188 | - $log->save(); |
|
189 | - return $log; |
|
190 | - } |
|
159 | + /** |
|
160 | + * Adds a gateway log for the specified object, given its ID and type |
|
161 | + * |
|
162 | + * @param string $message |
|
163 | + * @param mixed $related_obj_id |
|
164 | + * @param string $related_obj_type |
|
165 | + * @throws EE_Error |
|
166 | + * @return EE_Change_Log |
|
167 | + */ |
|
168 | + public function gateway_log($message, $related_obj_id, $related_obj_type) |
|
169 | + { |
|
170 | + if (! EE_Registry::instance()->is_model_name($related_obj_type)) { |
|
171 | + throw new EE_Error( |
|
172 | + sprintf( |
|
173 | + esc_html__( |
|
174 | + "'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc", |
|
175 | + "event_espresso" |
|
176 | + ), |
|
177 | + $related_obj_type |
|
178 | + ) |
|
179 | + ); |
|
180 | + } |
|
181 | + /** @var EE_Change_Log $log */ |
|
182 | + $log = EE_Change_Log::new_instance(array( |
|
183 | + 'LOG_type' => EEM_Change_Log::type_gateway, |
|
184 | + 'LOG_message' => $message, |
|
185 | + 'OBJ_ID' => $related_obj_id, |
|
186 | + 'OBJ_type' => $related_obj_type, |
|
187 | + )); |
|
188 | + $log->save(); |
|
189 | + return $log; |
|
190 | + } |
|
191 | 191 | |
192 | 192 | |
193 | - /** |
|
194 | - * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential |
|
195 | - * |
|
196 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
197 | - * @return array of arrays |
|
198 | - * @throws EE_Error |
|
199 | - */ |
|
200 | - public function get_all_efficiently($query_params) |
|
201 | - { |
|
202 | - return $this->_get_all_wpdb_results($query_params); |
|
203 | - } |
|
193 | + /** |
|
194 | + * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential |
|
195 | + * |
|
196 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
197 | + * @return array of arrays |
|
198 | + * @throws EE_Error |
|
199 | + */ |
|
200 | + public function get_all_efficiently($query_params) |
|
201 | + { |
|
202 | + return $this->_get_all_wpdb_results($query_params); |
|
203 | + } |
|
204 | 204 | |
205 | 205 | |
206 | - /** |
|
207 | - * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use |
|
208 | - * models after this, they may be out-of-sync with the database |
|
209 | - * |
|
210 | - * @param DateTime $datetime |
|
211 | - * @return false|int |
|
212 | - * @throws EE_Error |
|
213 | - */ |
|
214 | - public function delete_gateway_logs_older_than(DateTime $datetime) |
|
215 | - { |
|
216 | - global $wpdb; |
|
217 | - return $wpdb->query( |
|
218 | - $wpdb->prepare( |
|
219 | - 'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s', |
|
220 | - EEM_Change_Log::type_gateway, |
|
221 | - $datetime->format(EE_Datetime_Field::mysql_timestamp_format) |
|
222 | - ) |
|
223 | - ); |
|
224 | - } |
|
206 | + /** |
|
207 | + * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use |
|
208 | + * models after this, they may be out-of-sync with the database |
|
209 | + * |
|
210 | + * @param DateTime $datetime |
|
211 | + * @return false|int |
|
212 | + * @throws EE_Error |
|
213 | + */ |
|
214 | + public function delete_gateway_logs_older_than(DateTime $datetime) |
|
215 | + { |
|
216 | + global $wpdb; |
|
217 | + return $wpdb->query( |
|
218 | + $wpdb->prepare( |
|
219 | + 'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s', |
|
220 | + EEM_Change_Log::type_gateway, |
|
221 | + $datetime->format(EE_Datetime_Field::mysql_timestamp_format) |
|
222 | + ) |
|
223 | + ); |
|
224 | + } |
|
225 | 225 | |
226 | 226 | |
227 | - /** |
|
228 | - * Returns the map of type to pretty label for identifiers used for `LOG_type`. Client code can register their own |
|
229 | - * map vai the given filter. |
|
230 | - * |
|
231 | - * @return array |
|
232 | - */ |
|
233 | - public static function get_pretty_label_map_for_registered_types() |
|
234 | - { |
|
235 | - return apply_filters( |
|
236 | - 'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types', |
|
237 | - array( |
|
238 | - self::type_create => esc_html__("Create", "event_espresso"), |
|
239 | - self::type_update => esc_html__("Update", "event_espresso"), |
|
240 | - self::type_delete => esc_html__("Delete", "event_espresso"), |
|
241 | - self::type_debug => esc_html__("Debug", "event_espresso"), |
|
242 | - self::type_error => esc_html__("Error", "event_espresso"), |
|
243 | - self::type_gateway => esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso') |
|
244 | - ) |
|
245 | - ); |
|
246 | - } |
|
227 | + /** |
|
228 | + * Returns the map of type to pretty label for identifiers used for `LOG_type`. Client code can register their own |
|
229 | + * map vai the given filter. |
|
230 | + * |
|
231 | + * @return array |
|
232 | + */ |
|
233 | + public static function get_pretty_label_map_for_registered_types() |
|
234 | + { |
|
235 | + return apply_filters( |
|
236 | + 'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types', |
|
237 | + array( |
|
238 | + self::type_create => esc_html__("Create", "event_espresso"), |
|
239 | + self::type_update => esc_html__("Update", "event_espresso"), |
|
240 | + self::type_delete => esc_html__("Delete", "event_espresso"), |
|
241 | + self::type_debug => esc_html__("Debug", "event_espresso"), |
|
242 | + self::type_error => esc_html__("Error", "event_espresso"), |
|
243 | + self::type_gateway => esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso') |
|
244 | + ) |
|
245 | + ); |
|
246 | + } |
|
247 | 247 | |
248 | 248 | |
249 | - /** |
|
250 | - * Return the pretty (localized) label for the given log type identifier. |
|
251 | - * @param string $type_identifier |
|
252 | - * @return string |
|
253 | - */ |
|
254 | - public static function get_pretty_label_for_type($type_identifier) |
|
255 | - { |
|
256 | - $type_identifier_map = self::get_pretty_label_map_for_registered_types(); |
|
257 | - // we fallback to the incoming type identifier if there is no localized label for it. |
|
258 | - return isset($type_identifier_map[ $type_identifier ]) |
|
259 | - ? $type_identifier_map[ $type_identifier ] |
|
260 | - : $type_identifier; |
|
261 | - } |
|
249 | + /** |
|
250 | + * Return the pretty (localized) label for the given log type identifier. |
|
251 | + * @param string $type_identifier |
|
252 | + * @return string |
|
253 | + */ |
|
254 | + public static function get_pretty_label_for_type($type_identifier) |
|
255 | + { |
|
256 | + $type_identifier_map = self::get_pretty_label_map_for_registered_types(); |
|
257 | + // we fallback to the incoming type identifier if there is no localized label for it. |
|
258 | + return isset($type_identifier_map[ $type_identifier ]) |
|
259 | + ? $type_identifier_map[ $type_identifier ] |
|
260 | + : $type_identifier; |
|
261 | + } |
|
262 | 262 | } |
@@ -38,10 +38,10 @@ |
||
38 | 38 | )); |
39 | 39 | $this->_model_relations = array(); |
40 | 40 | foreach ($models_this_can_attach_to as $model) { |
41 | - $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation(); |
|
41 | + $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation(); |
|
42 | 42 | } |
43 | 43 | foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) { |
44 | - $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value'); |
|
44 | + $this->_cap_restriction_generators[$cap_context] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value'); |
|
45 | 45 | } |
46 | 46 | parent::__construct($timezone); |
47 | 47 | } |
@@ -16,33 +16,33 @@ |
||
16 | 16 | */ |
17 | 17 | class EEM_Extra_Meta extends EEM_Base |
18 | 18 | { |
19 | - // private instance of the Attendee object |
|
20 | - protected static $_instance = null; |
|
19 | + // private instance of the Attendee object |
|
20 | + protected static $_instance = null; |
|
21 | 21 | |
22 | - protected function __construct($timezone = null) |
|
23 | - { |
|
24 | - $this->singular_item = esc_html__('Extra Meta', 'event_espresso'); |
|
25 | - $this->plural_item = esc_html__('Extra Metas', 'event_espresso'); |
|
26 | - $this->_tables = array( |
|
27 | - 'Extra_Meta' => new EE_Primary_Table('esp_extra_meta', 'EXM_ID') |
|
28 | - ); |
|
29 | - $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models); |
|
30 | - $this->_fields = array( |
|
31 | - 'Extra_Meta' => array( |
|
32 | - 'EXM_ID' => new EE_Primary_Key_Int_Field('EXM_ID', esc_html__("Extra Meta ID", "event_espresso")), |
|
33 | - 'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', esc_html__("Primary Key of Attached Thing", "event_espresso"), false, 0, $models_this_can_attach_to), |
|
34 | - 'EXM_type' => new EE_Any_Foreign_Model_Name_Field('EXM_type', esc_html__("Model of Attached Thing", "event_espresso"), false, 'Transaction', $models_this_can_attach_to), |
|
35 | - 'EXM_key' => new EE_Plain_Text_Field('EXM_key', esc_html__("Meta Key", "event_espresso"), false, ''), |
|
36 | - 'EXM_value' => new EE_Maybe_Serialized_Text_Field('EXM_value', esc_html__("Meta Value", "event_espresso"), true) |
|
22 | + protected function __construct($timezone = null) |
|
23 | + { |
|
24 | + $this->singular_item = esc_html__('Extra Meta', 'event_espresso'); |
|
25 | + $this->plural_item = esc_html__('Extra Metas', 'event_espresso'); |
|
26 | + $this->_tables = array( |
|
27 | + 'Extra_Meta' => new EE_Primary_Table('esp_extra_meta', 'EXM_ID') |
|
28 | + ); |
|
29 | + $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models); |
|
30 | + $this->_fields = array( |
|
31 | + 'Extra_Meta' => array( |
|
32 | + 'EXM_ID' => new EE_Primary_Key_Int_Field('EXM_ID', esc_html__("Extra Meta ID", "event_espresso")), |
|
33 | + 'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', esc_html__("Primary Key of Attached Thing", "event_espresso"), false, 0, $models_this_can_attach_to), |
|
34 | + 'EXM_type' => new EE_Any_Foreign_Model_Name_Field('EXM_type', esc_html__("Model of Attached Thing", "event_espresso"), false, 'Transaction', $models_this_can_attach_to), |
|
35 | + 'EXM_key' => new EE_Plain_Text_Field('EXM_key', esc_html__("Meta Key", "event_espresso"), false, ''), |
|
36 | + 'EXM_value' => new EE_Maybe_Serialized_Text_Field('EXM_value', esc_html__("Meta Value", "event_espresso"), true) |
|
37 | 37 | |
38 | - )); |
|
39 | - $this->_model_relations = array(); |
|
40 | - foreach ($models_this_can_attach_to as $model) { |
|
41 | - $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation(); |
|
42 | - } |
|
43 | - foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) { |
|
44 | - $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value'); |
|
45 | - } |
|
46 | - parent::__construct($timezone); |
|
47 | - } |
|
38 | + )); |
|
39 | + $this->_model_relations = array(); |
|
40 | + foreach ($models_this_can_attach_to as $model) { |
|
41 | + $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation(); |
|
42 | + } |
|
43 | + foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) { |
|
44 | + $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value'); |
|
45 | + } |
|
46 | + parent::__construct($timezone); |
|
47 | + } |
|
48 | 48 | } |
@@ -45,10 +45,10 @@ discard block |
||
45 | 45 | 'WP_User' => new EE_Belongs_To_Relation(), |
46 | 46 | ); |
47 | 47 | // this model is generally available for reading |
48 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
49 | - $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
50 | - $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
51 | - $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
48 | + $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public(); |
|
49 | + $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
50 | + $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
51 | + $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
52 | 52 | parent::__construct($timezone); |
53 | 53 | } |
54 | 54 | /** |
@@ -59,7 +59,7 @@ discard block |
||
59 | 59 | public function get_latest_question_group_order() |
60 | 60 | { |
61 | 61 | $columns_to_select = array( |
62 | - 'max_order' => array("MAX(QSG_order)","%d") |
|
62 | + 'max_order' => array("MAX(QSG_order)", "%d") |
|
63 | 63 | ); |
64 | 64 | $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select); |
65 | 65 | return $max[0]['max_order']; |
@@ -11,58 +11,58 @@ |
||
11 | 11 | */ |
12 | 12 | class EEM_Question_Group extends EEM_Soft_Delete_Base |
13 | 13 | { |
14 | - const system_personal = 1; |
|
15 | - const system_address = 2; |
|
16 | - // private instance of the Attendee object |
|
17 | - protected static $_instance = null; |
|
14 | + const system_personal = 1; |
|
15 | + const system_address = 2; |
|
16 | + // private instance of the Attendee object |
|
17 | + protected static $_instance = null; |
|
18 | 18 | |
19 | 19 | |
20 | - protected function __construct($timezone = null) |
|
21 | - { |
|
22 | - $this->singular_item = esc_html__('Question Group', 'event_espresso'); |
|
23 | - $this->plural_item = esc_html__('Question Groups', 'event_espresso'); |
|
20 | + protected function __construct($timezone = null) |
|
21 | + { |
|
22 | + $this->singular_item = esc_html__('Question Group', 'event_espresso'); |
|
23 | + $this->plural_item = esc_html__('Question Groups', 'event_espresso'); |
|
24 | 24 | |
25 | - $this->_tables = array( |
|
26 | - 'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID') |
|
27 | - ); |
|
28 | - $this->_fields = array( |
|
29 | - 'Question_Group' => array( |
|
30 | - 'QSG_ID' => new EE_Primary_Key_Int_Field('QSG_ID', esc_html__('Question Group ID', 'event_espresso')), |
|
31 | - 'QSG_name' => new EE_Plain_Text_Field('QSG_name', esc_html__('Question Group Name', 'event_espresso'), false, ''), |
|
32 | - 'QSG_identifier' => new EE_Plain_Text_Field('QSG_identifier', esc_html__('Text ID for question Group', 'event_espresso'), false, ''), |
|
33 | - 'QSG_desc' => new EE_Post_Content_Field('QSG_desc', esc_html__('Description of Question Group', 'event_espresso'), true, ''), |
|
34 | - 'QSG_order' => new EE_Integer_Field('QSG_order', esc_html__('Order in which to show the question group', 'event_espresso'), true, 0), |
|
35 | - 'QSG_show_group_name' => new EE_Boolean_Field('QSG_show_group_name', esc_html__('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true), |
|
36 | - 'QSG_show_group_desc' => new EE_Boolean_Field('QSG_show_group_desc', esc_html__('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false), |
|
37 | - 'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', esc_html__('Question Group Creator ID', 'event_espresso'), false), |
|
38 | - 'QSG_system' => new EE_Integer_Field('QSG_system', esc_html__('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0), |
|
39 | - 'QSG_deleted' => new EE_Trashed_Flag_Field('QSG_deleted', esc_html__('Flag indicating this question group was deleted', 'event_espresso'), false, false) |
|
40 | - ) |
|
41 | - ); |
|
42 | - $this->_model_relations = array( |
|
43 | - 'Question' => new EE_HABTM_Relation('Question_Group_Question'), |
|
44 | - 'Event' => new EE_HABTM_Relation('Event_Question_Group'), |
|
45 | - 'Event_Question_Group' => new EE_Has_Many_Relation(), |
|
46 | - 'WP_User' => new EE_Belongs_To_Relation(), |
|
47 | - ); |
|
48 | - // this model is generally available for reading |
|
49 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
50 | - $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
51 | - $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
52 | - $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
53 | - parent::__construct($timezone); |
|
54 | - } |
|
55 | - /** |
|
56 | - * searches the db for the question group with the latest question order and returns that value. |
|
57 | - * @access public |
|
58 | - * @return int |
|
59 | - */ |
|
60 | - public function get_latest_question_group_order() |
|
61 | - { |
|
62 | - $columns_to_select = array( |
|
63 | - 'max_order' => array("MAX(QSG_order)","%d") |
|
64 | - ); |
|
65 | - $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select); |
|
66 | - return $max[0]['max_order']; |
|
67 | - } |
|
25 | + $this->_tables = array( |
|
26 | + 'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID') |
|
27 | + ); |
|
28 | + $this->_fields = array( |
|
29 | + 'Question_Group' => array( |
|
30 | + 'QSG_ID' => new EE_Primary_Key_Int_Field('QSG_ID', esc_html__('Question Group ID', 'event_espresso')), |
|
31 | + 'QSG_name' => new EE_Plain_Text_Field('QSG_name', esc_html__('Question Group Name', 'event_espresso'), false, ''), |
|
32 | + 'QSG_identifier' => new EE_Plain_Text_Field('QSG_identifier', esc_html__('Text ID for question Group', 'event_espresso'), false, ''), |
|
33 | + 'QSG_desc' => new EE_Post_Content_Field('QSG_desc', esc_html__('Description of Question Group', 'event_espresso'), true, ''), |
|
34 | + 'QSG_order' => new EE_Integer_Field('QSG_order', esc_html__('Order in which to show the question group', 'event_espresso'), true, 0), |
|
35 | + 'QSG_show_group_name' => new EE_Boolean_Field('QSG_show_group_name', esc_html__('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true), |
|
36 | + 'QSG_show_group_desc' => new EE_Boolean_Field('QSG_show_group_desc', esc_html__('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false), |
|
37 | + 'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', esc_html__('Question Group Creator ID', 'event_espresso'), false), |
|
38 | + 'QSG_system' => new EE_Integer_Field('QSG_system', esc_html__('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0), |
|
39 | + 'QSG_deleted' => new EE_Trashed_Flag_Field('QSG_deleted', esc_html__('Flag indicating this question group was deleted', 'event_espresso'), false, false) |
|
40 | + ) |
|
41 | + ); |
|
42 | + $this->_model_relations = array( |
|
43 | + 'Question' => new EE_HABTM_Relation('Question_Group_Question'), |
|
44 | + 'Event' => new EE_HABTM_Relation('Event_Question_Group'), |
|
45 | + 'Event_Question_Group' => new EE_Has_Many_Relation(), |
|
46 | + 'WP_User' => new EE_Belongs_To_Relation(), |
|
47 | + ); |
|
48 | + // this model is generally available for reading |
|
49 | + $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
50 | + $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
51 | + $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
52 | + $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system'); |
|
53 | + parent::__construct($timezone); |
|
54 | + } |
|
55 | + /** |
|
56 | + * searches the db for the question group with the latest question order and returns that value. |
|
57 | + * @access public |
|
58 | + * @return int |
|
59 | + */ |
|
60 | + public function get_latest_question_group_order() |
|
61 | + { |
|
62 | + $columns_to_select = array( |
|
63 | + 'max_order' => array("MAX(QSG_order)","%d") |
|
64 | + ); |
|
65 | + $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select); |
|
66 | + return $max[0]['max_order']; |
|
67 | + } |
|
68 | 68 | } |
@@ -284,8 +284,8 @@ discard block |
||
284 | 284 | */ |
285 | 285 | public function get_attendee_field_for_system_question($system_question_string) |
286 | 286 | { |
287 | - return isset($this->_system_question_to_attendee_field_name[ $system_question_string ]) |
|
288 | - ? $this->_system_question_to_attendee_field_name[ $system_question_string ] |
|
287 | + return isset($this->_system_question_to_attendee_field_name[$system_question_string]) |
|
288 | + ? $this->_system_question_to_attendee_field_name[$system_question_string] |
|
289 | 289 | : null; |
290 | 290 | } |
291 | 291 | |
@@ -353,7 +353,7 @@ discard block |
||
353 | 353 | return false; |
354 | 354 | } |
355 | 355 | $attendee = $this->get_all(array($where_cols_n_values)); |
356 | - if (! empty($attendee)) { |
|
356 | + if ( ! empty($attendee)) { |
|
357 | 357 | return array_shift($attendee); |
358 | 358 | } |
359 | 359 | return false; |
@@ -12,432 +12,432 @@ |
||
12 | 12 | */ |
13 | 13 | class EEM_Attendee extends EEM_CPT_Base |
14 | 14 | { |
15 | - // private instance of the Attendee object |
|
16 | - protected static $_instance = null; |
|
15 | + // private instance of the Attendee object |
|
16 | + protected static $_instance = null; |
|
17 | 17 | |
18 | - /** |
|
19 | - * QST_system for questions are strings not integers now, |
|
20 | - * so these constants are deprecated. |
|
21 | - * Please instead use the EEM_Attendee::system_question_* constants |
|
22 | - * |
|
23 | - * @deprecated |
|
24 | - */ |
|
25 | - const fname_question_id = 1; |
|
18 | + /** |
|
19 | + * QST_system for questions are strings not integers now, |
|
20 | + * so these constants are deprecated. |
|
21 | + * Please instead use the EEM_Attendee::system_question_* constants |
|
22 | + * |
|
23 | + * @deprecated |
|
24 | + */ |
|
25 | + const fname_question_id = 1; |
|
26 | 26 | |
27 | - /** |
|
28 | - * @deprecated |
|
29 | - */ |
|
30 | - const lname_question_id = 2; |
|
27 | + /** |
|
28 | + * @deprecated |
|
29 | + */ |
|
30 | + const lname_question_id = 2; |
|
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * @deprecated |
|
35 | - */ |
|
36 | - const email_question_id = 3; |
|
33 | + /** |
|
34 | + * @deprecated |
|
35 | + */ |
|
36 | + const email_question_id = 3; |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * @deprecated |
|
41 | - */ |
|
42 | - const address_question_id = 4; |
|
39 | + /** |
|
40 | + * @deprecated |
|
41 | + */ |
|
42 | + const address_question_id = 4; |
|
43 | 43 | |
44 | 44 | |
45 | - /** |
|
46 | - * @deprecated |
|
47 | - */ |
|
48 | - const address2_question_id = 5; |
|
45 | + /** |
|
46 | + * @deprecated |
|
47 | + */ |
|
48 | + const address2_question_id = 5; |
|
49 | 49 | |
50 | - |
|
51 | - /** |
|
52 | - * @deprecated |
|
53 | - */ |
|
54 | - const city_question_id = 6; |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * @deprecated |
|
59 | - */ |
|
60 | - const state_question_id = 7; |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * @deprecated |
|
65 | - */ |
|
66 | - const country_question_id = 8; |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * @deprecated |
|
71 | - */ |
|
72 | - const zip_question_id = 9; |
|
73 | - |
|
74 | - |
|
75 | - /** |
|
76 | - * @deprecated |
|
77 | - */ |
|
78 | - const phone_question_id = 10; |
|
79 | - |
|
80 | - /** |
|
81 | - * When looking for questions that correspond to attendee fields, |
|
82 | - * look for the question with this QST_system value. |
|
83 | - * These replace the old constants like EEM_Attendee::*_question_id |
|
84 | - */ |
|
85 | - const system_question_fname = 'fname'; |
|
86 | - |
|
87 | - const system_question_lname = 'lname'; |
|
88 | - |
|
89 | - const system_question_email = 'email'; |
|
90 | - |
|
91 | - const system_question_email_confirm = 'email_confirm'; |
|
92 | - |
|
93 | - const system_question_address = 'address'; |
|
94 | - |
|
95 | - const system_question_address2 = 'address2'; |
|
96 | - |
|
97 | - const system_question_city = 'city'; |
|
98 | - |
|
99 | - const system_question_state = 'state'; |
|
100 | - |
|
101 | - const system_question_country = 'country'; |
|
102 | - |
|
103 | - const system_question_zip = 'zip'; |
|
104 | - |
|
105 | - const system_question_phone = 'phone'; |
|
106 | - |
|
107 | - /** |
|
108 | - * Keys are all the EEM_Attendee::system_question_* constants, which are |
|
109 | - * also all the values of QST_system in the questions table, and values |
|
110 | - * are their corresponding Attendee field names |
|
111 | - * |
|
112 | - * @var array |
|
113 | - */ |
|
114 | - protected $_system_question_to_attendee_field_name = array( |
|
115 | - EEM_Attendee::system_question_fname => 'ATT_fname', |
|
116 | - EEM_Attendee::system_question_lname => 'ATT_lname', |
|
117 | - EEM_Attendee::system_question_email => 'ATT_email', |
|
118 | - EEM_Attendee::system_question_address => 'ATT_address', |
|
119 | - EEM_Attendee::system_question_address2 => 'ATT_address2', |
|
120 | - EEM_Attendee::system_question_city => 'ATT_city', |
|
121 | - EEM_Attendee::system_question_state => 'STA_ID', |
|
122 | - EEM_Attendee::system_question_country => 'CNT_ISO', |
|
123 | - EEM_Attendee::system_question_zip => 'ATT_zip', |
|
124 | - EEM_Attendee::system_question_phone => 'ATT_phone', |
|
125 | - ); |
|
126 | - |
|
127 | - |
|
128 | - |
|
129 | - /** |
|
130 | - * EEM_Attendee constructor. |
|
131 | - * |
|
132 | - * @param null $timezone |
|
133 | - * @param ModelFieldFactory $model_field_factory |
|
134 | - * @throws EE_Error |
|
135 | - * @throws InvalidArgumentException |
|
136 | - */ |
|
137 | - protected function __construct($timezone, ModelFieldFactory $model_field_factory) |
|
138 | - { |
|
139 | - $this->singular_item = esc_html__('Attendee', 'event_espresso'); |
|
140 | - $this->plural_item = esc_html__('Attendees', 'event_espresso'); |
|
141 | - $this->_tables = array( |
|
142 | - 'Attendee_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
143 | - 'Attendee_Meta' => new EE_Secondary_Table( |
|
144 | - 'esp_attendee_meta', |
|
145 | - 'ATTM_ID', |
|
146 | - 'ATT_ID' |
|
147 | - ), |
|
148 | - ); |
|
149 | - $this->_fields = array( |
|
150 | - 'Attendee_CPT' => array( |
|
151 | - 'ATT_ID' => $model_field_factory->createPrimaryKeyIntField( |
|
152 | - 'ID', |
|
153 | - esc_html__('Attendee ID', 'event_espresso') |
|
154 | - ), |
|
155 | - 'ATT_full_name' => $model_field_factory->createPlainTextField( |
|
156 | - 'post_title', |
|
157 | - esc_html__('Attendee Full Name', 'event_espresso'), |
|
158 | - false, |
|
159 | - esc_html__('Unknown', 'event_espresso') |
|
160 | - ), |
|
161 | - 'ATT_bio' => $model_field_factory->createPostContentField( |
|
162 | - 'post_content', |
|
163 | - esc_html__('Attendee Biography', 'event_espresso'), |
|
164 | - false, |
|
165 | - esc_html__('No Biography Provided', 'event_espresso') |
|
166 | - ), |
|
167 | - 'ATT_slug' => $model_field_factory->createSlugField( |
|
168 | - 'post_name', |
|
169 | - esc_html__('Attendee URL Slug', 'event_espresso') |
|
170 | - ), |
|
171 | - 'ATT_created' => $model_field_factory->createDatetimeField( |
|
172 | - 'post_date', |
|
173 | - esc_html__('Time Attendee Created', 'event_espresso') |
|
174 | - ), |
|
175 | - 'ATT_short_bio' => $model_field_factory->createSimpleHtmlField( |
|
176 | - 'post_excerpt', |
|
177 | - esc_html__('Attendee Short Biography', 'event_espresso'), |
|
178 | - true, |
|
179 | - esc_html__('No Biography Provided', 'event_espresso') |
|
180 | - ), |
|
181 | - 'ATT_modified' => $model_field_factory->createDatetimeField( |
|
182 | - 'post_modified', |
|
183 | - esc_html__('Time Attendee Last Modified', 'event_espresso') |
|
184 | - ), |
|
185 | - 'ATT_author' => $model_field_factory->createWpUserField( |
|
186 | - 'post_author', |
|
187 | - esc_html__('Creator ID of the first Event attended', 'event_espresso'), |
|
188 | - false |
|
189 | - ), |
|
190 | - 'ATT_parent' => $model_field_factory->createDbOnlyIntField( |
|
191 | - 'post_parent', |
|
192 | - esc_html__('Parent Attendee (unused)', 'event_espresso'), |
|
193 | - false, |
|
194 | - 0 |
|
195 | - ), |
|
196 | - 'post_type' => $model_field_factory->createWpPostTypeField('espresso_attendees'), |
|
197 | - 'status' => $model_field_factory->createWpPostStatusField( |
|
198 | - 'post_status', |
|
199 | - esc_html__('Attendee Status', 'event_espresso'), |
|
200 | - false, |
|
201 | - 'publish' |
|
202 | - ), |
|
203 | - 'password' => new EE_Password_Field( |
|
204 | - 'post_password', |
|
205 | - esc_html__('Password', 'event_espresso'), |
|
206 | - false, |
|
207 | - '', |
|
208 | - array( |
|
209 | - 'ATT_bio', |
|
210 | - 'ATT_short_bio', |
|
211 | - 'ATT_address', |
|
212 | - 'ATT_address2', |
|
213 | - 'ATT_city', |
|
214 | - 'STA_ID', |
|
215 | - 'CNT_ISO', |
|
216 | - 'ATT_zip', |
|
217 | - 'ATT_email', |
|
218 | - 'ATT_phone' |
|
219 | - ) |
|
220 | - ) |
|
221 | - ), |
|
222 | - 'Attendee_Meta' => array( |
|
223 | - 'ATTM_ID' => $model_field_factory->createDbOnlyIntField( |
|
224 | - 'ATTM_ID', |
|
225 | - esc_html__('Attendee Meta Row ID', 'event_espresso'), |
|
226 | - false |
|
227 | - ), |
|
228 | - 'ATT_ID_fk' => $model_field_factory->createDbOnlyIntField( |
|
229 | - 'ATT_ID', |
|
230 | - esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'), |
|
231 | - false |
|
232 | - ), |
|
233 | - 'ATT_fname' => $model_field_factory->createPlainTextField( |
|
234 | - 'ATT_fname', |
|
235 | - esc_html__('First Name', 'event_espresso') |
|
236 | - ), |
|
237 | - 'ATT_lname' => $model_field_factory->createPlainTextField( |
|
238 | - 'ATT_lname', |
|
239 | - esc_html__('Last Name', 'event_espresso') |
|
240 | - ), |
|
241 | - 'ATT_address' => $model_field_factory->createPlainTextField( |
|
242 | - 'ATT_address', |
|
243 | - esc_html__('Address Part 1', 'event_espresso') |
|
244 | - ), |
|
245 | - 'ATT_address2' => $model_field_factory->createPlainTextField( |
|
246 | - 'ATT_address2', |
|
247 | - esc_html__('Address Part 2', 'event_espresso') |
|
248 | - ), |
|
249 | - 'ATT_city' => $model_field_factory->createPlainTextField( |
|
250 | - 'ATT_city', |
|
251 | - esc_html__('City', 'event_espresso') |
|
252 | - ), |
|
253 | - 'STA_ID' => $model_field_factory->createForeignKeyIntField( |
|
254 | - 'STA_ID', |
|
255 | - esc_html__('State', 'event_espresso'), |
|
256 | - true, |
|
257 | - 0, |
|
258 | - 'State' |
|
259 | - ), |
|
260 | - 'CNT_ISO' => $model_field_factory->createForeignKeyStringField( |
|
261 | - 'CNT_ISO', |
|
262 | - esc_html__('Country', 'event_espresso'), |
|
263 | - true, |
|
264 | - '', |
|
265 | - 'Country' |
|
266 | - ), |
|
267 | - 'ATT_zip' => $model_field_factory->createPlainTextField( |
|
268 | - 'ATT_zip', |
|
269 | - esc_html__('ZIP/Postal Code', 'event_espresso') |
|
270 | - ), |
|
271 | - 'ATT_email' => $model_field_factory->createEmailField( |
|
272 | - 'ATT_email', |
|
273 | - esc_html__('Email Address', 'event_espresso') |
|
274 | - ), |
|
275 | - 'ATT_phone' => $model_field_factory->createPlainTextField( |
|
276 | - 'ATT_phone', |
|
277 | - esc_html__('Phone', 'event_espresso') |
|
278 | - ), |
|
279 | - ), |
|
280 | - ); |
|
281 | - $this->_model_relations = array( |
|
282 | - 'Registration' => new EE_Has_Many_Relation(), |
|
283 | - 'State' => new EE_Belongs_To_Relation(), |
|
284 | - 'Country' => new EE_Belongs_To_Relation(), |
|
285 | - 'Event' => new EE_HABTM_Relation('Registration', false), |
|
286 | - 'WP_User' => new EE_Belongs_To_Relation(), |
|
287 | - 'Message' => new EE_Has_Many_Any_Relation(false), |
|
288 | - // allow deletion of attendees even if they have messages in the queue for them. |
|
289 | - 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
290 | - 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
291 | - ); |
|
292 | - $this->_caps_slug = 'contacts'; |
|
293 | - $this->model_chain_to_password = ''; |
|
294 | - parent::__construct($timezone); |
|
295 | - } |
|
296 | - |
|
297 | - |
|
298 | - |
|
299 | - /** |
|
300 | - * Gets the name of the field on the attendee model corresponding to the system question string |
|
301 | - * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name |
|
302 | - * |
|
303 | - * @param string $system_question_string |
|
304 | - * @return string|null if not found |
|
305 | - */ |
|
306 | - public function get_attendee_field_for_system_question($system_question_string) |
|
307 | - { |
|
308 | - return isset($this->_system_question_to_attendee_field_name[ $system_question_string ]) |
|
309 | - ? $this->_system_question_to_attendee_field_name[ $system_question_string ] |
|
310 | - : null; |
|
311 | - } |
|
312 | - |
|
313 | - |
|
314 | - |
|
315 | - /** |
|
316 | - * Gets mapping from esp_question.QST_system values to their corresponding attendee field names |
|
317 | - * |
|
318 | - * @return array |
|
319 | - */ |
|
320 | - public function system_question_to_attendee_field_mapping() |
|
321 | - { |
|
322 | - return $this->_system_question_to_attendee_field_name; |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - |
|
327 | - /** |
|
328 | - * Gets all the attendees for a transaction (by using the esp_registration as a join table) |
|
329 | - * |
|
330 | - * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID |
|
331 | - * @return EE_Attendee[]|EE_Base_Class[] |
|
332 | - * @throws EE_Error |
|
333 | - */ |
|
334 | - public function get_attendees_for_transaction($transaction_id_or_obj) |
|
335 | - { |
|
336 | - return $this->get_all( |
|
337 | - array( |
|
338 | - array( |
|
339 | - 'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction |
|
340 | - ? $transaction_id_or_obj->ID() |
|
341 | - : $transaction_id_or_obj, |
|
342 | - ), |
|
343 | - ) |
|
344 | - ); |
|
345 | - } |
|
346 | - |
|
347 | - |
|
348 | - |
|
349 | - /** |
|
350 | - * retrieve a single attendee from db via their ID |
|
351 | - * |
|
352 | - * @param $ATT_ID |
|
353 | - * @return mixed array on success, FALSE on fail |
|
354 | - * @deprecated |
|
355 | - */ |
|
356 | - public function get_attendee_by_ID($ATT_ID = false) |
|
357 | - { |
|
358 | - // retrieve a particular EE_Attendee |
|
359 | - return $this->get_one_by_ID($ATT_ID); |
|
360 | - } |
|
361 | - |
|
362 | - |
|
363 | - |
|
364 | - /** |
|
365 | - * retrieve a single attendee from db via their ID |
|
366 | - * |
|
367 | - * @param array $where_cols_n_values |
|
368 | - * @return mixed array on success, FALSE on fail |
|
369 | - * @throws EE_Error |
|
370 | - */ |
|
371 | - public function get_attendee($where_cols_n_values = array()) |
|
372 | - { |
|
373 | - if (empty($where_cols_n_values)) { |
|
374 | - return false; |
|
375 | - } |
|
376 | - $attendee = $this->get_all(array($where_cols_n_values)); |
|
377 | - if (! empty($attendee)) { |
|
378 | - return array_shift($attendee); |
|
379 | - } |
|
380 | - return false; |
|
381 | - } |
|
382 | - |
|
383 | - |
|
384 | - |
|
385 | - /** |
|
386 | - * Search for an existing Attendee record in the DB |
|
387 | - * |
|
388 | - * @param array $where_cols_n_values |
|
389 | - * @return bool|mixed |
|
390 | - * @throws EE_Error |
|
391 | - */ |
|
392 | - public function find_existing_attendee($where_cols_n_values = null) |
|
393 | - { |
|
394 | - // search by combo of first and last names plus the email address |
|
395 | - $attendee_data_keys = array( |
|
396 | - 'ATT_fname' => $this->_ATT_fname, |
|
397 | - 'ATT_lname' => $this->_ATT_lname, |
|
398 | - 'ATT_email' => $this->_ATT_email, |
|
399 | - ); |
|
400 | - // no search params means attendee object already exists. |
|
401 | - $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values) |
|
402 | - ? $where_cols_n_values |
|
403 | - : $attendee_data_keys; |
|
404 | - $valid_data = true; |
|
405 | - // check for required values |
|
406 | - $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname']) |
|
407 | - ? $valid_data |
|
408 | - : false; |
|
409 | - $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname']) |
|
410 | - ? $valid_data |
|
411 | - : false; |
|
412 | - $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email']) |
|
413 | - ? $valid_data |
|
414 | - : false; |
|
415 | - if ($valid_data) { |
|
416 | - $attendee = $this->get_attendee($where_cols_n_values); |
|
417 | - if ($attendee instanceof EE_Attendee) { |
|
418 | - return $attendee; |
|
419 | - } |
|
420 | - } |
|
421 | - return false; |
|
422 | - } |
|
423 | - |
|
424 | - |
|
425 | - |
|
426 | - /** |
|
427 | - * Takes an incoming array of EE_Registration ids |
|
428 | - * and sends back a list of corresponding non duplicate EE_Attendee objects. |
|
429 | - * |
|
430 | - * @since 4.3.0 |
|
431 | - * @param array $ids array of EE_Registration ids |
|
432 | - * @return EE_Attendee[]|EE_Base_Class[] |
|
433 | - * @throws EE_Error |
|
434 | - */ |
|
435 | - public function get_array_of_contacts_from_reg_ids($ids) |
|
436 | - { |
|
437 | - $ids = (array) $ids; |
|
438 | - $_where = array( |
|
439 | - 'Registration.REG_ID' => array('in', $ids), |
|
440 | - ); |
|
441 | - return $this->get_all(array($_where)); |
|
442 | - } |
|
50 | + |
|
51 | + /** |
|
52 | + * @deprecated |
|
53 | + */ |
|
54 | + const city_question_id = 6; |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * @deprecated |
|
59 | + */ |
|
60 | + const state_question_id = 7; |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * @deprecated |
|
65 | + */ |
|
66 | + const country_question_id = 8; |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * @deprecated |
|
71 | + */ |
|
72 | + const zip_question_id = 9; |
|
73 | + |
|
74 | + |
|
75 | + /** |
|
76 | + * @deprecated |
|
77 | + */ |
|
78 | + const phone_question_id = 10; |
|
79 | + |
|
80 | + /** |
|
81 | + * When looking for questions that correspond to attendee fields, |
|
82 | + * look for the question with this QST_system value. |
|
83 | + * These replace the old constants like EEM_Attendee::*_question_id |
|
84 | + */ |
|
85 | + const system_question_fname = 'fname'; |
|
86 | + |
|
87 | + const system_question_lname = 'lname'; |
|
88 | + |
|
89 | + const system_question_email = 'email'; |
|
90 | + |
|
91 | + const system_question_email_confirm = 'email_confirm'; |
|
92 | + |
|
93 | + const system_question_address = 'address'; |
|
94 | + |
|
95 | + const system_question_address2 = 'address2'; |
|
96 | + |
|
97 | + const system_question_city = 'city'; |
|
98 | + |
|
99 | + const system_question_state = 'state'; |
|
100 | + |
|
101 | + const system_question_country = 'country'; |
|
102 | + |
|
103 | + const system_question_zip = 'zip'; |
|
104 | + |
|
105 | + const system_question_phone = 'phone'; |
|
106 | + |
|
107 | + /** |
|
108 | + * Keys are all the EEM_Attendee::system_question_* constants, which are |
|
109 | + * also all the values of QST_system in the questions table, and values |
|
110 | + * are their corresponding Attendee field names |
|
111 | + * |
|
112 | + * @var array |
|
113 | + */ |
|
114 | + protected $_system_question_to_attendee_field_name = array( |
|
115 | + EEM_Attendee::system_question_fname => 'ATT_fname', |
|
116 | + EEM_Attendee::system_question_lname => 'ATT_lname', |
|
117 | + EEM_Attendee::system_question_email => 'ATT_email', |
|
118 | + EEM_Attendee::system_question_address => 'ATT_address', |
|
119 | + EEM_Attendee::system_question_address2 => 'ATT_address2', |
|
120 | + EEM_Attendee::system_question_city => 'ATT_city', |
|
121 | + EEM_Attendee::system_question_state => 'STA_ID', |
|
122 | + EEM_Attendee::system_question_country => 'CNT_ISO', |
|
123 | + EEM_Attendee::system_question_zip => 'ATT_zip', |
|
124 | + EEM_Attendee::system_question_phone => 'ATT_phone', |
|
125 | + ); |
|
126 | + |
|
127 | + |
|
128 | + |
|
129 | + /** |
|
130 | + * EEM_Attendee constructor. |
|
131 | + * |
|
132 | + * @param null $timezone |
|
133 | + * @param ModelFieldFactory $model_field_factory |
|
134 | + * @throws EE_Error |
|
135 | + * @throws InvalidArgumentException |
|
136 | + */ |
|
137 | + protected function __construct($timezone, ModelFieldFactory $model_field_factory) |
|
138 | + { |
|
139 | + $this->singular_item = esc_html__('Attendee', 'event_espresso'); |
|
140 | + $this->plural_item = esc_html__('Attendees', 'event_espresso'); |
|
141 | + $this->_tables = array( |
|
142 | + 'Attendee_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
143 | + 'Attendee_Meta' => new EE_Secondary_Table( |
|
144 | + 'esp_attendee_meta', |
|
145 | + 'ATTM_ID', |
|
146 | + 'ATT_ID' |
|
147 | + ), |
|
148 | + ); |
|
149 | + $this->_fields = array( |
|
150 | + 'Attendee_CPT' => array( |
|
151 | + 'ATT_ID' => $model_field_factory->createPrimaryKeyIntField( |
|
152 | + 'ID', |
|
153 | + esc_html__('Attendee ID', 'event_espresso') |
|
154 | + ), |
|
155 | + 'ATT_full_name' => $model_field_factory->createPlainTextField( |
|
156 | + 'post_title', |
|
157 | + esc_html__('Attendee Full Name', 'event_espresso'), |
|
158 | + false, |
|
159 | + esc_html__('Unknown', 'event_espresso') |
|
160 | + ), |
|
161 | + 'ATT_bio' => $model_field_factory->createPostContentField( |
|
162 | + 'post_content', |
|
163 | + esc_html__('Attendee Biography', 'event_espresso'), |
|
164 | + false, |
|
165 | + esc_html__('No Biography Provided', 'event_espresso') |
|
166 | + ), |
|
167 | + 'ATT_slug' => $model_field_factory->createSlugField( |
|
168 | + 'post_name', |
|
169 | + esc_html__('Attendee URL Slug', 'event_espresso') |
|
170 | + ), |
|
171 | + 'ATT_created' => $model_field_factory->createDatetimeField( |
|
172 | + 'post_date', |
|
173 | + esc_html__('Time Attendee Created', 'event_espresso') |
|
174 | + ), |
|
175 | + 'ATT_short_bio' => $model_field_factory->createSimpleHtmlField( |
|
176 | + 'post_excerpt', |
|
177 | + esc_html__('Attendee Short Biography', 'event_espresso'), |
|
178 | + true, |
|
179 | + esc_html__('No Biography Provided', 'event_espresso') |
|
180 | + ), |
|
181 | + 'ATT_modified' => $model_field_factory->createDatetimeField( |
|
182 | + 'post_modified', |
|
183 | + esc_html__('Time Attendee Last Modified', 'event_espresso') |
|
184 | + ), |
|
185 | + 'ATT_author' => $model_field_factory->createWpUserField( |
|
186 | + 'post_author', |
|
187 | + esc_html__('Creator ID of the first Event attended', 'event_espresso'), |
|
188 | + false |
|
189 | + ), |
|
190 | + 'ATT_parent' => $model_field_factory->createDbOnlyIntField( |
|
191 | + 'post_parent', |
|
192 | + esc_html__('Parent Attendee (unused)', 'event_espresso'), |
|
193 | + false, |
|
194 | + 0 |
|
195 | + ), |
|
196 | + 'post_type' => $model_field_factory->createWpPostTypeField('espresso_attendees'), |
|
197 | + 'status' => $model_field_factory->createWpPostStatusField( |
|
198 | + 'post_status', |
|
199 | + esc_html__('Attendee Status', 'event_espresso'), |
|
200 | + false, |
|
201 | + 'publish' |
|
202 | + ), |
|
203 | + 'password' => new EE_Password_Field( |
|
204 | + 'post_password', |
|
205 | + esc_html__('Password', 'event_espresso'), |
|
206 | + false, |
|
207 | + '', |
|
208 | + array( |
|
209 | + 'ATT_bio', |
|
210 | + 'ATT_short_bio', |
|
211 | + 'ATT_address', |
|
212 | + 'ATT_address2', |
|
213 | + 'ATT_city', |
|
214 | + 'STA_ID', |
|
215 | + 'CNT_ISO', |
|
216 | + 'ATT_zip', |
|
217 | + 'ATT_email', |
|
218 | + 'ATT_phone' |
|
219 | + ) |
|
220 | + ) |
|
221 | + ), |
|
222 | + 'Attendee_Meta' => array( |
|
223 | + 'ATTM_ID' => $model_field_factory->createDbOnlyIntField( |
|
224 | + 'ATTM_ID', |
|
225 | + esc_html__('Attendee Meta Row ID', 'event_espresso'), |
|
226 | + false |
|
227 | + ), |
|
228 | + 'ATT_ID_fk' => $model_field_factory->createDbOnlyIntField( |
|
229 | + 'ATT_ID', |
|
230 | + esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'), |
|
231 | + false |
|
232 | + ), |
|
233 | + 'ATT_fname' => $model_field_factory->createPlainTextField( |
|
234 | + 'ATT_fname', |
|
235 | + esc_html__('First Name', 'event_espresso') |
|
236 | + ), |
|
237 | + 'ATT_lname' => $model_field_factory->createPlainTextField( |
|
238 | + 'ATT_lname', |
|
239 | + esc_html__('Last Name', 'event_espresso') |
|
240 | + ), |
|
241 | + 'ATT_address' => $model_field_factory->createPlainTextField( |
|
242 | + 'ATT_address', |
|
243 | + esc_html__('Address Part 1', 'event_espresso') |
|
244 | + ), |
|
245 | + 'ATT_address2' => $model_field_factory->createPlainTextField( |
|
246 | + 'ATT_address2', |
|
247 | + esc_html__('Address Part 2', 'event_espresso') |
|
248 | + ), |
|
249 | + 'ATT_city' => $model_field_factory->createPlainTextField( |
|
250 | + 'ATT_city', |
|
251 | + esc_html__('City', 'event_espresso') |
|
252 | + ), |
|
253 | + 'STA_ID' => $model_field_factory->createForeignKeyIntField( |
|
254 | + 'STA_ID', |
|
255 | + esc_html__('State', 'event_espresso'), |
|
256 | + true, |
|
257 | + 0, |
|
258 | + 'State' |
|
259 | + ), |
|
260 | + 'CNT_ISO' => $model_field_factory->createForeignKeyStringField( |
|
261 | + 'CNT_ISO', |
|
262 | + esc_html__('Country', 'event_espresso'), |
|
263 | + true, |
|
264 | + '', |
|
265 | + 'Country' |
|
266 | + ), |
|
267 | + 'ATT_zip' => $model_field_factory->createPlainTextField( |
|
268 | + 'ATT_zip', |
|
269 | + esc_html__('ZIP/Postal Code', 'event_espresso') |
|
270 | + ), |
|
271 | + 'ATT_email' => $model_field_factory->createEmailField( |
|
272 | + 'ATT_email', |
|
273 | + esc_html__('Email Address', 'event_espresso') |
|
274 | + ), |
|
275 | + 'ATT_phone' => $model_field_factory->createPlainTextField( |
|
276 | + 'ATT_phone', |
|
277 | + esc_html__('Phone', 'event_espresso') |
|
278 | + ), |
|
279 | + ), |
|
280 | + ); |
|
281 | + $this->_model_relations = array( |
|
282 | + 'Registration' => new EE_Has_Many_Relation(), |
|
283 | + 'State' => new EE_Belongs_To_Relation(), |
|
284 | + 'Country' => new EE_Belongs_To_Relation(), |
|
285 | + 'Event' => new EE_HABTM_Relation('Registration', false), |
|
286 | + 'WP_User' => new EE_Belongs_To_Relation(), |
|
287 | + 'Message' => new EE_Has_Many_Any_Relation(false), |
|
288 | + // allow deletion of attendees even if they have messages in the queue for them. |
|
289 | + 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
290 | + 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
291 | + ); |
|
292 | + $this->_caps_slug = 'contacts'; |
|
293 | + $this->model_chain_to_password = ''; |
|
294 | + parent::__construct($timezone); |
|
295 | + } |
|
296 | + |
|
297 | + |
|
298 | + |
|
299 | + /** |
|
300 | + * Gets the name of the field on the attendee model corresponding to the system question string |
|
301 | + * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name |
|
302 | + * |
|
303 | + * @param string $system_question_string |
|
304 | + * @return string|null if not found |
|
305 | + */ |
|
306 | + public function get_attendee_field_for_system_question($system_question_string) |
|
307 | + { |
|
308 | + return isset($this->_system_question_to_attendee_field_name[ $system_question_string ]) |
|
309 | + ? $this->_system_question_to_attendee_field_name[ $system_question_string ] |
|
310 | + : null; |
|
311 | + } |
|
312 | + |
|
313 | + |
|
314 | + |
|
315 | + /** |
|
316 | + * Gets mapping from esp_question.QST_system values to their corresponding attendee field names |
|
317 | + * |
|
318 | + * @return array |
|
319 | + */ |
|
320 | + public function system_question_to_attendee_field_mapping() |
|
321 | + { |
|
322 | + return $this->_system_question_to_attendee_field_name; |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + |
|
327 | + /** |
|
328 | + * Gets all the attendees for a transaction (by using the esp_registration as a join table) |
|
329 | + * |
|
330 | + * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID |
|
331 | + * @return EE_Attendee[]|EE_Base_Class[] |
|
332 | + * @throws EE_Error |
|
333 | + */ |
|
334 | + public function get_attendees_for_transaction($transaction_id_or_obj) |
|
335 | + { |
|
336 | + return $this->get_all( |
|
337 | + array( |
|
338 | + array( |
|
339 | + 'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction |
|
340 | + ? $transaction_id_or_obj->ID() |
|
341 | + : $transaction_id_or_obj, |
|
342 | + ), |
|
343 | + ) |
|
344 | + ); |
|
345 | + } |
|
346 | + |
|
347 | + |
|
348 | + |
|
349 | + /** |
|
350 | + * retrieve a single attendee from db via their ID |
|
351 | + * |
|
352 | + * @param $ATT_ID |
|
353 | + * @return mixed array on success, FALSE on fail |
|
354 | + * @deprecated |
|
355 | + */ |
|
356 | + public function get_attendee_by_ID($ATT_ID = false) |
|
357 | + { |
|
358 | + // retrieve a particular EE_Attendee |
|
359 | + return $this->get_one_by_ID($ATT_ID); |
|
360 | + } |
|
361 | + |
|
362 | + |
|
363 | + |
|
364 | + /** |
|
365 | + * retrieve a single attendee from db via their ID |
|
366 | + * |
|
367 | + * @param array $where_cols_n_values |
|
368 | + * @return mixed array on success, FALSE on fail |
|
369 | + * @throws EE_Error |
|
370 | + */ |
|
371 | + public function get_attendee($where_cols_n_values = array()) |
|
372 | + { |
|
373 | + if (empty($where_cols_n_values)) { |
|
374 | + return false; |
|
375 | + } |
|
376 | + $attendee = $this->get_all(array($where_cols_n_values)); |
|
377 | + if (! empty($attendee)) { |
|
378 | + return array_shift($attendee); |
|
379 | + } |
|
380 | + return false; |
|
381 | + } |
|
382 | + |
|
383 | + |
|
384 | + |
|
385 | + /** |
|
386 | + * Search for an existing Attendee record in the DB |
|
387 | + * |
|
388 | + * @param array $where_cols_n_values |
|
389 | + * @return bool|mixed |
|
390 | + * @throws EE_Error |
|
391 | + */ |
|
392 | + public function find_existing_attendee($where_cols_n_values = null) |
|
393 | + { |
|
394 | + // search by combo of first and last names plus the email address |
|
395 | + $attendee_data_keys = array( |
|
396 | + 'ATT_fname' => $this->_ATT_fname, |
|
397 | + 'ATT_lname' => $this->_ATT_lname, |
|
398 | + 'ATT_email' => $this->_ATT_email, |
|
399 | + ); |
|
400 | + // no search params means attendee object already exists. |
|
401 | + $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values) |
|
402 | + ? $where_cols_n_values |
|
403 | + : $attendee_data_keys; |
|
404 | + $valid_data = true; |
|
405 | + // check for required values |
|
406 | + $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname']) |
|
407 | + ? $valid_data |
|
408 | + : false; |
|
409 | + $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname']) |
|
410 | + ? $valid_data |
|
411 | + : false; |
|
412 | + $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email']) |
|
413 | + ? $valid_data |
|
414 | + : false; |
|
415 | + if ($valid_data) { |
|
416 | + $attendee = $this->get_attendee($where_cols_n_values); |
|
417 | + if ($attendee instanceof EE_Attendee) { |
|
418 | + return $attendee; |
|
419 | + } |
|
420 | + } |
|
421 | + return false; |
|
422 | + } |
|
423 | + |
|
424 | + |
|
425 | + |
|
426 | + /** |
|
427 | + * Takes an incoming array of EE_Registration ids |
|
428 | + * and sends back a list of corresponding non duplicate EE_Attendee objects. |
|
429 | + * |
|
430 | + * @since 4.3.0 |
|
431 | + * @param array $ids array of EE_Registration ids |
|
432 | + * @return EE_Attendee[]|EE_Base_Class[] |
|
433 | + * @throws EE_Error |
|
434 | + */ |
|
435 | + public function get_array_of_contacts_from_reg_ids($ids) |
|
436 | + { |
|
437 | + $ids = (array) $ids; |
|
438 | + $_where = array( |
|
439 | + 'Registration.REG_ID' => array('in', $ids), |
|
440 | + ); |
|
441 | + return $this->get_all(array($_where)); |
|
442 | + } |
|
443 | 443 | } |
@@ -59,11 +59,11 @@ |
||
59 | 59 | ); |
60 | 60 | $this->_model_relations = array(); |
61 | 61 | foreach ($models_this_can_attach_to as $model) { |
62 | - $this->_model_relations[ $model ] = new EE_Belongs_To_Relation(); |
|
62 | + $this->_model_relations[$model] = new EE_Belongs_To_Relation(); |
|
63 | 63 | } |
64 | 64 | $this->_wp_core_model = true; |
65 | 65 | foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) { |
66 | - $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta( |
|
66 | + $this->_cap_restriction_generators[$cap_context] = new EE_Restriction_Generator_Meta( |
|
67 | 67 | 'meta_key', |
68 | 68 | 'meta_value' |
69 | 69 | ); |
@@ -18,56 +18,56 @@ |
||
18 | 18 | */ |
19 | 19 | class EEM_Post_Meta extends EEM_Base |
20 | 20 | { |
21 | - // private instance of the EE_Post_Meta object |
|
22 | - protected static $_instance = null; |
|
21 | + // private instance of the EE_Post_Meta object |
|
22 | + protected static $_instance = null; |
|
23 | 23 | |
24 | 24 | |
25 | 25 | |
26 | - protected function __construct($timezone = null) |
|
27 | - { |
|
28 | - $this->singular_item = esc_html__('Post Meta', 'event_espresso'); |
|
29 | - $this->plural_item = esc_html__('Post Metas', 'event_espresso'); |
|
30 | - $this->_tables = array( |
|
31 | - 'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'), |
|
32 | - ); |
|
33 | - $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models()); |
|
34 | - $this->_fields = array( |
|
35 | - 'Post_Meta' => array( |
|
36 | - 'meta_id' => new EE_Primary_Key_Int_Field( |
|
37 | - 'meta_id', |
|
38 | - esc_html__("Meta ID", "event_espresso") |
|
39 | - ), |
|
40 | - 'post_id' => new EE_Foreign_Key_Int_Field( |
|
41 | - 'post_id', |
|
42 | - esc_html__("Primary Key of Post", "event_espresso"), |
|
43 | - false, |
|
44 | - 0, |
|
45 | - $models_this_can_attach_to |
|
46 | - ), |
|
47 | - 'meta_key' => new EE_Plain_Text_Field( |
|
48 | - 'meta_key', |
|
49 | - esc_html__("Meta Key", "event_espresso"), |
|
50 | - false, |
|
51 | - '' |
|
52 | - ), |
|
53 | - 'meta_value' => new EE_Maybe_Serialized_Text_Field( |
|
54 | - 'meta_value', |
|
55 | - esc_html__("Meta Value", "event_espresso"), |
|
56 | - true |
|
57 | - ), |
|
58 | - ), |
|
59 | - ); |
|
60 | - $this->_model_relations = array(); |
|
61 | - foreach ($models_this_can_attach_to as $model) { |
|
62 | - $this->_model_relations[ $model ] = new EE_Belongs_To_Relation(); |
|
63 | - } |
|
64 | - $this->_wp_core_model = true; |
|
65 | - foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) { |
|
66 | - $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta( |
|
67 | - 'meta_key', |
|
68 | - 'meta_value' |
|
69 | - ); |
|
70 | - } |
|
71 | - parent::__construct($timezone); |
|
72 | - } |
|
26 | + protected function __construct($timezone = null) |
|
27 | + { |
|
28 | + $this->singular_item = esc_html__('Post Meta', 'event_espresso'); |
|
29 | + $this->plural_item = esc_html__('Post Metas', 'event_espresso'); |
|
30 | + $this->_tables = array( |
|
31 | + 'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'), |
|
32 | + ); |
|
33 | + $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models()); |
|
34 | + $this->_fields = array( |
|
35 | + 'Post_Meta' => array( |
|
36 | + 'meta_id' => new EE_Primary_Key_Int_Field( |
|
37 | + 'meta_id', |
|
38 | + esc_html__("Meta ID", "event_espresso") |
|
39 | + ), |
|
40 | + 'post_id' => new EE_Foreign_Key_Int_Field( |
|
41 | + 'post_id', |
|
42 | + esc_html__("Primary Key of Post", "event_espresso"), |
|
43 | + false, |
|
44 | + 0, |
|
45 | + $models_this_can_attach_to |
|
46 | + ), |
|
47 | + 'meta_key' => new EE_Plain_Text_Field( |
|
48 | + 'meta_key', |
|
49 | + esc_html__("Meta Key", "event_espresso"), |
|
50 | + false, |
|
51 | + '' |
|
52 | + ), |
|
53 | + 'meta_value' => new EE_Maybe_Serialized_Text_Field( |
|
54 | + 'meta_value', |
|
55 | + esc_html__("Meta Value", "event_espresso"), |
|
56 | + true |
|
57 | + ), |
|
58 | + ), |
|
59 | + ); |
|
60 | + $this->_model_relations = array(); |
|
61 | + foreach ($models_this_can_attach_to as $model) { |
|
62 | + $this->_model_relations[ $model ] = new EE_Belongs_To_Relation(); |
|
63 | + } |
|
64 | + $this->_wp_core_model = true; |
|
65 | + foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) { |
|
66 | + $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta( |
|
67 | + 'meta_key', |
|
68 | + 'meta_value' |
|
69 | + ); |
|
70 | + } |
|
71 | + parent::__construct($timezone); |
|
72 | + } |
|
73 | 73 | } |