@@ -11,104 +11,104 @@ |
||
11 | 11 | class EE_State extends EE_Base_Class |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @param array $props_n_values |
|
16 | - * @return EE_State|mixed |
|
17 | - */ |
|
18 | - public static function new_instance($props_n_values = array()) |
|
19 | - { |
|
20 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__); |
|
21 | - return $has_object ? $has_object : new self($props_n_values); |
|
22 | - } |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * @param array $props_n_values |
|
27 | - * @return EE_State |
|
28 | - */ |
|
29 | - public static function new_instance_from_db($props_n_values = array()) |
|
30 | - { |
|
31 | - return new self($props_n_values, true); |
|
32 | - } |
|
33 | - |
|
34 | - |
|
35 | - /** |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - public function country_iso() |
|
39 | - { |
|
40 | - return $this->get('CNT_ISO'); |
|
41 | - } |
|
42 | - |
|
43 | - |
|
44 | - /** |
|
45 | - * @return string |
|
46 | - */ |
|
47 | - public function abbrev() |
|
48 | - { |
|
49 | - return $this->get('STA_abbrev'); |
|
50 | - } |
|
51 | - |
|
52 | - |
|
53 | - /** |
|
54 | - * @return bool |
|
55 | - */ |
|
56 | - public function active() |
|
57 | - { |
|
58 | - return $this->get('STA_active'); |
|
59 | - } |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * @return string |
|
64 | - */ |
|
65 | - public function name() |
|
66 | - { |
|
67 | - return $this->get('STA_name'); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * @return EE_Country |
|
73 | - */ |
|
74 | - public function country() |
|
75 | - { |
|
76 | - return $this->get_first_related('Country'); |
|
77 | - } |
|
78 | - |
|
79 | - |
|
80 | - /** |
|
81 | - * @param $iso |
|
82 | - */ |
|
83 | - public function set_country_iso($iso) |
|
84 | - { |
|
85 | - $this->set('CNT_ISO', $iso); |
|
86 | - } |
|
87 | - |
|
88 | - |
|
89 | - /** |
|
90 | - * @param $abbrev |
|
91 | - */ |
|
92 | - public function set_abbrev($abbrev) |
|
93 | - { |
|
94 | - $this->set('STA_abbrev', $abbrev); |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * @param $active |
|
100 | - */ |
|
101 | - public function set_active($active) |
|
102 | - { |
|
103 | - $this->set('STA_active', $active); |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * @param $name |
|
109 | - */ |
|
110 | - public function set_name($name) |
|
111 | - { |
|
112 | - $this->set('STA_name', $name); |
|
113 | - } |
|
14 | + /** |
|
15 | + * @param array $props_n_values |
|
16 | + * @return EE_State|mixed |
|
17 | + */ |
|
18 | + public static function new_instance($props_n_values = array()) |
|
19 | + { |
|
20 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__); |
|
21 | + return $has_object ? $has_object : new self($props_n_values); |
|
22 | + } |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * @param array $props_n_values |
|
27 | + * @return EE_State |
|
28 | + */ |
|
29 | + public static function new_instance_from_db($props_n_values = array()) |
|
30 | + { |
|
31 | + return new self($props_n_values, true); |
|
32 | + } |
|
33 | + |
|
34 | + |
|
35 | + /** |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + public function country_iso() |
|
39 | + { |
|
40 | + return $this->get('CNT_ISO'); |
|
41 | + } |
|
42 | + |
|
43 | + |
|
44 | + /** |
|
45 | + * @return string |
|
46 | + */ |
|
47 | + public function abbrev() |
|
48 | + { |
|
49 | + return $this->get('STA_abbrev'); |
|
50 | + } |
|
51 | + |
|
52 | + |
|
53 | + /** |
|
54 | + * @return bool |
|
55 | + */ |
|
56 | + public function active() |
|
57 | + { |
|
58 | + return $this->get('STA_active'); |
|
59 | + } |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * @return string |
|
64 | + */ |
|
65 | + public function name() |
|
66 | + { |
|
67 | + return $this->get('STA_name'); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * @return EE_Country |
|
73 | + */ |
|
74 | + public function country() |
|
75 | + { |
|
76 | + return $this->get_first_related('Country'); |
|
77 | + } |
|
78 | + |
|
79 | + |
|
80 | + /** |
|
81 | + * @param $iso |
|
82 | + */ |
|
83 | + public function set_country_iso($iso) |
|
84 | + { |
|
85 | + $this->set('CNT_ISO', $iso); |
|
86 | + } |
|
87 | + |
|
88 | + |
|
89 | + /** |
|
90 | + * @param $abbrev |
|
91 | + */ |
|
92 | + public function set_abbrev($abbrev) |
|
93 | + { |
|
94 | + $this->set('STA_abbrev', $abbrev); |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * @param $active |
|
100 | + */ |
|
101 | + public function set_active($active) |
|
102 | + { |
|
103 | + $this->set('STA_active', $active); |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * @param $name |
|
109 | + */ |
|
110 | + public function set_name($name) |
|
111 | + { |
|
112 | + $this->set('STA_name', $name); |
|
113 | + } |
|
114 | 114 | } |
@@ -12,25 +12,25 @@ |
||
12 | 12 | class EE_Event_Message_Template extends EE_Base_Class |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * @param array $props_n_values |
|
17 | - * @param null $timezone |
|
18 | - * @return EE_Event_Message_Template|mixed |
|
19 | - */ |
|
20 | - public static function new_instance($props_n_values = array(), $timezone = null) |
|
21 | - { |
|
22 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone); |
|
23 | - return $has_object ? $has_object : new self($props_n_values, false, $timezone); |
|
24 | - } |
|
15 | + /** |
|
16 | + * @param array $props_n_values |
|
17 | + * @param null $timezone |
|
18 | + * @return EE_Event_Message_Template|mixed |
|
19 | + */ |
|
20 | + public static function new_instance($props_n_values = array(), $timezone = null) |
|
21 | + { |
|
22 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone); |
|
23 | + return $has_object ? $has_object : new self($props_n_values, false, $timezone); |
|
24 | + } |
|
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * @param array $props_n_values |
|
29 | - * @param null $timezone |
|
30 | - * @return EE_Event_Message_Template |
|
31 | - */ |
|
32 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
33 | - { |
|
34 | - return new self($props_n_values, true, $timezone); |
|
35 | - } |
|
27 | + /** |
|
28 | + * @param array $props_n_values |
|
29 | + * @param null $timezone |
|
30 | + * @return EE_Event_Message_Template |
|
31 | + */ |
|
32 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
33 | + { |
|
34 | + return new self($props_n_values, true, $timezone); |
|
35 | + } |
|
36 | 36 | } |
@@ -11,217 +11,217 @@ |
||
11 | 11 | class EE_Change_Log extends EE_Base_Class |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @param array $props_n_values incoming values |
|
16 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
17 | - * used.) |
|
18 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
19 | - * date_format and the second value is the time format |
|
20 | - * @return EE_Change_Log |
|
21 | - * @throws EE_Error |
|
22 | - */ |
|
23 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
24 | - { |
|
25 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
26 | - return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
27 | - } |
|
28 | - |
|
29 | - |
|
30 | - /** |
|
31 | - * @param array $props_n_values incoming values from the database |
|
32 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
33 | - * the website will be used. |
|
34 | - * @return EE_Change_Log |
|
35 | - */ |
|
36 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
37 | - { |
|
38 | - return new self($props_n_values, true, $timezone); |
|
39 | - } |
|
40 | - |
|
41 | - /** |
|
42 | - * Gets message |
|
43 | - * |
|
44 | - * @return mixed |
|
45 | - * @throws EE_Error |
|
46 | - */ |
|
47 | - public function message() |
|
48 | - { |
|
49 | - return $this->get('LOG_message'); |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * Sets message |
|
54 | - * |
|
55 | - * @param mixed $message |
|
56 | - * @throws EE_Error |
|
57 | - */ |
|
58 | - public function set_message($message) |
|
59 | - { |
|
60 | - $this->set('LOG_message', $message); |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Gets time |
|
65 | - * |
|
66 | - * @return string |
|
67 | - * @throws EE_Error |
|
68 | - */ |
|
69 | - public function time() |
|
70 | - { |
|
71 | - return $this->get('LOG_time'); |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * Sets time |
|
76 | - * |
|
77 | - * @param string $time |
|
78 | - * @throws EE_Error |
|
79 | - */ |
|
80 | - public function set_time($time) |
|
81 | - { |
|
82 | - $this->set('LOG_time', $time); |
|
83 | - } |
|
84 | - |
|
85 | - /** |
|
86 | - * Gets log_type |
|
87 | - * |
|
88 | - * @return string |
|
89 | - * @throws EE_Error |
|
90 | - */ |
|
91 | - public function log_type() |
|
92 | - { |
|
93 | - return $this->get('LOG_type'); |
|
94 | - } |
|
95 | - |
|
96 | - |
|
97 | - /** |
|
98 | - * Return the localized log type label. |
|
99 | - * |
|
100 | - * @return string |
|
101 | - * @throws EE_Error |
|
102 | - */ |
|
103 | - public function log_type_label() |
|
104 | - { |
|
105 | - return EEM_Change_Log::get_pretty_label_for_type($this->log_type()); |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Sets log_type |
|
110 | - * |
|
111 | - * @param string $log_type |
|
112 | - * @throws EE_Error |
|
113 | - */ |
|
114 | - public function set_log_type($log_type) |
|
115 | - { |
|
116 | - $this->set('LOG_type', $log_type); |
|
117 | - } |
|
118 | - |
|
119 | - /** |
|
120 | - * Gets type of the model object related to this log |
|
121 | - * |
|
122 | - * @return string |
|
123 | - * @throws EE_Error |
|
124 | - */ |
|
125 | - public function OBJ_type() |
|
126 | - { |
|
127 | - return $this->get('OBJ_type'); |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * Sets type |
|
132 | - * |
|
133 | - * @param string $type |
|
134 | - * @throws EE_Error |
|
135 | - */ |
|
136 | - public function set_OBJ_type($type) |
|
137 | - { |
|
138 | - $this->set('OBJ_type', $type); |
|
139 | - } |
|
140 | - |
|
141 | - /** |
|
142 | - * Gets OBJ_ID (the ID of the item related to this log) |
|
143 | - * |
|
144 | - * @return mixed |
|
145 | - * @throws EE_Error |
|
146 | - */ |
|
147 | - public function OBJ_ID() |
|
148 | - { |
|
149 | - return $this->get('OBJ_ID'); |
|
150 | - } |
|
151 | - |
|
152 | - /** |
|
153 | - * Sets OBJ_ID |
|
154 | - * |
|
155 | - * @param mixed $OBJ_ID |
|
156 | - * @throws EE_Error |
|
157 | - */ |
|
158 | - public function set_OBJ_ID($OBJ_ID) |
|
159 | - { |
|
160 | - $this->set('OBJ_ID', $OBJ_ID); |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Gets wp_user |
|
165 | - * |
|
166 | - * @return int |
|
167 | - * @throws EE_Error |
|
168 | - */ |
|
169 | - public function wp_user() |
|
170 | - { |
|
171 | - return $this->get('LOG_wp_user'); |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * Sets wp_user |
|
176 | - * |
|
177 | - * @param int $wp_user_id |
|
178 | - * @throws EE_Error |
|
179 | - */ |
|
180 | - public function set_wp_user($wp_user_id) |
|
181 | - { |
|
182 | - $this->set('LOG_wp_user', $wp_user_id); |
|
183 | - } |
|
184 | - |
|
185 | - /** |
|
186 | - * Gets the model object attached to this log |
|
187 | - * |
|
188 | - * @return EE_Base_Class |
|
189 | - * @throws EE_Error |
|
190 | - */ |
|
191 | - public function object() |
|
192 | - { |
|
193 | - $model_name_of_related_obj = $this->OBJ_type(); |
|
194 | - $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj); |
|
195 | - if (! $is_model_name) { |
|
196 | - return null; |
|
197 | - } else { |
|
198 | - return $this->get_first_related($model_name_of_related_obj); |
|
199 | - } |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using |
|
204 | - * _add_relation_to because you don't have to specify what type of model you're |
|
205 | - * associating it with |
|
206 | - * |
|
207 | - * @param EE_Base_Class $object |
|
208 | - * @param boolean $save |
|
209 | - * @return bool if $save=true, NULL is $save=false |
|
210 | - * @throws EE_Error |
|
211 | - */ |
|
212 | - public function set_object($object, $save = true) |
|
213 | - { |
|
214 | - if ($object instanceof EE_Base_Class) { |
|
215 | - $this->set_OBJ_type($object->get_model()->get_this_model_name()); |
|
216 | - $this->set_OBJ_ID($object->ID()); |
|
217 | - } else { |
|
218 | - $this->set_OBJ_type(null); |
|
219 | - $this->set_OBJ_ID(null); |
|
220 | - } |
|
221 | - if ($save) { |
|
222 | - return $this->save(); |
|
223 | - } else { |
|
224 | - return null; |
|
225 | - } |
|
226 | - } |
|
14 | + /** |
|
15 | + * @param array $props_n_values incoming values |
|
16 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
17 | + * used.) |
|
18 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
19 | + * date_format and the second value is the time format |
|
20 | + * @return EE_Change_Log |
|
21 | + * @throws EE_Error |
|
22 | + */ |
|
23 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
24 | + { |
|
25 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
26 | + return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
27 | + } |
|
28 | + |
|
29 | + |
|
30 | + /** |
|
31 | + * @param array $props_n_values incoming values from the database |
|
32 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
33 | + * the website will be used. |
|
34 | + * @return EE_Change_Log |
|
35 | + */ |
|
36 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
37 | + { |
|
38 | + return new self($props_n_values, true, $timezone); |
|
39 | + } |
|
40 | + |
|
41 | + /** |
|
42 | + * Gets message |
|
43 | + * |
|
44 | + * @return mixed |
|
45 | + * @throws EE_Error |
|
46 | + */ |
|
47 | + public function message() |
|
48 | + { |
|
49 | + return $this->get('LOG_message'); |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * Sets message |
|
54 | + * |
|
55 | + * @param mixed $message |
|
56 | + * @throws EE_Error |
|
57 | + */ |
|
58 | + public function set_message($message) |
|
59 | + { |
|
60 | + $this->set('LOG_message', $message); |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Gets time |
|
65 | + * |
|
66 | + * @return string |
|
67 | + * @throws EE_Error |
|
68 | + */ |
|
69 | + public function time() |
|
70 | + { |
|
71 | + return $this->get('LOG_time'); |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * Sets time |
|
76 | + * |
|
77 | + * @param string $time |
|
78 | + * @throws EE_Error |
|
79 | + */ |
|
80 | + public function set_time($time) |
|
81 | + { |
|
82 | + $this->set('LOG_time', $time); |
|
83 | + } |
|
84 | + |
|
85 | + /** |
|
86 | + * Gets log_type |
|
87 | + * |
|
88 | + * @return string |
|
89 | + * @throws EE_Error |
|
90 | + */ |
|
91 | + public function log_type() |
|
92 | + { |
|
93 | + return $this->get('LOG_type'); |
|
94 | + } |
|
95 | + |
|
96 | + |
|
97 | + /** |
|
98 | + * Return the localized log type label. |
|
99 | + * |
|
100 | + * @return string |
|
101 | + * @throws EE_Error |
|
102 | + */ |
|
103 | + public function log_type_label() |
|
104 | + { |
|
105 | + return EEM_Change_Log::get_pretty_label_for_type($this->log_type()); |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Sets log_type |
|
110 | + * |
|
111 | + * @param string $log_type |
|
112 | + * @throws EE_Error |
|
113 | + */ |
|
114 | + public function set_log_type($log_type) |
|
115 | + { |
|
116 | + $this->set('LOG_type', $log_type); |
|
117 | + } |
|
118 | + |
|
119 | + /** |
|
120 | + * Gets type of the model object related to this log |
|
121 | + * |
|
122 | + * @return string |
|
123 | + * @throws EE_Error |
|
124 | + */ |
|
125 | + public function OBJ_type() |
|
126 | + { |
|
127 | + return $this->get('OBJ_type'); |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * Sets type |
|
132 | + * |
|
133 | + * @param string $type |
|
134 | + * @throws EE_Error |
|
135 | + */ |
|
136 | + public function set_OBJ_type($type) |
|
137 | + { |
|
138 | + $this->set('OBJ_type', $type); |
|
139 | + } |
|
140 | + |
|
141 | + /** |
|
142 | + * Gets OBJ_ID (the ID of the item related to this log) |
|
143 | + * |
|
144 | + * @return mixed |
|
145 | + * @throws EE_Error |
|
146 | + */ |
|
147 | + public function OBJ_ID() |
|
148 | + { |
|
149 | + return $this->get('OBJ_ID'); |
|
150 | + } |
|
151 | + |
|
152 | + /** |
|
153 | + * Sets OBJ_ID |
|
154 | + * |
|
155 | + * @param mixed $OBJ_ID |
|
156 | + * @throws EE_Error |
|
157 | + */ |
|
158 | + public function set_OBJ_ID($OBJ_ID) |
|
159 | + { |
|
160 | + $this->set('OBJ_ID', $OBJ_ID); |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Gets wp_user |
|
165 | + * |
|
166 | + * @return int |
|
167 | + * @throws EE_Error |
|
168 | + */ |
|
169 | + public function wp_user() |
|
170 | + { |
|
171 | + return $this->get('LOG_wp_user'); |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * Sets wp_user |
|
176 | + * |
|
177 | + * @param int $wp_user_id |
|
178 | + * @throws EE_Error |
|
179 | + */ |
|
180 | + public function set_wp_user($wp_user_id) |
|
181 | + { |
|
182 | + $this->set('LOG_wp_user', $wp_user_id); |
|
183 | + } |
|
184 | + |
|
185 | + /** |
|
186 | + * Gets the model object attached to this log |
|
187 | + * |
|
188 | + * @return EE_Base_Class |
|
189 | + * @throws EE_Error |
|
190 | + */ |
|
191 | + public function object() |
|
192 | + { |
|
193 | + $model_name_of_related_obj = $this->OBJ_type(); |
|
194 | + $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj); |
|
195 | + if (! $is_model_name) { |
|
196 | + return null; |
|
197 | + } else { |
|
198 | + return $this->get_first_related($model_name_of_related_obj); |
|
199 | + } |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using |
|
204 | + * _add_relation_to because you don't have to specify what type of model you're |
|
205 | + * associating it with |
|
206 | + * |
|
207 | + * @param EE_Base_Class $object |
|
208 | + * @param boolean $save |
|
209 | + * @return bool if $save=true, NULL is $save=false |
|
210 | + * @throws EE_Error |
|
211 | + */ |
|
212 | + public function set_object($object, $save = true) |
|
213 | + { |
|
214 | + if ($object instanceof EE_Base_Class) { |
|
215 | + $this->set_OBJ_type($object->get_model()->get_this_model_name()); |
|
216 | + $this->set_OBJ_ID($object->ID()); |
|
217 | + } else { |
|
218 | + $this->set_OBJ_type(null); |
|
219 | + $this->set_OBJ_ID(null); |
|
220 | + } |
|
221 | + if ($save) { |
|
222 | + return $this->save(); |
|
223 | + } else { |
|
224 | + return null; |
|
225 | + } |
|
226 | + } |
|
227 | 227 | } |
@@ -192,7 +192,7 @@ |
||
192 | 192 | { |
193 | 193 | $model_name_of_related_obj = $this->OBJ_type(); |
194 | 194 | $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj); |
195 | - if (! $is_model_name) { |
|
195 | + if ( ! $is_model_name) { |
|
196 | 196 | return null; |
197 | 197 | } else { |
198 | 198 | return $this->get_first_related($model_name_of_related_obj); |
@@ -36,88 +36,88 @@ |
||
36 | 36 | class EE_Line_Item_Filter_Processor |
37 | 37 | { |
38 | 38 | |
39 | - /** |
|
40 | - * @type EE_Line_Item_Filter_Collection $line_item_filters |
|
41 | - */ |
|
42 | - protected $line_item_filters; |
|
39 | + /** |
|
40 | + * @type EE_Line_Item_Filter_Collection $line_item_filters |
|
41 | + */ |
|
42 | + protected $line_item_filters; |
|
43 | 43 | |
44 | - /** |
|
45 | - * @type EEI_Line_Item $grand_total_line_item |
|
46 | - */ |
|
47 | - protected $grand_total_line_item; |
|
44 | + /** |
|
45 | + * @type EEI_Line_Item $grand_total_line_item |
|
46 | + */ |
|
47 | + protected $grand_total_line_item; |
|
48 | 48 | |
49 | 49 | |
50 | - /** |
|
51 | - * EE_Line_Item_Filter_Processor constructor. |
|
52 | - * |
|
53 | - * @param \EE_Line_Item_Filter_Collection $line_item_filters |
|
54 | - * @param \EEI_Line_Item $grand_total_line_item |
|
55 | - * @throws \EE_Error |
|
56 | - */ |
|
57 | - public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item) |
|
58 | - { |
|
59 | - $this->line_item_filters = $line_item_filters; |
|
60 | - if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) { |
|
61 | - throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso')); |
|
62 | - } |
|
63 | - $this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item); |
|
64 | - } |
|
50 | + /** |
|
51 | + * EE_Line_Item_Filter_Processor constructor. |
|
52 | + * |
|
53 | + * @param \EE_Line_Item_Filter_Collection $line_item_filters |
|
54 | + * @param \EEI_Line_Item $grand_total_line_item |
|
55 | + * @throws \EE_Error |
|
56 | + */ |
|
57 | + public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item) |
|
58 | + { |
|
59 | + $this->line_item_filters = $line_item_filters; |
|
60 | + if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) { |
|
61 | + throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso')); |
|
62 | + } |
|
63 | + $this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item); |
|
64 | + } |
|
65 | 65 | |
66 | 66 | |
67 | - /** |
|
68 | - * clone_and_reset_line_item_tree |
|
69 | - * |
|
70 | - * @param \EEI_Line_Item $line_item |
|
71 | - * @return \EEI_Line_Item |
|
72 | - */ |
|
73 | - protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item) |
|
74 | - { |
|
75 | - $cloned_line_item = $this->clone_and_reset_line_item($line_item); |
|
76 | - foreach ($line_item->children() as $child_line_item) { |
|
77 | - $cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item)); |
|
78 | - } |
|
79 | - return $cloned_line_item; |
|
80 | - } |
|
67 | + /** |
|
68 | + * clone_and_reset_line_item_tree |
|
69 | + * |
|
70 | + * @param \EEI_Line_Item $line_item |
|
71 | + * @return \EEI_Line_Item |
|
72 | + */ |
|
73 | + protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item) |
|
74 | + { |
|
75 | + $cloned_line_item = $this->clone_and_reset_line_item($line_item); |
|
76 | + foreach ($line_item->children() as $child_line_item) { |
|
77 | + $cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item)); |
|
78 | + } |
|
79 | + return $cloned_line_item; |
|
80 | + } |
|
81 | 81 | |
82 | 82 | |
83 | - /** |
|
84 | - * clone_and_reset_line_item |
|
85 | - * |
|
86 | - * clones the incoming object |
|
87 | - * resets any fields that represent database primary keys |
|
88 | - * resets total |
|
89 | - * |
|
90 | - * @param \EEI_Line_Item $line_item |
|
91 | - * @return \EEI_Line_Item |
|
92 | - */ |
|
93 | - protected function clone_and_reset_line_item(EEI_Line_Item $line_item) |
|
94 | - { |
|
95 | - // we don't actually want to work with the original line item, so clone it |
|
96 | - $cloned_line_item = clone $line_item; |
|
97 | - $cloned_line_item->set('LIN_ID', null); |
|
98 | - $cloned_line_item->set('LIN_parent', null); |
|
99 | - $cloned_line_item->clear_related_line_item_cache(); |
|
100 | - foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) { |
|
101 | - $cloned_line_item->clear_cache($relation_name, null, true); |
|
102 | - } |
|
103 | - $cloned_line_item->set_allow_persist(false); |
|
104 | - return $cloned_line_item; |
|
105 | - } |
|
83 | + /** |
|
84 | + * clone_and_reset_line_item |
|
85 | + * |
|
86 | + * clones the incoming object |
|
87 | + * resets any fields that represent database primary keys |
|
88 | + * resets total |
|
89 | + * |
|
90 | + * @param \EEI_Line_Item $line_item |
|
91 | + * @return \EEI_Line_Item |
|
92 | + */ |
|
93 | + protected function clone_and_reset_line_item(EEI_Line_Item $line_item) |
|
94 | + { |
|
95 | + // we don't actually want to work with the original line item, so clone it |
|
96 | + $cloned_line_item = clone $line_item; |
|
97 | + $cloned_line_item->set('LIN_ID', null); |
|
98 | + $cloned_line_item->set('LIN_parent', null); |
|
99 | + $cloned_line_item->clear_related_line_item_cache(); |
|
100 | + foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) { |
|
101 | + $cloned_line_item->clear_cache($relation_name, null, true); |
|
102 | + } |
|
103 | + $cloned_line_item->set_allow_persist(false); |
|
104 | + return $cloned_line_item; |
|
105 | + } |
|
106 | 106 | |
107 | 107 | |
108 | - /** |
|
109 | - * process |
|
110 | - * |
|
111 | - * @return EEI_Line_Item |
|
112 | - */ |
|
113 | - public function process() |
|
114 | - { |
|
115 | - $this->line_item_filters->rewind(); |
|
116 | - while ($this->line_item_filters->valid()) { |
|
117 | - $this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item); |
|
118 | - $this->line_item_filters->next(); |
|
119 | - } |
|
120 | - $this->grand_total_line_item->recalculate_total_including_taxes(); |
|
121 | - return $this->grand_total_line_item; |
|
122 | - } |
|
108 | + /** |
|
109 | + * process |
|
110 | + * |
|
111 | + * @return EEI_Line_Item |
|
112 | + */ |
|
113 | + public function process() |
|
114 | + { |
|
115 | + $this->line_item_filters->rewind(); |
|
116 | + while ($this->line_item_filters->valid()) { |
|
117 | + $this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item); |
|
118 | + $this->line_item_filters->next(); |
|
119 | + } |
|
120 | + $this->grand_total_line_item->recalculate_total_including_taxes(); |
|
121 | + return $this->grand_total_line_item; |
|
122 | + } |
|
123 | 123 | } |
@@ -14,96 +14,96 @@ |
||
14 | 14 | class EE_Non_Zero_Line_Item_Filter extends EE_Line_Item_Filter_Base |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * EE_Non_Zero_Line_Item_Filter constructor. |
|
19 | - */ |
|
20 | - public function __construct() |
|
21 | - { |
|
22 | - } |
|
17 | + /** |
|
18 | + * EE_Non_Zero_Line_Item_Filter constructor. |
|
19 | + */ |
|
20 | + public function __construct() |
|
21 | + { |
|
22 | + } |
|
23 | 23 | |
24 | 24 | |
25 | - /** |
|
26 | - * Creates a duplicate of the line item tree, except only includes billable items |
|
27 | - * and the portion of line items attributed to billable things |
|
28 | - * |
|
29 | - * @param EEI_Line_Item $line_item |
|
30 | - * @return EEI_Line_Item |
|
31 | - */ |
|
32 | - public function process(EEI_Line_Item $line_item) |
|
33 | - { |
|
34 | - $non_zero_line_item = $this->_filter_zero_line_item($line_item); |
|
35 | - if (! $non_zero_line_item instanceof EEI_Line_Item) { |
|
36 | - return null; |
|
37 | - } |
|
38 | - // if this is an event subtotal, we want to only include it if it |
|
39 | - // has a non-zero total and at least one ticket line item child |
|
40 | - if ($line_item->children()) { |
|
41 | - $ticket_or_subtotals_with_tkt_children_count = 0; |
|
42 | - foreach ($line_item->children() as $child_line_item) { |
|
43 | - $code = $child_line_item->code(); |
|
44 | - $child_line_item = $this->process($child_line_item); |
|
45 | - if (! $child_line_item instanceof EEI_Line_Item) { |
|
46 | - $line_item->delete_child_line_item($code); |
|
47 | - continue; |
|
48 | - } |
|
49 | - if (( |
|
50 | - $child_line_item instanceof EEI_Line_Item |
|
51 | - && $child_line_item->type() === EEM_Line_Item::type_sub_total |
|
52 | - ) |
|
53 | - || ( |
|
54 | - $child_line_item instanceof EEI_Line_Item |
|
55 | - && $child_line_item->type() === EEM_Line_Item::type_line_item |
|
56 | - && $child_line_item->OBJ_type() === 'Ticket' |
|
57 | - ) |
|
58 | - ) { |
|
59 | - $ticket_or_subtotals_with_tkt_children_count++; |
|
60 | - } |
|
61 | - } |
|
62 | - // if this is an event subtotal with NO ticket children |
|
63 | - // we basically want to ignore it |
|
64 | - return $this->_filter_zero_subtotal_line_item( |
|
65 | - $non_zero_line_item, |
|
66 | - $ticket_or_subtotals_with_tkt_children_count |
|
67 | - ); |
|
68 | - } |
|
69 | - return $non_zero_line_item; |
|
70 | - } |
|
25 | + /** |
|
26 | + * Creates a duplicate of the line item tree, except only includes billable items |
|
27 | + * and the portion of line items attributed to billable things |
|
28 | + * |
|
29 | + * @param EEI_Line_Item $line_item |
|
30 | + * @return EEI_Line_Item |
|
31 | + */ |
|
32 | + public function process(EEI_Line_Item $line_item) |
|
33 | + { |
|
34 | + $non_zero_line_item = $this->_filter_zero_line_item($line_item); |
|
35 | + if (! $non_zero_line_item instanceof EEI_Line_Item) { |
|
36 | + return null; |
|
37 | + } |
|
38 | + // if this is an event subtotal, we want to only include it if it |
|
39 | + // has a non-zero total and at least one ticket line item child |
|
40 | + if ($line_item->children()) { |
|
41 | + $ticket_or_subtotals_with_tkt_children_count = 0; |
|
42 | + foreach ($line_item->children() as $child_line_item) { |
|
43 | + $code = $child_line_item->code(); |
|
44 | + $child_line_item = $this->process($child_line_item); |
|
45 | + if (! $child_line_item instanceof EEI_Line_Item) { |
|
46 | + $line_item->delete_child_line_item($code); |
|
47 | + continue; |
|
48 | + } |
|
49 | + if (( |
|
50 | + $child_line_item instanceof EEI_Line_Item |
|
51 | + && $child_line_item->type() === EEM_Line_Item::type_sub_total |
|
52 | + ) |
|
53 | + || ( |
|
54 | + $child_line_item instanceof EEI_Line_Item |
|
55 | + && $child_line_item->type() === EEM_Line_Item::type_line_item |
|
56 | + && $child_line_item->OBJ_type() === 'Ticket' |
|
57 | + ) |
|
58 | + ) { |
|
59 | + $ticket_or_subtotals_with_tkt_children_count++; |
|
60 | + } |
|
61 | + } |
|
62 | + // if this is an event subtotal with NO ticket children |
|
63 | + // we basically want to ignore it |
|
64 | + return $this->_filter_zero_subtotal_line_item( |
|
65 | + $non_zero_line_item, |
|
66 | + $ticket_or_subtotals_with_tkt_children_count |
|
67 | + ); |
|
68 | + } |
|
69 | + return $non_zero_line_item; |
|
70 | + } |
|
71 | 71 | |
72 | 72 | |
73 | - /** |
|
74 | - * Creates a new, unsaved line item, but if it's a ticket line item |
|
75 | - * with a total of 0, or a subtotal of 0, returns null instead |
|
76 | - * |
|
77 | - * @param EEI_Line_Item $line_item |
|
78 | - * @return EEI_Line_Item |
|
79 | - */ |
|
80 | - protected function _filter_zero_line_item(EEI_Line_Item $line_item) |
|
81 | - { |
|
82 | - if ($line_item->type() === EEM_Line_Item::type_line_item |
|
83 | - && $line_item->OBJ_type() === 'Ticket' |
|
84 | - && (int) $line_item->quantity() === 0 |
|
85 | - ) { |
|
86 | - return null; |
|
87 | - } |
|
88 | - return $line_item; |
|
89 | - } |
|
73 | + /** |
|
74 | + * Creates a new, unsaved line item, but if it's a ticket line item |
|
75 | + * with a total of 0, or a subtotal of 0, returns null instead |
|
76 | + * |
|
77 | + * @param EEI_Line_Item $line_item |
|
78 | + * @return EEI_Line_Item |
|
79 | + */ |
|
80 | + protected function _filter_zero_line_item(EEI_Line_Item $line_item) |
|
81 | + { |
|
82 | + if ($line_item->type() === EEM_Line_Item::type_line_item |
|
83 | + && $line_item->OBJ_type() === 'Ticket' |
|
84 | + && (int) $line_item->quantity() === 0 |
|
85 | + ) { |
|
86 | + return null; |
|
87 | + } |
|
88 | + return $line_item; |
|
89 | + } |
|
90 | 90 | |
91 | 91 | |
92 | - /** |
|
93 | - * Creates a new, unsaved line item, but if it's a ticket line item |
|
94 | - * with a total of 0, or a subtotal of 0, returns null instead |
|
95 | - * |
|
96 | - * @param EEI_Line_Item $line_item |
|
97 | - * @param int $ticket_children |
|
98 | - * @return EEI_Line_Item |
|
99 | - */ |
|
100 | - protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0) |
|
101 | - { |
|
102 | - if ((int) $ticket_children === 0 |
|
103 | - && $line_item->type() === EEM_Line_Item::type_sub_total |
|
104 | - ) { |
|
105 | - return null; |
|
106 | - } |
|
107 | - return $line_item; |
|
108 | - } |
|
92 | + /** |
|
93 | + * Creates a new, unsaved line item, but if it's a ticket line item |
|
94 | + * with a total of 0, or a subtotal of 0, returns null instead |
|
95 | + * |
|
96 | + * @param EEI_Line_Item $line_item |
|
97 | + * @param int $ticket_children |
|
98 | + * @return EEI_Line_Item |
|
99 | + */ |
|
100 | + protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0) |
|
101 | + { |
|
102 | + if ((int) $ticket_children === 0 |
|
103 | + && $line_item->type() === EEM_Line_Item::type_sub_total |
|
104 | + ) { |
|
105 | + return null; |
|
106 | + } |
|
107 | + return $line_item; |
|
108 | + } |
|
109 | 109 | } |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | public function process(EEI_Line_Item $line_item) |
33 | 33 | { |
34 | 34 | $non_zero_line_item = $this->_filter_zero_line_item($line_item); |
35 | - if (! $non_zero_line_item instanceof EEI_Line_Item) { |
|
35 | + if ( ! $non_zero_line_item instanceof EEI_Line_Item) { |
|
36 | 36 | return null; |
37 | 37 | } |
38 | 38 | // if this is an event subtotal, we want to only include it if it |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | foreach ($line_item->children() as $child_line_item) { |
43 | 43 | $code = $child_line_item->code(); |
44 | 44 | $child_line_item = $this->process($child_line_item); |
45 | - if (! $child_line_item instanceof EEI_Line_Item) { |
|
45 | + if ( ! $child_line_item instanceof EEI_Line_Item) { |
|
46 | 46 | $line_item->delete_child_line_item($code); |
47 | 47 | continue; |
48 | 48 | } |
@@ -18,11 +18,11 @@ |
||
18 | 18 | { |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * EE_Line_Item_Filter_Collection constructor. |
|
23 | - */ |
|
24 | - public function __construct() |
|
25 | - { |
|
26 | - $this->interface = 'EEI_Line_Item_Filter'; |
|
27 | - } |
|
21 | + /** |
|
22 | + * EE_Line_Item_Filter_Collection constructor. |
|
23 | + */ |
|
24 | + public function __construct() |
|
25 | + { |
|
26 | + $this->interface = 'EEI_Line_Item_Filter'; |
|
27 | + } |
|
28 | 28 | } |
@@ -18,48 +18,48 @@ |
||
18 | 18 | { |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * EE_Billable_Line_Item_Filter constructor. |
|
23 | - * |
|
24 | - * @param EE_Registration[] $registrations |
|
25 | - */ |
|
26 | - public function __construct($registrations) |
|
27 | - { |
|
28 | - parent::__construct($this->_remove_unbillable_registrations($registrations)); |
|
29 | - } |
|
21 | + /** |
|
22 | + * EE_Billable_Line_Item_Filter constructor. |
|
23 | + * |
|
24 | + * @param EE_Registration[] $registrations |
|
25 | + */ |
|
26 | + public function __construct($registrations) |
|
27 | + { |
|
28 | + parent::__construct($this->_remove_unbillable_registrations($registrations)); |
|
29 | + } |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * _calculate_billable_ticket_quantities_from_registrations |
|
34 | - * compiles a list of EE_Tickets for each event in the passed array |
|
35 | - * |
|
36 | - * @access protected |
|
37 | - * @param EE_Registration[] $registrations |
|
38 | - * @return mixed |
|
39 | - */ |
|
40 | - protected function _remove_unbillable_registrations($registrations = array()) |
|
41 | - { |
|
42 | - if (! empty($registrations)) { |
|
43 | - // these reg statuses require payment (if event is not free) |
|
44 | - $requires_payment = EEM_Registration::reg_statuses_that_allow_payment(); |
|
45 | - foreach ($registrations as $key => $registration) { |
|
46 | - if (! $registration instanceof EE_Registration) { |
|
47 | - continue; |
|
48 | - } |
|
49 | - // are we billing for this registration at this moment ? |
|
50 | - if (! |
|
51 | - $registration->owes_monies_and_can_pay($requires_payment) && |
|
52 | - ! ( |
|
53 | - // free registration with valid reg status |
|
54 | - $registration->final_price() == 0 && |
|
55 | - in_array($registration->status_ID(), $requires_payment) |
|
56 | - ) |
|
57 | - ) { |
|
58 | - // not billable. remove it |
|
59 | - unset($registrations[ $key ]); |
|
60 | - } |
|
61 | - } |
|
62 | - } |
|
63 | - return $registrations; |
|
64 | - } |
|
32 | + /** |
|
33 | + * _calculate_billable_ticket_quantities_from_registrations |
|
34 | + * compiles a list of EE_Tickets for each event in the passed array |
|
35 | + * |
|
36 | + * @access protected |
|
37 | + * @param EE_Registration[] $registrations |
|
38 | + * @return mixed |
|
39 | + */ |
|
40 | + protected function _remove_unbillable_registrations($registrations = array()) |
|
41 | + { |
|
42 | + if (! empty($registrations)) { |
|
43 | + // these reg statuses require payment (if event is not free) |
|
44 | + $requires_payment = EEM_Registration::reg_statuses_that_allow_payment(); |
|
45 | + foreach ($registrations as $key => $registration) { |
|
46 | + if (! $registration instanceof EE_Registration) { |
|
47 | + continue; |
|
48 | + } |
|
49 | + // are we billing for this registration at this moment ? |
|
50 | + if (! |
|
51 | + $registration->owes_monies_and_can_pay($requires_payment) && |
|
52 | + ! ( |
|
53 | + // free registration with valid reg status |
|
54 | + $registration->final_price() == 0 && |
|
55 | + in_array($registration->status_ID(), $requires_payment) |
|
56 | + ) |
|
57 | + ) { |
|
58 | + // not billable. remove it |
|
59 | + unset($registrations[ $key ]); |
|
60 | + } |
|
61 | + } |
|
62 | + } |
|
63 | + return $registrations; |
|
64 | + } |
|
65 | 65 | } |
@@ -39,16 +39,15 @@ discard block |
||
39 | 39 | */ |
40 | 40 | protected function _remove_unbillable_registrations($registrations = array()) |
41 | 41 | { |
42 | - if (! empty($registrations)) { |
|
42 | + if ( ! empty($registrations)) { |
|
43 | 43 | // these reg statuses require payment (if event is not free) |
44 | 44 | $requires_payment = EEM_Registration::reg_statuses_that_allow_payment(); |
45 | 45 | foreach ($registrations as $key => $registration) { |
46 | - if (! $registration instanceof EE_Registration) { |
|
46 | + if ( ! $registration instanceof EE_Registration) { |
|
47 | 47 | continue; |
48 | 48 | } |
49 | 49 | // are we billing for this registration at this moment ? |
50 | - if (! |
|
51 | - $registration->owes_monies_and_can_pay($requires_payment) && |
|
50 | + if ( ! $registration->owes_monies_and_can_pay($requires_payment) && |
|
52 | 51 | ! ( |
53 | 52 | // free registration with valid reg status |
54 | 53 | $registration->final_price() == 0 && |
@@ -56,7 +55,7 @@ discard block |
||
56 | 55 | ) |
57 | 56 | ) { |
58 | 57 | // not billable. remove it |
59 | - unset($registrations[ $key ]); |
|
58 | + unset($registrations[$key]); |
|
60 | 59 | } |
61 | 60 | } |
62 | 61 | } |
@@ -16,14 +16,14 @@ |
||
16 | 16 | { |
17 | 17 | |
18 | 18 | |
19 | - /** |
|
20 | - * process |
|
21 | - * |
|
22 | - * @param \EEI_Line_Item $line_item |
|
23 | - * @return \EEI_Line_Item |
|
24 | - */ |
|
25 | - public function process(EEI_Line_Item $line_item) |
|
26 | - { |
|
27 | - return $line_item; |
|
28 | - } |
|
19 | + /** |
|
20 | + * process |
|
21 | + * |
|
22 | + * @param \EEI_Line_Item $line_item |
|
23 | + * @return \EEI_Line_Item |
|
24 | + */ |
|
25 | + public function process(EEI_Line_Item $line_item) |
|
26 | + { |
|
27 | + return $line_item; |
|
28 | + } |
|
29 | 29 | } |
@@ -16,12 +16,12 @@ |
||
16 | 16 | class EE_Single_Registration_Line_Item_Filter extends EE_Specific_Registrations_Line_Item_Filter |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * |
|
21 | - * @param EE_Registration $registration |
|
22 | - */ |
|
23 | - public function __construct($registration) |
|
24 | - { |
|
25 | - parent::__construct(array($registration)); |
|
26 | - } |
|
19 | + /** |
|
20 | + * |
|
21 | + * @param EE_Registration $registration |
|
22 | + */ |
|
23 | + public function __construct($registration) |
|
24 | + { |
|
25 | + parent::__construct(array($registration)); |
|
26 | + } |
|
27 | 27 | } |