@@ -781,7 +781,7 @@ |
||
| 781 | 781 | /** |
| 782 | 782 | * Gets the event that's related to the ticket, if this line item represents a ticket. |
| 783 | 783 | * |
| 784 | - * @return EE_Event|null |
|
| 784 | + * @return EE_Base_Class|null |
|
| 785 | 785 | * @throws EE_Error |
| 786 | 786 | * @throws InvalidArgumentException |
| 787 | 787 | * @throws InvalidDataTypeException |
@@ -88,7 +88,7 @@ discard block |
||
| 88 | 88 | protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
| 89 | 89 | { |
| 90 | 90 | parent::__construct($fieldValues, $bydb, $timezone); |
| 91 | - if (! $this->get('LIN_code')) { |
|
| 91 | + if ( ! $this->get('LIN_code')) { |
|
| 92 | 92 | $this->set_code($this->generate_code()); |
| 93 | 93 | } |
| 94 | 94 | } |
@@ -155,7 +155,7 @@ discard block |
||
| 155 | 155 | public function name() |
| 156 | 156 | { |
| 157 | 157 | $name = $this->get('LIN_name'); |
| 158 | - if (! $name) { |
|
| 158 | + if ( ! $name) { |
|
| 159 | 159 | $name = ucwords(str_replace('-', ' ', $this->type())); |
| 160 | 160 | } |
| 161 | 161 | return $name; |
@@ -615,7 +615,7 @@ discard block |
||
| 615 | 615 | ) |
| 616 | 616 | ); |
| 617 | 617 | } |
| 618 | - if (! is_array($this->_children)) { |
|
| 618 | + if ( ! is_array($this->_children)) { |
|
| 619 | 619 | $this->_children = array(); |
| 620 | 620 | } |
| 621 | 621 | return $this->_children; |
@@ -856,7 +856,7 @@ discard block |
||
| 856 | 856 | } |
| 857 | 857 | return $line_item->save(); |
| 858 | 858 | } |
| 859 | - $this->_children[ $line_item->code() ] = $line_item; |
|
| 859 | + $this->_children[$line_item->code()] = $line_item; |
|
| 860 | 860 | if ($line_item->parent() !== $this) { |
| 861 | 861 | $line_item->set_parent($this); |
| 862 | 862 | } |
@@ -880,7 +880,7 @@ discard block |
||
| 880 | 880 | public function set_parent($line_item) |
| 881 | 881 | { |
| 882 | 882 | if ($this->ID()) { |
| 883 | - if (! $line_item->ID()) { |
|
| 883 | + if ( ! $line_item->ID()) { |
|
| 884 | 884 | $line_item->save(); |
| 885 | 885 | } |
| 886 | 886 | $this->set_parent_ID($line_item->ID()); |
@@ -912,8 +912,8 @@ discard block |
||
| 912 | 912 | array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)) |
| 913 | 913 | ); |
| 914 | 914 | } |
| 915 | - return isset($this->_children[ $code ]) |
|
| 916 | - ? $this->_children[ $code ] |
|
| 915 | + return isset($this->_children[$code]) |
|
| 916 | + ? $this->_children[$code] |
|
| 917 | 917 | : null; |
| 918 | 918 | } |
| 919 | 919 | |
@@ -973,8 +973,8 @@ discard block |
||
| 973 | 973 | } |
| 974 | 974 | return $items_deleted; |
| 975 | 975 | } |
| 976 | - if (isset($this->_children[ $code ])) { |
|
| 977 | - unset($this->_children[ $code ]); |
|
| 976 | + if (isset($this->_children[$code])) { |
|
| 977 | + unset($this->_children[$code]); |
|
| 978 | 978 | return 1; |
| 979 | 979 | } |
| 980 | 980 | return 0; |
@@ -1015,7 +1015,7 @@ discard block |
||
| 1015 | 1015 | public function generate_code() |
| 1016 | 1016 | { |
| 1017 | 1017 | // each line item in the cart requires a unique identifier |
| 1018 | - return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime()); |
|
| 1018 | + return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime()); |
|
| 1019 | 1019 | } |
| 1020 | 1020 | |
| 1021 | 1021 | |
@@ -1220,7 +1220,7 @@ discard block |
||
| 1220 | 1220 | $has_children = ! empty($my_children); |
| 1221 | 1221 | if ($has_children && $this->is_line_item()) { |
| 1222 | 1222 | $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children); |
| 1223 | - } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 1223 | + } elseif ( ! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 1224 | 1224 | $total = $this->unit_price() * $this->quantity(); |
| 1225 | 1225 | } elseif ($this->is_sub_total() || $this->is_total()) { |
| 1226 | 1226 | $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children); |
@@ -1229,18 +1229,18 @@ discard block |
||
| 1229 | 1229 | return 0; |
| 1230 | 1230 | } |
| 1231 | 1231 | // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events) |
| 1232 | - if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 1232 | + if ( ! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 1233 | 1233 | ) { |
| 1234 | 1234 | if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) { |
| 1235 | 1235 | $this->set_quantity(1); |
| 1236 | 1236 | } |
| 1237 | - if (! $this->is_percent()) { |
|
| 1237 | + if ( ! $this->is_percent()) { |
|
| 1238 | 1238 | $this->set_unit_price($total); |
| 1239 | 1239 | } |
| 1240 | 1240 | } |
| 1241 | 1241 | // we don't want to bother saving grand totals, because that needs to factor in taxes anyways |
| 1242 | 1242 | // so it ought to be |
| 1243 | - if (! $this->is_total()) { |
|
| 1243 | + if ( ! $this->is_total()) { |
|
| 1244 | 1244 | $this->set_total($total); |
| 1245 | 1245 | // if not a percent line item, make sure we keep the unit price in sync |
| 1246 | 1246 | if ($has_children |
@@ -1587,7 +1587,7 @@ discard block |
||
| 1587 | 1587 | public function save_this_and_descendants_to_txn($txn_id = null) |
| 1588 | 1588 | { |
| 1589 | 1589 | $count = 0; |
| 1590 | - if (! $txn_id) { |
|
| 1590 | + if ( ! $txn_id) { |
|
| 1591 | 1591 | $txn_id = $this->TXN_ID(); |
| 1592 | 1592 | } |
| 1593 | 1593 | $this->set_TXN_ID($txn_id); |
@@ -14,1739 +14,1739 @@ |
||
| 14 | 14 | class EE_Line_Item extends EE_Base_Class implements EEI_Line_Item |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * for children line items (currently not a normal relation) |
|
| 19 | - * |
|
| 20 | - * @type EE_Line_Item[] |
|
| 21 | - */ |
|
| 22 | - protected $_children = array(); |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * for the parent line item |
|
| 26 | - * |
|
| 27 | - * @var EE_Line_Item |
|
| 28 | - */ |
|
| 29 | - protected $_parent; |
|
| 30 | - |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @param array $props_n_values incoming values |
|
| 34 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 35 | - * used.) |
|
| 36 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 37 | - * date_format and the second value is the time format |
|
| 38 | - * @return EE_Line_Item |
|
| 39 | - * @throws EE_Error |
|
| 40 | - * @throws InvalidArgumentException |
|
| 41 | - * @throws InvalidDataTypeException |
|
| 42 | - * @throws InvalidInterfaceException |
|
| 43 | - * @throws ReflectionException |
|
| 44 | - */ |
|
| 45 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 46 | - { |
|
| 47 | - $has_object = parent::_check_for_object( |
|
| 48 | - $props_n_values, |
|
| 49 | - __CLASS__, |
|
| 50 | - $timezone, |
|
| 51 | - $date_formats |
|
| 52 | - ); |
|
| 53 | - return $has_object |
|
| 54 | - ? $has_object |
|
| 55 | - : new self($props_n_values, false, $timezone); |
|
| 56 | - } |
|
| 57 | - |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * @param array $props_n_values incoming values from the database |
|
| 61 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 62 | - * the website will be used. |
|
| 63 | - * @return EE_Line_Item |
|
| 64 | - * @throws EE_Error |
|
| 65 | - * @throws InvalidArgumentException |
|
| 66 | - * @throws InvalidDataTypeException |
|
| 67 | - * @throws InvalidInterfaceException |
|
| 68 | - * @throws ReflectionException |
|
| 69 | - */ |
|
| 70 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 71 | - { |
|
| 72 | - return new self($props_n_values, true, $timezone); |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Adds some defaults if they're not specified |
|
| 78 | - * |
|
| 79 | - * @param array $fieldValues |
|
| 80 | - * @param bool $bydb |
|
| 81 | - * @param string $timezone |
|
| 82 | - * @throws EE_Error |
|
| 83 | - * @throws InvalidArgumentException |
|
| 84 | - * @throws InvalidDataTypeException |
|
| 85 | - * @throws InvalidInterfaceException |
|
| 86 | - * @throws ReflectionException |
|
| 87 | - */ |
|
| 88 | - protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
|
| 89 | - { |
|
| 90 | - parent::__construct($fieldValues, $bydb, $timezone); |
|
| 91 | - if (! $this->get('LIN_code')) { |
|
| 92 | - $this->set_code($this->generate_code()); |
|
| 93 | - } |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * Gets ID |
|
| 99 | - * |
|
| 100 | - * @return int |
|
| 101 | - * @throws EE_Error |
|
| 102 | - * @throws InvalidArgumentException |
|
| 103 | - * @throws InvalidDataTypeException |
|
| 104 | - * @throws InvalidInterfaceException |
|
| 105 | - * @throws ReflectionException |
|
| 106 | - */ |
|
| 107 | - public function ID() |
|
| 108 | - { |
|
| 109 | - return $this->get('LIN_ID'); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Gets TXN_ID |
|
| 115 | - * |
|
| 116 | - * @return int |
|
| 117 | - * @throws EE_Error |
|
| 118 | - * @throws InvalidArgumentException |
|
| 119 | - * @throws InvalidDataTypeException |
|
| 120 | - * @throws InvalidInterfaceException |
|
| 121 | - * @throws ReflectionException |
|
| 122 | - */ |
|
| 123 | - public function TXN_ID() |
|
| 124 | - { |
|
| 125 | - return $this->get('TXN_ID'); |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * Sets TXN_ID |
|
| 131 | - * |
|
| 132 | - * @param int $TXN_ID |
|
| 133 | - * @throws EE_Error |
|
| 134 | - * @throws InvalidArgumentException |
|
| 135 | - * @throws InvalidDataTypeException |
|
| 136 | - * @throws InvalidInterfaceException |
|
| 137 | - * @throws ReflectionException |
|
| 138 | - */ |
|
| 139 | - public function set_TXN_ID($TXN_ID) |
|
| 140 | - { |
|
| 141 | - $this->set('TXN_ID', $TXN_ID); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Gets name |
|
| 147 | - * |
|
| 148 | - * @return string |
|
| 149 | - * @throws EE_Error |
|
| 150 | - * @throws InvalidArgumentException |
|
| 151 | - * @throws InvalidDataTypeException |
|
| 152 | - * @throws InvalidInterfaceException |
|
| 153 | - * @throws ReflectionException |
|
| 154 | - */ |
|
| 155 | - public function name() |
|
| 156 | - { |
|
| 157 | - $name = $this->get('LIN_name'); |
|
| 158 | - if (! $name) { |
|
| 159 | - $name = ucwords(str_replace('-', ' ', $this->type())); |
|
| 160 | - } |
|
| 161 | - return $name; |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * Sets name |
|
| 167 | - * |
|
| 168 | - * @param string $name |
|
| 169 | - * @throws EE_Error |
|
| 170 | - * @throws InvalidArgumentException |
|
| 171 | - * @throws InvalidDataTypeException |
|
| 172 | - * @throws InvalidInterfaceException |
|
| 173 | - * @throws ReflectionException |
|
| 174 | - */ |
|
| 175 | - public function set_name($name) |
|
| 176 | - { |
|
| 177 | - $this->set('LIN_name', $name); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Gets desc |
|
| 183 | - * |
|
| 184 | - * @return string |
|
| 185 | - * @throws EE_Error |
|
| 186 | - * @throws InvalidArgumentException |
|
| 187 | - * @throws InvalidDataTypeException |
|
| 188 | - * @throws InvalidInterfaceException |
|
| 189 | - * @throws ReflectionException |
|
| 190 | - */ |
|
| 191 | - public function desc() |
|
| 192 | - { |
|
| 193 | - return $this->get('LIN_desc'); |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * Sets desc |
|
| 199 | - * |
|
| 200 | - * @param string $desc |
|
| 201 | - * @throws EE_Error |
|
| 202 | - * @throws InvalidArgumentException |
|
| 203 | - * @throws InvalidDataTypeException |
|
| 204 | - * @throws InvalidInterfaceException |
|
| 205 | - * @throws ReflectionException |
|
| 206 | - */ |
|
| 207 | - public function set_desc($desc) |
|
| 208 | - { |
|
| 209 | - $this->set('LIN_desc', $desc); |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - |
|
| 213 | - /** |
|
| 214 | - * Gets quantity |
|
| 215 | - * |
|
| 216 | - * @return int |
|
| 217 | - * @throws EE_Error |
|
| 218 | - * @throws InvalidArgumentException |
|
| 219 | - * @throws InvalidDataTypeException |
|
| 220 | - * @throws InvalidInterfaceException |
|
| 221 | - * @throws ReflectionException |
|
| 222 | - */ |
|
| 223 | - public function quantity() |
|
| 224 | - { |
|
| 225 | - return $this->get('LIN_quantity'); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * Sets quantity |
|
| 231 | - * |
|
| 232 | - * @param int $quantity |
|
| 233 | - * @throws EE_Error |
|
| 234 | - * @throws InvalidArgumentException |
|
| 235 | - * @throws InvalidDataTypeException |
|
| 236 | - * @throws InvalidInterfaceException |
|
| 237 | - * @throws ReflectionException |
|
| 238 | - */ |
|
| 239 | - public function set_quantity($quantity) |
|
| 240 | - { |
|
| 241 | - $this->set('LIN_quantity', max($quantity, 0)); |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - |
|
| 245 | - /** |
|
| 246 | - * Gets item_id |
|
| 247 | - * |
|
| 248 | - * @return string |
|
| 249 | - * @throws EE_Error |
|
| 250 | - * @throws InvalidArgumentException |
|
| 251 | - * @throws InvalidDataTypeException |
|
| 252 | - * @throws InvalidInterfaceException |
|
| 253 | - * @throws ReflectionException |
|
| 254 | - */ |
|
| 255 | - public function OBJ_ID() |
|
| 256 | - { |
|
| 257 | - return $this->get('OBJ_ID'); |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - |
|
| 261 | - /** |
|
| 262 | - * Sets item_id |
|
| 263 | - * |
|
| 264 | - * @param string $item_id |
|
| 265 | - * @throws EE_Error |
|
| 266 | - * @throws InvalidArgumentException |
|
| 267 | - * @throws InvalidDataTypeException |
|
| 268 | - * @throws InvalidInterfaceException |
|
| 269 | - * @throws ReflectionException |
|
| 270 | - */ |
|
| 271 | - public function set_OBJ_ID($item_id) |
|
| 272 | - { |
|
| 273 | - $this->set('OBJ_ID', $item_id); |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - |
|
| 277 | - /** |
|
| 278 | - * Gets item_type |
|
| 279 | - * |
|
| 280 | - * @return string |
|
| 281 | - * @throws EE_Error |
|
| 282 | - * @throws InvalidArgumentException |
|
| 283 | - * @throws InvalidDataTypeException |
|
| 284 | - * @throws InvalidInterfaceException |
|
| 285 | - * @throws ReflectionException |
|
| 286 | - */ |
|
| 287 | - public function OBJ_type() |
|
| 288 | - { |
|
| 289 | - return $this->get('OBJ_type'); |
|
| 290 | - } |
|
| 291 | - |
|
| 292 | - |
|
| 293 | - /** |
|
| 294 | - * Gets item_type |
|
| 295 | - * |
|
| 296 | - * @return string |
|
| 297 | - * @throws EE_Error |
|
| 298 | - * @throws InvalidArgumentException |
|
| 299 | - * @throws InvalidDataTypeException |
|
| 300 | - * @throws InvalidInterfaceException |
|
| 301 | - * @throws ReflectionException |
|
| 302 | - */ |
|
| 303 | - public function OBJ_type_i18n() |
|
| 304 | - { |
|
| 305 | - $obj_type = $this->OBJ_type(); |
|
| 306 | - switch ($obj_type) { |
|
| 307 | - case EEM_Line_Item::OBJ_TYPE_EVENT: |
|
| 308 | - $obj_type = esc_html__('Event', 'event_espresso'); |
|
| 309 | - break; |
|
| 310 | - case EEM_Line_Item::OBJ_TYPE_PRICE: |
|
| 311 | - $obj_type = esc_html__('Price', 'event_espresso'); |
|
| 312 | - break; |
|
| 313 | - case EEM_Line_Item::OBJ_TYPE_PROMOTION: |
|
| 314 | - $obj_type = esc_html__('Promotion', 'event_espresso'); |
|
| 315 | - break; |
|
| 316 | - case EEM_Line_Item::OBJ_TYPE_TICKET: |
|
| 317 | - $obj_type = esc_html__('Ticket', 'event_espresso'); |
|
| 318 | - break; |
|
| 319 | - case EEM_Line_Item::OBJ_TYPE_TRANSACTION: |
|
| 320 | - $obj_type = esc_html__('Transaction', 'event_espresso'); |
|
| 321 | - break; |
|
| 322 | - } |
|
| 323 | - return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this); |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - |
|
| 327 | - /** |
|
| 328 | - * Sets item_type |
|
| 329 | - * |
|
| 330 | - * @param string $OBJ_type |
|
| 331 | - * @throws EE_Error |
|
| 332 | - * @throws InvalidArgumentException |
|
| 333 | - * @throws InvalidDataTypeException |
|
| 334 | - * @throws InvalidInterfaceException |
|
| 335 | - * @throws ReflectionException |
|
| 336 | - */ |
|
| 337 | - public function set_OBJ_type($OBJ_type) |
|
| 338 | - { |
|
| 339 | - $this->set('OBJ_type', $OBJ_type); |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - |
|
| 343 | - /** |
|
| 344 | - * Gets unit_price |
|
| 345 | - * |
|
| 346 | - * @return float |
|
| 347 | - * @throws EE_Error |
|
| 348 | - * @throws InvalidArgumentException |
|
| 349 | - * @throws InvalidDataTypeException |
|
| 350 | - * @throws InvalidInterfaceException |
|
| 351 | - * @throws ReflectionException |
|
| 352 | - */ |
|
| 353 | - public function unit_price() |
|
| 354 | - { |
|
| 355 | - return $this->get('LIN_unit_price'); |
|
| 356 | - } |
|
| 357 | - |
|
| 358 | - |
|
| 359 | - /** |
|
| 360 | - * Sets unit_price |
|
| 361 | - * |
|
| 362 | - * @param float $unit_price |
|
| 363 | - * @throws EE_Error |
|
| 364 | - * @throws InvalidArgumentException |
|
| 365 | - * @throws InvalidDataTypeException |
|
| 366 | - * @throws InvalidInterfaceException |
|
| 367 | - * @throws ReflectionException |
|
| 368 | - */ |
|
| 369 | - public function set_unit_price($unit_price) |
|
| 370 | - { |
|
| 371 | - $this->set('LIN_unit_price', $unit_price); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - |
|
| 375 | - /** |
|
| 376 | - * Checks if this item is a percentage modifier or not |
|
| 377 | - * |
|
| 378 | - * @return boolean |
|
| 379 | - * @throws EE_Error |
|
| 380 | - * @throws InvalidArgumentException |
|
| 381 | - * @throws InvalidDataTypeException |
|
| 382 | - * @throws InvalidInterfaceException |
|
| 383 | - * @throws ReflectionException |
|
| 384 | - */ |
|
| 385 | - public function is_percent() |
|
| 386 | - { |
|
| 387 | - if ($this->is_tax_sub_total()) { |
|
| 388 | - // tax subtotals HAVE a percent on them, that percentage only applies |
|
| 389 | - // to taxable items, so its' an exception. Treat it like a flat line item |
|
| 390 | - return false; |
|
| 391 | - } |
|
| 392 | - $unit_price = abs($this->get('LIN_unit_price')); |
|
| 393 | - $percent = abs($this->get('LIN_percent')); |
|
| 394 | - if ($unit_price < .001 && $percent) { |
|
| 395 | - return true; |
|
| 396 | - } |
|
| 397 | - if ($unit_price >= .001 && ! $percent) { |
|
| 398 | - return false; |
|
| 399 | - } |
|
| 400 | - if ($unit_price >= .001 && $percent) { |
|
| 401 | - throw new EE_Error( |
|
| 402 | - sprintf( |
|
| 403 | - esc_html__( |
|
| 404 | - 'A Line Item can not have a unit price of (%s) AND a percent (%s)!', |
|
| 405 | - 'event_espresso' |
|
| 406 | - ), |
|
| 407 | - $unit_price, |
|
| 408 | - $percent |
|
| 409 | - ) |
|
| 410 | - ); |
|
| 411 | - } |
|
| 412 | - // if they're both 0, assume its not a percent item |
|
| 413 | - return false; |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - |
|
| 417 | - /** |
|
| 418 | - * Gets percent (between 100-.001) |
|
| 419 | - * |
|
| 420 | - * @return float |
|
| 421 | - * @throws EE_Error |
|
| 422 | - * @throws InvalidArgumentException |
|
| 423 | - * @throws InvalidDataTypeException |
|
| 424 | - * @throws InvalidInterfaceException |
|
| 425 | - * @throws ReflectionException |
|
| 426 | - */ |
|
| 427 | - public function percent() |
|
| 428 | - { |
|
| 429 | - return $this->get('LIN_percent'); |
|
| 430 | - } |
|
| 431 | - |
|
| 432 | - |
|
| 433 | - /** |
|
| 434 | - * Sets percent (between 100-0.01) |
|
| 435 | - * |
|
| 436 | - * @param float $percent |
|
| 437 | - * @throws EE_Error |
|
| 438 | - * @throws InvalidArgumentException |
|
| 439 | - * @throws InvalidDataTypeException |
|
| 440 | - * @throws InvalidInterfaceException |
|
| 441 | - * @throws ReflectionException |
|
| 442 | - */ |
|
| 443 | - public function set_percent($percent) |
|
| 444 | - { |
|
| 445 | - $this->set('LIN_percent', $percent); |
|
| 446 | - } |
|
| 447 | - |
|
| 448 | - |
|
| 449 | - /** |
|
| 450 | - * Gets total |
|
| 451 | - * |
|
| 452 | - * @return float |
|
| 453 | - * @throws EE_Error |
|
| 454 | - * @throws InvalidArgumentException |
|
| 455 | - * @throws InvalidDataTypeException |
|
| 456 | - * @throws InvalidInterfaceException |
|
| 457 | - * @throws ReflectionException |
|
| 458 | - */ |
|
| 459 | - public function total() |
|
| 460 | - { |
|
| 461 | - return $this->get('LIN_total'); |
|
| 462 | - } |
|
| 463 | - |
|
| 464 | - |
|
| 465 | - /** |
|
| 466 | - * Sets total |
|
| 467 | - * |
|
| 468 | - * @param float $total |
|
| 469 | - * @throws EE_Error |
|
| 470 | - * @throws InvalidArgumentException |
|
| 471 | - * @throws InvalidDataTypeException |
|
| 472 | - * @throws InvalidInterfaceException |
|
| 473 | - * @throws ReflectionException |
|
| 474 | - */ |
|
| 475 | - public function set_total($total) |
|
| 476 | - { |
|
| 477 | - $this->set('LIN_total', $total); |
|
| 478 | - } |
|
| 479 | - |
|
| 480 | - |
|
| 481 | - /** |
|
| 482 | - * Gets order |
|
| 483 | - * |
|
| 484 | - * @return int |
|
| 485 | - * @throws EE_Error |
|
| 486 | - * @throws InvalidArgumentException |
|
| 487 | - * @throws InvalidDataTypeException |
|
| 488 | - * @throws InvalidInterfaceException |
|
| 489 | - * @throws ReflectionException |
|
| 490 | - */ |
|
| 491 | - public function order() |
|
| 492 | - { |
|
| 493 | - return $this->get('LIN_order'); |
|
| 494 | - } |
|
| 495 | - |
|
| 496 | - |
|
| 497 | - /** |
|
| 498 | - * Sets order |
|
| 499 | - * |
|
| 500 | - * @param int $order |
|
| 501 | - * @throws EE_Error |
|
| 502 | - * @throws InvalidArgumentException |
|
| 503 | - * @throws InvalidDataTypeException |
|
| 504 | - * @throws InvalidInterfaceException |
|
| 505 | - * @throws ReflectionException |
|
| 506 | - */ |
|
| 507 | - public function set_order($order) |
|
| 508 | - { |
|
| 509 | - $this->set('LIN_order', $order); |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - |
|
| 513 | - /** |
|
| 514 | - * Gets parent |
|
| 515 | - * |
|
| 516 | - * @return int |
|
| 517 | - * @throws EE_Error |
|
| 518 | - * @throws InvalidArgumentException |
|
| 519 | - * @throws InvalidDataTypeException |
|
| 520 | - * @throws InvalidInterfaceException |
|
| 521 | - * @throws ReflectionException |
|
| 522 | - */ |
|
| 523 | - public function parent_ID() |
|
| 524 | - { |
|
| 525 | - return $this->get('LIN_parent'); |
|
| 526 | - } |
|
| 527 | - |
|
| 528 | - |
|
| 529 | - /** |
|
| 530 | - * Sets parent |
|
| 531 | - * |
|
| 532 | - * @param int $parent |
|
| 533 | - * @throws EE_Error |
|
| 534 | - * @throws InvalidArgumentException |
|
| 535 | - * @throws InvalidDataTypeException |
|
| 536 | - * @throws InvalidInterfaceException |
|
| 537 | - * @throws ReflectionException |
|
| 538 | - */ |
|
| 539 | - public function set_parent_ID($parent) |
|
| 540 | - { |
|
| 541 | - $this->set('LIN_parent', $parent); |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - |
|
| 545 | - /** |
|
| 546 | - * Gets type |
|
| 547 | - * |
|
| 548 | - * @return string |
|
| 549 | - * @throws EE_Error |
|
| 550 | - * @throws InvalidArgumentException |
|
| 551 | - * @throws InvalidDataTypeException |
|
| 552 | - * @throws InvalidInterfaceException |
|
| 553 | - * @throws ReflectionException |
|
| 554 | - */ |
|
| 555 | - public function type() |
|
| 556 | - { |
|
| 557 | - return $this->get('LIN_type'); |
|
| 558 | - } |
|
| 559 | - |
|
| 560 | - |
|
| 561 | - /** |
|
| 562 | - * Sets type |
|
| 563 | - * |
|
| 564 | - * @param string $type |
|
| 565 | - * @throws EE_Error |
|
| 566 | - * @throws InvalidArgumentException |
|
| 567 | - * @throws InvalidDataTypeException |
|
| 568 | - * @throws InvalidInterfaceException |
|
| 569 | - * @throws ReflectionException |
|
| 570 | - */ |
|
| 571 | - public function set_type($type) |
|
| 572 | - { |
|
| 573 | - $this->set('LIN_type', $type); |
|
| 574 | - } |
|
| 575 | - |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\ |
|
| 579 | - * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB |
|
| 580 | - * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()` |
|
| 581 | - * or indirectly by `EE_Line_item::add_child_line_item()`) |
|
| 582 | - * |
|
| 583 | - * @return EE_Base_Class|EE_Line_Item |
|
| 584 | - * @throws EE_Error |
|
| 585 | - * @throws InvalidArgumentException |
|
| 586 | - * @throws InvalidDataTypeException |
|
| 587 | - * @throws InvalidInterfaceException |
|
| 588 | - * @throws ReflectionException |
|
| 589 | - */ |
|
| 590 | - public function parent() |
|
| 591 | - { |
|
| 592 | - return $this->ID() |
|
| 593 | - ? $this->get_model()->get_one_by_ID($this->parent_ID()) |
|
| 594 | - : $this->_parent; |
|
| 595 | - } |
|
| 596 | - |
|
| 597 | - |
|
| 598 | - /** |
|
| 599 | - * Gets ALL the children of this line item (ie, all the parts that contribute towards this total). |
|
| 600 | - * |
|
| 601 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 602 | - * @throws EE_Error |
|
| 603 | - * @throws InvalidArgumentException |
|
| 604 | - * @throws InvalidDataTypeException |
|
| 605 | - * @throws InvalidInterfaceException |
|
| 606 | - * @throws ReflectionException |
|
| 607 | - */ |
|
| 608 | - public function children() |
|
| 609 | - { |
|
| 610 | - if ($this->ID()) { |
|
| 611 | - return $this->get_model()->get_all( |
|
| 612 | - array( |
|
| 613 | - array('LIN_parent' => $this->ID()), |
|
| 614 | - 'order_by' => array('LIN_order' => 'ASC'), |
|
| 615 | - ) |
|
| 616 | - ); |
|
| 617 | - } |
|
| 618 | - if (! is_array($this->_children)) { |
|
| 619 | - $this->_children = array(); |
|
| 620 | - } |
|
| 621 | - return $this->_children; |
|
| 622 | - } |
|
| 623 | - |
|
| 624 | - |
|
| 625 | - /** |
|
| 626 | - * Gets code |
|
| 627 | - * |
|
| 628 | - * @return string |
|
| 629 | - * @throws EE_Error |
|
| 630 | - * @throws InvalidArgumentException |
|
| 631 | - * @throws InvalidDataTypeException |
|
| 632 | - * @throws InvalidInterfaceException |
|
| 633 | - * @throws ReflectionException |
|
| 634 | - */ |
|
| 635 | - public function code() |
|
| 636 | - { |
|
| 637 | - return $this->get('LIN_code'); |
|
| 638 | - } |
|
| 639 | - |
|
| 640 | - |
|
| 641 | - /** |
|
| 642 | - * Sets code |
|
| 643 | - * |
|
| 644 | - * @param string $code |
|
| 645 | - * @throws EE_Error |
|
| 646 | - * @throws InvalidArgumentException |
|
| 647 | - * @throws InvalidDataTypeException |
|
| 648 | - * @throws InvalidInterfaceException |
|
| 649 | - * @throws ReflectionException |
|
| 650 | - */ |
|
| 651 | - public function set_code($code) |
|
| 652 | - { |
|
| 653 | - $this->set('LIN_code', $code); |
|
| 654 | - } |
|
| 655 | - |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * Gets is_taxable |
|
| 659 | - * |
|
| 660 | - * @return boolean |
|
| 661 | - * @throws EE_Error |
|
| 662 | - * @throws InvalidArgumentException |
|
| 663 | - * @throws InvalidDataTypeException |
|
| 664 | - * @throws InvalidInterfaceException |
|
| 665 | - * @throws ReflectionException |
|
| 666 | - */ |
|
| 667 | - public function is_taxable() |
|
| 668 | - { |
|
| 669 | - return $this->get('LIN_is_taxable'); |
|
| 670 | - } |
|
| 671 | - |
|
| 672 | - |
|
| 673 | - /** |
|
| 674 | - * Sets is_taxable |
|
| 675 | - * |
|
| 676 | - * @param boolean $is_taxable |
|
| 677 | - * @throws EE_Error |
|
| 678 | - * @throws InvalidArgumentException |
|
| 679 | - * @throws InvalidDataTypeException |
|
| 680 | - * @throws InvalidInterfaceException |
|
| 681 | - * @throws ReflectionException |
|
| 682 | - */ |
|
| 683 | - public function set_is_taxable($is_taxable) |
|
| 684 | - { |
|
| 685 | - $this->set('LIN_is_taxable', $is_taxable); |
|
| 686 | - } |
|
| 687 | - |
|
| 688 | - |
|
| 689 | - /** |
|
| 690 | - * Gets the object that this model-joins-to. |
|
| 691 | - * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on |
|
| 692 | - * EEM_Promotion_Object |
|
| 693 | - * Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object |
|
| 694 | - * |
|
| 695 | - * @return EE_Base_Class | NULL |
|
| 696 | - * @throws EE_Error |
|
| 697 | - * @throws InvalidArgumentException |
|
| 698 | - * @throws InvalidDataTypeException |
|
| 699 | - * @throws InvalidInterfaceException |
|
| 700 | - * @throws ReflectionException |
|
| 701 | - */ |
|
| 702 | - public function get_object() |
|
| 703 | - { |
|
| 704 | - $model_name_of_related_obj = $this->OBJ_type(); |
|
| 705 | - return $this->get_model()->has_relation($model_name_of_related_obj) |
|
| 706 | - ? $this->get_first_related($model_name_of_related_obj) |
|
| 707 | - : null; |
|
| 708 | - } |
|
| 709 | - |
|
| 710 | - |
|
| 711 | - /** |
|
| 712 | - * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket. |
|
| 713 | - * (IE, if this line item is for a price or something else, will return NULL) |
|
| 714 | - * |
|
| 715 | - * @param array $query_params |
|
| 716 | - * @return EE_Base_Class|EE_Ticket |
|
| 717 | - * @throws EE_Error |
|
| 718 | - * @throws InvalidArgumentException |
|
| 719 | - * @throws InvalidDataTypeException |
|
| 720 | - * @throws InvalidInterfaceException |
|
| 721 | - * @throws ReflectionException |
|
| 722 | - */ |
|
| 723 | - public function ticket($query_params = array()) |
|
| 724 | - { |
|
| 725 | - // we're going to assume that when this method is called |
|
| 726 | - // we always want to receive the attached ticket EVEN if that ticket is archived. |
|
| 727 | - // This can be overridden via the incoming $query_params argument |
|
| 728 | - $remove_defaults = array('default_where_conditions' => 'none'); |
|
| 729 | - $query_params = array_merge($remove_defaults, $query_params); |
|
| 730 | - return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params); |
|
| 731 | - } |
|
| 732 | - |
|
| 733 | - |
|
| 734 | - /** |
|
| 735 | - * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket |
|
| 736 | - * |
|
| 737 | - * @return EE_Datetime | NULL |
|
| 738 | - * @throws EE_Error |
|
| 739 | - * @throws InvalidArgumentException |
|
| 740 | - * @throws InvalidDataTypeException |
|
| 741 | - * @throws InvalidInterfaceException |
|
| 742 | - * @throws ReflectionException |
|
| 743 | - */ |
|
| 744 | - public function get_ticket_datetime() |
|
| 745 | - { |
|
| 746 | - if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 747 | - $ticket = $this->ticket(); |
|
| 748 | - if ($ticket instanceof EE_Ticket) { |
|
| 749 | - $datetime = $ticket->first_datetime(); |
|
| 750 | - if ($datetime instanceof EE_Datetime) { |
|
| 751 | - return $datetime; |
|
| 752 | - } |
|
| 753 | - } |
|
| 754 | - } |
|
| 755 | - return null; |
|
| 756 | - } |
|
| 757 | - |
|
| 758 | - |
|
| 759 | - /** |
|
| 760 | - * Gets the event's name that's related to the ticket, if this is for |
|
| 761 | - * a ticket |
|
| 762 | - * |
|
| 763 | - * @return string |
|
| 764 | - * @throws EE_Error |
|
| 765 | - * @throws InvalidArgumentException |
|
| 766 | - * @throws InvalidDataTypeException |
|
| 767 | - * @throws InvalidInterfaceException |
|
| 768 | - * @throws ReflectionException |
|
| 769 | - */ |
|
| 770 | - public function ticket_event_name() |
|
| 771 | - { |
|
| 772 | - $event_name = esc_html__('Unknown', 'event_espresso'); |
|
| 773 | - $event = $this->ticket_event(); |
|
| 774 | - if ($event instanceof EE_Event) { |
|
| 775 | - $event_name = $event->name(); |
|
| 776 | - } |
|
| 777 | - return $event_name; |
|
| 778 | - } |
|
| 779 | - |
|
| 780 | - |
|
| 781 | - /** |
|
| 782 | - * Gets the event that's related to the ticket, if this line item represents a ticket. |
|
| 783 | - * |
|
| 784 | - * @return EE_Event|null |
|
| 785 | - * @throws EE_Error |
|
| 786 | - * @throws InvalidArgumentException |
|
| 787 | - * @throws InvalidDataTypeException |
|
| 788 | - * @throws InvalidInterfaceException |
|
| 789 | - * @throws ReflectionException |
|
| 790 | - */ |
|
| 791 | - public function ticket_event() |
|
| 792 | - { |
|
| 793 | - $event = null; |
|
| 794 | - $ticket = $this->ticket(); |
|
| 795 | - if ($ticket instanceof EE_Ticket) { |
|
| 796 | - $datetime = $ticket->first_datetime(); |
|
| 797 | - if ($datetime instanceof EE_Datetime) { |
|
| 798 | - $event = $datetime->event(); |
|
| 799 | - } |
|
| 800 | - } |
|
| 801 | - return $event; |
|
| 802 | - } |
|
| 803 | - |
|
| 804 | - |
|
| 805 | - /** |
|
| 806 | - * Gets the first datetime for this lien item, assuming it's for a ticket |
|
| 807 | - * |
|
| 808 | - * @param string $date_format |
|
| 809 | - * @param string $time_format |
|
| 810 | - * @return string |
|
| 811 | - * @throws EE_Error |
|
| 812 | - * @throws InvalidArgumentException |
|
| 813 | - * @throws InvalidDataTypeException |
|
| 814 | - * @throws InvalidInterfaceException |
|
| 815 | - * @throws ReflectionException |
|
| 816 | - */ |
|
| 817 | - public function ticket_datetime_start($date_format = '', $time_format = '') |
|
| 818 | - { |
|
| 819 | - $first_datetime_string = esc_html__('Unknown', 'event_espresso'); |
|
| 820 | - $datetime = $this->get_ticket_datetime(); |
|
| 821 | - if ($datetime) { |
|
| 822 | - $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format); |
|
| 823 | - } |
|
| 824 | - return $first_datetime_string; |
|
| 825 | - } |
|
| 826 | - |
|
| 827 | - |
|
| 828 | - /** |
|
| 829 | - * Adds the line item as a child to this line item. If there is another child line |
|
| 830 | - * item with the same LIN_code, it is overwritten by this new one |
|
| 831 | - * |
|
| 832 | - * @param EEI_Line_Item $line_item |
|
| 833 | - * @param bool $set_order |
|
| 834 | - * @return bool success |
|
| 835 | - * @throws EE_Error |
|
| 836 | - * @throws InvalidArgumentException |
|
| 837 | - * @throws InvalidDataTypeException |
|
| 838 | - * @throws InvalidInterfaceException |
|
| 839 | - * @throws ReflectionException |
|
| 840 | - */ |
|
| 841 | - public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) |
|
| 842 | - { |
|
| 843 | - // should we calculate the LIN_order for this line item ? |
|
| 844 | - if ($set_order || $line_item->order() === null) { |
|
| 845 | - $line_item->set_order(count($this->children())); |
|
| 846 | - } |
|
| 847 | - if ($this->ID()) { |
|
| 848 | - // check for any duplicate line items (with the same code), if so, this replaces it |
|
| 849 | - $line_item_with_same_code = $this->get_child_line_item($line_item->code()); |
|
| 850 | - if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) { |
|
| 851 | - $this->delete_child_line_item($line_item_with_same_code->code()); |
|
| 852 | - } |
|
| 853 | - $line_item->set_parent_ID($this->ID()); |
|
| 854 | - if ($this->TXN_ID()) { |
|
| 855 | - $line_item->set_TXN_ID($this->TXN_ID()); |
|
| 856 | - } |
|
| 857 | - return $line_item->save(); |
|
| 858 | - } |
|
| 859 | - $this->_children[ $line_item->code() ] = $line_item; |
|
| 860 | - if ($line_item->parent() !== $this) { |
|
| 861 | - $line_item->set_parent($this); |
|
| 862 | - } |
|
| 863 | - return true; |
|
| 864 | - } |
|
| 865 | - |
|
| 866 | - |
|
| 867 | - /** |
|
| 868 | - * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation. |
|
| 869 | - * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save() |
|
| 870 | - * However, if this line item is NOT saved to the DB, this just caches the parent on |
|
| 871 | - * the EE_Line_Item::_parent property. |
|
| 872 | - * |
|
| 873 | - * @param EE_Line_Item $line_item |
|
| 874 | - * @throws EE_Error |
|
| 875 | - * @throws InvalidArgumentException |
|
| 876 | - * @throws InvalidDataTypeException |
|
| 877 | - * @throws InvalidInterfaceException |
|
| 878 | - * @throws ReflectionException |
|
| 879 | - */ |
|
| 880 | - public function set_parent($line_item) |
|
| 881 | - { |
|
| 882 | - if ($this->ID()) { |
|
| 883 | - if (! $line_item->ID()) { |
|
| 884 | - $line_item->save(); |
|
| 885 | - } |
|
| 886 | - $this->set_parent_ID($line_item->ID()); |
|
| 887 | - $this->save(); |
|
| 888 | - } else { |
|
| 889 | - $this->_parent = $line_item; |
|
| 890 | - $this->set_parent_ID($line_item->ID()); |
|
| 891 | - } |
|
| 892 | - } |
|
| 893 | - |
|
| 894 | - |
|
| 895 | - /** |
|
| 896 | - * Gets the child line item as specified by its code. Because this returns an object (by reference) |
|
| 897 | - * you can modify this child line item and the parent (this object) can know about them |
|
| 898 | - * because it also has a reference to that line item |
|
| 899 | - * |
|
| 900 | - * @param string $code |
|
| 901 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 902 | - * @throws EE_Error |
|
| 903 | - * @throws InvalidArgumentException |
|
| 904 | - * @throws InvalidDataTypeException |
|
| 905 | - * @throws InvalidInterfaceException |
|
| 906 | - * @throws ReflectionException |
|
| 907 | - */ |
|
| 908 | - public function get_child_line_item($code) |
|
| 909 | - { |
|
| 910 | - if ($this->ID()) { |
|
| 911 | - return $this->get_model()->get_one( |
|
| 912 | - array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)) |
|
| 913 | - ); |
|
| 914 | - } |
|
| 915 | - return isset($this->_children[ $code ]) |
|
| 916 | - ? $this->_children[ $code ] |
|
| 917 | - : null; |
|
| 918 | - } |
|
| 919 | - |
|
| 920 | - |
|
| 921 | - /** |
|
| 922 | - * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD |
|
| 923 | - * cached on it) |
|
| 924 | - * |
|
| 925 | - * @return int |
|
| 926 | - * @throws EE_Error |
|
| 927 | - * @throws InvalidArgumentException |
|
| 928 | - * @throws InvalidDataTypeException |
|
| 929 | - * @throws InvalidInterfaceException |
|
| 930 | - * @throws ReflectionException |
|
| 931 | - */ |
|
| 932 | - public function delete_children_line_items() |
|
| 933 | - { |
|
| 934 | - if ($this->ID()) { |
|
| 935 | - return $this->get_model()->delete(array(array('LIN_parent' => $this->ID()))); |
|
| 936 | - } |
|
| 937 | - $count = count($this->_children); |
|
| 938 | - $this->_children = array(); |
|
| 939 | - return $count; |
|
| 940 | - } |
|
| 941 | - |
|
| 942 | - |
|
| 943 | - /** |
|
| 944 | - * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line |
|
| 945 | - * HAS NOT been saved to the DB, removes the child line item with index $code. |
|
| 946 | - * Also searches through the child's children for a matching line item. However, once a line item has been found |
|
| 947 | - * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be |
|
| 948 | - * deleted) |
|
| 949 | - * |
|
| 950 | - * @param string $code |
|
| 951 | - * @param bool $stop_search_once_found |
|
| 952 | - * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to |
|
| 953 | - * the DB yet) |
|
| 954 | - * @throws EE_Error |
|
| 955 | - * @throws InvalidArgumentException |
|
| 956 | - * @throws InvalidDataTypeException |
|
| 957 | - * @throws InvalidInterfaceException |
|
| 958 | - * @throws ReflectionException |
|
| 959 | - */ |
|
| 960 | - public function delete_child_line_item($code, $stop_search_once_found = true) |
|
| 961 | - { |
|
| 962 | - if ($this->ID()) { |
|
| 963 | - $items_deleted = 0; |
|
| 964 | - if ($this->code() === $code) { |
|
| 965 | - $items_deleted += EEH_Line_Item::delete_all_child_items($this); |
|
| 966 | - $items_deleted += (int) $this->delete(); |
|
| 967 | - if ($stop_search_once_found) { |
|
| 968 | - return $items_deleted; |
|
| 969 | - } |
|
| 970 | - } |
|
| 971 | - foreach ($this->children() as $child_line_item) { |
|
| 972 | - $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found); |
|
| 973 | - } |
|
| 974 | - return $items_deleted; |
|
| 975 | - } |
|
| 976 | - if (isset($this->_children[ $code ])) { |
|
| 977 | - unset($this->_children[ $code ]); |
|
| 978 | - return 1; |
|
| 979 | - } |
|
| 980 | - return 0; |
|
| 981 | - } |
|
| 982 | - |
|
| 983 | - |
|
| 984 | - /** |
|
| 985 | - * If this line item is in the database, is of the type subtotal, and |
|
| 986 | - * has no children, why do we have it? It should be deleted so this function |
|
| 987 | - * does that |
|
| 988 | - * |
|
| 989 | - * @return boolean |
|
| 990 | - * @throws EE_Error |
|
| 991 | - * @throws InvalidArgumentException |
|
| 992 | - * @throws InvalidDataTypeException |
|
| 993 | - * @throws InvalidInterfaceException |
|
| 994 | - * @throws ReflectionException |
|
| 995 | - */ |
|
| 996 | - public function delete_if_childless_subtotal() |
|
| 997 | - { |
|
| 998 | - if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) { |
|
| 999 | - return $this->delete(); |
|
| 1000 | - } |
|
| 1001 | - return false; |
|
| 1002 | - } |
|
| 1003 | - |
|
| 1004 | - |
|
| 1005 | - /** |
|
| 1006 | - * Creates a code and returns a string. doesn't assign the code to this model object |
|
| 1007 | - * |
|
| 1008 | - * @return string |
|
| 1009 | - * @throws EE_Error |
|
| 1010 | - * @throws InvalidArgumentException |
|
| 1011 | - * @throws InvalidDataTypeException |
|
| 1012 | - * @throws InvalidInterfaceException |
|
| 1013 | - * @throws ReflectionException |
|
| 1014 | - */ |
|
| 1015 | - public function generate_code() |
|
| 1016 | - { |
|
| 1017 | - // each line item in the cart requires a unique identifier |
|
| 1018 | - return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime()); |
|
| 1019 | - } |
|
| 1020 | - |
|
| 1021 | - |
|
| 1022 | - /** |
|
| 1023 | - * @return bool |
|
| 1024 | - * @throws EE_Error |
|
| 1025 | - * @throws InvalidArgumentException |
|
| 1026 | - * @throws InvalidDataTypeException |
|
| 1027 | - * @throws InvalidInterfaceException |
|
| 1028 | - * @throws ReflectionException |
|
| 1029 | - */ |
|
| 1030 | - public function is_tax() |
|
| 1031 | - { |
|
| 1032 | - return $this->type() === EEM_Line_Item::type_tax; |
|
| 1033 | - } |
|
| 1034 | - |
|
| 1035 | - |
|
| 1036 | - /** |
|
| 1037 | - * @return bool |
|
| 1038 | - * @throws EE_Error |
|
| 1039 | - * @throws InvalidArgumentException |
|
| 1040 | - * @throws InvalidDataTypeException |
|
| 1041 | - * @throws InvalidInterfaceException |
|
| 1042 | - * @throws ReflectionException |
|
| 1043 | - */ |
|
| 1044 | - public function is_tax_sub_total() |
|
| 1045 | - { |
|
| 1046 | - return $this->type() === EEM_Line_Item::type_tax_sub_total; |
|
| 1047 | - } |
|
| 1048 | - |
|
| 1049 | - |
|
| 1050 | - /** |
|
| 1051 | - * @return bool |
|
| 1052 | - * @throws EE_Error |
|
| 1053 | - * @throws InvalidArgumentException |
|
| 1054 | - * @throws InvalidDataTypeException |
|
| 1055 | - * @throws InvalidInterfaceException |
|
| 1056 | - * @throws ReflectionException |
|
| 1057 | - */ |
|
| 1058 | - public function is_line_item() |
|
| 1059 | - { |
|
| 1060 | - return $this->type() === EEM_Line_Item::type_line_item; |
|
| 1061 | - } |
|
| 1062 | - |
|
| 1063 | - |
|
| 1064 | - /** |
|
| 1065 | - * @return bool |
|
| 1066 | - * @throws EE_Error |
|
| 1067 | - * @throws InvalidArgumentException |
|
| 1068 | - * @throws InvalidDataTypeException |
|
| 1069 | - * @throws InvalidInterfaceException |
|
| 1070 | - * @throws ReflectionException |
|
| 1071 | - */ |
|
| 1072 | - public function is_sub_line_item() |
|
| 1073 | - { |
|
| 1074 | - return $this->type() === EEM_Line_Item::type_sub_line_item; |
|
| 1075 | - } |
|
| 1076 | - |
|
| 1077 | - |
|
| 1078 | - /** |
|
| 1079 | - * @return bool |
|
| 1080 | - * @throws EE_Error |
|
| 1081 | - * @throws InvalidArgumentException |
|
| 1082 | - * @throws InvalidDataTypeException |
|
| 1083 | - * @throws InvalidInterfaceException |
|
| 1084 | - * @throws ReflectionException |
|
| 1085 | - */ |
|
| 1086 | - public function is_sub_total() |
|
| 1087 | - { |
|
| 1088 | - return $this->type() === EEM_Line_Item::type_sub_total; |
|
| 1089 | - } |
|
| 1090 | - |
|
| 1091 | - |
|
| 1092 | - /** |
|
| 1093 | - * Whether or not this line item is a cancellation line item |
|
| 1094 | - * |
|
| 1095 | - * @return boolean |
|
| 1096 | - * @throws EE_Error |
|
| 1097 | - * @throws InvalidArgumentException |
|
| 1098 | - * @throws InvalidDataTypeException |
|
| 1099 | - * @throws InvalidInterfaceException |
|
| 1100 | - * @throws ReflectionException |
|
| 1101 | - */ |
|
| 1102 | - public function is_cancellation() |
|
| 1103 | - { |
|
| 1104 | - return EEM_Line_Item::type_cancellation === $this->type(); |
|
| 1105 | - } |
|
| 1106 | - |
|
| 1107 | - |
|
| 1108 | - /** |
|
| 1109 | - * @return bool |
|
| 1110 | - * @throws EE_Error |
|
| 1111 | - * @throws InvalidArgumentException |
|
| 1112 | - * @throws InvalidDataTypeException |
|
| 1113 | - * @throws InvalidInterfaceException |
|
| 1114 | - * @throws ReflectionException |
|
| 1115 | - */ |
|
| 1116 | - public function is_total() |
|
| 1117 | - { |
|
| 1118 | - return $this->type() === EEM_Line_Item::type_total; |
|
| 1119 | - } |
|
| 1120 | - |
|
| 1121 | - |
|
| 1122 | - /** |
|
| 1123 | - * @return bool |
|
| 1124 | - * @throws EE_Error |
|
| 1125 | - * @throws InvalidArgumentException |
|
| 1126 | - * @throws InvalidDataTypeException |
|
| 1127 | - * @throws InvalidInterfaceException |
|
| 1128 | - * @throws ReflectionException |
|
| 1129 | - */ |
|
| 1130 | - public function is_cancelled() |
|
| 1131 | - { |
|
| 1132 | - return $this->type() === EEM_Line_Item::type_cancellation; |
|
| 1133 | - } |
|
| 1134 | - |
|
| 1135 | - |
|
| 1136 | - /** |
|
| 1137 | - * @return string like '2, 004.00', formatted according to the localized currency |
|
| 1138 | - * @throws EE_Error |
|
| 1139 | - * @throws InvalidArgumentException |
|
| 1140 | - * @throws InvalidDataTypeException |
|
| 1141 | - * @throws InvalidInterfaceException |
|
| 1142 | - * @throws ReflectionException |
|
| 1143 | - */ |
|
| 1144 | - public function unit_price_no_code() |
|
| 1145 | - { |
|
| 1146 | - return $this->get_pretty('LIN_unit_price', 'no_currency_code'); |
|
| 1147 | - } |
|
| 1148 | - |
|
| 1149 | - |
|
| 1150 | - /** |
|
| 1151 | - * @return string like '2, 004.00', formatted according to the localized currency |
|
| 1152 | - * @throws EE_Error |
|
| 1153 | - * @throws InvalidArgumentException |
|
| 1154 | - * @throws InvalidDataTypeException |
|
| 1155 | - * @throws InvalidInterfaceException |
|
| 1156 | - * @throws ReflectionException |
|
| 1157 | - */ |
|
| 1158 | - public function total_no_code() |
|
| 1159 | - { |
|
| 1160 | - return $this->get_pretty('LIN_total', 'no_currency_code'); |
|
| 1161 | - } |
|
| 1162 | - |
|
| 1163 | - |
|
| 1164 | - /** |
|
| 1165 | - * Gets the final total on this item, taking taxes into account. |
|
| 1166 | - * Has the side-effect of setting the sub-total as it was just calculated. |
|
| 1167 | - * If this is used on a grand-total line item, also updates the transaction's |
|
| 1168 | - * TXN_total (provided this line item is allowed to persist, otherwise we don't |
|
| 1169 | - * want to change a persistable transaction with info from a non-persistent line item) |
|
| 1170 | - * |
|
| 1171 | - * @param bool $update_txn_status |
|
| 1172 | - * @return float |
|
| 1173 | - * @throws EE_Error |
|
| 1174 | - * @throws InvalidArgumentException |
|
| 1175 | - * @throws InvalidDataTypeException |
|
| 1176 | - * @throws InvalidInterfaceException |
|
| 1177 | - * @throws ReflectionException |
|
| 1178 | - * @throws RuntimeException |
|
| 1179 | - */ |
|
| 1180 | - public function recalculate_total_including_taxes($update_txn_status = false) |
|
| 1181 | - { |
|
| 1182 | - $pre_tax_total = $this->recalculate_pre_tax_total(); |
|
| 1183 | - $tax_total = $this->recalculate_taxes_and_tax_total(); |
|
| 1184 | - $total = $pre_tax_total + $tax_total; |
|
| 1185 | - // no negative totals plz |
|
| 1186 | - $total = max($total, 0); |
|
| 1187 | - $this->set_total($total); |
|
| 1188 | - // only update the related transaction's total |
|
| 1189 | - // if we intend to save this line item and its a grand total |
|
| 1190 | - if ($this->allow_persist() && $this->type() === EEM_Line_Item::type_total |
|
| 1191 | - && $this->transaction() |
|
| 1192 | - instanceof |
|
| 1193 | - EE_Transaction |
|
| 1194 | - ) { |
|
| 1195 | - $this->transaction()->set_total($total); |
|
| 1196 | - if ($update_txn_status) { |
|
| 1197 | - // don't save the TXN because that will be done below |
|
| 1198 | - // and the following method only saves if the status changes |
|
| 1199 | - $this->transaction()->update_status_based_on_total_paid(false); |
|
| 1200 | - } |
|
| 1201 | - if ($this->transaction()->ID()) { |
|
| 1202 | - $this->transaction()->save(); |
|
| 1203 | - } |
|
| 1204 | - } |
|
| 1205 | - $this->maybe_save(); |
|
| 1206 | - return $total; |
|
| 1207 | - } |
|
| 1208 | - |
|
| 1209 | - |
|
| 1210 | - /** |
|
| 1211 | - * Recursively goes through all the children and recalculates sub-totals EXCEPT for |
|
| 1212 | - * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its |
|
| 1213 | - * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and |
|
| 1214 | - * when this is called on the grand total |
|
| 1215 | - * |
|
| 1216 | - * @return float |
|
| 1217 | - * @throws EE_Error |
|
| 1218 | - * @throws InvalidArgumentException |
|
| 1219 | - * @throws InvalidDataTypeException |
|
| 1220 | - * @throws InvalidInterfaceException |
|
| 1221 | - * @throws ReflectionException |
|
| 1222 | - */ |
|
| 1223 | - public function recalculate_pre_tax_total() |
|
| 1224 | - { |
|
| 1225 | - $total = 0; |
|
| 1226 | - $my_children = $this->children(); |
|
| 1227 | - $has_children = ! empty($my_children); |
|
| 1228 | - if ($has_children && $this->is_line_item()) { |
|
| 1229 | - $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children); |
|
| 1230 | - } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 1231 | - $total = $this->unit_price() * $this->quantity(); |
|
| 1232 | - } elseif ($this->is_sub_total() || $this->is_total()) { |
|
| 1233 | - $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children); |
|
| 1234 | - } elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) { |
|
| 1235 | - // completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total |
|
| 1236 | - return 0; |
|
| 1237 | - } |
|
| 1238 | - // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events) |
|
| 1239 | - if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 1240 | - ) { |
|
| 1241 | - if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) { |
|
| 1242 | - $this->set_quantity(1); |
|
| 1243 | - } |
|
| 1244 | - if (! $this->is_percent()) { |
|
| 1245 | - $this->set_unit_price($total); |
|
| 1246 | - } |
|
| 1247 | - } |
|
| 1248 | - // we don't want to bother saving grand totals, because that needs to factor in taxes anyways |
|
| 1249 | - // so it ought to be |
|
| 1250 | - if (! $this->is_total()) { |
|
| 1251 | - $this->set_total($total); |
|
| 1252 | - // if not a percent line item, make sure we keep the unit price in sync |
|
| 1253 | - if ($has_children |
|
| 1254 | - && $this->is_line_item() |
|
| 1255 | - && ! $this->is_percent() |
|
| 1256 | - ) { |
|
| 1257 | - if ($this->quantity() === 0) { |
|
| 1258 | - $new_unit_price = 0; |
|
| 1259 | - } else { |
|
| 1260 | - $new_unit_price = $this->total() / $this->quantity(); |
|
| 1261 | - } |
|
| 1262 | - $this->set_unit_price($new_unit_price); |
|
| 1263 | - } |
|
| 1264 | - $this->maybe_save(); |
|
| 1265 | - } |
|
| 1266 | - return $total; |
|
| 1267 | - } |
|
| 1268 | - |
|
| 1269 | - |
|
| 1270 | - /** |
|
| 1271 | - * Calculates the pretax total when this line item is a subtotal or total line item. |
|
| 1272 | - * Basically does a sum-then-round approach (ie, any percent line item that are children |
|
| 1273 | - * will calculate their total based on the un-rounded total we're working with so far, and |
|
| 1274 | - * THEN round the result; instead of rounding as we go like with sub-line-items) |
|
| 1275 | - * |
|
| 1276 | - * @param float $calculated_total_so_far |
|
| 1277 | - * @param EE_Line_Item[] $my_children |
|
| 1278 | - * @return float |
|
| 1279 | - * @throws EE_Error |
|
| 1280 | - * @throws InvalidArgumentException |
|
| 1281 | - * @throws InvalidDataTypeException |
|
| 1282 | - * @throws InvalidInterfaceException |
|
| 1283 | - * @throws ReflectionException |
|
| 1284 | - */ |
|
| 1285 | - protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) |
|
| 1286 | - { |
|
| 1287 | - if ($my_children === null) { |
|
| 1288 | - $my_children = $this->children(); |
|
| 1289 | - } |
|
| 1290 | - $subtotal_quantity = 0; |
|
| 1291 | - // get the total of all its children |
|
| 1292 | - foreach ($my_children as $child_line_item) { |
|
| 1293 | - if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1294 | - // percentage line items are based on total so far |
|
| 1295 | - if ($child_line_item->is_percent()) { |
|
| 1296 | - // round as we go so that the line items add up ok |
|
| 1297 | - $percent_total = round( |
|
| 1298 | - $calculated_total_so_far * $child_line_item->percent() / 100, |
|
| 1299 | - EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1300 | - ); |
|
| 1301 | - $child_line_item->set_total($percent_total); |
|
| 1302 | - // so far all percent line items should have a quantity of 1 |
|
| 1303 | - // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1304 | - $child_line_item->set_quantity(1); |
|
| 1305 | - $child_line_item->maybe_save(); |
|
| 1306 | - $calculated_total_so_far += $percent_total; |
|
| 1307 | - } else { |
|
| 1308 | - // verify flat sub-line-item quantities match their parent |
|
| 1309 | - if ($child_line_item->is_sub_line_item()) { |
|
| 1310 | - $child_line_item->set_quantity($this->quantity()); |
|
| 1311 | - } |
|
| 1312 | - $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1313 | - $subtotal_quantity += $child_line_item->quantity(); |
|
| 1314 | - } |
|
| 1315 | - } |
|
| 1316 | - } |
|
| 1317 | - if ($this->is_sub_total()) { |
|
| 1318 | - // no negative totals plz |
|
| 1319 | - $calculated_total_so_far = max($calculated_total_so_far, 0); |
|
| 1320 | - $subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0; |
|
| 1321 | - $this->set_quantity($subtotal_quantity); |
|
| 1322 | - $this->maybe_save(); |
|
| 1323 | - } |
|
| 1324 | - return $calculated_total_so_far; |
|
| 1325 | - } |
|
| 1326 | - |
|
| 1327 | - |
|
| 1328 | - /** |
|
| 1329 | - * Calculates the pretax total for a normal line item, in a round-then-sum approach |
|
| 1330 | - * (where each sub-line-item is applied to the base price for the line item |
|
| 1331 | - * and the result is immediately rounded, rather than summing all the sub-line-items |
|
| 1332 | - * then rounding, like we do when recalculating pretax totals on totals and subtotals). |
|
| 1333 | - * |
|
| 1334 | - * @param float $calculated_total_so_far |
|
| 1335 | - * @param EE_Line_Item[] $my_children |
|
| 1336 | - * @return float |
|
| 1337 | - * @throws EE_Error |
|
| 1338 | - * @throws InvalidArgumentException |
|
| 1339 | - * @throws InvalidDataTypeException |
|
| 1340 | - * @throws InvalidInterfaceException |
|
| 1341 | - * @throws ReflectionException |
|
| 1342 | - */ |
|
| 1343 | - protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) |
|
| 1344 | - { |
|
| 1345 | - if ($my_children === null) { |
|
| 1346 | - $my_children = $this->children(); |
|
| 1347 | - } |
|
| 1348 | - // we need to keep track of the running total for a single item, |
|
| 1349 | - // because we need to round as we go |
|
| 1350 | - $unit_price_for_total = 0; |
|
| 1351 | - $quantity_for_total = 1; |
|
| 1352 | - // get the total of all its children |
|
| 1353 | - foreach ($my_children as $child_line_item) { |
|
| 1354 | - if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1355 | - if ($child_line_item->is_percent()) { |
|
| 1356 | - // it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity |
|
| 1357 | - // not total multiplied by percent, because that ignores rounding along-the-way |
|
| 1358 | - $percent_unit_price = round( |
|
| 1359 | - $unit_price_for_total * $child_line_item->percent() / 100, |
|
| 1360 | - EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1361 | - ); |
|
| 1362 | - $percent_total = $percent_unit_price * $quantity_for_total; |
|
| 1363 | - $child_line_item->set_total($percent_total); |
|
| 1364 | - // so far all percent line items should have a quantity of 1 |
|
| 1365 | - // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1366 | - $child_line_item->set_quantity(1); |
|
| 1367 | - $child_line_item->maybe_save(); |
|
| 1368 | - $calculated_total_so_far += $percent_total; |
|
| 1369 | - $unit_price_for_total += $percent_unit_price; |
|
| 1370 | - } else { |
|
| 1371 | - // verify flat sub-line-item quantities match their parent |
|
| 1372 | - if ($child_line_item->is_sub_line_item()) { |
|
| 1373 | - $child_line_item->set_quantity($this->quantity()); |
|
| 1374 | - } |
|
| 1375 | - $quantity_for_total = $child_line_item->quantity(); |
|
| 1376 | - $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1377 | - $unit_price_for_total += $child_line_item->unit_price(); |
|
| 1378 | - } |
|
| 1379 | - } |
|
| 1380 | - } |
|
| 1381 | - return $calculated_total_so_far; |
|
| 1382 | - } |
|
| 1383 | - |
|
| 1384 | - |
|
| 1385 | - /** |
|
| 1386 | - * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets |
|
| 1387 | - * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items |
|
| 1388 | - * and tax sub-total if already in the DB |
|
| 1389 | - * |
|
| 1390 | - * @return float |
|
| 1391 | - * @throws EE_Error |
|
| 1392 | - * @throws InvalidArgumentException |
|
| 1393 | - * @throws InvalidDataTypeException |
|
| 1394 | - * @throws InvalidInterfaceException |
|
| 1395 | - * @throws ReflectionException |
|
| 1396 | - */ |
|
| 1397 | - public function recalculate_taxes_and_tax_total() |
|
| 1398 | - { |
|
| 1399 | - // get all taxes |
|
| 1400 | - $taxes = $this->tax_descendants(); |
|
| 1401 | - // calculate the pretax total |
|
| 1402 | - $taxable_total = $this->taxable_total(); |
|
| 1403 | - $tax_total = 0; |
|
| 1404 | - foreach ($taxes as $tax) { |
|
| 1405 | - $total_on_this_tax = $taxable_total * $tax->percent() / 100; |
|
| 1406 | - // remember the total on this line item |
|
| 1407 | - $tax->set_total($total_on_this_tax); |
|
| 1408 | - $tax->maybe_save(); |
|
| 1409 | - $tax_total += $tax->total(); |
|
| 1410 | - } |
|
| 1411 | - $this->_recalculate_tax_sub_total(); |
|
| 1412 | - return $tax_total; |
|
| 1413 | - } |
|
| 1414 | - |
|
| 1415 | - |
|
| 1416 | - /** |
|
| 1417 | - * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated |
|
| 1418 | - * |
|
| 1419 | - * @return void |
|
| 1420 | - * @throws EE_Error |
|
| 1421 | - * @throws InvalidArgumentException |
|
| 1422 | - * @throws InvalidDataTypeException |
|
| 1423 | - * @throws InvalidInterfaceException |
|
| 1424 | - * @throws ReflectionException |
|
| 1425 | - */ |
|
| 1426 | - private function _recalculate_tax_sub_total() |
|
| 1427 | - { |
|
| 1428 | - if ($this->is_tax_sub_total()) { |
|
| 1429 | - $total = 0; |
|
| 1430 | - $total_percent = 0; |
|
| 1431 | - // simply loop through all its children (which should be taxes) and sum their total |
|
| 1432 | - foreach ($this->children() as $child_tax) { |
|
| 1433 | - if ($child_tax instanceof EE_Line_Item) { |
|
| 1434 | - $total += $child_tax->total(); |
|
| 1435 | - $total_percent += $child_tax->percent(); |
|
| 1436 | - } |
|
| 1437 | - } |
|
| 1438 | - $this->set_total($total); |
|
| 1439 | - $this->set_percent($total_percent); |
|
| 1440 | - $this->maybe_save(); |
|
| 1441 | - } elseif ($this->is_total()) { |
|
| 1442 | - foreach ($this->children() as $maybe_tax_subtotal) { |
|
| 1443 | - if ($maybe_tax_subtotal instanceof EE_Line_Item) { |
|
| 1444 | - $maybe_tax_subtotal->_recalculate_tax_sub_total(); |
|
| 1445 | - } |
|
| 1446 | - } |
|
| 1447 | - } |
|
| 1448 | - } |
|
| 1449 | - |
|
| 1450 | - |
|
| 1451 | - /** |
|
| 1452 | - * Gets the total tax on this line item. Assumes taxes have already been calculated using |
|
| 1453 | - * recalculate_taxes_and_total |
|
| 1454 | - * |
|
| 1455 | - * @return float |
|
| 1456 | - * @throws EE_Error |
|
| 1457 | - * @throws InvalidArgumentException |
|
| 1458 | - * @throws InvalidDataTypeException |
|
| 1459 | - * @throws InvalidInterfaceException |
|
| 1460 | - * @throws ReflectionException |
|
| 1461 | - */ |
|
| 1462 | - public function get_total_tax() |
|
| 1463 | - { |
|
| 1464 | - $this->_recalculate_tax_sub_total(); |
|
| 1465 | - $total = 0; |
|
| 1466 | - foreach ($this->tax_descendants() as $tax_line_item) { |
|
| 1467 | - if ($tax_line_item instanceof EE_Line_Item) { |
|
| 1468 | - $total += $tax_line_item->total(); |
|
| 1469 | - } |
|
| 1470 | - } |
|
| 1471 | - return $total; |
|
| 1472 | - } |
|
| 1473 | - |
|
| 1474 | - |
|
| 1475 | - /** |
|
| 1476 | - * Gets the total for all the items purchased only |
|
| 1477 | - * |
|
| 1478 | - * @return float |
|
| 1479 | - * @throws EE_Error |
|
| 1480 | - * @throws InvalidArgumentException |
|
| 1481 | - * @throws InvalidDataTypeException |
|
| 1482 | - * @throws InvalidInterfaceException |
|
| 1483 | - * @throws ReflectionException |
|
| 1484 | - */ |
|
| 1485 | - public function get_items_total() |
|
| 1486 | - { |
|
| 1487 | - // by default, let's make sure we're consistent with the existing line item |
|
| 1488 | - if ($this->is_total()) { |
|
| 1489 | - $pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this); |
|
| 1490 | - if ($pretax_subtotal_li instanceof EE_Line_Item) { |
|
| 1491 | - return $pretax_subtotal_li->total(); |
|
| 1492 | - } |
|
| 1493 | - } |
|
| 1494 | - $total = 0; |
|
| 1495 | - foreach ($this->get_items() as $item) { |
|
| 1496 | - if ($item instanceof EE_Line_Item) { |
|
| 1497 | - $total += $item->total(); |
|
| 1498 | - } |
|
| 1499 | - } |
|
| 1500 | - return $total; |
|
| 1501 | - } |
|
| 1502 | - |
|
| 1503 | - |
|
| 1504 | - /** |
|
| 1505 | - * Gets all the descendants (ie, children or children of children etc) that |
|
| 1506 | - * are of the type 'tax' |
|
| 1507 | - * |
|
| 1508 | - * @return EE_Line_Item[] |
|
| 1509 | - * @throws EE_Error |
|
| 1510 | - */ |
|
| 1511 | - public function tax_descendants() |
|
| 1512 | - { |
|
| 1513 | - return EEH_Line_Item::get_tax_descendants($this); |
|
| 1514 | - } |
|
| 1515 | - |
|
| 1516 | - |
|
| 1517 | - /** |
|
| 1518 | - * Gets all the real items purchased which are children of this item |
|
| 1519 | - * |
|
| 1520 | - * @return EE_Line_Item[] |
|
| 1521 | - * @throws EE_Error |
|
| 1522 | - */ |
|
| 1523 | - public function get_items() |
|
| 1524 | - { |
|
| 1525 | - return EEH_Line_Item::get_line_item_descendants($this); |
|
| 1526 | - } |
|
| 1527 | - |
|
| 1528 | - |
|
| 1529 | - /** |
|
| 1530 | - * Returns the amount taxable among this line item's children (or if it has no children, |
|
| 1531 | - * how much of it is taxable). Does not recalculate totals or subtotals. |
|
| 1532 | - * If the taxable total is negative, (eg, if none of the tickets were taxable, |
|
| 1533 | - * but there is a "Taxable" discount), returns 0. |
|
| 1534 | - * |
|
| 1535 | - * @return float |
|
| 1536 | - * @throws EE_Error |
|
| 1537 | - * @throws InvalidArgumentException |
|
| 1538 | - * @throws InvalidDataTypeException |
|
| 1539 | - * @throws InvalidInterfaceException |
|
| 1540 | - * @throws ReflectionException |
|
| 1541 | - */ |
|
| 1542 | - public function taxable_total() |
|
| 1543 | - { |
|
| 1544 | - $total = 0; |
|
| 1545 | - if ($this->children()) { |
|
| 1546 | - foreach ($this->children() as $child_line_item) { |
|
| 1547 | - if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) { |
|
| 1548 | - // if it's a percent item, only take into account the percent |
|
| 1549 | - // that's taxable too (the taxable total so far) |
|
| 1550 | - if ($child_line_item->is_percent()) { |
|
| 1551 | - $total += ($total * $child_line_item->percent() / 100); |
|
| 1552 | - } else { |
|
| 1553 | - $total += $child_line_item->total(); |
|
| 1554 | - } |
|
| 1555 | - } elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) { |
|
| 1556 | - $total += $child_line_item->taxable_total(); |
|
| 1557 | - } |
|
| 1558 | - } |
|
| 1559 | - } |
|
| 1560 | - return max($total, 0); |
|
| 1561 | - } |
|
| 1562 | - |
|
| 1563 | - |
|
| 1564 | - /** |
|
| 1565 | - * Gets the transaction for this line item |
|
| 1566 | - * |
|
| 1567 | - * @return EE_Base_Class|EE_Transaction |
|
| 1568 | - * @throws EE_Error |
|
| 1569 | - * @throws InvalidArgumentException |
|
| 1570 | - * @throws InvalidDataTypeException |
|
| 1571 | - * @throws InvalidInterfaceException |
|
| 1572 | - * @throws ReflectionException |
|
| 1573 | - */ |
|
| 1574 | - public function transaction() |
|
| 1575 | - { |
|
| 1576 | - return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION); |
|
| 1577 | - } |
|
| 1578 | - |
|
| 1579 | - |
|
| 1580 | - /** |
|
| 1581 | - * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1582 | - * Because there currently is no proper parent-child relation on the model, |
|
| 1583 | - * save_this_and_cached() will NOT save the descendants. |
|
| 1584 | - * Also sets the transaction on this line item and all its descendants before saving |
|
| 1585 | - * |
|
| 1586 | - * @param int $txn_id if none is provided, assumes $this->TXN_ID() |
|
| 1587 | - * @return int count of items saved |
|
| 1588 | - * @throws EE_Error |
|
| 1589 | - * @throws InvalidArgumentException |
|
| 1590 | - * @throws InvalidDataTypeException |
|
| 1591 | - * @throws InvalidInterfaceException |
|
| 1592 | - * @throws ReflectionException |
|
| 1593 | - */ |
|
| 1594 | - public function save_this_and_descendants_to_txn($txn_id = null) |
|
| 1595 | - { |
|
| 1596 | - $count = 0; |
|
| 1597 | - if (! $txn_id) { |
|
| 1598 | - $txn_id = $this->TXN_ID(); |
|
| 1599 | - } |
|
| 1600 | - $this->set_TXN_ID($txn_id); |
|
| 1601 | - $children = $this->children(); |
|
| 1602 | - $count += $this->save() |
|
| 1603 | - ? 1 |
|
| 1604 | - : 0; |
|
| 1605 | - foreach ($children as $child_line_item) { |
|
| 1606 | - if ($child_line_item instanceof EE_Line_Item) { |
|
| 1607 | - $child_line_item->set_parent_ID($this->ID()); |
|
| 1608 | - $count += $child_line_item->save_this_and_descendants_to_txn($txn_id); |
|
| 1609 | - } |
|
| 1610 | - } |
|
| 1611 | - return $count; |
|
| 1612 | - } |
|
| 1613 | - |
|
| 1614 | - |
|
| 1615 | - /** |
|
| 1616 | - * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1617 | - * |
|
| 1618 | - * @return int count of items saved |
|
| 1619 | - * @throws EE_Error |
|
| 1620 | - * @throws InvalidArgumentException |
|
| 1621 | - * @throws InvalidDataTypeException |
|
| 1622 | - * @throws InvalidInterfaceException |
|
| 1623 | - * @throws ReflectionException |
|
| 1624 | - */ |
|
| 1625 | - public function save_this_and_descendants() |
|
| 1626 | - { |
|
| 1627 | - $count = 0; |
|
| 1628 | - $children = $this->children(); |
|
| 1629 | - $count += $this->save() |
|
| 1630 | - ? 1 |
|
| 1631 | - : 0; |
|
| 1632 | - foreach ($children as $child_line_item) { |
|
| 1633 | - if ($child_line_item instanceof EE_Line_Item) { |
|
| 1634 | - $child_line_item->set_parent_ID($this->ID()); |
|
| 1635 | - $count += $child_line_item->save_this_and_descendants(); |
|
| 1636 | - } |
|
| 1637 | - } |
|
| 1638 | - return $count; |
|
| 1639 | - } |
|
| 1640 | - |
|
| 1641 | - |
|
| 1642 | - /** |
|
| 1643 | - * returns the cancellation line item if this item was cancelled |
|
| 1644 | - * |
|
| 1645 | - * @return EE_Line_Item[] |
|
| 1646 | - * @throws InvalidArgumentException |
|
| 1647 | - * @throws InvalidInterfaceException |
|
| 1648 | - * @throws InvalidDataTypeException |
|
| 1649 | - * @throws ReflectionException |
|
| 1650 | - * @throws EE_Error |
|
| 1651 | - */ |
|
| 1652 | - public function get_cancellations() |
|
| 1653 | - { |
|
| 1654 | - EE_Registry::instance()->load_helper('Line_Item'); |
|
| 1655 | - return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation); |
|
| 1656 | - } |
|
| 1657 | - |
|
| 1658 | - |
|
| 1659 | - /** |
|
| 1660 | - * If this item has an ID, then this saves it again to update the db |
|
| 1661 | - * |
|
| 1662 | - * @return int count of items saved |
|
| 1663 | - * @throws EE_Error |
|
| 1664 | - * @throws InvalidArgumentException |
|
| 1665 | - * @throws InvalidDataTypeException |
|
| 1666 | - * @throws InvalidInterfaceException |
|
| 1667 | - * @throws ReflectionException |
|
| 1668 | - */ |
|
| 1669 | - public function maybe_save() |
|
| 1670 | - { |
|
| 1671 | - if ($this->ID()) { |
|
| 1672 | - return $this->save(); |
|
| 1673 | - } |
|
| 1674 | - return false; |
|
| 1675 | - } |
|
| 1676 | - |
|
| 1677 | - |
|
| 1678 | - /** |
|
| 1679 | - * clears the cached children and parent from the line item |
|
| 1680 | - * |
|
| 1681 | - * @return void |
|
| 1682 | - */ |
|
| 1683 | - public function clear_related_line_item_cache() |
|
| 1684 | - { |
|
| 1685 | - $this->_children = array(); |
|
| 1686 | - $this->_parent = null; |
|
| 1687 | - } |
|
| 1688 | - |
|
| 1689 | - |
|
| 1690 | - /** |
|
| 1691 | - * @param bool $raw |
|
| 1692 | - * @return int |
|
| 1693 | - * @throws EE_Error |
|
| 1694 | - * @throws InvalidArgumentException |
|
| 1695 | - * @throws InvalidDataTypeException |
|
| 1696 | - * @throws InvalidInterfaceException |
|
| 1697 | - * @throws ReflectionException |
|
| 1698 | - */ |
|
| 1699 | - public function timestamp($raw = false) |
|
| 1700 | - { |
|
| 1701 | - return $raw |
|
| 1702 | - ? $this->get_raw('LIN_timestamp') |
|
| 1703 | - : $this->get('LIN_timestamp'); |
|
| 1704 | - } |
|
| 1705 | - |
|
| 1706 | - |
|
| 1707 | - |
|
| 1708 | - |
|
| 1709 | - /************************* DEPRECATED *************************/ |
|
| 1710 | - /** |
|
| 1711 | - * @deprecated 4.6.0 |
|
| 1712 | - * @param string $type one of the constants on EEM_Line_Item |
|
| 1713 | - * @return EE_Line_Item[] |
|
| 1714 | - * @throws EE_Error |
|
| 1715 | - */ |
|
| 1716 | - protected function _get_descendants_of_type($type) |
|
| 1717 | - { |
|
| 1718 | - EE_Error::doing_it_wrong( |
|
| 1719 | - 'EE_Line_Item::_get_descendants_of_type()', |
|
| 1720 | - sprintf( |
|
| 1721 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1722 | - 'EEH_Line_Item::get_descendants_of_type()' |
|
| 1723 | - ), |
|
| 1724 | - '4.6.0' |
|
| 1725 | - ); |
|
| 1726 | - return EEH_Line_Item::get_descendants_of_type($this, $type); |
|
| 1727 | - } |
|
| 1728 | - |
|
| 1729 | - |
|
| 1730 | - /** |
|
| 1731 | - * @deprecated 4.6.0 |
|
| 1732 | - * @param string $type like one of the EEM_Line_Item::type_* |
|
| 1733 | - * @return EE_Line_Item |
|
| 1734 | - * @throws EE_Error |
|
| 1735 | - * @throws InvalidArgumentException |
|
| 1736 | - * @throws InvalidDataTypeException |
|
| 1737 | - * @throws InvalidInterfaceException |
|
| 1738 | - * @throws ReflectionException |
|
| 1739 | - */ |
|
| 1740 | - public function get_nearest_descendant_of_type($type) |
|
| 1741 | - { |
|
| 1742 | - EE_Error::doing_it_wrong( |
|
| 1743 | - 'EE_Line_Item::get_nearest_descendant_of_type()', |
|
| 1744 | - sprintf( |
|
| 1745 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1746 | - 'EEH_Line_Item::get_nearest_descendant_of_type()' |
|
| 1747 | - ), |
|
| 1748 | - '4.6.0' |
|
| 1749 | - ); |
|
| 1750 | - return EEH_Line_Item::get_nearest_descendant_of_type($this, $type); |
|
| 1751 | - } |
|
| 17 | + /** |
|
| 18 | + * for children line items (currently not a normal relation) |
|
| 19 | + * |
|
| 20 | + * @type EE_Line_Item[] |
|
| 21 | + */ |
|
| 22 | + protected $_children = array(); |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * for the parent line item |
|
| 26 | + * |
|
| 27 | + * @var EE_Line_Item |
|
| 28 | + */ |
|
| 29 | + protected $_parent; |
|
| 30 | + |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @param array $props_n_values incoming values |
|
| 34 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 35 | + * used.) |
|
| 36 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 37 | + * date_format and the second value is the time format |
|
| 38 | + * @return EE_Line_Item |
|
| 39 | + * @throws EE_Error |
|
| 40 | + * @throws InvalidArgumentException |
|
| 41 | + * @throws InvalidDataTypeException |
|
| 42 | + * @throws InvalidInterfaceException |
|
| 43 | + * @throws ReflectionException |
|
| 44 | + */ |
|
| 45 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 46 | + { |
|
| 47 | + $has_object = parent::_check_for_object( |
|
| 48 | + $props_n_values, |
|
| 49 | + __CLASS__, |
|
| 50 | + $timezone, |
|
| 51 | + $date_formats |
|
| 52 | + ); |
|
| 53 | + return $has_object |
|
| 54 | + ? $has_object |
|
| 55 | + : new self($props_n_values, false, $timezone); |
|
| 56 | + } |
|
| 57 | + |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * @param array $props_n_values incoming values from the database |
|
| 61 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 62 | + * the website will be used. |
|
| 63 | + * @return EE_Line_Item |
|
| 64 | + * @throws EE_Error |
|
| 65 | + * @throws InvalidArgumentException |
|
| 66 | + * @throws InvalidDataTypeException |
|
| 67 | + * @throws InvalidInterfaceException |
|
| 68 | + * @throws ReflectionException |
|
| 69 | + */ |
|
| 70 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 71 | + { |
|
| 72 | + return new self($props_n_values, true, $timezone); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Adds some defaults if they're not specified |
|
| 78 | + * |
|
| 79 | + * @param array $fieldValues |
|
| 80 | + * @param bool $bydb |
|
| 81 | + * @param string $timezone |
|
| 82 | + * @throws EE_Error |
|
| 83 | + * @throws InvalidArgumentException |
|
| 84 | + * @throws InvalidDataTypeException |
|
| 85 | + * @throws InvalidInterfaceException |
|
| 86 | + * @throws ReflectionException |
|
| 87 | + */ |
|
| 88 | + protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
|
| 89 | + { |
|
| 90 | + parent::__construct($fieldValues, $bydb, $timezone); |
|
| 91 | + if (! $this->get('LIN_code')) { |
|
| 92 | + $this->set_code($this->generate_code()); |
|
| 93 | + } |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * Gets ID |
|
| 99 | + * |
|
| 100 | + * @return int |
|
| 101 | + * @throws EE_Error |
|
| 102 | + * @throws InvalidArgumentException |
|
| 103 | + * @throws InvalidDataTypeException |
|
| 104 | + * @throws InvalidInterfaceException |
|
| 105 | + * @throws ReflectionException |
|
| 106 | + */ |
|
| 107 | + public function ID() |
|
| 108 | + { |
|
| 109 | + return $this->get('LIN_ID'); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Gets TXN_ID |
|
| 115 | + * |
|
| 116 | + * @return int |
|
| 117 | + * @throws EE_Error |
|
| 118 | + * @throws InvalidArgumentException |
|
| 119 | + * @throws InvalidDataTypeException |
|
| 120 | + * @throws InvalidInterfaceException |
|
| 121 | + * @throws ReflectionException |
|
| 122 | + */ |
|
| 123 | + public function TXN_ID() |
|
| 124 | + { |
|
| 125 | + return $this->get('TXN_ID'); |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * Sets TXN_ID |
|
| 131 | + * |
|
| 132 | + * @param int $TXN_ID |
|
| 133 | + * @throws EE_Error |
|
| 134 | + * @throws InvalidArgumentException |
|
| 135 | + * @throws InvalidDataTypeException |
|
| 136 | + * @throws InvalidInterfaceException |
|
| 137 | + * @throws ReflectionException |
|
| 138 | + */ |
|
| 139 | + public function set_TXN_ID($TXN_ID) |
|
| 140 | + { |
|
| 141 | + $this->set('TXN_ID', $TXN_ID); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Gets name |
|
| 147 | + * |
|
| 148 | + * @return string |
|
| 149 | + * @throws EE_Error |
|
| 150 | + * @throws InvalidArgumentException |
|
| 151 | + * @throws InvalidDataTypeException |
|
| 152 | + * @throws InvalidInterfaceException |
|
| 153 | + * @throws ReflectionException |
|
| 154 | + */ |
|
| 155 | + public function name() |
|
| 156 | + { |
|
| 157 | + $name = $this->get('LIN_name'); |
|
| 158 | + if (! $name) { |
|
| 159 | + $name = ucwords(str_replace('-', ' ', $this->type())); |
|
| 160 | + } |
|
| 161 | + return $name; |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * Sets name |
|
| 167 | + * |
|
| 168 | + * @param string $name |
|
| 169 | + * @throws EE_Error |
|
| 170 | + * @throws InvalidArgumentException |
|
| 171 | + * @throws InvalidDataTypeException |
|
| 172 | + * @throws InvalidInterfaceException |
|
| 173 | + * @throws ReflectionException |
|
| 174 | + */ |
|
| 175 | + public function set_name($name) |
|
| 176 | + { |
|
| 177 | + $this->set('LIN_name', $name); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Gets desc |
|
| 183 | + * |
|
| 184 | + * @return string |
|
| 185 | + * @throws EE_Error |
|
| 186 | + * @throws InvalidArgumentException |
|
| 187 | + * @throws InvalidDataTypeException |
|
| 188 | + * @throws InvalidInterfaceException |
|
| 189 | + * @throws ReflectionException |
|
| 190 | + */ |
|
| 191 | + public function desc() |
|
| 192 | + { |
|
| 193 | + return $this->get('LIN_desc'); |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * Sets desc |
|
| 199 | + * |
|
| 200 | + * @param string $desc |
|
| 201 | + * @throws EE_Error |
|
| 202 | + * @throws InvalidArgumentException |
|
| 203 | + * @throws InvalidDataTypeException |
|
| 204 | + * @throws InvalidInterfaceException |
|
| 205 | + * @throws ReflectionException |
|
| 206 | + */ |
|
| 207 | + public function set_desc($desc) |
|
| 208 | + { |
|
| 209 | + $this->set('LIN_desc', $desc); |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + |
|
| 213 | + /** |
|
| 214 | + * Gets quantity |
|
| 215 | + * |
|
| 216 | + * @return int |
|
| 217 | + * @throws EE_Error |
|
| 218 | + * @throws InvalidArgumentException |
|
| 219 | + * @throws InvalidDataTypeException |
|
| 220 | + * @throws InvalidInterfaceException |
|
| 221 | + * @throws ReflectionException |
|
| 222 | + */ |
|
| 223 | + public function quantity() |
|
| 224 | + { |
|
| 225 | + return $this->get('LIN_quantity'); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * Sets quantity |
|
| 231 | + * |
|
| 232 | + * @param int $quantity |
|
| 233 | + * @throws EE_Error |
|
| 234 | + * @throws InvalidArgumentException |
|
| 235 | + * @throws InvalidDataTypeException |
|
| 236 | + * @throws InvalidInterfaceException |
|
| 237 | + * @throws ReflectionException |
|
| 238 | + */ |
|
| 239 | + public function set_quantity($quantity) |
|
| 240 | + { |
|
| 241 | + $this->set('LIN_quantity', max($quantity, 0)); |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + |
|
| 245 | + /** |
|
| 246 | + * Gets item_id |
|
| 247 | + * |
|
| 248 | + * @return string |
|
| 249 | + * @throws EE_Error |
|
| 250 | + * @throws InvalidArgumentException |
|
| 251 | + * @throws InvalidDataTypeException |
|
| 252 | + * @throws InvalidInterfaceException |
|
| 253 | + * @throws ReflectionException |
|
| 254 | + */ |
|
| 255 | + public function OBJ_ID() |
|
| 256 | + { |
|
| 257 | + return $this->get('OBJ_ID'); |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + |
|
| 261 | + /** |
|
| 262 | + * Sets item_id |
|
| 263 | + * |
|
| 264 | + * @param string $item_id |
|
| 265 | + * @throws EE_Error |
|
| 266 | + * @throws InvalidArgumentException |
|
| 267 | + * @throws InvalidDataTypeException |
|
| 268 | + * @throws InvalidInterfaceException |
|
| 269 | + * @throws ReflectionException |
|
| 270 | + */ |
|
| 271 | + public function set_OBJ_ID($item_id) |
|
| 272 | + { |
|
| 273 | + $this->set('OBJ_ID', $item_id); |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + |
|
| 277 | + /** |
|
| 278 | + * Gets item_type |
|
| 279 | + * |
|
| 280 | + * @return string |
|
| 281 | + * @throws EE_Error |
|
| 282 | + * @throws InvalidArgumentException |
|
| 283 | + * @throws InvalidDataTypeException |
|
| 284 | + * @throws InvalidInterfaceException |
|
| 285 | + * @throws ReflectionException |
|
| 286 | + */ |
|
| 287 | + public function OBJ_type() |
|
| 288 | + { |
|
| 289 | + return $this->get('OBJ_type'); |
|
| 290 | + } |
|
| 291 | + |
|
| 292 | + |
|
| 293 | + /** |
|
| 294 | + * Gets item_type |
|
| 295 | + * |
|
| 296 | + * @return string |
|
| 297 | + * @throws EE_Error |
|
| 298 | + * @throws InvalidArgumentException |
|
| 299 | + * @throws InvalidDataTypeException |
|
| 300 | + * @throws InvalidInterfaceException |
|
| 301 | + * @throws ReflectionException |
|
| 302 | + */ |
|
| 303 | + public function OBJ_type_i18n() |
|
| 304 | + { |
|
| 305 | + $obj_type = $this->OBJ_type(); |
|
| 306 | + switch ($obj_type) { |
|
| 307 | + case EEM_Line_Item::OBJ_TYPE_EVENT: |
|
| 308 | + $obj_type = esc_html__('Event', 'event_espresso'); |
|
| 309 | + break; |
|
| 310 | + case EEM_Line_Item::OBJ_TYPE_PRICE: |
|
| 311 | + $obj_type = esc_html__('Price', 'event_espresso'); |
|
| 312 | + break; |
|
| 313 | + case EEM_Line_Item::OBJ_TYPE_PROMOTION: |
|
| 314 | + $obj_type = esc_html__('Promotion', 'event_espresso'); |
|
| 315 | + break; |
|
| 316 | + case EEM_Line_Item::OBJ_TYPE_TICKET: |
|
| 317 | + $obj_type = esc_html__('Ticket', 'event_espresso'); |
|
| 318 | + break; |
|
| 319 | + case EEM_Line_Item::OBJ_TYPE_TRANSACTION: |
|
| 320 | + $obj_type = esc_html__('Transaction', 'event_espresso'); |
|
| 321 | + break; |
|
| 322 | + } |
|
| 323 | + return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this); |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + |
|
| 327 | + /** |
|
| 328 | + * Sets item_type |
|
| 329 | + * |
|
| 330 | + * @param string $OBJ_type |
|
| 331 | + * @throws EE_Error |
|
| 332 | + * @throws InvalidArgumentException |
|
| 333 | + * @throws InvalidDataTypeException |
|
| 334 | + * @throws InvalidInterfaceException |
|
| 335 | + * @throws ReflectionException |
|
| 336 | + */ |
|
| 337 | + public function set_OBJ_type($OBJ_type) |
|
| 338 | + { |
|
| 339 | + $this->set('OBJ_type', $OBJ_type); |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + |
|
| 343 | + /** |
|
| 344 | + * Gets unit_price |
|
| 345 | + * |
|
| 346 | + * @return float |
|
| 347 | + * @throws EE_Error |
|
| 348 | + * @throws InvalidArgumentException |
|
| 349 | + * @throws InvalidDataTypeException |
|
| 350 | + * @throws InvalidInterfaceException |
|
| 351 | + * @throws ReflectionException |
|
| 352 | + */ |
|
| 353 | + public function unit_price() |
|
| 354 | + { |
|
| 355 | + return $this->get('LIN_unit_price'); |
|
| 356 | + } |
|
| 357 | + |
|
| 358 | + |
|
| 359 | + /** |
|
| 360 | + * Sets unit_price |
|
| 361 | + * |
|
| 362 | + * @param float $unit_price |
|
| 363 | + * @throws EE_Error |
|
| 364 | + * @throws InvalidArgumentException |
|
| 365 | + * @throws InvalidDataTypeException |
|
| 366 | + * @throws InvalidInterfaceException |
|
| 367 | + * @throws ReflectionException |
|
| 368 | + */ |
|
| 369 | + public function set_unit_price($unit_price) |
|
| 370 | + { |
|
| 371 | + $this->set('LIN_unit_price', $unit_price); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + |
|
| 375 | + /** |
|
| 376 | + * Checks if this item is a percentage modifier or not |
|
| 377 | + * |
|
| 378 | + * @return boolean |
|
| 379 | + * @throws EE_Error |
|
| 380 | + * @throws InvalidArgumentException |
|
| 381 | + * @throws InvalidDataTypeException |
|
| 382 | + * @throws InvalidInterfaceException |
|
| 383 | + * @throws ReflectionException |
|
| 384 | + */ |
|
| 385 | + public function is_percent() |
|
| 386 | + { |
|
| 387 | + if ($this->is_tax_sub_total()) { |
|
| 388 | + // tax subtotals HAVE a percent on them, that percentage only applies |
|
| 389 | + // to taxable items, so its' an exception. Treat it like a flat line item |
|
| 390 | + return false; |
|
| 391 | + } |
|
| 392 | + $unit_price = abs($this->get('LIN_unit_price')); |
|
| 393 | + $percent = abs($this->get('LIN_percent')); |
|
| 394 | + if ($unit_price < .001 && $percent) { |
|
| 395 | + return true; |
|
| 396 | + } |
|
| 397 | + if ($unit_price >= .001 && ! $percent) { |
|
| 398 | + return false; |
|
| 399 | + } |
|
| 400 | + if ($unit_price >= .001 && $percent) { |
|
| 401 | + throw new EE_Error( |
|
| 402 | + sprintf( |
|
| 403 | + esc_html__( |
|
| 404 | + 'A Line Item can not have a unit price of (%s) AND a percent (%s)!', |
|
| 405 | + 'event_espresso' |
|
| 406 | + ), |
|
| 407 | + $unit_price, |
|
| 408 | + $percent |
|
| 409 | + ) |
|
| 410 | + ); |
|
| 411 | + } |
|
| 412 | + // if they're both 0, assume its not a percent item |
|
| 413 | + return false; |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + |
|
| 417 | + /** |
|
| 418 | + * Gets percent (between 100-.001) |
|
| 419 | + * |
|
| 420 | + * @return float |
|
| 421 | + * @throws EE_Error |
|
| 422 | + * @throws InvalidArgumentException |
|
| 423 | + * @throws InvalidDataTypeException |
|
| 424 | + * @throws InvalidInterfaceException |
|
| 425 | + * @throws ReflectionException |
|
| 426 | + */ |
|
| 427 | + public function percent() |
|
| 428 | + { |
|
| 429 | + return $this->get('LIN_percent'); |
|
| 430 | + } |
|
| 431 | + |
|
| 432 | + |
|
| 433 | + /** |
|
| 434 | + * Sets percent (between 100-0.01) |
|
| 435 | + * |
|
| 436 | + * @param float $percent |
|
| 437 | + * @throws EE_Error |
|
| 438 | + * @throws InvalidArgumentException |
|
| 439 | + * @throws InvalidDataTypeException |
|
| 440 | + * @throws InvalidInterfaceException |
|
| 441 | + * @throws ReflectionException |
|
| 442 | + */ |
|
| 443 | + public function set_percent($percent) |
|
| 444 | + { |
|
| 445 | + $this->set('LIN_percent', $percent); |
|
| 446 | + } |
|
| 447 | + |
|
| 448 | + |
|
| 449 | + /** |
|
| 450 | + * Gets total |
|
| 451 | + * |
|
| 452 | + * @return float |
|
| 453 | + * @throws EE_Error |
|
| 454 | + * @throws InvalidArgumentException |
|
| 455 | + * @throws InvalidDataTypeException |
|
| 456 | + * @throws InvalidInterfaceException |
|
| 457 | + * @throws ReflectionException |
|
| 458 | + */ |
|
| 459 | + public function total() |
|
| 460 | + { |
|
| 461 | + return $this->get('LIN_total'); |
|
| 462 | + } |
|
| 463 | + |
|
| 464 | + |
|
| 465 | + /** |
|
| 466 | + * Sets total |
|
| 467 | + * |
|
| 468 | + * @param float $total |
|
| 469 | + * @throws EE_Error |
|
| 470 | + * @throws InvalidArgumentException |
|
| 471 | + * @throws InvalidDataTypeException |
|
| 472 | + * @throws InvalidInterfaceException |
|
| 473 | + * @throws ReflectionException |
|
| 474 | + */ |
|
| 475 | + public function set_total($total) |
|
| 476 | + { |
|
| 477 | + $this->set('LIN_total', $total); |
|
| 478 | + } |
|
| 479 | + |
|
| 480 | + |
|
| 481 | + /** |
|
| 482 | + * Gets order |
|
| 483 | + * |
|
| 484 | + * @return int |
|
| 485 | + * @throws EE_Error |
|
| 486 | + * @throws InvalidArgumentException |
|
| 487 | + * @throws InvalidDataTypeException |
|
| 488 | + * @throws InvalidInterfaceException |
|
| 489 | + * @throws ReflectionException |
|
| 490 | + */ |
|
| 491 | + public function order() |
|
| 492 | + { |
|
| 493 | + return $this->get('LIN_order'); |
|
| 494 | + } |
|
| 495 | + |
|
| 496 | + |
|
| 497 | + /** |
|
| 498 | + * Sets order |
|
| 499 | + * |
|
| 500 | + * @param int $order |
|
| 501 | + * @throws EE_Error |
|
| 502 | + * @throws InvalidArgumentException |
|
| 503 | + * @throws InvalidDataTypeException |
|
| 504 | + * @throws InvalidInterfaceException |
|
| 505 | + * @throws ReflectionException |
|
| 506 | + */ |
|
| 507 | + public function set_order($order) |
|
| 508 | + { |
|
| 509 | + $this->set('LIN_order', $order); |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + |
|
| 513 | + /** |
|
| 514 | + * Gets parent |
|
| 515 | + * |
|
| 516 | + * @return int |
|
| 517 | + * @throws EE_Error |
|
| 518 | + * @throws InvalidArgumentException |
|
| 519 | + * @throws InvalidDataTypeException |
|
| 520 | + * @throws InvalidInterfaceException |
|
| 521 | + * @throws ReflectionException |
|
| 522 | + */ |
|
| 523 | + public function parent_ID() |
|
| 524 | + { |
|
| 525 | + return $this->get('LIN_parent'); |
|
| 526 | + } |
|
| 527 | + |
|
| 528 | + |
|
| 529 | + /** |
|
| 530 | + * Sets parent |
|
| 531 | + * |
|
| 532 | + * @param int $parent |
|
| 533 | + * @throws EE_Error |
|
| 534 | + * @throws InvalidArgumentException |
|
| 535 | + * @throws InvalidDataTypeException |
|
| 536 | + * @throws InvalidInterfaceException |
|
| 537 | + * @throws ReflectionException |
|
| 538 | + */ |
|
| 539 | + public function set_parent_ID($parent) |
|
| 540 | + { |
|
| 541 | + $this->set('LIN_parent', $parent); |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + |
|
| 545 | + /** |
|
| 546 | + * Gets type |
|
| 547 | + * |
|
| 548 | + * @return string |
|
| 549 | + * @throws EE_Error |
|
| 550 | + * @throws InvalidArgumentException |
|
| 551 | + * @throws InvalidDataTypeException |
|
| 552 | + * @throws InvalidInterfaceException |
|
| 553 | + * @throws ReflectionException |
|
| 554 | + */ |
|
| 555 | + public function type() |
|
| 556 | + { |
|
| 557 | + return $this->get('LIN_type'); |
|
| 558 | + } |
|
| 559 | + |
|
| 560 | + |
|
| 561 | + /** |
|
| 562 | + * Sets type |
|
| 563 | + * |
|
| 564 | + * @param string $type |
|
| 565 | + * @throws EE_Error |
|
| 566 | + * @throws InvalidArgumentException |
|
| 567 | + * @throws InvalidDataTypeException |
|
| 568 | + * @throws InvalidInterfaceException |
|
| 569 | + * @throws ReflectionException |
|
| 570 | + */ |
|
| 571 | + public function set_type($type) |
|
| 572 | + { |
|
| 573 | + $this->set('LIN_type', $type); |
|
| 574 | + } |
|
| 575 | + |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\ |
|
| 579 | + * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB |
|
| 580 | + * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()` |
|
| 581 | + * or indirectly by `EE_Line_item::add_child_line_item()`) |
|
| 582 | + * |
|
| 583 | + * @return EE_Base_Class|EE_Line_Item |
|
| 584 | + * @throws EE_Error |
|
| 585 | + * @throws InvalidArgumentException |
|
| 586 | + * @throws InvalidDataTypeException |
|
| 587 | + * @throws InvalidInterfaceException |
|
| 588 | + * @throws ReflectionException |
|
| 589 | + */ |
|
| 590 | + public function parent() |
|
| 591 | + { |
|
| 592 | + return $this->ID() |
|
| 593 | + ? $this->get_model()->get_one_by_ID($this->parent_ID()) |
|
| 594 | + : $this->_parent; |
|
| 595 | + } |
|
| 596 | + |
|
| 597 | + |
|
| 598 | + /** |
|
| 599 | + * Gets ALL the children of this line item (ie, all the parts that contribute towards this total). |
|
| 600 | + * |
|
| 601 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 602 | + * @throws EE_Error |
|
| 603 | + * @throws InvalidArgumentException |
|
| 604 | + * @throws InvalidDataTypeException |
|
| 605 | + * @throws InvalidInterfaceException |
|
| 606 | + * @throws ReflectionException |
|
| 607 | + */ |
|
| 608 | + public function children() |
|
| 609 | + { |
|
| 610 | + if ($this->ID()) { |
|
| 611 | + return $this->get_model()->get_all( |
|
| 612 | + array( |
|
| 613 | + array('LIN_parent' => $this->ID()), |
|
| 614 | + 'order_by' => array('LIN_order' => 'ASC'), |
|
| 615 | + ) |
|
| 616 | + ); |
|
| 617 | + } |
|
| 618 | + if (! is_array($this->_children)) { |
|
| 619 | + $this->_children = array(); |
|
| 620 | + } |
|
| 621 | + return $this->_children; |
|
| 622 | + } |
|
| 623 | + |
|
| 624 | + |
|
| 625 | + /** |
|
| 626 | + * Gets code |
|
| 627 | + * |
|
| 628 | + * @return string |
|
| 629 | + * @throws EE_Error |
|
| 630 | + * @throws InvalidArgumentException |
|
| 631 | + * @throws InvalidDataTypeException |
|
| 632 | + * @throws InvalidInterfaceException |
|
| 633 | + * @throws ReflectionException |
|
| 634 | + */ |
|
| 635 | + public function code() |
|
| 636 | + { |
|
| 637 | + return $this->get('LIN_code'); |
|
| 638 | + } |
|
| 639 | + |
|
| 640 | + |
|
| 641 | + /** |
|
| 642 | + * Sets code |
|
| 643 | + * |
|
| 644 | + * @param string $code |
|
| 645 | + * @throws EE_Error |
|
| 646 | + * @throws InvalidArgumentException |
|
| 647 | + * @throws InvalidDataTypeException |
|
| 648 | + * @throws InvalidInterfaceException |
|
| 649 | + * @throws ReflectionException |
|
| 650 | + */ |
|
| 651 | + public function set_code($code) |
|
| 652 | + { |
|
| 653 | + $this->set('LIN_code', $code); |
|
| 654 | + } |
|
| 655 | + |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * Gets is_taxable |
|
| 659 | + * |
|
| 660 | + * @return boolean |
|
| 661 | + * @throws EE_Error |
|
| 662 | + * @throws InvalidArgumentException |
|
| 663 | + * @throws InvalidDataTypeException |
|
| 664 | + * @throws InvalidInterfaceException |
|
| 665 | + * @throws ReflectionException |
|
| 666 | + */ |
|
| 667 | + public function is_taxable() |
|
| 668 | + { |
|
| 669 | + return $this->get('LIN_is_taxable'); |
|
| 670 | + } |
|
| 671 | + |
|
| 672 | + |
|
| 673 | + /** |
|
| 674 | + * Sets is_taxable |
|
| 675 | + * |
|
| 676 | + * @param boolean $is_taxable |
|
| 677 | + * @throws EE_Error |
|
| 678 | + * @throws InvalidArgumentException |
|
| 679 | + * @throws InvalidDataTypeException |
|
| 680 | + * @throws InvalidInterfaceException |
|
| 681 | + * @throws ReflectionException |
|
| 682 | + */ |
|
| 683 | + public function set_is_taxable($is_taxable) |
|
| 684 | + { |
|
| 685 | + $this->set('LIN_is_taxable', $is_taxable); |
|
| 686 | + } |
|
| 687 | + |
|
| 688 | + |
|
| 689 | + /** |
|
| 690 | + * Gets the object that this model-joins-to. |
|
| 691 | + * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on |
|
| 692 | + * EEM_Promotion_Object |
|
| 693 | + * Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object |
|
| 694 | + * |
|
| 695 | + * @return EE_Base_Class | NULL |
|
| 696 | + * @throws EE_Error |
|
| 697 | + * @throws InvalidArgumentException |
|
| 698 | + * @throws InvalidDataTypeException |
|
| 699 | + * @throws InvalidInterfaceException |
|
| 700 | + * @throws ReflectionException |
|
| 701 | + */ |
|
| 702 | + public function get_object() |
|
| 703 | + { |
|
| 704 | + $model_name_of_related_obj = $this->OBJ_type(); |
|
| 705 | + return $this->get_model()->has_relation($model_name_of_related_obj) |
|
| 706 | + ? $this->get_first_related($model_name_of_related_obj) |
|
| 707 | + : null; |
|
| 708 | + } |
|
| 709 | + |
|
| 710 | + |
|
| 711 | + /** |
|
| 712 | + * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket. |
|
| 713 | + * (IE, if this line item is for a price or something else, will return NULL) |
|
| 714 | + * |
|
| 715 | + * @param array $query_params |
|
| 716 | + * @return EE_Base_Class|EE_Ticket |
|
| 717 | + * @throws EE_Error |
|
| 718 | + * @throws InvalidArgumentException |
|
| 719 | + * @throws InvalidDataTypeException |
|
| 720 | + * @throws InvalidInterfaceException |
|
| 721 | + * @throws ReflectionException |
|
| 722 | + */ |
|
| 723 | + public function ticket($query_params = array()) |
|
| 724 | + { |
|
| 725 | + // we're going to assume that when this method is called |
|
| 726 | + // we always want to receive the attached ticket EVEN if that ticket is archived. |
|
| 727 | + // This can be overridden via the incoming $query_params argument |
|
| 728 | + $remove_defaults = array('default_where_conditions' => 'none'); |
|
| 729 | + $query_params = array_merge($remove_defaults, $query_params); |
|
| 730 | + return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params); |
|
| 731 | + } |
|
| 732 | + |
|
| 733 | + |
|
| 734 | + /** |
|
| 735 | + * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket |
|
| 736 | + * |
|
| 737 | + * @return EE_Datetime | NULL |
|
| 738 | + * @throws EE_Error |
|
| 739 | + * @throws InvalidArgumentException |
|
| 740 | + * @throws InvalidDataTypeException |
|
| 741 | + * @throws InvalidInterfaceException |
|
| 742 | + * @throws ReflectionException |
|
| 743 | + */ |
|
| 744 | + public function get_ticket_datetime() |
|
| 745 | + { |
|
| 746 | + if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 747 | + $ticket = $this->ticket(); |
|
| 748 | + if ($ticket instanceof EE_Ticket) { |
|
| 749 | + $datetime = $ticket->first_datetime(); |
|
| 750 | + if ($datetime instanceof EE_Datetime) { |
|
| 751 | + return $datetime; |
|
| 752 | + } |
|
| 753 | + } |
|
| 754 | + } |
|
| 755 | + return null; |
|
| 756 | + } |
|
| 757 | + |
|
| 758 | + |
|
| 759 | + /** |
|
| 760 | + * Gets the event's name that's related to the ticket, if this is for |
|
| 761 | + * a ticket |
|
| 762 | + * |
|
| 763 | + * @return string |
|
| 764 | + * @throws EE_Error |
|
| 765 | + * @throws InvalidArgumentException |
|
| 766 | + * @throws InvalidDataTypeException |
|
| 767 | + * @throws InvalidInterfaceException |
|
| 768 | + * @throws ReflectionException |
|
| 769 | + */ |
|
| 770 | + public function ticket_event_name() |
|
| 771 | + { |
|
| 772 | + $event_name = esc_html__('Unknown', 'event_espresso'); |
|
| 773 | + $event = $this->ticket_event(); |
|
| 774 | + if ($event instanceof EE_Event) { |
|
| 775 | + $event_name = $event->name(); |
|
| 776 | + } |
|
| 777 | + return $event_name; |
|
| 778 | + } |
|
| 779 | + |
|
| 780 | + |
|
| 781 | + /** |
|
| 782 | + * Gets the event that's related to the ticket, if this line item represents a ticket. |
|
| 783 | + * |
|
| 784 | + * @return EE_Event|null |
|
| 785 | + * @throws EE_Error |
|
| 786 | + * @throws InvalidArgumentException |
|
| 787 | + * @throws InvalidDataTypeException |
|
| 788 | + * @throws InvalidInterfaceException |
|
| 789 | + * @throws ReflectionException |
|
| 790 | + */ |
|
| 791 | + public function ticket_event() |
|
| 792 | + { |
|
| 793 | + $event = null; |
|
| 794 | + $ticket = $this->ticket(); |
|
| 795 | + if ($ticket instanceof EE_Ticket) { |
|
| 796 | + $datetime = $ticket->first_datetime(); |
|
| 797 | + if ($datetime instanceof EE_Datetime) { |
|
| 798 | + $event = $datetime->event(); |
|
| 799 | + } |
|
| 800 | + } |
|
| 801 | + return $event; |
|
| 802 | + } |
|
| 803 | + |
|
| 804 | + |
|
| 805 | + /** |
|
| 806 | + * Gets the first datetime for this lien item, assuming it's for a ticket |
|
| 807 | + * |
|
| 808 | + * @param string $date_format |
|
| 809 | + * @param string $time_format |
|
| 810 | + * @return string |
|
| 811 | + * @throws EE_Error |
|
| 812 | + * @throws InvalidArgumentException |
|
| 813 | + * @throws InvalidDataTypeException |
|
| 814 | + * @throws InvalidInterfaceException |
|
| 815 | + * @throws ReflectionException |
|
| 816 | + */ |
|
| 817 | + public function ticket_datetime_start($date_format = '', $time_format = '') |
|
| 818 | + { |
|
| 819 | + $first_datetime_string = esc_html__('Unknown', 'event_espresso'); |
|
| 820 | + $datetime = $this->get_ticket_datetime(); |
|
| 821 | + if ($datetime) { |
|
| 822 | + $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format); |
|
| 823 | + } |
|
| 824 | + return $first_datetime_string; |
|
| 825 | + } |
|
| 826 | + |
|
| 827 | + |
|
| 828 | + /** |
|
| 829 | + * Adds the line item as a child to this line item. If there is another child line |
|
| 830 | + * item with the same LIN_code, it is overwritten by this new one |
|
| 831 | + * |
|
| 832 | + * @param EEI_Line_Item $line_item |
|
| 833 | + * @param bool $set_order |
|
| 834 | + * @return bool success |
|
| 835 | + * @throws EE_Error |
|
| 836 | + * @throws InvalidArgumentException |
|
| 837 | + * @throws InvalidDataTypeException |
|
| 838 | + * @throws InvalidInterfaceException |
|
| 839 | + * @throws ReflectionException |
|
| 840 | + */ |
|
| 841 | + public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) |
|
| 842 | + { |
|
| 843 | + // should we calculate the LIN_order for this line item ? |
|
| 844 | + if ($set_order || $line_item->order() === null) { |
|
| 845 | + $line_item->set_order(count($this->children())); |
|
| 846 | + } |
|
| 847 | + if ($this->ID()) { |
|
| 848 | + // check for any duplicate line items (with the same code), if so, this replaces it |
|
| 849 | + $line_item_with_same_code = $this->get_child_line_item($line_item->code()); |
|
| 850 | + if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) { |
|
| 851 | + $this->delete_child_line_item($line_item_with_same_code->code()); |
|
| 852 | + } |
|
| 853 | + $line_item->set_parent_ID($this->ID()); |
|
| 854 | + if ($this->TXN_ID()) { |
|
| 855 | + $line_item->set_TXN_ID($this->TXN_ID()); |
|
| 856 | + } |
|
| 857 | + return $line_item->save(); |
|
| 858 | + } |
|
| 859 | + $this->_children[ $line_item->code() ] = $line_item; |
|
| 860 | + if ($line_item->parent() !== $this) { |
|
| 861 | + $line_item->set_parent($this); |
|
| 862 | + } |
|
| 863 | + return true; |
|
| 864 | + } |
|
| 865 | + |
|
| 866 | + |
|
| 867 | + /** |
|
| 868 | + * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation. |
|
| 869 | + * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save() |
|
| 870 | + * However, if this line item is NOT saved to the DB, this just caches the parent on |
|
| 871 | + * the EE_Line_Item::_parent property. |
|
| 872 | + * |
|
| 873 | + * @param EE_Line_Item $line_item |
|
| 874 | + * @throws EE_Error |
|
| 875 | + * @throws InvalidArgumentException |
|
| 876 | + * @throws InvalidDataTypeException |
|
| 877 | + * @throws InvalidInterfaceException |
|
| 878 | + * @throws ReflectionException |
|
| 879 | + */ |
|
| 880 | + public function set_parent($line_item) |
|
| 881 | + { |
|
| 882 | + if ($this->ID()) { |
|
| 883 | + if (! $line_item->ID()) { |
|
| 884 | + $line_item->save(); |
|
| 885 | + } |
|
| 886 | + $this->set_parent_ID($line_item->ID()); |
|
| 887 | + $this->save(); |
|
| 888 | + } else { |
|
| 889 | + $this->_parent = $line_item; |
|
| 890 | + $this->set_parent_ID($line_item->ID()); |
|
| 891 | + } |
|
| 892 | + } |
|
| 893 | + |
|
| 894 | + |
|
| 895 | + /** |
|
| 896 | + * Gets the child line item as specified by its code. Because this returns an object (by reference) |
|
| 897 | + * you can modify this child line item and the parent (this object) can know about them |
|
| 898 | + * because it also has a reference to that line item |
|
| 899 | + * |
|
| 900 | + * @param string $code |
|
| 901 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 902 | + * @throws EE_Error |
|
| 903 | + * @throws InvalidArgumentException |
|
| 904 | + * @throws InvalidDataTypeException |
|
| 905 | + * @throws InvalidInterfaceException |
|
| 906 | + * @throws ReflectionException |
|
| 907 | + */ |
|
| 908 | + public function get_child_line_item($code) |
|
| 909 | + { |
|
| 910 | + if ($this->ID()) { |
|
| 911 | + return $this->get_model()->get_one( |
|
| 912 | + array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)) |
|
| 913 | + ); |
|
| 914 | + } |
|
| 915 | + return isset($this->_children[ $code ]) |
|
| 916 | + ? $this->_children[ $code ] |
|
| 917 | + : null; |
|
| 918 | + } |
|
| 919 | + |
|
| 920 | + |
|
| 921 | + /** |
|
| 922 | + * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD |
|
| 923 | + * cached on it) |
|
| 924 | + * |
|
| 925 | + * @return int |
|
| 926 | + * @throws EE_Error |
|
| 927 | + * @throws InvalidArgumentException |
|
| 928 | + * @throws InvalidDataTypeException |
|
| 929 | + * @throws InvalidInterfaceException |
|
| 930 | + * @throws ReflectionException |
|
| 931 | + */ |
|
| 932 | + public function delete_children_line_items() |
|
| 933 | + { |
|
| 934 | + if ($this->ID()) { |
|
| 935 | + return $this->get_model()->delete(array(array('LIN_parent' => $this->ID()))); |
|
| 936 | + } |
|
| 937 | + $count = count($this->_children); |
|
| 938 | + $this->_children = array(); |
|
| 939 | + return $count; |
|
| 940 | + } |
|
| 941 | + |
|
| 942 | + |
|
| 943 | + /** |
|
| 944 | + * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line |
|
| 945 | + * HAS NOT been saved to the DB, removes the child line item with index $code. |
|
| 946 | + * Also searches through the child's children for a matching line item. However, once a line item has been found |
|
| 947 | + * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be |
|
| 948 | + * deleted) |
|
| 949 | + * |
|
| 950 | + * @param string $code |
|
| 951 | + * @param bool $stop_search_once_found |
|
| 952 | + * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to |
|
| 953 | + * the DB yet) |
|
| 954 | + * @throws EE_Error |
|
| 955 | + * @throws InvalidArgumentException |
|
| 956 | + * @throws InvalidDataTypeException |
|
| 957 | + * @throws InvalidInterfaceException |
|
| 958 | + * @throws ReflectionException |
|
| 959 | + */ |
|
| 960 | + public function delete_child_line_item($code, $stop_search_once_found = true) |
|
| 961 | + { |
|
| 962 | + if ($this->ID()) { |
|
| 963 | + $items_deleted = 0; |
|
| 964 | + if ($this->code() === $code) { |
|
| 965 | + $items_deleted += EEH_Line_Item::delete_all_child_items($this); |
|
| 966 | + $items_deleted += (int) $this->delete(); |
|
| 967 | + if ($stop_search_once_found) { |
|
| 968 | + return $items_deleted; |
|
| 969 | + } |
|
| 970 | + } |
|
| 971 | + foreach ($this->children() as $child_line_item) { |
|
| 972 | + $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found); |
|
| 973 | + } |
|
| 974 | + return $items_deleted; |
|
| 975 | + } |
|
| 976 | + if (isset($this->_children[ $code ])) { |
|
| 977 | + unset($this->_children[ $code ]); |
|
| 978 | + return 1; |
|
| 979 | + } |
|
| 980 | + return 0; |
|
| 981 | + } |
|
| 982 | + |
|
| 983 | + |
|
| 984 | + /** |
|
| 985 | + * If this line item is in the database, is of the type subtotal, and |
|
| 986 | + * has no children, why do we have it? It should be deleted so this function |
|
| 987 | + * does that |
|
| 988 | + * |
|
| 989 | + * @return boolean |
|
| 990 | + * @throws EE_Error |
|
| 991 | + * @throws InvalidArgumentException |
|
| 992 | + * @throws InvalidDataTypeException |
|
| 993 | + * @throws InvalidInterfaceException |
|
| 994 | + * @throws ReflectionException |
|
| 995 | + */ |
|
| 996 | + public function delete_if_childless_subtotal() |
|
| 997 | + { |
|
| 998 | + if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) { |
|
| 999 | + return $this->delete(); |
|
| 1000 | + } |
|
| 1001 | + return false; |
|
| 1002 | + } |
|
| 1003 | + |
|
| 1004 | + |
|
| 1005 | + /** |
|
| 1006 | + * Creates a code and returns a string. doesn't assign the code to this model object |
|
| 1007 | + * |
|
| 1008 | + * @return string |
|
| 1009 | + * @throws EE_Error |
|
| 1010 | + * @throws InvalidArgumentException |
|
| 1011 | + * @throws InvalidDataTypeException |
|
| 1012 | + * @throws InvalidInterfaceException |
|
| 1013 | + * @throws ReflectionException |
|
| 1014 | + */ |
|
| 1015 | + public function generate_code() |
|
| 1016 | + { |
|
| 1017 | + // each line item in the cart requires a unique identifier |
|
| 1018 | + return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime()); |
|
| 1019 | + } |
|
| 1020 | + |
|
| 1021 | + |
|
| 1022 | + /** |
|
| 1023 | + * @return bool |
|
| 1024 | + * @throws EE_Error |
|
| 1025 | + * @throws InvalidArgumentException |
|
| 1026 | + * @throws InvalidDataTypeException |
|
| 1027 | + * @throws InvalidInterfaceException |
|
| 1028 | + * @throws ReflectionException |
|
| 1029 | + */ |
|
| 1030 | + public function is_tax() |
|
| 1031 | + { |
|
| 1032 | + return $this->type() === EEM_Line_Item::type_tax; |
|
| 1033 | + } |
|
| 1034 | + |
|
| 1035 | + |
|
| 1036 | + /** |
|
| 1037 | + * @return bool |
|
| 1038 | + * @throws EE_Error |
|
| 1039 | + * @throws InvalidArgumentException |
|
| 1040 | + * @throws InvalidDataTypeException |
|
| 1041 | + * @throws InvalidInterfaceException |
|
| 1042 | + * @throws ReflectionException |
|
| 1043 | + */ |
|
| 1044 | + public function is_tax_sub_total() |
|
| 1045 | + { |
|
| 1046 | + return $this->type() === EEM_Line_Item::type_tax_sub_total; |
|
| 1047 | + } |
|
| 1048 | + |
|
| 1049 | + |
|
| 1050 | + /** |
|
| 1051 | + * @return bool |
|
| 1052 | + * @throws EE_Error |
|
| 1053 | + * @throws InvalidArgumentException |
|
| 1054 | + * @throws InvalidDataTypeException |
|
| 1055 | + * @throws InvalidInterfaceException |
|
| 1056 | + * @throws ReflectionException |
|
| 1057 | + */ |
|
| 1058 | + public function is_line_item() |
|
| 1059 | + { |
|
| 1060 | + return $this->type() === EEM_Line_Item::type_line_item; |
|
| 1061 | + } |
|
| 1062 | + |
|
| 1063 | + |
|
| 1064 | + /** |
|
| 1065 | + * @return bool |
|
| 1066 | + * @throws EE_Error |
|
| 1067 | + * @throws InvalidArgumentException |
|
| 1068 | + * @throws InvalidDataTypeException |
|
| 1069 | + * @throws InvalidInterfaceException |
|
| 1070 | + * @throws ReflectionException |
|
| 1071 | + */ |
|
| 1072 | + public function is_sub_line_item() |
|
| 1073 | + { |
|
| 1074 | + return $this->type() === EEM_Line_Item::type_sub_line_item; |
|
| 1075 | + } |
|
| 1076 | + |
|
| 1077 | + |
|
| 1078 | + /** |
|
| 1079 | + * @return bool |
|
| 1080 | + * @throws EE_Error |
|
| 1081 | + * @throws InvalidArgumentException |
|
| 1082 | + * @throws InvalidDataTypeException |
|
| 1083 | + * @throws InvalidInterfaceException |
|
| 1084 | + * @throws ReflectionException |
|
| 1085 | + */ |
|
| 1086 | + public function is_sub_total() |
|
| 1087 | + { |
|
| 1088 | + return $this->type() === EEM_Line_Item::type_sub_total; |
|
| 1089 | + } |
|
| 1090 | + |
|
| 1091 | + |
|
| 1092 | + /** |
|
| 1093 | + * Whether or not this line item is a cancellation line item |
|
| 1094 | + * |
|
| 1095 | + * @return boolean |
|
| 1096 | + * @throws EE_Error |
|
| 1097 | + * @throws InvalidArgumentException |
|
| 1098 | + * @throws InvalidDataTypeException |
|
| 1099 | + * @throws InvalidInterfaceException |
|
| 1100 | + * @throws ReflectionException |
|
| 1101 | + */ |
|
| 1102 | + public function is_cancellation() |
|
| 1103 | + { |
|
| 1104 | + return EEM_Line_Item::type_cancellation === $this->type(); |
|
| 1105 | + } |
|
| 1106 | + |
|
| 1107 | + |
|
| 1108 | + /** |
|
| 1109 | + * @return bool |
|
| 1110 | + * @throws EE_Error |
|
| 1111 | + * @throws InvalidArgumentException |
|
| 1112 | + * @throws InvalidDataTypeException |
|
| 1113 | + * @throws InvalidInterfaceException |
|
| 1114 | + * @throws ReflectionException |
|
| 1115 | + */ |
|
| 1116 | + public function is_total() |
|
| 1117 | + { |
|
| 1118 | + return $this->type() === EEM_Line_Item::type_total; |
|
| 1119 | + } |
|
| 1120 | + |
|
| 1121 | + |
|
| 1122 | + /** |
|
| 1123 | + * @return bool |
|
| 1124 | + * @throws EE_Error |
|
| 1125 | + * @throws InvalidArgumentException |
|
| 1126 | + * @throws InvalidDataTypeException |
|
| 1127 | + * @throws InvalidInterfaceException |
|
| 1128 | + * @throws ReflectionException |
|
| 1129 | + */ |
|
| 1130 | + public function is_cancelled() |
|
| 1131 | + { |
|
| 1132 | + return $this->type() === EEM_Line_Item::type_cancellation; |
|
| 1133 | + } |
|
| 1134 | + |
|
| 1135 | + |
|
| 1136 | + /** |
|
| 1137 | + * @return string like '2, 004.00', formatted according to the localized currency |
|
| 1138 | + * @throws EE_Error |
|
| 1139 | + * @throws InvalidArgumentException |
|
| 1140 | + * @throws InvalidDataTypeException |
|
| 1141 | + * @throws InvalidInterfaceException |
|
| 1142 | + * @throws ReflectionException |
|
| 1143 | + */ |
|
| 1144 | + public function unit_price_no_code() |
|
| 1145 | + { |
|
| 1146 | + return $this->get_pretty('LIN_unit_price', 'no_currency_code'); |
|
| 1147 | + } |
|
| 1148 | + |
|
| 1149 | + |
|
| 1150 | + /** |
|
| 1151 | + * @return string like '2, 004.00', formatted according to the localized currency |
|
| 1152 | + * @throws EE_Error |
|
| 1153 | + * @throws InvalidArgumentException |
|
| 1154 | + * @throws InvalidDataTypeException |
|
| 1155 | + * @throws InvalidInterfaceException |
|
| 1156 | + * @throws ReflectionException |
|
| 1157 | + */ |
|
| 1158 | + public function total_no_code() |
|
| 1159 | + { |
|
| 1160 | + return $this->get_pretty('LIN_total', 'no_currency_code'); |
|
| 1161 | + } |
|
| 1162 | + |
|
| 1163 | + |
|
| 1164 | + /** |
|
| 1165 | + * Gets the final total on this item, taking taxes into account. |
|
| 1166 | + * Has the side-effect of setting the sub-total as it was just calculated. |
|
| 1167 | + * If this is used on a grand-total line item, also updates the transaction's |
|
| 1168 | + * TXN_total (provided this line item is allowed to persist, otherwise we don't |
|
| 1169 | + * want to change a persistable transaction with info from a non-persistent line item) |
|
| 1170 | + * |
|
| 1171 | + * @param bool $update_txn_status |
|
| 1172 | + * @return float |
|
| 1173 | + * @throws EE_Error |
|
| 1174 | + * @throws InvalidArgumentException |
|
| 1175 | + * @throws InvalidDataTypeException |
|
| 1176 | + * @throws InvalidInterfaceException |
|
| 1177 | + * @throws ReflectionException |
|
| 1178 | + * @throws RuntimeException |
|
| 1179 | + */ |
|
| 1180 | + public function recalculate_total_including_taxes($update_txn_status = false) |
|
| 1181 | + { |
|
| 1182 | + $pre_tax_total = $this->recalculate_pre_tax_total(); |
|
| 1183 | + $tax_total = $this->recalculate_taxes_and_tax_total(); |
|
| 1184 | + $total = $pre_tax_total + $tax_total; |
|
| 1185 | + // no negative totals plz |
|
| 1186 | + $total = max($total, 0); |
|
| 1187 | + $this->set_total($total); |
|
| 1188 | + // only update the related transaction's total |
|
| 1189 | + // if we intend to save this line item and its a grand total |
|
| 1190 | + if ($this->allow_persist() && $this->type() === EEM_Line_Item::type_total |
|
| 1191 | + && $this->transaction() |
|
| 1192 | + instanceof |
|
| 1193 | + EE_Transaction |
|
| 1194 | + ) { |
|
| 1195 | + $this->transaction()->set_total($total); |
|
| 1196 | + if ($update_txn_status) { |
|
| 1197 | + // don't save the TXN because that will be done below |
|
| 1198 | + // and the following method only saves if the status changes |
|
| 1199 | + $this->transaction()->update_status_based_on_total_paid(false); |
|
| 1200 | + } |
|
| 1201 | + if ($this->transaction()->ID()) { |
|
| 1202 | + $this->transaction()->save(); |
|
| 1203 | + } |
|
| 1204 | + } |
|
| 1205 | + $this->maybe_save(); |
|
| 1206 | + return $total; |
|
| 1207 | + } |
|
| 1208 | + |
|
| 1209 | + |
|
| 1210 | + /** |
|
| 1211 | + * Recursively goes through all the children and recalculates sub-totals EXCEPT for |
|
| 1212 | + * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its |
|
| 1213 | + * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and |
|
| 1214 | + * when this is called on the grand total |
|
| 1215 | + * |
|
| 1216 | + * @return float |
|
| 1217 | + * @throws EE_Error |
|
| 1218 | + * @throws InvalidArgumentException |
|
| 1219 | + * @throws InvalidDataTypeException |
|
| 1220 | + * @throws InvalidInterfaceException |
|
| 1221 | + * @throws ReflectionException |
|
| 1222 | + */ |
|
| 1223 | + public function recalculate_pre_tax_total() |
|
| 1224 | + { |
|
| 1225 | + $total = 0; |
|
| 1226 | + $my_children = $this->children(); |
|
| 1227 | + $has_children = ! empty($my_children); |
|
| 1228 | + if ($has_children && $this->is_line_item()) { |
|
| 1229 | + $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children); |
|
| 1230 | + } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 1231 | + $total = $this->unit_price() * $this->quantity(); |
|
| 1232 | + } elseif ($this->is_sub_total() || $this->is_total()) { |
|
| 1233 | + $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children); |
|
| 1234 | + } elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) { |
|
| 1235 | + // completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total |
|
| 1236 | + return 0; |
|
| 1237 | + } |
|
| 1238 | + // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events) |
|
| 1239 | + if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 1240 | + ) { |
|
| 1241 | + if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) { |
|
| 1242 | + $this->set_quantity(1); |
|
| 1243 | + } |
|
| 1244 | + if (! $this->is_percent()) { |
|
| 1245 | + $this->set_unit_price($total); |
|
| 1246 | + } |
|
| 1247 | + } |
|
| 1248 | + // we don't want to bother saving grand totals, because that needs to factor in taxes anyways |
|
| 1249 | + // so it ought to be |
|
| 1250 | + if (! $this->is_total()) { |
|
| 1251 | + $this->set_total($total); |
|
| 1252 | + // if not a percent line item, make sure we keep the unit price in sync |
|
| 1253 | + if ($has_children |
|
| 1254 | + && $this->is_line_item() |
|
| 1255 | + && ! $this->is_percent() |
|
| 1256 | + ) { |
|
| 1257 | + if ($this->quantity() === 0) { |
|
| 1258 | + $new_unit_price = 0; |
|
| 1259 | + } else { |
|
| 1260 | + $new_unit_price = $this->total() / $this->quantity(); |
|
| 1261 | + } |
|
| 1262 | + $this->set_unit_price($new_unit_price); |
|
| 1263 | + } |
|
| 1264 | + $this->maybe_save(); |
|
| 1265 | + } |
|
| 1266 | + return $total; |
|
| 1267 | + } |
|
| 1268 | + |
|
| 1269 | + |
|
| 1270 | + /** |
|
| 1271 | + * Calculates the pretax total when this line item is a subtotal or total line item. |
|
| 1272 | + * Basically does a sum-then-round approach (ie, any percent line item that are children |
|
| 1273 | + * will calculate their total based on the un-rounded total we're working with so far, and |
|
| 1274 | + * THEN round the result; instead of rounding as we go like with sub-line-items) |
|
| 1275 | + * |
|
| 1276 | + * @param float $calculated_total_so_far |
|
| 1277 | + * @param EE_Line_Item[] $my_children |
|
| 1278 | + * @return float |
|
| 1279 | + * @throws EE_Error |
|
| 1280 | + * @throws InvalidArgumentException |
|
| 1281 | + * @throws InvalidDataTypeException |
|
| 1282 | + * @throws InvalidInterfaceException |
|
| 1283 | + * @throws ReflectionException |
|
| 1284 | + */ |
|
| 1285 | + protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) |
|
| 1286 | + { |
|
| 1287 | + if ($my_children === null) { |
|
| 1288 | + $my_children = $this->children(); |
|
| 1289 | + } |
|
| 1290 | + $subtotal_quantity = 0; |
|
| 1291 | + // get the total of all its children |
|
| 1292 | + foreach ($my_children as $child_line_item) { |
|
| 1293 | + if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1294 | + // percentage line items are based on total so far |
|
| 1295 | + if ($child_line_item->is_percent()) { |
|
| 1296 | + // round as we go so that the line items add up ok |
|
| 1297 | + $percent_total = round( |
|
| 1298 | + $calculated_total_so_far * $child_line_item->percent() / 100, |
|
| 1299 | + EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1300 | + ); |
|
| 1301 | + $child_line_item->set_total($percent_total); |
|
| 1302 | + // so far all percent line items should have a quantity of 1 |
|
| 1303 | + // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1304 | + $child_line_item->set_quantity(1); |
|
| 1305 | + $child_line_item->maybe_save(); |
|
| 1306 | + $calculated_total_so_far += $percent_total; |
|
| 1307 | + } else { |
|
| 1308 | + // verify flat sub-line-item quantities match their parent |
|
| 1309 | + if ($child_line_item->is_sub_line_item()) { |
|
| 1310 | + $child_line_item->set_quantity($this->quantity()); |
|
| 1311 | + } |
|
| 1312 | + $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1313 | + $subtotal_quantity += $child_line_item->quantity(); |
|
| 1314 | + } |
|
| 1315 | + } |
|
| 1316 | + } |
|
| 1317 | + if ($this->is_sub_total()) { |
|
| 1318 | + // no negative totals plz |
|
| 1319 | + $calculated_total_so_far = max($calculated_total_so_far, 0); |
|
| 1320 | + $subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0; |
|
| 1321 | + $this->set_quantity($subtotal_quantity); |
|
| 1322 | + $this->maybe_save(); |
|
| 1323 | + } |
|
| 1324 | + return $calculated_total_so_far; |
|
| 1325 | + } |
|
| 1326 | + |
|
| 1327 | + |
|
| 1328 | + /** |
|
| 1329 | + * Calculates the pretax total for a normal line item, in a round-then-sum approach |
|
| 1330 | + * (where each sub-line-item is applied to the base price for the line item |
|
| 1331 | + * and the result is immediately rounded, rather than summing all the sub-line-items |
|
| 1332 | + * then rounding, like we do when recalculating pretax totals on totals and subtotals). |
|
| 1333 | + * |
|
| 1334 | + * @param float $calculated_total_so_far |
|
| 1335 | + * @param EE_Line_Item[] $my_children |
|
| 1336 | + * @return float |
|
| 1337 | + * @throws EE_Error |
|
| 1338 | + * @throws InvalidArgumentException |
|
| 1339 | + * @throws InvalidDataTypeException |
|
| 1340 | + * @throws InvalidInterfaceException |
|
| 1341 | + * @throws ReflectionException |
|
| 1342 | + */ |
|
| 1343 | + protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) |
|
| 1344 | + { |
|
| 1345 | + if ($my_children === null) { |
|
| 1346 | + $my_children = $this->children(); |
|
| 1347 | + } |
|
| 1348 | + // we need to keep track of the running total for a single item, |
|
| 1349 | + // because we need to round as we go |
|
| 1350 | + $unit_price_for_total = 0; |
|
| 1351 | + $quantity_for_total = 1; |
|
| 1352 | + // get the total of all its children |
|
| 1353 | + foreach ($my_children as $child_line_item) { |
|
| 1354 | + if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1355 | + if ($child_line_item->is_percent()) { |
|
| 1356 | + // it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity |
|
| 1357 | + // not total multiplied by percent, because that ignores rounding along-the-way |
|
| 1358 | + $percent_unit_price = round( |
|
| 1359 | + $unit_price_for_total * $child_line_item->percent() / 100, |
|
| 1360 | + EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1361 | + ); |
|
| 1362 | + $percent_total = $percent_unit_price * $quantity_for_total; |
|
| 1363 | + $child_line_item->set_total($percent_total); |
|
| 1364 | + // so far all percent line items should have a quantity of 1 |
|
| 1365 | + // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1366 | + $child_line_item->set_quantity(1); |
|
| 1367 | + $child_line_item->maybe_save(); |
|
| 1368 | + $calculated_total_so_far += $percent_total; |
|
| 1369 | + $unit_price_for_total += $percent_unit_price; |
|
| 1370 | + } else { |
|
| 1371 | + // verify flat sub-line-item quantities match their parent |
|
| 1372 | + if ($child_line_item->is_sub_line_item()) { |
|
| 1373 | + $child_line_item->set_quantity($this->quantity()); |
|
| 1374 | + } |
|
| 1375 | + $quantity_for_total = $child_line_item->quantity(); |
|
| 1376 | + $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1377 | + $unit_price_for_total += $child_line_item->unit_price(); |
|
| 1378 | + } |
|
| 1379 | + } |
|
| 1380 | + } |
|
| 1381 | + return $calculated_total_so_far; |
|
| 1382 | + } |
|
| 1383 | + |
|
| 1384 | + |
|
| 1385 | + /** |
|
| 1386 | + * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets |
|
| 1387 | + * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items |
|
| 1388 | + * and tax sub-total if already in the DB |
|
| 1389 | + * |
|
| 1390 | + * @return float |
|
| 1391 | + * @throws EE_Error |
|
| 1392 | + * @throws InvalidArgumentException |
|
| 1393 | + * @throws InvalidDataTypeException |
|
| 1394 | + * @throws InvalidInterfaceException |
|
| 1395 | + * @throws ReflectionException |
|
| 1396 | + */ |
|
| 1397 | + public function recalculate_taxes_and_tax_total() |
|
| 1398 | + { |
|
| 1399 | + // get all taxes |
|
| 1400 | + $taxes = $this->tax_descendants(); |
|
| 1401 | + // calculate the pretax total |
|
| 1402 | + $taxable_total = $this->taxable_total(); |
|
| 1403 | + $tax_total = 0; |
|
| 1404 | + foreach ($taxes as $tax) { |
|
| 1405 | + $total_on_this_tax = $taxable_total * $tax->percent() / 100; |
|
| 1406 | + // remember the total on this line item |
|
| 1407 | + $tax->set_total($total_on_this_tax); |
|
| 1408 | + $tax->maybe_save(); |
|
| 1409 | + $tax_total += $tax->total(); |
|
| 1410 | + } |
|
| 1411 | + $this->_recalculate_tax_sub_total(); |
|
| 1412 | + return $tax_total; |
|
| 1413 | + } |
|
| 1414 | + |
|
| 1415 | + |
|
| 1416 | + /** |
|
| 1417 | + * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated |
|
| 1418 | + * |
|
| 1419 | + * @return void |
|
| 1420 | + * @throws EE_Error |
|
| 1421 | + * @throws InvalidArgumentException |
|
| 1422 | + * @throws InvalidDataTypeException |
|
| 1423 | + * @throws InvalidInterfaceException |
|
| 1424 | + * @throws ReflectionException |
|
| 1425 | + */ |
|
| 1426 | + private function _recalculate_tax_sub_total() |
|
| 1427 | + { |
|
| 1428 | + if ($this->is_tax_sub_total()) { |
|
| 1429 | + $total = 0; |
|
| 1430 | + $total_percent = 0; |
|
| 1431 | + // simply loop through all its children (which should be taxes) and sum their total |
|
| 1432 | + foreach ($this->children() as $child_tax) { |
|
| 1433 | + if ($child_tax instanceof EE_Line_Item) { |
|
| 1434 | + $total += $child_tax->total(); |
|
| 1435 | + $total_percent += $child_tax->percent(); |
|
| 1436 | + } |
|
| 1437 | + } |
|
| 1438 | + $this->set_total($total); |
|
| 1439 | + $this->set_percent($total_percent); |
|
| 1440 | + $this->maybe_save(); |
|
| 1441 | + } elseif ($this->is_total()) { |
|
| 1442 | + foreach ($this->children() as $maybe_tax_subtotal) { |
|
| 1443 | + if ($maybe_tax_subtotal instanceof EE_Line_Item) { |
|
| 1444 | + $maybe_tax_subtotal->_recalculate_tax_sub_total(); |
|
| 1445 | + } |
|
| 1446 | + } |
|
| 1447 | + } |
|
| 1448 | + } |
|
| 1449 | + |
|
| 1450 | + |
|
| 1451 | + /** |
|
| 1452 | + * Gets the total tax on this line item. Assumes taxes have already been calculated using |
|
| 1453 | + * recalculate_taxes_and_total |
|
| 1454 | + * |
|
| 1455 | + * @return float |
|
| 1456 | + * @throws EE_Error |
|
| 1457 | + * @throws InvalidArgumentException |
|
| 1458 | + * @throws InvalidDataTypeException |
|
| 1459 | + * @throws InvalidInterfaceException |
|
| 1460 | + * @throws ReflectionException |
|
| 1461 | + */ |
|
| 1462 | + public function get_total_tax() |
|
| 1463 | + { |
|
| 1464 | + $this->_recalculate_tax_sub_total(); |
|
| 1465 | + $total = 0; |
|
| 1466 | + foreach ($this->tax_descendants() as $tax_line_item) { |
|
| 1467 | + if ($tax_line_item instanceof EE_Line_Item) { |
|
| 1468 | + $total += $tax_line_item->total(); |
|
| 1469 | + } |
|
| 1470 | + } |
|
| 1471 | + return $total; |
|
| 1472 | + } |
|
| 1473 | + |
|
| 1474 | + |
|
| 1475 | + /** |
|
| 1476 | + * Gets the total for all the items purchased only |
|
| 1477 | + * |
|
| 1478 | + * @return float |
|
| 1479 | + * @throws EE_Error |
|
| 1480 | + * @throws InvalidArgumentException |
|
| 1481 | + * @throws InvalidDataTypeException |
|
| 1482 | + * @throws InvalidInterfaceException |
|
| 1483 | + * @throws ReflectionException |
|
| 1484 | + */ |
|
| 1485 | + public function get_items_total() |
|
| 1486 | + { |
|
| 1487 | + // by default, let's make sure we're consistent with the existing line item |
|
| 1488 | + if ($this->is_total()) { |
|
| 1489 | + $pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this); |
|
| 1490 | + if ($pretax_subtotal_li instanceof EE_Line_Item) { |
|
| 1491 | + return $pretax_subtotal_li->total(); |
|
| 1492 | + } |
|
| 1493 | + } |
|
| 1494 | + $total = 0; |
|
| 1495 | + foreach ($this->get_items() as $item) { |
|
| 1496 | + if ($item instanceof EE_Line_Item) { |
|
| 1497 | + $total += $item->total(); |
|
| 1498 | + } |
|
| 1499 | + } |
|
| 1500 | + return $total; |
|
| 1501 | + } |
|
| 1502 | + |
|
| 1503 | + |
|
| 1504 | + /** |
|
| 1505 | + * Gets all the descendants (ie, children or children of children etc) that |
|
| 1506 | + * are of the type 'tax' |
|
| 1507 | + * |
|
| 1508 | + * @return EE_Line_Item[] |
|
| 1509 | + * @throws EE_Error |
|
| 1510 | + */ |
|
| 1511 | + public function tax_descendants() |
|
| 1512 | + { |
|
| 1513 | + return EEH_Line_Item::get_tax_descendants($this); |
|
| 1514 | + } |
|
| 1515 | + |
|
| 1516 | + |
|
| 1517 | + /** |
|
| 1518 | + * Gets all the real items purchased which are children of this item |
|
| 1519 | + * |
|
| 1520 | + * @return EE_Line_Item[] |
|
| 1521 | + * @throws EE_Error |
|
| 1522 | + */ |
|
| 1523 | + public function get_items() |
|
| 1524 | + { |
|
| 1525 | + return EEH_Line_Item::get_line_item_descendants($this); |
|
| 1526 | + } |
|
| 1527 | + |
|
| 1528 | + |
|
| 1529 | + /** |
|
| 1530 | + * Returns the amount taxable among this line item's children (or if it has no children, |
|
| 1531 | + * how much of it is taxable). Does not recalculate totals or subtotals. |
|
| 1532 | + * If the taxable total is negative, (eg, if none of the tickets were taxable, |
|
| 1533 | + * but there is a "Taxable" discount), returns 0. |
|
| 1534 | + * |
|
| 1535 | + * @return float |
|
| 1536 | + * @throws EE_Error |
|
| 1537 | + * @throws InvalidArgumentException |
|
| 1538 | + * @throws InvalidDataTypeException |
|
| 1539 | + * @throws InvalidInterfaceException |
|
| 1540 | + * @throws ReflectionException |
|
| 1541 | + */ |
|
| 1542 | + public function taxable_total() |
|
| 1543 | + { |
|
| 1544 | + $total = 0; |
|
| 1545 | + if ($this->children()) { |
|
| 1546 | + foreach ($this->children() as $child_line_item) { |
|
| 1547 | + if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) { |
|
| 1548 | + // if it's a percent item, only take into account the percent |
|
| 1549 | + // that's taxable too (the taxable total so far) |
|
| 1550 | + if ($child_line_item->is_percent()) { |
|
| 1551 | + $total += ($total * $child_line_item->percent() / 100); |
|
| 1552 | + } else { |
|
| 1553 | + $total += $child_line_item->total(); |
|
| 1554 | + } |
|
| 1555 | + } elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) { |
|
| 1556 | + $total += $child_line_item->taxable_total(); |
|
| 1557 | + } |
|
| 1558 | + } |
|
| 1559 | + } |
|
| 1560 | + return max($total, 0); |
|
| 1561 | + } |
|
| 1562 | + |
|
| 1563 | + |
|
| 1564 | + /** |
|
| 1565 | + * Gets the transaction for this line item |
|
| 1566 | + * |
|
| 1567 | + * @return EE_Base_Class|EE_Transaction |
|
| 1568 | + * @throws EE_Error |
|
| 1569 | + * @throws InvalidArgumentException |
|
| 1570 | + * @throws InvalidDataTypeException |
|
| 1571 | + * @throws InvalidInterfaceException |
|
| 1572 | + * @throws ReflectionException |
|
| 1573 | + */ |
|
| 1574 | + public function transaction() |
|
| 1575 | + { |
|
| 1576 | + return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION); |
|
| 1577 | + } |
|
| 1578 | + |
|
| 1579 | + |
|
| 1580 | + /** |
|
| 1581 | + * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1582 | + * Because there currently is no proper parent-child relation on the model, |
|
| 1583 | + * save_this_and_cached() will NOT save the descendants. |
|
| 1584 | + * Also sets the transaction on this line item and all its descendants before saving |
|
| 1585 | + * |
|
| 1586 | + * @param int $txn_id if none is provided, assumes $this->TXN_ID() |
|
| 1587 | + * @return int count of items saved |
|
| 1588 | + * @throws EE_Error |
|
| 1589 | + * @throws InvalidArgumentException |
|
| 1590 | + * @throws InvalidDataTypeException |
|
| 1591 | + * @throws InvalidInterfaceException |
|
| 1592 | + * @throws ReflectionException |
|
| 1593 | + */ |
|
| 1594 | + public function save_this_and_descendants_to_txn($txn_id = null) |
|
| 1595 | + { |
|
| 1596 | + $count = 0; |
|
| 1597 | + if (! $txn_id) { |
|
| 1598 | + $txn_id = $this->TXN_ID(); |
|
| 1599 | + } |
|
| 1600 | + $this->set_TXN_ID($txn_id); |
|
| 1601 | + $children = $this->children(); |
|
| 1602 | + $count += $this->save() |
|
| 1603 | + ? 1 |
|
| 1604 | + : 0; |
|
| 1605 | + foreach ($children as $child_line_item) { |
|
| 1606 | + if ($child_line_item instanceof EE_Line_Item) { |
|
| 1607 | + $child_line_item->set_parent_ID($this->ID()); |
|
| 1608 | + $count += $child_line_item->save_this_and_descendants_to_txn($txn_id); |
|
| 1609 | + } |
|
| 1610 | + } |
|
| 1611 | + return $count; |
|
| 1612 | + } |
|
| 1613 | + |
|
| 1614 | + |
|
| 1615 | + /** |
|
| 1616 | + * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1617 | + * |
|
| 1618 | + * @return int count of items saved |
|
| 1619 | + * @throws EE_Error |
|
| 1620 | + * @throws InvalidArgumentException |
|
| 1621 | + * @throws InvalidDataTypeException |
|
| 1622 | + * @throws InvalidInterfaceException |
|
| 1623 | + * @throws ReflectionException |
|
| 1624 | + */ |
|
| 1625 | + public function save_this_and_descendants() |
|
| 1626 | + { |
|
| 1627 | + $count = 0; |
|
| 1628 | + $children = $this->children(); |
|
| 1629 | + $count += $this->save() |
|
| 1630 | + ? 1 |
|
| 1631 | + : 0; |
|
| 1632 | + foreach ($children as $child_line_item) { |
|
| 1633 | + if ($child_line_item instanceof EE_Line_Item) { |
|
| 1634 | + $child_line_item->set_parent_ID($this->ID()); |
|
| 1635 | + $count += $child_line_item->save_this_and_descendants(); |
|
| 1636 | + } |
|
| 1637 | + } |
|
| 1638 | + return $count; |
|
| 1639 | + } |
|
| 1640 | + |
|
| 1641 | + |
|
| 1642 | + /** |
|
| 1643 | + * returns the cancellation line item if this item was cancelled |
|
| 1644 | + * |
|
| 1645 | + * @return EE_Line_Item[] |
|
| 1646 | + * @throws InvalidArgumentException |
|
| 1647 | + * @throws InvalidInterfaceException |
|
| 1648 | + * @throws InvalidDataTypeException |
|
| 1649 | + * @throws ReflectionException |
|
| 1650 | + * @throws EE_Error |
|
| 1651 | + */ |
|
| 1652 | + public function get_cancellations() |
|
| 1653 | + { |
|
| 1654 | + EE_Registry::instance()->load_helper('Line_Item'); |
|
| 1655 | + return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation); |
|
| 1656 | + } |
|
| 1657 | + |
|
| 1658 | + |
|
| 1659 | + /** |
|
| 1660 | + * If this item has an ID, then this saves it again to update the db |
|
| 1661 | + * |
|
| 1662 | + * @return int count of items saved |
|
| 1663 | + * @throws EE_Error |
|
| 1664 | + * @throws InvalidArgumentException |
|
| 1665 | + * @throws InvalidDataTypeException |
|
| 1666 | + * @throws InvalidInterfaceException |
|
| 1667 | + * @throws ReflectionException |
|
| 1668 | + */ |
|
| 1669 | + public function maybe_save() |
|
| 1670 | + { |
|
| 1671 | + if ($this->ID()) { |
|
| 1672 | + return $this->save(); |
|
| 1673 | + } |
|
| 1674 | + return false; |
|
| 1675 | + } |
|
| 1676 | + |
|
| 1677 | + |
|
| 1678 | + /** |
|
| 1679 | + * clears the cached children and parent from the line item |
|
| 1680 | + * |
|
| 1681 | + * @return void |
|
| 1682 | + */ |
|
| 1683 | + public function clear_related_line_item_cache() |
|
| 1684 | + { |
|
| 1685 | + $this->_children = array(); |
|
| 1686 | + $this->_parent = null; |
|
| 1687 | + } |
|
| 1688 | + |
|
| 1689 | + |
|
| 1690 | + /** |
|
| 1691 | + * @param bool $raw |
|
| 1692 | + * @return int |
|
| 1693 | + * @throws EE_Error |
|
| 1694 | + * @throws InvalidArgumentException |
|
| 1695 | + * @throws InvalidDataTypeException |
|
| 1696 | + * @throws InvalidInterfaceException |
|
| 1697 | + * @throws ReflectionException |
|
| 1698 | + */ |
|
| 1699 | + public function timestamp($raw = false) |
|
| 1700 | + { |
|
| 1701 | + return $raw |
|
| 1702 | + ? $this->get_raw('LIN_timestamp') |
|
| 1703 | + : $this->get('LIN_timestamp'); |
|
| 1704 | + } |
|
| 1705 | + |
|
| 1706 | + |
|
| 1707 | + |
|
| 1708 | + |
|
| 1709 | + /************************* DEPRECATED *************************/ |
|
| 1710 | + /** |
|
| 1711 | + * @deprecated 4.6.0 |
|
| 1712 | + * @param string $type one of the constants on EEM_Line_Item |
|
| 1713 | + * @return EE_Line_Item[] |
|
| 1714 | + * @throws EE_Error |
|
| 1715 | + */ |
|
| 1716 | + protected function _get_descendants_of_type($type) |
|
| 1717 | + { |
|
| 1718 | + EE_Error::doing_it_wrong( |
|
| 1719 | + 'EE_Line_Item::_get_descendants_of_type()', |
|
| 1720 | + sprintf( |
|
| 1721 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1722 | + 'EEH_Line_Item::get_descendants_of_type()' |
|
| 1723 | + ), |
|
| 1724 | + '4.6.0' |
|
| 1725 | + ); |
|
| 1726 | + return EEH_Line_Item::get_descendants_of_type($this, $type); |
|
| 1727 | + } |
|
| 1728 | + |
|
| 1729 | + |
|
| 1730 | + /** |
|
| 1731 | + * @deprecated 4.6.0 |
|
| 1732 | + * @param string $type like one of the EEM_Line_Item::type_* |
|
| 1733 | + * @return EE_Line_Item |
|
| 1734 | + * @throws EE_Error |
|
| 1735 | + * @throws InvalidArgumentException |
|
| 1736 | + * @throws InvalidDataTypeException |
|
| 1737 | + * @throws InvalidInterfaceException |
|
| 1738 | + * @throws ReflectionException |
|
| 1739 | + */ |
|
| 1740 | + public function get_nearest_descendant_of_type($type) |
|
| 1741 | + { |
|
| 1742 | + EE_Error::doing_it_wrong( |
|
| 1743 | + 'EE_Line_Item::get_nearest_descendant_of_type()', |
|
| 1744 | + sprintf( |
|
| 1745 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1746 | + 'EEH_Line_Item::get_nearest_descendant_of_type()' |
|
| 1747 | + ), |
|
| 1748 | + '4.6.0' |
|
| 1749 | + ); |
|
| 1750 | + return EEH_Line_Item::get_nearest_descendant_of_type($this, $type); |
|
| 1751 | + } |
|
| 1752 | 1752 | } |
@@ -1027,7 +1027,7 @@ discard block |
||
| 1027 | 1027 | * Deletes ALL children of the passed line item |
| 1028 | 1028 | * |
| 1029 | 1029 | * @param EE_Line_Item $parent_line_item |
| 1030 | - * @return bool |
|
| 1030 | + * @return integer |
|
| 1031 | 1031 | * @throws EE_Error |
| 1032 | 1032 | * @throws InvalidArgumentException |
| 1033 | 1033 | * @throws InvalidDataTypeException |
@@ -1333,6 +1333,7 @@ discard block |
||
| 1333 | 1333 | * @param string $line_item_type one of the EEM_Line_Item constants |
| 1334 | 1334 | * @param string | NULL $obj_type object model class name (minus prefix) or NULL to ignore object type when |
| 1335 | 1335 | * searching |
| 1336 | + * @param string $obj_type |
|
| 1336 | 1337 | * @return EE_Line_Item[] |
| 1337 | 1338 | * @throws EE_Error |
| 1338 | 1339 | */ |
@@ -138,7 +138,7 @@ discard block |
||
| 138 | 138 | */ |
| 139 | 139 | public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
| 140 | 140 | { |
| 141 | - if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) { |
|
| 141 | + if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) { |
|
| 142 | 142 | throw new EE_Error( |
| 143 | 143 | sprintf( |
| 144 | 144 | esc_html__( |
@@ -153,7 +153,7 @@ discard block |
||
| 153 | 153 | // either increment the qty for an existing ticket |
| 154 | 154 | $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty); |
| 155 | 155 | // or add a new one |
| 156 | - if (! $line_item instanceof EE_Line_Item) { |
|
| 156 | + if ( ! $line_item instanceof EE_Line_Item) { |
|
| 157 | 157 | $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty); |
| 158 | 158 | } |
| 159 | 159 | $total_line_item->recalculate_total_including_taxes(); |
@@ -214,7 +214,7 @@ discard block |
||
| 214 | 214 | */ |
| 215 | 215 | public static function increment_quantity(EE_Line_Item $line_item, $qty = 1) |
| 216 | 216 | { |
| 217 | - if (! $line_item->is_percent()) { |
|
| 217 | + if ( ! $line_item->is_percent()) { |
|
| 218 | 218 | $qty += $line_item->quantity(); |
| 219 | 219 | $line_item->set_quantity($qty); |
| 220 | 220 | $line_item->set_total($line_item->unit_price() * $qty); |
@@ -243,7 +243,7 @@ discard block |
||
| 243 | 243 | */ |
| 244 | 244 | public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1) |
| 245 | 245 | { |
| 246 | - if (! $line_item->is_percent()) { |
|
| 246 | + if ( ! $line_item->is_percent()) { |
|
| 247 | 247 | $qty = $line_item->quantity() - $qty; |
| 248 | 248 | $qty = max($qty, 0); |
| 249 | 249 | $line_item->set_quantity($qty); |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | */ |
| 273 | 273 | public static function update_quantity(EE_Line_Item $line_item, $new_quantity) |
| 274 | 274 | { |
| 275 | - if (! $line_item->is_percent()) { |
|
| 275 | + if ( ! $line_item->is_percent()) { |
|
| 276 | 276 | $line_item->set_quantity($new_quantity); |
| 277 | 277 | $line_item->set_total($line_item->unit_price() * $new_quantity); |
| 278 | 278 | $line_item->save(); |
@@ -312,7 +312,7 @@ discard block |
||
| 312 | 312 | // add $ticket to cart |
| 313 | 313 | $line_item = EE_Line_Item::new_instance(array( |
| 314 | 314 | 'LIN_name' => $ticket->name(), |
| 315 | - 'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event, |
|
| 315 | + 'LIN_desc' => $ticket->description() !== '' ? $ticket->description().' '.$event : $event, |
|
| 316 | 316 | 'LIN_unit_price' => $ticket->price(), |
| 317 | 317 | 'LIN_quantity' => $qty, |
| 318 | 318 | 'LIN_is_taxable' => $ticket->taxable(), |
@@ -462,7 +462,7 @@ discard block |
||
| 462 | 462 | 'event_espresso' |
| 463 | 463 | ), |
| 464 | 464 | $ticket_line_item->name(), |
| 465 | - current_time(get_option('date_format') . ' ' . get_option('time_format')) |
|
| 465 | + current_time(get_option('date_format').' '.get_option('time_format')) |
|
| 466 | 466 | ), |
| 467 | 467 | 'LIN_unit_price' => 0, // $ticket_line_item->unit_price() |
| 468 | 468 | 'LIN_quantity' => $qty, |
@@ -524,7 +524,7 @@ discard block |
||
| 524 | 524 | ); |
| 525 | 525 | $cancellation_line_item = reset($cancellation_line_item); |
| 526 | 526 | // verify that this ticket was indeed previously cancelled |
| 527 | - if (! $cancellation_line_item instanceof EE_Line_Item) { |
|
| 527 | + if ( ! $cancellation_line_item instanceof EE_Line_Item) { |
|
| 528 | 528 | return false; |
| 529 | 529 | } |
| 530 | 530 | if ($cancellation_line_item->quantity() > $qty) { |
@@ -729,7 +729,7 @@ discard block |
||
| 729 | 729 | 'LIN_code' => 'taxes', |
| 730 | 730 | 'LIN_name' => esc_html__('Taxes', 'event_espresso'), |
| 731 | 731 | 'LIN_type' => EEM_Line_Item::type_tax_sub_total, |
| 732 | - 'LIN_order' => 1000,// this should always come last |
|
| 732 | + 'LIN_order' => 1000, // this should always come last |
|
| 733 | 733 | )); |
| 734 | 734 | $tax_line_item = apply_filters( |
| 735 | 735 | 'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item', |
@@ -785,7 +785,7 @@ discard block |
||
| 785 | 785 | */ |
| 786 | 786 | public static function get_event_code($event) |
| 787 | 787 | { |
| 788 | - return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0'); |
|
| 788 | + return 'event-'.($event instanceof EE_Event ? $event->ID() : '0'); |
|
| 789 | 789 | } |
| 790 | 790 | |
| 791 | 791 | |
@@ -834,7 +834,7 @@ discard block |
||
| 834 | 834 | public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket) |
| 835 | 835 | { |
| 836 | 836 | $first_datetime = $ticket->first_datetime(); |
| 837 | - if (! $first_datetime instanceof EE_Datetime) { |
|
| 837 | + if ( ! $first_datetime instanceof EE_Datetime) { |
|
| 838 | 838 | throw new EE_Error( |
| 839 | 839 | sprintf( |
| 840 | 840 | __('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), |
@@ -843,7 +843,7 @@ discard block |
||
| 843 | 843 | ); |
| 844 | 844 | } |
| 845 | 845 | $event = $first_datetime->event(); |
| 846 | - if (! $event instanceof EE_Event) { |
|
| 846 | + if ( ! $event instanceof EE_Event) { |
|
| 847 | 847 | throw new EE_Error( |
| 848 | 848 | sprintf( |
| 849 | 849 | esc_html__( |
@@ -855,7 +855,7 @@ discard block |
||
| 855 | 855 | ); |
| 856 | 856 | } |
| 857 | 857 | $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event); |
| 858 | - if (! $events_sub_total instanceof EE_Line_Item) { |
|
| 858 | + if ( ! $events_sub_total instanceof EE_Line_Item) { |
|
| 859 | 859 | throw new EE_Error( |
| 860 | 860 | sprintf( |
| 861 | 861 | esc_html__( |
@@ -891,7 +891,7 @@ discard block |
||
| 891 | 891 | $found = false; |
| 892 | 892 | foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) { |
| 893 | 893 | // default event subtotal, we should only ever find this the first time this method is called |
| 894 | - if (! $event_line_item->OBJ_ID()) { |
|
| 894 | + if ( ! $event_line_item->OBJ_ID()) { |
|
| 895 | 895 | // let's use this! but first... set the event details |
| 896 | 896 | EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
| 897 | 897 | $found = true; |
@@ -903,7 +903,7 @@ discard block |
||
| 903 | 903 | break; |
| 904 | 904 | } |
| 905 | 905 | } |
| 906 | - if (! $found) { |
|
| 906 | + if ( ! $found) { |
|
| 907 | 907 | // there is no event sub-total yet, so add it |
| 908 | 908 | $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total); |
| 909 | 909 | // create a new "event" subtotal below that |
@@ -1018,7 +1018,7 @@ discard block |
||
| 1018 | 1018 | public static function ensure_taxes_applied($total_line_item) |
| 1019 | 1019 | { |
| 1020 | 1020 | $taxes_subtotal = self::get_taxes_subtotal($total_line_item); |
| 1021 | - if (! $taxes_subtotal->children()) { |
|
| 1021 | + if ( ! $taxes_subtotal->children()) { |
|
| 1022 | 1022 | self::apply_taxes($total_line_item); |
| 1023 | 1023 | } |
| 1024 | 1024 | return $taxes_subtotal->total(); |
@@ -1085,7 +1085,7 @@ discard block |
||
| 1085 | 1085 | do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
| 1086 | 1086 | |
| 1087 | 1087 | // check if only a single line_item_id was passed |
| 1088 | - if (! empty($line_item_codes) && ! is_array($line_item_codes)) { |
|
| 1088 | + if ( ! empty($line_item_codes) && ! is_array($line_item_codes)) { |
|
| 1089 | 1089 | // place single line_item_id in an array to appear as multiple line_item_ids |
| 1090 | 1090 | $line_item_codes = array($line_item_codes); |
| 1091 | 1091 | } |
@@ -1192,7 +1192,7 @@ discard block |
||
| 1192 | 1192 | if ($code_substring_for_whitelist !== null) { |
| 1193 | 1193 | $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false; |
| 1194 | 1194 | } |
| 1195 | - if (! $whitelisted && $line_item->is_line_item()) { |
|
| 1195 | + if ( ! $whitelisted && $line_item->is_line_item()) { |
|
| 1196 | 1196 | $line_item->set_is_taxable($taxable); |
| 1197 | 1197 | } |
| 1198 | 1198 | foreach ($line_item->children() as $child_line_item) { |
@@ -1554,7 +1554,7 @@ discard block |
||
| 1554 | 1554 | public static function visualize(EE_Line_Item $line_item, $indentation = 0) |
| 1555 | 1555 | { |
| 1556 | 1556 | echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
| 1557 | - if (! $indentation) { |
|
| 1557 | + if ( ! $indentation) { |
|
| 1558 | 1558 | echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
| 1559 | 1559 | } |
| 1560 | 1560 | for ($i = 0; $i < $indentation; $i++) { |
@@ -1565,12 +1565,12 @@ discard block |
||
| 1565 | 1565 | if ($line_item->is_percent()) { |
| 1566 | 1566 | $breakdown = "{$line_item->percent()}%"; |
| 1567 | 1567 | } else { |
| 1568 | - $breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}"; |
|
| 1568 | + $breakdown = '$'."{$line_item->unit_price()} x {$line_item->quantity()}"; |
|
| 1569 | 1569 | } |
| 1570 | 1570 | } |
| 1571 | 1571 | echo $line_item->name(); |
| 1572 | 1572 | echo " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : "; |
| 1573 | - echo '$' . (string) $line_item->total(); |
|
| 1573 | + echo '$'.(string) $line_item->total(); |
|
| 1574 | 1574 | if ($breakdown) { |
| 1575 | 1575 | echo " ( {$breakdown} )"; |
| 1576 | 1576 | } |
@@ -1658,8 +1658,8 @@ discard block |
||
| 1658 | 1658 | if ($line_item_id === 'taxable') { |
| 1659 | 1659 | continue; |
| 1660 | 1660 | } |
| 1661 | - $taxable_total = $running_totals['taxable'][ $line_item_id ]; |
|
| 1662 | - $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal); |
|
| 1661 | + $taxable_total = $running_totals['taxable'][$line_item_id]; |
|
| 1662 | + $running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal); |
|
| 1663 | 1663 | } |
| 1664 | 1664 | break; |
| 1665 | 1665 | |
@@ -1667,7 +1667,7 @@ discard block |
||
| 1667 | 1667 | // ticket line items or ???? |
| 1668 | 1668 | if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) { |
| 1669 | 1669 | // kk it's a ticket |
| 1670 | - if (isset($running_totals[ $child_line_item->ID() ])) { |
|
| 1670 | + if (isset($running_totals[$child_line_item->ID()])) { |
|
| 1671 | 1671 | // huh? that shouldn't happen. |
| 1672 | 1672 | $running_totals['total'] += $child_line_item->total(); |
| 1673 | 1673 | } else { |
@@ -1678,18 +1678,18 @@ discard block |
||
| 1678 | 1678 | $taxable_amount = 0; |
| 1679 | 1679 | } |
| 1680 | 1680 | // are we only calculating totals for some tickets? |
| 1681 | - if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) { |
|
| 1682 | - $quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ]; |
|
| 1683 | - $running_totals[ $child_line_item->ID() ] = $quantity |
|
| 1681 | + if (isset($billable_ticket_quantities[$child_line_item->OBJ_ID()])) { |
|
| 1682 | + $quantity = $billable_ticket_quantities[$child_line_item->OBJ_ID()]; |
|
| 1683 | + $running_totals[$child_line_item->ID()] = $quantity |
|
| 1684 | 1684 | ? $child_line_item->unit_price() |
| 1685 | 1685 | : 0; |
| 1686 | - $running_totals['taxable'][ $child_line_item->ID() ] = $quantity |
|
| 1686 | + $running_totals['taxable'][$child_line_item->ID()] = $quantity |
|
| 1687 | 1687 | ? $taxable_amount |
| 1688 | 1688 | : 0; |
| 1689 | 1689 | } else { |
| 1690 | 1690 | $quantity = $child_line_item->quantity(); |
| 1691 | - $running_totals[ $child_line_item->ID() ] = $child_line_item->unit_price(); |
|
| 1692 | - $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount; |
|
| 1691 | + $running_totals[$child_line_item->ID()] = $child_line_item->unit_price(); |
|
| 1692 | + $running_totals['taxable'][$child_line_item->ID()] = $taxable_amount; |
|
| 1693 | 1693 | } |
| 1694 | 1694 | $running_totals['taxable']['total'] += $taxable_amount * $quantity; |
| 1695 | 1695 | $running_totals['total'] += $child_line_item->unit_price() * $quantity; |
@@ -1709,12 +1709,12 @@ discard block |
||
| 1709 | 1709 | } |
| 1710 | 1710 | // update the running totals |
| 1711 | 1711 | // yes this actually even works for the running grand total! |
| 1712 | - $running_totals[ $line_item_id ] = |
|
| 1712 | + $running_totals[$line_item_id] = |
|
| 1713 | 1713 | $line_items_percent_of_running_total * $this_running_total; |
| 1714 | 1714 | |
| 1715 | 1715 | if ($child_line_item->is_taxable()) { |
| 1716 | - $running_totals['taxable'][ $line_item_id ] = |
|
| 1717 | - $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ]; |
|
| 1716 | + $running_totals['taxable'][$line_item_id] = |
|
| 1717 | + $line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id]; |
|
| 1718 | 1718 | } |
| 1719 | 1719 | } |
| 1720 | 1720 | } |
@@ -1747,8 +1747,8 @@ discard block |
||
| 1747 | 1747 | ); |
| 1748 | 1748 | } |
| 1749 | 1749 | // ok now find this new registration's final price |
| 1750 | - if (isset($final_prices_per_ticket_line_item[ $ticket_line_item->ID() ])) { |
|
| 1751 | - return $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ]; |
|
| 1750 | + if (isset($final_prices_per_ticket_line_item[$ticket_line_item->ID()])) { |
|
| 1751 | + return $final_prices_per_ticket_line_item[$ticket_line_item->ID()]; |
|
| 1752 | 1752 | } |
| 1753 | 1753 | $message = sprintf( |
| 1754 | 1754 | esc_html__( |
@@ -1758,7 +1758,7 @@ discard block |
||
| 1758 | 1758 | $ticket_line_item->ID() |
| 1759 | 1759 | ); |
| 1760 | 1760 | if (WP_DEBUG) { |
| 1761 | - $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true); |
|
| 1761 | + $message .= '<br>'.print_r($final_prices_per_ticket_line_item, true); |
|
| 1762 | 1762 | throw new OutOfRangeException($message); |
| 1763 | 1763 | } |
| 1764 | 1764 | EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message); |
@@ -21,2045 +21,2045 @@ |
||
| 21 | 21 | class EEH_Line_Item |
| 22 | 22 | { |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * Adds a simple item (unrelated to any other model object) to the provided PARENT line item. |
|
| 26 | - * Does NOT automatically re-calculate the line item totals or update the related transaction. |
|
| 27 | - * You should call recalculate_total_including_taxes() on the grant total line item after this |
|
| 28 | - * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 29 | - * to keep the registration final prices in-sync with the transaction's total. |
|
| 30 | - * |
|
| 31 | - * @param EE_Line_Item $parent_line_item |
|
| 32 | - * @param string $name |
|
| 33 | - * @param float $unit_price |
|
| 34 | - * @param string $description |
|
| 35 | - * @param int $quantity |
|
| 36 | - * @param boolean $taxable |
|
| 37 | - * @param boolean $code if set to a value, ensures there is only one line item with that code |
|
| 38 | - * @return boolean success |
|
| 39 | - * @throws EE_Error |
|
| 40 | - * @throws InvalidArgumentException |
|
| 41 | - * @throws InvalidDataTypeException |
|
| 42 | - * @throws InvalidInterfaceException |
|
| 43 | - * @throws ReflectionException |
|
| 44 | - */ |
|
| 45 | - public static function add_unrelated_item( |
|
| 46 | - EE_Line_Item $parent_line_item, |
|
| 47 | - $name, |
|
| 48 | - $unit_price, |
|
| 49 | - $description = '', |
|
| 50 | - $quantity = 1, |
|
| 51 | - $taxable = false, |
|
| 52 | - $code = null |
|
| 53 | - ) { |
|
| 54 | - $items_subtotal = self::get_pre_tax_subtotal($parent_line_item); |
|
| 55 | - $line_item = EE_Line_Item::new_instance(array( |
|
| 56 | - 'LIN_name' => $name, |
|
| 57 | - 'LIN_desc' => $description, |
|
| 58 | - 'LIN_unit_price' => $unit_price, |
|
| 59 | - 'LIN_quantity' => $quantity, |
|
| 60 | - 'LIN_percent' => null, |
|
| 61 | - 'LIN_is_taxable' => $taxable, |
|
| 62 | - 'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0, |
|
| 63 | - 'LIN_total' => (float) $unit_price * (int) $quantity, |
|
| 64 | - 'LIN_type' => EEM_Line_Item::type_line_item, |
|
| 65 | - 'LIN_code' => $code, |
|
| 66 | - )); |
|
| 67 | - $line_item = apply_filters( |
|
| 68 | - 'FHEE__EEH_Line_Item__add_unrelated_item__line_item', |
|
| 69 | - $line_item, |
|
| 70 | - $parent_line_item |
|
| 71 | - ); |
|
| 72 | - return self::add_item($parent_line_item, $line_item); |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Adds a simple item ( unrelated to any other model object) to the total line item, |
|
| 78 | - * in the correct spot in the line item tree. Automatically |
|
| 79 | - * re-calculates the line item totals and updates the related transaction. But |
|
| 80 | - * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 81 | - * should probably change because of this). |
|
| 82 | - * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 83 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 84 | - * |
|
| 85 | - * @param EE_Line_Item $parent_line_item |
|
| 86 | - * @param string $name |
|
| 87 | - * @param float $percentage_amount |
|
| 88 | - * @param string $description |
|
| 89 | - * @param boolean $taxable |
|
| 90 | - * @return boolean success |
|
| 91 | - * @throws EE_Error |
|
| 92 | - */ |
|
| 93 | - public static function add_percentage_based_item( |
|
| 94 | - EE_Line_Item $parent_line_item, |
|
| 95 | - $name, |
|
| 96 | - $percentage_amount, |
|
| 97 | - $description = '', |
|
| 98 | - $taxable = false |
|
| 99 | - ) { |
|
| 100 | - $line_item = EE_Line_Item::new_instance(array( |
|
| 101 | - 'LIN_name' => $name, |
|
| 102 | - 'LIN_desc' => $description, |
|
| 103 | - 'LIN_unit_price' => 0, |
|
| 104 | - 'LIN_percent' => $percentage_amount, |
|
| 105 | - 'LIN_quantity' => 1, |
|
| 106 | - 'LIN_is_taxable' => $taxable, |
|
| 107 | - 'LIN_total' => (float) ($percentage_amount * ($parent_line_item->total() / 100)), |
|
| 108 | - 'LIN_type' => EEM_Line_Item::type_line_item, |
|
| 109 | - 'LIN_parent' => $parent_line_item->ID(), |
|
| 110 | - )); |
|
| 111 | - $line_item = apply_filters( |
|
| 112 | - 'FHEE__EEH_Line_Item__add_percentage_based_item__line_item', |
|
| 113 | - $line_item |
|
| 114 | - ); |
|
| 115 | - return $parent_line_item->add_child_line_item($line_item, false); |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * Returns the new line item created by adding a purchase of the ticket |
|
| 121 | - * ensures that ticket line item is saved, and that cart total has been recalculated. |
|
| 122 | - * If this ticket has already been purchased, just increments its count. |
|
| 123 | - * Automatically re-calculates the line item totals and updates the related transaction. But |
|
| 124 | - * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 125 | - * should probably change because of this). |
|
| 126 | - * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 127 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 128 | - * |
|
| 129 | - * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total |
|
| 130 | - * @param EE_Ticket $ticket |
|
| 131 | - * @param int $qty |
|
| 132 | - * @return EE_Line_Item |
|
| 133 | - * @throws EE_Error |
|
| 134 | - * @throws InvalidArgumentException |
|
| 135 | - * @throws InvalidDataTypeException |
|
| 136 | - * @throws InvalidInterfaceException |
|
| 137 | - * @throws ReflectionException |
|
| 138 | - */ |
|
| 139 | - public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
| 140 | - { |
|
| 141 | - if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) { |
|
| 142 | - throw new EE_Error( |
|
| 143 | - sprintf( |
|
| 144 | - esc_html__( |
|
| 145 | - 'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', |
|
| 146 | - 'event_espresso' |
|
| 147 | - ), |
|
| 148 | - $ticket->ID(), |
|
| 149 | - $total_line_item->ID() |
|
| 150 | - ) |
|
| 151 | - ); |
|
| 152 | - } |
|
| 153 | - // either increment the qty for an existing ticket |
|
| 154 | - $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty); |
|
| 155 | - // or add a new one |
|
| 156 | - if (! $line_item instanceof EE_Line_Item) { |
|
| 157 | - $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty); |
|
| 158 | - } |
|
| 159 | - $total_line_item->recalculate_total_including_taxes(); |
|
| 160 | - return $line_item; |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Returns the new line item created by adding a purchase of the ticket |
|
| 166 | - * |
|
| 167 | - * @param EE_Line_Item $total_line_item |
|
| 168 | - * @param EE_Ticket $ticket |
|
| 169 | - * @param int $qty |
|
| 170 | - * @return EE_Line_Item |
|
| 171 | - * @throws EE_Error |
|
| 172 | - * @throws InvalidArgumentException |
|
| 173 | - * @throws InvalidDataTypeException |
|
| 174 | - * @throws InvalidInterfaceException |
|
| 175 | - * @throws ReflectionException |
|
| 176 | - */ |
|
| 177 | - public static function increment_ticket_qty_if_already_in_cart( |
|
| 178 | - EE_Line_Item $total_line_item, |
|
| 179 | - EE_Ticket $ticket, |
|
| 180 | - $qty = 1 |
|
| 181 | - ) { |
|
| 182 | - $line_item = null; |
|
| 183 | - if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) { |
|
| 184 | - $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item); |
|
| 185 | - foreach ((array) $ticket_line_items as $ticket_line_item) { |
|
| 186 | - if ($ticket_line_item instanceof EE_Line_Item |
|
| 187 | - && (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID() |
|
| 188 | - ) { |
|
| 189 | - $line_item = $ticket_line_item; |
|
| 190 | - break; |
|
| 191 | - } |
|
| 192 | - } |
|
| 193 | - } |
|
| 194 | - if ($line_item instanceof EE_Line_Item) { |
|
| 195 | - EEH_Line_Item::increment_quantity($line_item, $qty); |
|
| 196 | - return $line_item; |
|
| 197 | - } |
|
| 198 | - return null; |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
| 204 | - * Does NOT save or recalculate other line items totals |
|
| 205 | - * |
|
| 206 | - * @param EE_Line_Item $line_item |
|
| 207 | - * @param int $qty |
|
| 208 | - * @return void |
|
| 209 | - * @throws EE_Error |
|
| 210 | - * @throws InvalidArgumentException |
|
| 211 | - * @throws InvalidDataTypeException |
|
| 212 | - * @throws InvalidInterfaceException |
|
| 213 | - * @throws ReflectionException |
|
| 214 | - */ |
|
| 215 | - public static function increment_quantity(EE_Line_Item $line_item, $qty = 1) |
|
| 216 | - { |
|
| 217 | - if (! $line_item->is_percent()) { |
|
| 218 | - $qty += $line_item->quantity(); |
|
| 219 | - $line_item->set_quantity($qty); |
|
| 220 | - $line_item->set_total($line_item->unit_price() * $qty); |
|
| 221 | - $line_item->save(); |
|
| 222 | - } |
|
| 223 | - foreach ($line_item->children() as $child) { |
|
| 224 | - if ($child->is_sub_line_item()) { |
|
| 225 | - EEH_Line_Item::update_quantity($child, $qty); |
|
| 226 | - } |
|
| 227 | - } |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
| 233 | - * Does NOT save or recalculate other line items totals |
|
| 234 | - * |
|
| 235 | - * @param EE_Line_Item $line_item |
|
| 236 | - * @param int $qty |
|
| 237 | - * @return void |
|
| 238 | - * @throws EE_Error |
|
| 239 | - * @throws InvalidArgumentException |
|
| 240 | - * @throws InvalidDataTypeException |
|
| 241 | - * @throws InvalidInterfaceException |
|
| 242 | - * @throws ReflectionException |
|
| 243 | - */ |
|
| 244 | - public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1) |
|
| 245 | - { |
|
| 246 | - if (! $line_item->is_percent()) { |
|
| 247 | - $qty = $line_item->quantity() - $qty; |
|
| 248 | - $qty = max($qty, 0); |
|
| 249 | - $line_item->set_quantity($qty); |
|
| 250 | - $line_item->set_total($line_item->unit_price() * $qty); |
|
| 251 | - $line_item->save(); |
|
| 252 | - } |
|
| 253 | - foreach ($line_item->children() as $child) { |
|
| 254 | - if ($child->is_sub_line_item()) { |
|
| 255 | - EEH_Line_Item::update_quantity($child, $qty); |
|
| 256 | - } |
|
| 257 | - } |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - |
|
| 261 | - /** |
|
| 262 | - * Updates the line item and its children's quantities to the specified number. |
|
| 263 | - * Does NOT save them or recalculate totals. |
|
| 264 | - * |
|
| 265 | - * @param EE_Line_Item $line_item |
|
| 266 | - * @param int $new_quantity |
|
| 267 | - * @throws EE_Error |
|
| 268 | - * @throws InvalidArgumentException |
|
| 269 | - * @throws InvalidDataTypeException |
|
| 270 | - * @throws InvalidInterfaceException |
|
| 271 | - * @throws ReflectionException |
|
| 272 | - */ |
|
| 273 | - public static function update_quantity(EE_Line_Item $line_item, $new_quantity) |
|
| 274 | - { |
|
| 275 | - if (! $line_item->is_percent()) { |
|
| 276 | - $line_item->set_quantity($new_quantity); |
|
| 277 | - $line_item->set_total($line_item->unit_price() * $new_quantity); |
|
| 278 | - $line_item->save(); |
|
| 279 | - } |
|
| 280 | - foreach ($line_item->children() as $child) { |
|
| 281 | - if ($child->is_sub_line_item()) { |
|
| 282 | - EEH_Line_Item::update_quantity($child, $new_quantity); |
|
| 283 | - } |
|
| 284 | - } |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Returns the new line item created by adding a purchase of the ticket |
|
| 290 | - * |
|
| 291 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 292 | - * @param EE_Ticket $ticket |
|
| 293 | - * @param int $qty |
|
| 294 | - * @return EE_Line_Item |
|
| 295 | - * @throws EE_Error |
|
| 296 | - * @throws InvalidArgumentException |
|
| 297 | - * @throws InvalidDataTypeException |
|
| 298 | - * @throws InvalidInterfaceException |
|
| 299 | - * @throws ReflectionException |
|
| 300 | - */ |
|
| 301 | - public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
| 302 | - { |
|
| 303 | - $datetimes = $ticket->datetimes(); |
|
| 304 | - $first_datetime = reset($datetimes); |
|
| 305 | - $first_datetime_name = esc_html__('Event', 'event_espresso'); |
|
| 306 | - if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) { |
|
| 307 | - $first_datetime_name = $first_datetime->event()->name(); |
|
| 308 | - } |
|
| 309 | - $event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name); |
|
| 310 | - // get event subtotal line |
|
| 311 | - $events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket); |
|
| 312 | - // add $ticket to cart |
|
| 313 | - $line_item = EE_Line_Item::new_instance(array( |
|
| 314 | - 'LIN_name' => $ticket->name(), |
|
| 315 | - 'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event, |
|
| 316 | - 'LIN_unit_price' => $ticket->price(), |
|
| 317 | - 'LIN_quantity' => $qty, |
|
| 318 | - 'LIN_is_taxable' => $ticket->taxable(), |
|
| 319 | - 'LIN_order' => count($events_sub_total->children()), |
|
| 320 | - 'LIN_total' => $ticket->price() * $qty, |
|
| 321 | - 'LIN_type' => EEM_Line_Item::type_line_item, |
|
| 322 | - 'OBJ_ID' => $ticket->ID(), |
|
| 323 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 324 | - )); |
|
| 325 | - $line_item = apply_filters( |
|
| 326 | - 'FHEE__EEH_Line_Item__create_ticket_line_item__line_item', |
|
| 327 | - $line_item |
|
| 328 | - ); |
|
| 329 | - $events_sub_total->add_child_line_item($line_item); |
|
| 330 | - // now add the sub-line items |
|
| 331 | - $running_total_for_ticket = 0; |
|
| 332 | - foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) { |
|
| 333 | - $sign = $price->is_discount() ? -1 : 1; |
|
| 334 | - $price_total = $price->is_percent() |
|
| 335 | - ? $running_total_for_ticket * $price->amount() / 100 |
|
| 336 | - : $price->amount() * $qty; |
|
| 337 | - $sub_line_item = EE_Line_Item::new_instance(array( |
|
| 338 | - 'LIN_name' => $price->name(), |
|
| 339 | - 'LIN_desc' => $price->desc(), |
|
| 340 | - 'LIN_quantity' => $price->is_percent() ? null : $qty, |
|
| 341 | - 'LIN_is_taxable' => false, |
|
| 342 | - 'LIN_order' => $price->order(), |
|
| 343 | - 'LIN_total' => $sign * $price_total, |
|
| 344 | - 'LIN_type' => EEM_Line_Item::type_sub_line_item, |
|
| 345 | - 'OBJ_ID' => $price->ID(), |
|
| 346 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
| 347 | - )); |
|
| 348 | - $sub_line_item = apply_filters( |
|
| 349 | - 'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item', |
|
| 350 | - $sub_line_item |
|
| 351 | - ); |
|
| 352 | - if ($price->is_percent()) { |
|
| 353 | - $sub_line_item->set_percent($sign * $price->amount()); |
|
| 354 | - } else { |
|
| 355 | - $sub_line_item->set_unit_price($sign * $price->amount()); |
|
| 356 | - } |
|
| 357 | - $running_total_for_ticket += $price_total; |
|
| 358 | - $line_item->add_child_line_item($sub_line_item); |
|
| 359 | - } |
|
| 360 | - return $line_item; |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * Adds the specified item under the pre-tax-sub-total line item. Automatically |
|
| 366 | - * re-calculates the line item totals and updates the related transaction. But |
|
| 367 | - * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 368 | - * should probably change because of this). |
|
| 369 | - * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 370 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 371 | - * |
|
| 372 | - * @param EE_Line_Item $total_line_item |
|
| 373 | - * @param EE_Line_Item $item to be added |
|
| 374 | - * @return boolean |
|
| 375 | - * @throws EE_Error |
|
| 376 | - * @throws InvalidArgumentException |
|
| 377 | - * @throws InvalidDataTypeException |
|
| 378 | - * @throws InvalidInterfaceException |
|
| 379 | - * @throws ReflectionException |
|
| 380 | - */ |
|
| 381 | - public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item) |
|
| 382 | - { |
|
| 383 | - $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item); |
|
| 384 | - if ($pre_tax_subtotal instanceof EE_Line_Item) { |
|
| 385 | - $success = $pre_tax_subtotal->add_child_line_item($item); |
|
| 386 | - } else { |
|
| 387 | - return false; |
|
| 388 | - } |
|
| 389 | - $total_line_item->recalculate_total_including_taxes(); |
|
| 390 | - return $success; |
|
| 391 | - } |
|
| 392 | - |
|
| 393 | - |
|
| 394 | - /** |
|
| 395 | - * cancels an existing ticket line item, |
|
| 396 | - * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item. |
|
| 397 | - * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
| 398 | - * |
|
| 399 | - * @param EE_Line_Item $ticket_line_item |
|
| 400 | - * @param int $qty |
|
| 401 | - * @return bool success |
|
| 402 | - * @throws EE_Error |
|
| 403 | - * @throws InvalidArgumentException |
|
| 404 | - * @throws InvalidDataTypeException |
|
| 405 | - * @throws InvalidInterfaceException |
|
| 406 | - * @throws ReflectionException |
|
| 407 | - */ |
|
| 408 | - public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
| 409 | - { |
|
| 410 | - // validate incoming line_item |
|
| 411 | - if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 412 | - throw new EE_Error( |
|
| 413 | - sprintf( |
|
| 414 | - esc_html__( |
|
| 415 | - 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
| 416 | - 'event_espresso' |
|
| 417 | - ), |
|
| 418 | - $ticket_line_item->type() |
|
| 419 | - ) |
|
| 420 | - ); |
|
| 421 | - } |
|
| 422 | - if ($ticket_line_item->quantity() < $qty) { |
|
| 423 | - throw new EE_Error( |
|
| 424 | - sprintf( |
|
| 425 | - esc_html__( |
|
| 426 | - 'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', |
|
| 427 | - 'event_espresso' |
|
| 428 | - ), |
|
| 429 | - $qty, |
|
| 430 | - $ticket_line_item->quantity() |
|
| 431 | - ) |
|
| 432 | - ); |
|
| 433 | - } |
|
| 434 | - // decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this |
|
| 435 | - $ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty); |
|
| 436 | - foreach ($ticket_line_item->children() as $child_line_item) { |
|
| 437 | - if ($child_line_item->is_sub_line_item() |
|
| 438 | - && ! $child_line_item->is_percent() |
|
| 439 | - && ! $child_line_item->is_cancellation() |
|
| 440 | - ) { |
|
| 441 | - $child_line_item->set_quantity($child_line_item->quantity() - $qty); |
|
| 442 | - } |
|
| 443 | - } |
|
| 444 | - // get cancellation sub line item |
|
| 445 | - $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
| 446 | - $ticket_line_item, |
|
| 447 | - EEM_Line_Item::type_cancellation |
|
| 448 | - ); |
|
| 449 | - $cancellation_line_item = reset($cancellation_line_item); |
|
| 450 | - // verify that this ticket was indeed previously cancelled |
|
| 451 | - if ($cancellation_line_item instanceof EE_Line_Item) { |
|
| 452 | - // increment cancelled quantity |
|
| 453 | - $cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty); |
|
| 454 | - } else { |
|
| 455 | - // create cancellation sub line item |
|
| 456 | - $cancellation_line_item = EE_Line_Item::new_instance(array( |
|
| 457 | - 'LIN_name' => esc_html__('Cancellation', 'event_espresso'), |
|
| 458 | - 'LIN_desc' => sprintf( |
|
| 459 | - esc_html_x( |
|
| 460 | - 'Cancelled %1$s : %2$s', |
|
| 461 | - 'Cancelled Ticket Name : 2015-01-01 11:11', |
|
| 462 | - 'event_espresso' |
|
| 463 | - ), |
|
| 464 | - $ticket_line_item->name(), |
|
| 465 | - current_time(get_option('date_format') . ' ' . get_option('time_format')) |
|
| 466 | - ), |
|
| 467 | - 'LIN_unit_price' => 0, // $ticket_line_item->unit_price() |
|
| 468 | - 'LIN_quantity' => $qty, |
|
| 469 | - 'LIN_is_taxable' => $ticket_line_item->is_taxable(), |
|
| 470 | - 'LIN_order' => count($ticket_line_item->children()), |
|
| 471 | - 'LIN_total' => 0, // $ticket_line_item->unit_price() |
|
| 472 | - 'LIN_type' => EEM_Line_Item::type_cancellation, |
|
| 473 | - )); |
|
| 474 | - $ticket_line_item->add_child_line_item($cancellation_line_item); |
|
| 475 | - } |
|
| 476 | - if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
| 477 | - // decrement parent line item quantity |
|
| 478 | - $event_line_item = $ticket_line_item->parent(); |
|
| 479 | - if ($event_line_item instanceof EE_Line_Item |
|
| 480 | - && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
| 481 | - ) { |
|
| 482 | - $event_line_item->set_quantity($event_line_item->quantity() - $qty); |
|
| 483 | - $event_line_item->save(); |
|
| 484 | - } |
|
| 485 | - EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
| 486 | - return true; |
|
| 487 | - } |
|
| 488 | - return false; |
|
| 489 | - } |
|
| 490 | - |
|
| 491 | - |
|
| 492 | - /** |
|
| 493 | - * reinstates (un-cancels?) a previously canceled ticket line item, |
|
| 494 | - * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item. |
|
| 495 | - * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
| 496 | - * |
|
| 497 | - * @param EE_Line_Item $ticket_line_item |
|
| 498 | - * @param int $qty |
|
| 499 | - * @return bool success |
|
| 500 | - * @throws EE_Error |
|
| 501 | - * @throws InvalidArgumentException |
|
| 502 | - * @throws InvalidDataTypeException |
|
| 503 | - * @throws InvalidInterfaceException |
|
| 504 | - * @throws ReflectionException |
|
| 505 | - */ |
|
| 506 | - public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
| 507 | - { |
|
| 508 | - // validate incoming line_item |
|
| 509 | - if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 510 | - throw new EE_Error( |
|
| 511 | - sprintf( |
|
| 512 | - esc_html__( |
|
| 513 | - 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
| 514 | - 'event_espresso' |
|
| 515 | - ), |
|
| 516 | - $ticket_line_item->type() |
|
| 517 | - ) |
|
| 518 | - ); |
|
| 519 | - } |
|
| 520 | - // get cancellation sub line item |
|
| 521 | - $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
| 522 | - $ticket_line_item, |
|
| 523 | - EEM_Line_Item::type_cancellation |
|
| 524 | - ); |
|
| 525 | - $cancellation_line_item = reset($cancellation_line_item); |
|
| 526 | - // verify that this ticket was indeed previously cancelled |
|
| 527 | - if (! $cancellation_line_item instanceof EE_Line_Item) { |
|
| 528 | - return false; |
|
| 529 | - } |
|
| 530 | - if ($cancellation_line_item->quantity() > $qty) { |
|
| 531 | - // decrement cancelled quantity |
|
| 532 | - $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
| 533 | - } elseif ($cancellation_line_item->quantity() === $qty) { |
|
| 534 | - // decrement cancelled quantity in case anyone still has the object kicking around |
|
| 535 | - $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
| 536 | - // delete because quantity will end up as 0 |
|
| 537 | - $cancellation_line_item->delete(); |
|
| 538 | - // and attempt to destroy the object, |
|
| 539 | - // even though PHP won't actually destroy it until it needs the memory |
|
| 540 | - unset($cancellation_line_item); |
|
| 541 | - } else { |
|
| 542 | - // what ?!?! negative quantity ?!?! |
|
| 543 | - throw new EE_Error( |
|
| 544 | - sprintf( |
|
| 545 | - esc_html__( |
|
| 546 | - 'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.', |
|
| 547 | - 'event_espresso' |
|
| 548 | - ), |
|
| 549 | - $qty, |
|
| 550 | - $cancellation_line_item->quantity() |
|
| 551 | - ) |
|
| 552 | - ); |
|
| 553 | - } |
|
| 554 | - // increment ticket quantity |
|
| 555 | - $ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty); |
|
| 556 | - if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
| 557 | - // increment parent line item quantity |
|
| 558 | - $event_line_item = $ticket_line_item->parent(); |
|
| 559 | - if ($event_line_item instanceof EE_Line_Item |
|
| 560 | - && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
| 561 | - ) { |
|
| 562 | - $event_line_item->set_quantity($event_line_item->quantity() + $qty); |
|
| 563 | - } |
|
| 564 | - EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
| 565 | - return true; |
|
| 566 | - } |
|
| 567 | - return false; |
|
| 568 | - } |
|
| 569 | - |
|
| 570 | - |
|
| 571 | - /** |
|
| 572 | - * calls EEH_Line_Item::find_transaction_grand_total_for_line_item() |
|
| 573 | - * then EE_Line_Item::recalculate_total_including_taxes() on the result |
|
| 574 | - * |
|
| 575 | - * @param EE_Line_Item $line_item |
|
| 576 | - * @return float |
|
| 577 | - * @throws EE_Error |
|
| 578 | - * @throws InvalidArgumentException |
|
| 579 | - * @throws InvalidDataTypeException |
|
| 580 | - * @throws InvalidInterfaceException |
|
| 581 | - * @throws ReflectionException |
|
| 582 | - */ |
|
| 583 | - public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item) |
|
| 584 | - { |
|
| 585 | - $grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item); |
|
| 586 | - return $grand_total_line_item->recalculate_total_including_taxes(); |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - |
|
| 590 | - /** |
|
| 591 | - * Gets the line item which contains the subtotal of all the items |
|
| 592 | - * |
|
| 593 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 594 | - * @return EE_Line_Item |
|
| 595 | - * @throws EE_Error |
|
| 596 | - * @throws InvalidArgumentException |
|
| 597 | - * @throws InvalidDataTypeException |
|
| 598 | - * @throws InvalidInterfaceException |
|
| 599 | - * @throws ReflectionException |
|
| 600 | - */ |
|
| 601 | - public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item) |
|
| 602 | - { |
|
| 603 | - $pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal'); |
|
| 604 | - return $pre_tax_subtotal instanceof EE_Line_Item |
|
| 605 | - ? $pre_tax_subtotal |
|
| 606 | - : self::create_pre_tax_subtotal($total_line_item); |
|
| 607 | - } |
|
| 608 | - |
|
| 609 | - |
|
| 610 | - /** |
|
| 611 | - * Gets the line item for the taxes subtotal |
|
| 612 | - * |
|
| 613 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 614 | - * @return EE_Line_Item |
|
| 615 | - * @throws EE_Error |
|
| 616 | - * @throws InvalidArgumentException |
|
| 617 | - * @throws InvalidDataTypeException |
|
| 618 | - * @throws InvalidInterfaceException |
|
| 619 | - * @throws ReflectionException |
|
| 620 | - */ |
|
| 621 | - public static function get_taxes_subtotal(EE_Line_Item $total_line_item) |
|
| 622 | - { |
|
| 623 | - $taxes = $total_line_item->get_child_line_item('taxes'); |
|
| 624 | - return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - |
|
| 628 | - /** |
|
| 629 | - * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object |
|
| 630 | - * |
|
| 631 | - * @param EE_Line_Item $line_item |
|
| 632 | - * @param EE_Transaction $transaction |
|
| 633 | - * @return void |
|
| 634 | - * @throws EE_Error |
|
| 635 | - * @throws InvalidArgumentException |
|
| 636 | - * @throws InvalidDataTypeException |
|
| 637 | - * @throws InvalidInterfaceException |
|
| 638 | - * @throws ReflectionException |
|
| 639 | - */ |
|
| 640 | - public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = null) |
|
| 641 | - { |
|
| 642 | - if ($transaction) { |
|
| 643 | - /** @type EEM_Transaction $EEM_Transaction */ |
|
| 644 | - $EEM_Transaction = EE_Registry::instance()->load_model('Transaction'); |
|
| 645 | - $TXN_ID = $EEM_Transaction->ensure_is_ID($transaction); |
|
| 646 | - $line_item->set_TXN_ID($TXN_ID); |
|
| 647 | - } |
|
| 648 | - } |
|
| 649 | - |
|
| 650 | - |
|
| 651 | - /** |
|
| 652 | - * Creates a new default total line item for the transaction, |
|
| 653 | - * and its tickets subtotal and taxes subtotal line items (and adds the |
|
| 654 | - * existing taxes as children of the taxes subtotal line item) |
|
| 655 | - * |
|
| 656 | - * @param EE_Transaction $transaction |
|
| 657 | - * @return EE_Line_Item of type total |
|
| 658 | - * @throws EE_Error |
|
| 659 | - * @throws InvalidArgumentException |
|
| 660 | - * @throws InvalidDataTypeException |
|
| 661 | - * @throws InvalidInterfaceException |
|
| 662 | - * @throws ReflectionException |
|
| 663 | - */ |
|
| 664 | - public static function create_total_line_item($transaction = null) |
|
| 665 | - { |
|
| 666 | - $total_line_item = EE_Line_Item::new_instance(array( |
|
| 667 | - 'LIN_code' => 'total', |
|
| 668 | - 'LIN_name' => esc_html__('Grand Total', 'event_espresso'), |
|
| 669 | - 'LIN_type' => EEM_Line_Item::type_total, |
|
| 670 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION, |
|
| 671 | - )); |
|
| 672 | - $total_line_item = apply_filters( |
|
| 673 | - 'FHEE__EEH_Line_Item__create_total_line_item__total_line_item', |
|
| 674 | - $total_line_item |
|
| 675 | - ); |
|
| 676 | - self::set_TXN_ID($total_line_item, $transaction); |
|
| 677 | - self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
| 678 | - self::create_taxes_subtotal($total_line_item, $transaction); |
|
| 679 | - return $total_line_item; |
|
| 680 | - } |
|
| 681 | - |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Creates a default items subtotal line item |
|
| 685 | - * |
|
| 686 | - * @param EE_Line_Item $total_line_item |
|
| 687 | - * @param EE_Transaction $transaction |
|
| 688 | - * @return EE_Line_Item |
|
| 689 | - * @throws EE_Error |
|
| 690 | - * @throws InvalidArgumentException |
|
| 691 | - * @throws InvalidDataTypeException |
|
| 692 | - * @throws InvalidInterfaceException |
|
| 693 | - * @throws ReflectionException |
|
| 694 | - */ |
|
| 695 | - protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 696 | - { |
|
| 697 | - $pre_tax_line_item = EE_Line_Item::new_instance(array( |
|
| 698 | - 'LIN_code' => 'pre-tax-subtotal', |
|
| 699 | - 'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'), |
|
| 700 | - 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
| 701 | - )); |
|
| 702 | - $pre_tax_line_item = apply_filters( |
|
| 703 | - 'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item', |
|
| 704 | - $pre_tax_line_item |
|
| 705 | - ); |
|
| 706 | - self::set_TXN_ID($pre_tax_line_item, $transaction); |
|
| 707 | - $total_line_item->add_child_line_item($pre_tax_line_item); |
|
| 708 | - self::create_event_subtotal($pre_tax_line_item, $transaction); |
|
| 709 | - return $pre_tax_line_item; |
|
| 710 | - } |
|
| 711 | - |
|
| 712 | - |
|
| 713 | - /** |
|
| 714 | - * Creates a line item for the taxes subtotal and finds all the tax prices |
|
| 715 | - * and applies taxes to it |
|
| 716 | - * |
|
| 717 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 718 | - * @param EE_Transaction $transaction |
|
| 719 | - * @return EE_Line_Item |
|
| 720 | - * @throws EE_Error |
|
| 721 | - * @throws InvalidArgumentException |
|
| 722 | - * @throws InvalidDataTypeException |
|
| 723 | - * @throws InvalidInterfaceException |
|
| 724 | - * @throws ReflectionException |
|
| 725 | - */ |
|
| 726 | - protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 727 | - { |
|
| 728 | - $tax_line_item = EE_Line_Item::new_instance(array( |
|
| 729 | - 'LIN_code' => 'taxes', |
|
| 730 | - 'LIN_name' => esc_html__('Taxes', 'event_espresso'), |
|
| 731 | - 'LIN_type' => EEM_Line_Item::type_tax_sub_total, |
|
| 732 | - 'LIN_order' => 1000,// this should always come last |
|
| 733 | - )); |
|
| 734 | - $tax_line_item = apply_filters( |
|
| 735 | - 'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item', |
|
| 736 | - $tax_line_item |
|
| 737 | - ); |
|
| 738 | - self::set_TXN_ID($tax_line_item, $transaction); |
|
| 739 | - $total_line_item->add_child_line_item($tax_line_item); |
|
| 740 | - // and lastly, add the actual taxes |
|
| 741 | - self::apply_taxes($total_line_item); |
|
| 742 | - return $tax_line_item; |
|
| 743 | - } |
|
| 744 | - |
|
| 745 | - |
|
| 746 | - /** |
|
| 747 | - * Creates a default items subtotal line item |
|
| 748 | - * |
|
| 749 | - * @param EE_Line_Item $pre_tax_line_item |
|
| 750 | - * @param EE_Transaction $transaction |
|
| 751 | - * @param EE_Event $event |
|
| 752 | - * @return EE_Line_Item |
|
| 753 | - * @throws EE_Error |
|
| 754 | - * @throws InvalidArgumentException |
|
| 755 | - * @throws InvalidDataTypeException |
|
| 756 | - * @throws InvalidInterfaceException |
|
| 757 | - * @throws ReflectionException |
|
| 758 | - */ |
|
| 759 | - public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = null, $event = null) |
|
| 760 | - { |
|
| 761 | - $event_line_item = EE_Line_Item::new_instance(array( |
|
| 762 | - 'LIN_code' => self::get_event_code($event), |
|
| 763 | - 'LIN_name' => self::get_event_name($event), |
|
| 764 | - 'LIN_desc' => self::get_event_desc($event), |
|
| 765 | - 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
| 766 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT, |
|
| 767 | - 'OBJ_ID' => $event instanceof EE_Event ? $event->ID() : 0, |
|
| 768 | - )); |
|
| 769 | - $event_line_item = apply_filters( |
|
| 770 | - 'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item', |
|
| 771 | - $event_line_item |
|
| 772 | - ); |
|
| 773 | - self::set_TXN_ID($event_line_item, $transaction); |
|
| 774 | - $pre_tax_line_item->add_child_line_item($event_line_item); |
|
| 775 | - return $event_line_item; |
|
| 776 | - } |
|
| 777 | - |
|
| 778 | - |
|
| 779 | - /** |
|
| 780 | - * Gets what the event ticket's code SHOULD be |
|
| 781 | - * |
|
| 782 | - * @param EE_Event $event |
|
| 783 | - * @return string |
|
| 784 | - * @throws EE_Error |
|
| 785 | - */ |
|
| 786 | - public static function get_event_code($event) |
|
| 787 | - { |
|
| 788 | - return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0'); |
|
| 789 | - } |
|
| 790 | - |
|
| 791 | - |
|
| 792 | - /** |
|
| 793 | - * Gets the event name |
|
| 794 | - * |
|
| 795 | - * @param EE_Event $event |
|
| 796 | - * @return string |
|
| 797 | - * @throws EE_Error |
|
| 798 | - */ |
|
| 799 | - public static function get_event_name($event) |
|
| 800 | - { |
|
| 801 | - return $event instanceof EE_Event |
|
| 802 | - ? mb_substr($event->name(), 0, 245) |
|
| 803 | - : esc_html__('Event', 'event_espresso'); |
|
| 804 | - } |
|
| 805 | - |
|
| 806 | - |
|
| 807 | - /** |
|
| 808 | - * Gets the event excerpt |
|
| 809 | - * |
|
| 810 | - * @param EE_Event $event |
|
| 811 | - * @return string |
|
| 812 | - * @throws EE_Error |
|
| 813 | - */ |
|
| 814 | - public static function get_event_desc($event) |
|
| 815 | - { |
|
| 816 | - return $event instanceof EE_Event ? $event->short_description() : ''; |
|
| 817 | - } |
|
| 818 | - |
|
| 819 | - |
|
| 820 | - /** |
|
| 821 | - * Given the grand total line item and a ticket, finds the event sub-total |
|
| 822 | - * line item the ticket's purchase should be added onto |
|
| 823 | - * |
|
| 824 | - * @access public |
|
| 825 | - * @param EE_Line_Item $grand_total the grand total line item |
|
| 826 | - * @param EE_Ticket $ticket |
|
| 827 | - * @return EE_Line_Item |
|
| 828 | - * @throws EE_Error |
|
| 829 | - * @throws InvalidArgumentException |
|
| 830 | - * @throws InvalidDataTypeException |
|
| 831 | - * @throws InvalidInterfaceException |
|
| 832 | - * @throws ReflectionException |
|
| 833 | - */ |
|
| 834 | - public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket) |
|
| 835 | - { |
|
| 836 | - $first_datetime = $ticket->first_datetime(); |
|
| 837 | - if (! $first_datetime instanceof EE_Datetime) { |
|
| 838 | - throw new EE_Error( |
|
| 839 | - sprintf( |
|
| 840 | - __('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), |
|
| 841 | - $ticket->ID() |
|
| 842 | - ) |
|
| 843 | - ); |
|
| 844 | - } |
|
| 845 | - $event = $first_datetime->event(); |
|
| 846 | - if (! $event instanceof EE_Event) { |
|
| 847 | - throw new EE_Error( |
|
| 848 | - sprintf( |
|
| 849 | - esc_html__( |
|
| 850 | - 'The supplied ticket (ID %d) has no event data associated with it.', |
|
| 851 | - 'event_espresso' |
|
| 852 | - ), |
|
| 853 | - $ticket->ID() |
|
| 854 | - ) |
|
| 855 | - ); |
|
| 856 | - } |
|
| 857 | - $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event); |
|
| 858 | - if (! $events_sub_total instanceof EE_Line_Item) { |
|
| 859 | - throw new EE_Error( |
|
| 860 | - sprintf( |
|
| 861 | - esc_html__( |
|
| 862 | - 'There is no events sub-total for ticket %s on total line item %d', |
|
| 863 | - 'event_espresso' |
|
| 864 | - ), |
|
| 865 | - $ticket->ID(), |
|
| 866 | - $grand_total->ID() |
|
| 867 | - ) |
|
| 868 | - ); |
|
| 869 | - } |
|
| 870 | - return $events_sub_total; |
|
| 871 | - } |
|
| 872 | - |
|
| 873 | - |
|
| 874 | - /** |
|
| 875 | - * Gets the event line item |
|
| 876 | - * |
|
| 877 | - * @param EE_Line_Item $grand_total |
|
| 878 | - * @param EE_Event $event |
|
| 879 | - * @return EE_Line_Item for the event subtotal which is a child of $grand_total |
|
| 880 | - * @throws EE_Error |
|
| 881 | - * @throws InvalidArgumentException |
|
| 882 | - * @throws InvalidDataTypeException |
|
| 883 | - * @throws InvalidInterfaceException |
|
| 884 | - * @throws ReflectionException |
|
| 885 | - */ |
|
| 886 | - public static function get_event_line_item(EE_Line_Item $grand_total, $event) |
|
| 887 | - { |
|
| 888 | - /** @type EE_Event $event */ |
|
| 889 | - $event = EEM_Event::instance()->ensure_is_obj($event, true); |
|
| 890 | - $event_line_item = null; |
|
| 891 | - $found = false; |
|
| 892 | - foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) { |
|
| 893 | - // default event subtotal, we should only ever find this the first time this method is called |
|
| 894 | - if (! $event_line_item->OBJ_ID()) { |
|
| 895 | - // let's use this! but first... set the event details |
|
| 896 | - EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
| 897 | - $found = true; |
|
| 898 | - break; |
|
| 899 | - } |
|
| 900 | - if ($event_line_item->OBJ_ID() === $event->ID()) { |
|
| 901 | - // found existing line item for this event in the cart, so break out of loop and use this one |
|
| 902 | - $found = true; |
|
| 903 | - break; |
|
| 904 | - } |
|
| 905 | - } |
|
| 906 | - if (! $found) { |
|
| 907 | - // there is no event sub-total yet, so add it |
|
| 908 | - $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total); |
|
| 909 | - // create a new "event" subtotal below that |
|
| 910 | - $event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event); |
|
| 911 | - // and set the event details |
|
| 912 | - EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
| 913 | - } |
|
| 914 | - return $event_line_item; |
|
| 915 | - } |
|
| 916 | - |
|
| 917 | - |
|
| 918 | - /** |
|
| 919 | - * Creates a default items subtotal line item |
|
| 920 | - * |
|
| 921 | - * @param EE_Line_Item $event_line_item |
|
| 922 | - * @param EE_Event $event |
|
| 923 | - * @param EE_Transaction $transaction |
|
| 924 | - * @return void |
|
| 925 | - * @throws EE_Error |
|
| 926 | - * @throws InvalidArgumentException |
|
| 927 | - * @throws InvalidDataTypeException |
|
| 928 | - * @throws InvalidInterfaceException |
|
| 929 | - * @throws ReflectionException |
|
| 930 | - */ |
|
| 931 | - public static function set_event_subtotal_details( |
|
| 932 | - EE_Line_Item $event_line_item, |
|
| 933 | - EE_Event $event, |
|
| 934 | - $transaction = null |
|
| 935 | - ) { |
|
| 936 | - if ($event instanceof EE_Event) { |
|
| 937 | - $event_line_item->set_code(self::get_event_code($event)); |
|
| 938 | - $event_line_item->set_name(self::get_event_name($event)); |
|
| 939 | - $event_line_item->set_desc(self::get_event_desc($event)); |
|
| 940 | - $event_line_item->set_OBJ_ID($event->ID()); |
|
| 941 | - } |
|
| 942 | - self::set_TXN_ID($event_line_item, $transaction); |
|
| 943 | - } |
|
| 944 | - |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Finds what taxes should apply, adds them as tax line items under the taxes sub-total, |
|
| 948 | - * and recalculates the taxes sub-total and the grand total. Resets the taxes, so |
|
| 949 | - * any old taxes are removed |
|
| 950 | - * |
|
| 951 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 952 | - * @param bool $update_txn_status |
|
| 953 | - * @return bool |
|
| 954 | - * @throws EE_Error |
|
| 955 | - * @throws InvalidArgumentException |
|
| 956 | - * @throws InvalidDataTypeException |
|
| 957 | - * @throws InvalidInterfaceException |
|
| 958 | - * @throws ReflectionException |
|
| 959 | - * @throws RuntimeException |
|
| 960 | - */ |
|
| 961 | - public static function apply_taxes(EE_Line_Item $total_line_item, $update_txn_status = false) |
|
| 962 | - { |
|
| 963 | - /** @type EEM_Price $EEM_Price */ |
|
| 964 | - $EEM_Price = EE_Registry::instance()->load_model('Price'); |
|
| 965 | - // get array of taxes via Price Model |
|
| 966 | - $ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes(); |
|
| 967 | - ksort($ordered_taxes); |
|
| 968 | - $taxes_line_item = self::get_taxes_subtotal($total_line_item); |
|
| 969 | - // just to be safe, remove its old tax line items |
|
| 970 | - $deleted = $taxes_line_item->delete_children_line_items(); |
|
| 971 | - $updates = false; |
|
| 972 | - // loop thru taxes |
|
| 973 | - foreach ($ordered_taxes as $order => $taxes) { |
|
| 974 | - foreach ($taxes as $tax) { |
|
| 975 | - if ($tax instanceof EE_Price) { |
|
| 976 | - $tax_line_item = EE_Line_Item::new_instance( |
|
| 977 | - array( |
|
| 978 | - 'LIN_name' => $tax->name(), |
|
| 979 | - 'LIN_desc' => $tax->desc(), |
|
| 980 | - 'LIN_percent' => $tax->amount(), |
|
| 981 | - 'LIN_is_taxable' => false, |
|
| 982 | - 'LIN_order' => $order, |
|
| 983 | - 'LIN_total' => 0, |
|
| 984 | - 'LIN_type' => EEM_Line_Item::type_tax, |
|
| 985 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
| 986 | - 'OBJ_ID' => $tax->ID(), |
|
| 987 | - ) |
|
| 988 | - ); |
|
| 989 | - $tax_line_item = apply_filters( |
|
| 990 | - 'FHEE__EEH_Line_Item__apply_taxes__tax_line_item', |
|
| 991 | - $tax_line_item |
|
| 992 | - ); |
|
| 993 | - $updates = $taxes_line_item->add_child_line_item($tax_line_item) ? |
|
| 994 | - true : |
|
| 995 | - $updates; |
|
| 996 | - } |
|
| 997 | - } |
|
| 998 | - } |
|
| 999 | - // only recalculate totals if something changed |
|
| 1000 | - if ($deleted || $updates) { |
|
| 1001 | - $total_line_item->recalculate_total_including_taxes($update_txn_status); |
|
| 1002 | - return true; |
|
| 1003 | - } |
|
| 1004 | - return false; |
|
| 1005 | - } |
|
| 1006 | - |
|
| 1007 | - |
|
| 1008 | - /** |
|
| 1009 | - * Ensures that taxes have been applied to the order, if not applies them. |
|
| 1010 | - * Returns the total amount of tax |
|
| 1011 | - * |
|
| 1012 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 1013 | - * @return float |
|
| 1014 | - * @throws EE_Error |
|
| 1015 | - * @throws InvalidArgumentException |
|
| 1016 | - * @throws InvalidDataTypeException |
|
| 1017 | - * @throws InvalidInterfaceException |
|
| 1018 | - * @throws ReflectionException |
|
| 1019 | - */ |
|
| 1020 | - public static function ensure_taxes_applied($total_line_item) |
|
| 1021 | - { |
|
| 1022 | - $taxes_subtotal = self::get_taxes_subtotal($total_line_item); |
|
| 1023 | - if (! $taxes_subtotal->children()) { |
|
| 1024 | - self::apply_taxes($total_line_item); |
|
| 1025 | - } |
|
| 1026 | - return $taxes_subtotal->total(); |
|
| 1027 | - } |
|
| 1028 | - |
|
| 1029 | - |
|
| 1030 | - /** |
|
| 1031 | - * Deletes ALL children of the passed line item |
|
| 1032 | - * |
|
| 1033 | - * @param EE_Line_Item $parent_line_item |
|
| 1034 | - * @return bool |
|
| 1035 | - * @throws EE_Error |
|
| 1036 | - * @throws InvalidArgumentException |
|
| 1037 | - * @throws InvalidDataTypeException |
|
| 1038 | - * @throws InvalidInterfaceException |
|
| 1039 | - * @throws ReflectionException |
|
| 1040 | - */ |
|
| 1041 | - public static function delete_all_child_items(EE_Line_Item $parent_line_item) |
|
| 1042 | - { |
|
| 1043 | - $deleted = 0; |
|
| 1044 | - foreach ($parent_line_item->children() as $child_line_item) { |
|
| 1045 | - if ($child_line_item instanceof EE_Line_Item) { |
|
| 1046 | - $deleted += EEH_Line_Item::delete_all_child_items($child_line_item); |
|
| 1047 | - if ($child_line_item->ID()) { |
|
| 1048 | - $child_line_item->delete(); |
|
| 1049 | - unset($child_line_item); |
|
| 1050 | - } else { |
|
| 1051 | - $parent_line_item->delete_child_line_item($child_line_item->code()); |
|
| 1052 | - } |
|
| 1053 | - $deleted++; |
|
| 1054 | - } |
|
| 1055 | - } |
|
| 1056 | - return $deleted; |
|
| 1057 | - } |
|
| 1058 | - |
|
| 1059 | - |
|
| 1060 | - /** |
|
| 1061 | - * Deletes the line items as indicated by the line item code(s) provided, |
|
| 1062 | - * regardless of where they're found in the line item tree. Automatically |
|
| 1063 | - * re-calculates the line item totals and updates the related transaction. But |
|
| 1064 | - * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 1065 | - * should probably change because of this). |
|
| 1066 | - * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 1067 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 1068 | - * |
|
| 1069 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 1070 | - * @param array|bool|string $line_item_codes |
|
| 1071 | - * @return int number of items successfully removed |
|
| 1072 | - * @throws EE_Error |
|
| 1073 | - */ |
|
| 1074 | - public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false) |
|
| 1075 | - { |
|
| 1076 | - |
|
| 1077 | - if ($total_line_item->type() !== EEM_Line_Item::type_total) { |
|
| 1078 | - EE_Error::doing_it_wrong( |
|
| 1079 | - 'EEH_Line_Item::delete_items', |
|
| 1080 | - esc_html__( |
|
| 1081 | - 'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly', |
|
| 1082 | - 'event_espresso' |
|
| 1083 | - ), |
|
| 1084 | - '4.6.18' |
|
| 1085 | - ); |
|
| 1086 | - } |
|
| 1087 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 1088 | - |
|
| 1089 | - // check if only a single line_item_id was passed |
|
| 1090 | - if (! empty($line_item_codes) && ! is_array($line_item_codes)) { |
|
| 1091 | - // place single line_item_id in an array to appear as multiple line_item_ids |
|
| 1092 | - $line_item_codes = array($line_item_codes); |
|
| 1093 | - } |
|
| 1094 | - $removals = 0; |
|
| 1095 | - // cycle thru line_item_ids |
|
| 1096 | - foreach ($line_item_codes as $line_item_id) { |
|
| 1097 | - $removals += $total_line_item->delete_child_line_item($line_item_id); |
|
| 1098 | - } |
|
| 1099 | - |
|
| 1100 | - if ($removals > 0) { |
|
| 1101 | - $total_line_item->recalculate_taxes_and_tax_total(); |
|
| 1102 | - return $removals; |
|
| 1103 | - } else { |
|
| 1104 | - return false; |
|
| 1105 | - } |
|
| 1106 | - } |
|
| 1107 | - |
|
| 1108 | - |
|
| 1109 | - /** |
|
| 1110 | - * Overwrites the previous tax by clearing out the old taxes, and creates a new |
|
| 1111 | - * tax and updates the total line item accordingly |
|
| 1112 | - * |
|
| 1113 | - * @param EE_Line_Item $total_line_item |
|
| 1114 | - * @param float $amount |
|
| 1115 | - * @param string $name |
|
| 1116 | - * @param string $description |
|
| 1117 | - * @param string $code |
|
| 1118 | - * @param boolean $add_to_existing_line_item |
|
| 1119 | - * if true, and a duplicate line item with the same code is found, |
|
| 1120 | - * $amount will be added onto it; otherwise will simply set the taxes to match $amount |
|
| 1121 | - * @return EE_Line_Item the new tax line item created |
|
| 1122 | - * @throws EE_Error |
|
| 1123 | - * @throws InvalidArgumentException |
|
| 1124 | - * @throws InvalidDataTypeException |
|
| 1125 | - * @throws InvalidInterfaceException |
|
| 1126 | - * @throws ReflectionException |
|
| 1127 | - */ |
|
| 1128 | - public static function set_total_tax_to( |
|
| 1129 | - EE_Line_Item $total_line_item, |
|
| 1130 | - $amount, |
|
| 1131 | - $name = null, |
|
| 1132 | - $description = null, |
|
| 1133 | - $code = null, |
|
| 1134 | - $add_to_existing_line_item = false |
|
| 1135 | - ) { |
|
| 1136 | - $tax_subtotal = self::get_taxes_subtotal($total_line_item); |
|
| 1137 | - $taxable_total = $total_line_item->taxable_total(); |
|
| 1138 | - |
|
| 1139 | - if ($add_to_existing_line_item) { |
|
| 1140 | - $new_tax = $tax_subtotal->get_child_line_item($code); |
|
| 1141 | - EEM_Line_Item::instance()->delete( |
|
| 1142 | - array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID())) |
|
| 1143 | - ); |
|
| 1144 | - } else { |
|
| 1145 | - $new_tax = null; |
|
| 1146 | - $tax_subtotal->delete_children_line_items(); |
|
| 1147 | - } |
|
| 1148 | - if ($new_tax) { |
|
| 1149 | - $new_tax->set_total($new_tax->total() + $amount); |
|
| 1150 | - $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0); |
|
| 1151 | - } else { |
|
| 1152 | - // no existing tax item. Create it |
|
| 1153 | - $new_tax = EE_Line_Item::new_instance(array( |
|
| 1154 | - 'TXN_ID' => $total_line_item->TXN_ID(), |
|
| 1155 | - 'LIN_name' => $name ? $name : esc_html__('Tax', 'event_espresso'), |
|
| 1156 | - 'LIN_desc' => $description ? $description : '', |
|
| 1157 | - 'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0, |
|
| 1158 | - 'LIN_total' => $amount, |
|
| 1159 | - 'LIN_parent' => $tax_subtotal->ID(), |
|
| 1160 | - 'LIN_type' => EEM_Line_Item::type_tax, |
|
| 1161 | - 'LIN_code' => $code, |
|
| 1162 | - )); |
|
| 1163 | - } |
|
| 1164 | - |
|
| 1165 | - $new_tax = apply_filters( |
|
| 1166 | - 'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal', |
|
| 1167 | - $new_tax, |
|
| 1168 | - $total_line_item |
|
| 1169 | - ); |
|
| 1170 | - $new_tax->save(); |
|
| 1171 | - $tax_subtotal->set_total($new_tax->total()); |
|
| 1172 | - $tax_subtotal->save(); |
|
| 1173 | - $total_line_item->recalculate_total_including_taxes(); |
|
| 1174 | - return $new_tax; |
|
| 1175 | - } |
|
| 1176 | - |
|
| 1177 | - |
|
| 1178 | - /** |
|
| 1179 | - * Makes all the line items which are children of $line_item taxable (or not). |
|
| 1180 | - * Does NOT save the line items |
|
| 1181 | - * |
|
| 1182 | - * @param EE_Line_Item $line_item |
|
| 1183 | - * @param boolean $taxable |
|
| 1184 | - * @param string $code_substring_for_whitelist if this string is part of the line item's code |
|
| 1185 | - * it will be whitelisted (ie, except from becoming taxable) |
|
| 1186 | - * @throws EE_Error |
|
| 1187 | - */ |
|
| 1188 | - public static function set_line_items_taxable( |
|
| 1189 | - EE_Line_Item $line_item, |
|
| 1190 | - $taxable = true, |
|
| 1191 | - $code_substring_for_whitelist = null |
|
| 1192 | - ) { |
|
| 1193 | - $whitelisted = false; |
|
| 1194 | - if ($code_substring_for_whitelist !== null) { |
|
| 1195 | - $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false; |
|
| 1196 | - } |
|
| 1197 | - if (! $whitelisted && $line_item->is_line_item()) { |
|
| 1198 | - $line_item->set_is_taxable($taxable); |
|
| 1199 | - } |
|
| 1200 | - foreach ($line_item->children() as $child_line_item) { |
|
| 1201 | - EEH_Line_Item::set_line_items_taxable( |
|
| 1202 | - $child_line_item, |
|
| 1203 | - $taxable, |
|
| 1204 | - $code_substring_for_whitelist |
|
| 1205 | - ); |
|
| 1206 | - } |
|
| 1207 | - } |
|
| 1208 | - |
|
| 1209 | - |
|
| 1210 | - /** |
|
| 1211 | - * Gets all descendants that are event subtotals |
|
| 1212 | - * |
|
| 1213 | - * @uses EEH_Line_Item::get_subtotals_of_object_type() |
|
| 1214 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1215 | - * @return EE_Line_Item[] |
|
| 1216 | - * @throws EE_Error |
|
| 1217 | - */ |
|
| 1218 | - public static function get_event_subtotals(EE_Line_Item $parent_line_item) |
|
| 1219 | - { |
|
| 1220 | - return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT); |
|
| 1221 | - } |
|
| 1222 | - |
|
| 1223 | - |
|
| 1224 | - /** |
|
| 1225 | - * Gets all descendants subtotals that match the supplied object type |
|
| 1226 | - * |
|
| 1227 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1228 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1229 | - * @param string $obj_type |
|
| 1230 | - * @return EE_Line_Item[] |
|
| 1231 | - * @throws EE_Error |
|
| 1232 | - */ |
|
| 1233 | - public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
| 1234 | - { |
|
| 1235 | - return self::_get_descendants_by_type_and_object_type( |
|
| 1236 | - $parent_line_item, |
|
| 1237 | - EEM_Line_Item::type_sub_total, |
|
| 1238 | - $obj_type |
|
| 1239 | - ); |
|
| 1240 | - } |
|
| 1241 | - |
|
| 1242 | - |
|
| 1243 | - /** |
|
| 1244 | - * Gets all descendants that are tickets |
|
| 1245 | - * |
|
| 1246 | - * @uses EEH_Line_Item::get_line_items_of_object_type() |
|
| 1247 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1248 | - * @return EE_Line_Item[] |
|
| 1249 | - * @throws EE_Error |
|
| 1250 | - */ |
|
| 1251 | - public static function get_ticket_line_items(EE_Line_Item $parent_line_item) |
|
| 1252 | - { |
|
| 1253 | - return self::get_line_items_of_object_type( |
|
| 1254 | - $parent_line_item, |
|
| 1255 | - EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1256 | - ); |
|
| 1257 | - } |
|
| 1258 | - |
|
| 1259 | - |
|
| 1260 | - /** |
|
| 1261 | - * Gets all descendants subtotals that match the supplied object type |
|
| 1262 | - * |
|
| 1263 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1264 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1265 | - * @param string $obj_type |
|
| 1266 | - * @return EE_Line_Item[] |
|
| 1267 | - * @throws EE_Error |
|
| 1268 | - */ |
|
| 1269 | - public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
| 1270 | - { |
|
| 1271 | - return self::_get_descendants_by_type_and_object_type( |
|
| 1272 | - $parent_line_item, |
|
| 1273 | - EEM_Line_Item::type_line_item, |
|
| 1274 | - $obj_type |
|
| 1275 | - ); |
|
| 1276 | - } |
|
| 1277 | - |
|
| 1278 | - |
|
| 1279 | - /** |
|
| 1280 | - * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax' |
|
| 1281 | - * |
|
| 1282 | - * @uses EEH_Line_Item::get_descendants_of_type() |
|
| 1283 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1284 | - * @return EE_Line_Item[] |
|
| 1285 | - * @throws EE_Error |
|
| 1286 | - */ |
|
| 1287 | - public static function get_tax_descendants(EE_Line_Item $parent_line_item) |
|
| 1288 | - { |
|
| 1289 | - return EEH_Line_Item::get_descendants_of_type( |
|
| 1290 | - $parent_line_item, |
|
| 1291 | - EEM_Line_Item::type_tax |
|
| 1292 | - ); |
|
| 1293 | - } |
|
| 1294 | - |
|
| 1295 | - |
|
| 1296 | - /** |
|
| 1297 | - * Gets all the real items purchased which are children of this item |
|
| 1298 | - * |
|
| 1299 | - * @uses EEH_Line_Item::get_descendants_of_type() |
|
| 1300 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1301 | - * @return EE_Line_Item[] |
|
| 1302 | - * @throws EE_Error |
|
| 1303 | - */ |
|
| 1304 | - public static function get_line_item_descendants(EE_Line_Item $parent_line_item) |
|
| 1305 | - { |
|
| 1306 | - return EEH_Line_Item::get_descendants_of_type( |
|
| 1307 | - $parent_line_item, |
|
| 1308 | - EEM_Line_Item::type_line_item |
|
| 1309 | - ); |
|
| 1310 | - } |
|
| 1311 | - |
|
| 1312 | - |
|
| 1313 | - /** |
|
| 1314 | - * Gets all descendants of supplied line item that match the supplied line item type |
|
| 1315 | - * |
|
| 1316 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1317 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1318 | - * @param string $line_item_type one of the EEM_Line_Item constants |
|
| 1319 | - * @return EE_Line_Item[] |
|
| 1320 | - * @throws EE_Error |
|
| 1321 | - */ |
|
| 1322 | - public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type) |
|
| 1323 | - { |
|
| 1324 | - return self::_get_descendants_by_type_and_object_type( |
|
| 1325 | - $parent_line_item, |
|
| 1326 | - $line_item_type, |
|
| 1327 | - null |
|
| 1328 | - ); |
|
| 1329 | - } |
|
| 1330 | - |
|
| 1331 | - |
|
| 1332 | - /** |
|
| 1333 | - * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
| 1334 | - * as well |
|
| 1335 | - * |
|
| 1336 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1337 | - * @param string $line_item_type one of the EEM_Line_Item constants |
|
| 1338 | - * @param string | NULL $obj_type object model class name (minus prefix) or NULL to ignore object type when |
|
| 1339 | - * searching |
|
| 1340 | - * @return EE_Line_Item[] |
|
| 1341 | - * @throws EE_Error |
|
| 1342 | - */ |
|
| 1343 | - protected static function _get_descendants_by_type_and_object_type( |
|
| 1344 | - EE_Line_Item $parent_line_item, |
|
| 1345 | - $line_item_type, |
|
| 1346 | - $obj_type = null |
|
| 1347 | - ) { |
|
| 1348 | - $objects = array(); |
|
| 1349 | - foreach ($parent_line_item->children() as $child_line_item) { |
|
| 1350 | - if ($child_line_item instanceof EE_Line_Item) { |
|
| 1351 | - if ($child_line_item->type() === $line_item_type |
|
| 1352 | - && ( |
|
| 1353 | - $child_line_item->OBJ_type() === $obj_type || $obj_type === null |
|
| 1354 | - ) |
|
| 1355 | - ) { |
|
| 1356 | - $objects[] = $child_line_item; |
|
| 1357 | - } else { |
|
| 1358 | - // go-through-all-its children looking for more matches |
|
| 1359 | - $objects = array_merge( |
|
| 1360 | - $objects, |
|
| 1361 | - self::_get_descendants_by_type_and_object_type( |
|
| 1362 | - $child_line_item, |
|
| 1363 | - $line_item_type, |
|
| 1364 | - $obj_type |
|
| 1365 | - ) |
|
| 1366 | - ); |
|
| 1367 | - } |
|
| 1368 | - } |
|
| 1369 | - } |
|
| 1370 | - return $objects; |
|
| 1371 | - } |
|
| 1372 | - |
|
| 1373 | - |
|
| 1374 | - /** |
|
| 1375 | - * Gets all descendants subtotals that match the supplied object type |
|
| 1376 | - * |
|
| 1377 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1378 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1379 | - * @param string $OBJ_type object type (like Event) |
|
| 1380 | - * @param array $OBJ_IDs array of OBJ_IDs |
|
| 1381 | - * @return EE_Line_Item[] |
|
| 1382 | - * @throws EE_Error |
|
| 1383 | - */ |
|
| 1384 | - public static function get_line_items_by_object_type_and_IDs( |
|
| 1385 | - EE_Line_Item $parent_line_item, |
|
| 1386 | - $OBJ_type = '', |
|
| 1387 | - $OBJ_IDs = array() |
|
| 1388 | - ) { |
|
| 1389 | - return self::_get_descendants_by_object_type_and_object_ID( |
|
| 1390 | - $parent_line_item, |
|
| 1391 | - $OBJ_type, |
|
| 1392 | - $OBJ_IDs |
|
| 1393 | - ); |
|
| 1394 | - } |
|
| 1395 | - |
|
| 1396 | - |
|
| 1397 | - /** |
|
| 1398 | - * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
| 1399 | - * as well |
|
| 1400 | - * |
|
| 1401 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1402 | - * @param string $OBJ_type object type (like Event) |
|
| 1403 | - * @param array $OBJ_IDs array of OBJ_IDs |
|
| 1404 | - * @return EE_Line_Item[] |
|
| 1405 | - * @throws EE_Error |
|
| 1406 | - */ |
|
| 1407 | - protected static function _get_descendants_by_object_type_and_object_ID( |
|
| 1408 | - EE_Line_Item $parent_line_item, |
|
| 1409 | - $OBJ_type, |
|
| 1410 | - $OBJ_IDs |
|
| 1411 | - ) { |
|
| 1412 | - $objects = array(); |
|
| 1413 | - foreach ($parent_line_item->children() as $child_line_item) { |
|
| 1414 | - if ($child_line_item instanceof EE_Line_Item) { |
|
| 1415 | - if ($child_line_item->OBJ_type() === $OBJ_type |
|
| 1416 | - && is_array($OBJ_IDs) |
|
| 1417 | - && in_array($child_line_item->OBJ_ID(), $OBJ_IDs) |
|
| 1418 | - ) { |
|
| 1419 | - $objects[] = $child_line_item; |
|
| 1420 | - } else { |
|
| 1421 | - // go-through-all-its children looking for more matches |
|
| 1422 | - $objects = array_merge( |
|
| 1423 | - $objects, |
|
| 1424 | - self::_get_descendants_by_object_type_and_object_ID( |
|
| 1425 | - $child_line_item, |
|
| 1426 | - $OBJ_type, |
|
| 1427 | - $OBJ_IDs |
|
| 1428 | - ) |
|
| 1429 | - ); |
|
| 1430 | - } |
|
| 1431 | - } |
|
| 1432 | - } |
|
| 1433 | - return $objects; |
|
| 1434 | - } |
|
| 1435 | - |
|
| 1436 | - |
|
| 1437 | - /** |
|
| 1438 | - * Uses a breadth-first-search in order to find the nearest descendant of |
|
| 1439 | - * the specified type and returns it, else NULL |
|
| 1440 | - * |
|
| 1441 | - * @uses EEH_Line_Item::_get_nearest_descendant() |
|
| 1442 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1443 | - * @param string $type like one of the EEM_Line_Item::type_* |
|
| 1444 | - * @return EE_Line_Item |
|
| 1445 | - * @throws EE_Error |
|
| 1446 | - * @throws InvalidArgumentException |
|
| 1447 | - * @throws InvalidDataTypeException |
|
| 1448 | - * @throws InvalidInterfaceException |
|
| 1449 | - * @throws ReflectionException |
|
| 1450 | - */ |
|
| 1451 | - public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type) |
|
| 1452 | - { |
|
| 1453 | - return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type); |
|
| 1454 | - } |
|
| 1455 | - |
|
| 1456 | - |
|
| 1457 | - /** |
|
| 1458 | - * Uses a breadth-first-search in order to find the nearest descendant |
|
| 1459 | - * having the specified LIN_code and returns it, else NULL |
|
| 1460 | - * |
|
| 1461 | - * @uses EEH_Line_Item::_get_nearest_descendant() |
|
| 1462 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1463 | - * @param string $code any value used for LIN_code |
|
| 1464 | - * @return EE_Line_Item |
|
| 1465 | - * @throws EE_Error |
|
| 1466 | - * @throws InvalidArgumentException |
|
| 1467 | - * @throws InvalidDataTypeException |
|
| 1468 | - * @throws InvalidInterfaceException |
|
| 1469 | - * @throws ReflectionException |
|
| 1470 | - */ |
|
| 1471 | - public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code) |
|
| 1472 | - { |
|
| 1473 | - return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code); |
|
| 1474 | - } |
|
| 1475 | - |
|
| 1476 | - |
|
| 1477 | - /** |
|
| 1478 | - * Uses a breadth-first-search in order to find the nearest descendant |
|
| 1479 | - * having the specified LIN_code and returns it, else NULL |
|
| 1480 | - * |
|
| 1481 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1482 | - * @param string $search_field name of EE_Line_Item property |
|
| 1483 | - * @param string $value any value stored in $search_field |
|
| 1484 | - * @return EE_Line_Item |
|
| 1485 | - * @throws EE_Error |
|
| 1486 | - * @throws InvalidArgumentException |
|
| 1487 | - * @throws InvalidDataTypeException |
|
| 1488 | - * @throws InvalidInterfaceException |
|
| 1489 | - * @throws ReflectionException |
|
| 1490 | - */ |
|
| 1491 | - protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value) |
|
| 1492 | - { |
|
| 1493 | - foreach ($parent_line_item->children() as $child) { |
|
| 1494 | - if ($child->get($search_field) == $value) { |
|
| 1495 | - return $child; |
|
| 1496 | - } |
|
| 1497 | - } |
|
| 1498 | - foreach ($parent_line_item->children() as $child) { |
|
| 1499 | - $descendant_found = self::_get_nearest_descendant( |
|
| 1500 | - $child, |
|
| 1501 | - $search_field, |
|
| 1502 | - $value |
|
| 1503 | - ); |
|
| 1504 | - if ($descendant_found) { |
|
| 1505 | - return $descendant_found; |
|
| 1506 | - } |
|
| 1507 | - } |
|
| 1508 | - return null; |
|
| 1509 | - } |
|
| 1510 | - |
|
| 1511 | - |
|
| 1512 | - /** |
|
| 1513 | - * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction, |
|
| 1514 | - * else recursively walks up the line item tree until a parent of type total is found, |
|
| 1515 | - * |
|
| 1516 | - * @param EE_Line_Item $line_item |
|
| 1517 | - * @return EE_Line_Item |
|
| 1518 | - * @throws EE_Error |
|
| 1519 | - */ |
|
| 1520 | - public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item) |
|
| 1521 | - { |
|
| 1522 | - if ($line_item->TXN_ID()) { |
|
| 1523 | - $total_line_item = $line_item->transaction()->total_line_item(false); |
|
| 1524 | - if ($total_line_item instanceof EE_Line_Item) { |
|
| 1525 | - return $total_line_item; |
|
| 1526 | - } |
|
| 1527 | - } else { |
|
| 1528 | - $line_item_parent = $line_item->parent(); |
|
| 1529 | - if ($line_item_parent instanceof EE_Line_Item) { |
|
| 1530 | - if ($line_item_parent->is_total()) { |
|
| 1531 | - return $line_item_parent; |
|
| 1532 | - } |
|
| 1533 | - return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent); |
|
| 1534 | - } |
|
| 1535 | - } |
|
| 1536 | - throw new EE_Error( |
|
| 1537 | - sprintf( |
|
| 1538 | - esc_html__( |
|
| 1539 | - 'A valid grand total for line item %1$d was not found.', |
|
| 1540 | - 'event_espresso' |
|
| 1541 | - ), |
|
| 1542 | - $line_item->ID() |
|
| 1543 | - ) |
|
| 1544 | - ); |
|
| 1545 | - } |
|
| 1546 | - |
|
| 1547 | - |
|
| 1548 | - /** |
|
| 1549 | - * Prints out a representation of the line item tree |
|
| 1550 | - * |
|
| 1551 | - * @param EE_Line_Item $line_item |
|
| 1552 | - * @param int $indentation |
|
| 1553 | - * @return void |
|
| 1554 | - * @throws EE_Error |
|
| 1555 | - */ |
|
| 1556 | - public static function visualize(EE_Line_Item $line_item, $indentation = 0) |
|
| 1557 | - { |
|
| 1558 | - echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
| 1559 | - if (! $indentation) { |
|
| 1560 | - echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
| 1561 | - } |
|
| 1562 | - for ($i = 0; $i < $indentation; $i++) { |
|
| 1563 | - echo '. '; |
|
| 1564 | - } |
|
| 1565 | - $breakdown = ''; |
|
| 1566 | - if ($line_item->is_line_item()) { |
|
| 1567 | - if ($line_item->is_percent()) { |
|
| 1568 | - $breakdown = "{$line_item->percent()}%"; |
|
| 1569 | - } else { |
|
| 1570 | - $breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}"; |
|
| 1571 | - } |
|
| 1572 | - } |
|
| 1573 | - echo $line_item->name(); |
|
| 1574 | - echo " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : "; |
|
| 1575 | - echo '$' . (string) $line_item->total(); |
|
| 1576 | - if ($breakdown) { |
|
| 1577 | - echo " ( {$breakdown} )"; |
|
| 1578 | - } |
|
| 1579 | - if ($line_item->is_taxable()) { |
|
| 1580 | - echo ' * taxable'; |
|
| 1581 | - } |
|
| 1582 | - if ($line_item->children()) { |
|
| 1583 | - foreach ($line_item->children() as $child) { |
|
| 1584 | - self::visualize($child, $indentation + 1); |
|
| 1585 | - } |
|
| 1586 | - } |
|
| 1587 | - } |
|
| 1588 | - |
|
| 1589 | - |
|
| 1590 | - /** |
|
| 1591 | - * Calculates the registration's final price, taking into account that they |
|
| 1592 | - * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes, |
|
| 1593 | - * and receive a portion of any transaction-wide discounts. |
|
| 1594 | - * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount |
|
| 1595 | - * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get |
|
| 1596 | - * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50 |
|
| 1597 | - * and brent's final price should be $5.50. |
|
| 1598 | - * In order to do this, we basically need to traverse the line item tree calculating |
|
| 1599 | - * the running totals (just as if we were recalculating the total), but when we identify |
|
| 1600 | - * regular line items, we need to keep track of their share of the grand total. |
|
| 1601 | - * Also, we need to keep track of the TAXABLE total for each ticket purchase, so |
|
| 1602 | - * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total" |
|
| 1603 | - * when there are non-taxable items; otherwise they would be the same) |
|
| 1604 | - * |
|
| 1605 | - * @param EE_Line_Item $line_item |
|
| 1606 | - * @param array $billable_ticket_quantities array of EE_Ticket IDs and their corresponding quantity that |
|
| 1607 | - * can be included in price calculations at this moment |
|
| 1608 | - * @return array keys are line items for tickets IDs and values are their share of the running total, |
|
| 1609 | - * plus the key 'total', and 'taxable' which also has keys of all |
|
| 1610 | - * the ticket IDs. |
|
| 1611 | - * Eg array( |
|
| 1612 | - * 12 => 4.3 |
|
| 1613 | - * 23 => 8.0 |
|
| 1614 | - * 'total' => 16.6, |
|
| 1615 | - * 'taxable' => array( |
|
| 1616 | - * 12 => 10, |
|
| 1617 | - * 23 => 4 |
|
| 1618 | - * ). |
|
| 1619 | - * So to find which registrations have which final price, we need |
|
| 1620 | - * to find which line item is theirs, which can be done with |
|
| 1621 | - * `EEM_Line_Item::instance()->get_line_item_for_registration( |
|
| 1622 | - * $registration );` |
|
| 1623 | - * @throws EE_Error |
|
| 1624 | - * @throws InvalidArgumentException |
|
| 1625 | - * @throws InvalidDataTypeException |
|
| 1626 | - * @throws InvalidInterfaceException |
|
| 1627 | - * @throws ReflectionException |
|
| 1628 | - */ |
|
| 1629 | - public static function calculate_reg_final_prices_per_line_item( |
|
| 1630 | - EE_Line_Item $line_item, |
|
| 1631 | - $billable_ticket_quantities = array() |
|
| 1632 | - ) { |
|
| 1633 | - $running_totals = [ |
|
| 1634 | - 'total' => 0, |
|
| 1635 | - 'taxable' => ['total' => 0] |
|
| 1636 | - ]; |
|
| 1637 | - foreach ($line_item->children() as $child_line_item) { |
|
| 1638 | - switch ($child_line_item->type()) { |
|
| 1639 | - case EEM_Line_Item::type_sub_total: |
|
| 1640 | - $running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
| 1641 | - $child_line_item, |
|
| 1642 | - $billable_ticket_quantities |
|
| 1643 | - ); |
|
| 1644 | - // combine arrays but preserve numeric keys |
|
| 1645 | - $running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals); |
|
| 1646 | - $running_totals['total'] += $running_totals_from_subtotal['total']; |
|
| 1647 | - $running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total']; |
|
| 1648 | - break; |
|
| 1649 | - |
|
| 1650 | - case EEM_Line_Item::type_tax_sub_total: |
|
| 1651 | - // find how much the taxes percentage is |
|
| 1652 | - if ($child_line_item->percent() !== 0) { |
|
| 1653 | - $tax_percent_decimal = $child_line_item->percent() / 100; |
|
| 1654 | - } else { |
|
| 1655 | - $tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100; |
|
| 1656 | - } |
|
| 1657 | - // and apply to all the taxable totals, and add to the pretax totals |
|
| 1658 | - foreach ($running_totals as $line_item_id => $this_running_total) { |
|
| 1659 | - // "total" and "taxable" array key is an exception |
|
| 1660 | - if ($line_item_id === 'taxable') { |
|
| 1661 | - continue; |
|
| 1662 | - } |
|
| 1663 | - $taxable_total = $running_totals['taxable'][ $line_item_id ]; |
|
| 1664 | - $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal); |
|
| 1665 | - } |
|
| 1666 | - break; |
|
| 1667 | - |
|
| 1668 | - case EEM_Line_Item::type_line_item: |
|
| 1669 | - // ticket line items or ???? |
|
| 1670 | - if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 1671 | - // kk it's a ticket |
|
| 1672 | - if (isset($running_totals[ $child_line_item->ID() ])) { |
|
| 1673 | - // huh? that shouldn't happen. |
|
| 1674 | - $running_totals['total'] += $child_line_item->total(); |
|
| 1675 | - } else { |
|
| 1676 | - // its not in our running totals yet. great. |
|
| 1677 | - if ($child_line_item->is_taxable()) { |
|
| 1678 | - $taxable_amount = $child_line_item->unit_price(); |
|
| 1679 | - } else { |
|
| 1680 | - $taxable_amount = 0; |
|
| 1681 | - } |
|
| 1682 | - // are we only calculating totals for some tickets? |
|
| 1683 | - if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) { |
|
| 1684 | - $quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ]; |
|
| 1685 | - $running_totals[ $child_line_item->ID() ] = $quantity |
|
| 1686 | - ? $child_line_item->unit_price() |
|
| 1687 | - : 0; |
|
| 1688 | - $running_totals['taxable'][ $child_line_item->ID() ] = $quantity |
|
| 1689 | - ? $taxable_amount |
|
| 1690 | - : 0; |
|
| 1691 | - } else { |
|
| 1692 | - $quantity = $child_line_item->quantity(); |
|
| 1693 | - $running_totals[ $child_line_item->ID() ] = $child_line_item->unit_price(); |
|
| 1694 | - $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount; |
|
| 1695 | - } |
|
| 1696 | - $running_totals['taxable']['total'] += $taxable_amount * $quantity; |
|
| 1697 | - $running_totals['total'] += $child_line_item->unit_price() * $quantity; |
|
| 1698 | - } |
|
| 1699 | - } else { |
|
| 1700 | - // it's some other type of item added to the cart |
|
| 1701 | - // it should affect the running totals |
|
| 1702 | - // basically we want to convert it into a PERCENT modifier. Because |
|
| 1703 | - // more clearly affect all registration's final price equally |
|
| 1704 | - $line_items_percent_of_running_total = $running_totals['total'] > 0 |
|
| 1705 | - ? ($child_line_item->total() / $running_totals['total']) + 1 |
|
| 1706 | - : 1; |
|
| 1707 | - foreach ($running_totals as $line_item_id => $this_running_total) { |
|
| 1708 | - // the "taxable" array key is an exception |
|
| 1709 | - if ($line_item_id === 'taxable') { |
|
| 1710 | - continue; |
|
| 1711 | - } |
|
| 1712 | - // update the running totals |
|
| 1713 | - // yes this actually even works for the running grand total! |
|
| 1714 | - $running_totals[ $line_item_id ] = |
|
| 1715 | - $line_items_percent_of_running_total * $this_running_total; |
|
| 1716 | - |
|
| 1717 | - if ($child_line_item->is_taxable()) { |
|
| 1718 | - $running_totals['taxable'][ $line_item_id ] = |
|
| 1719 | - $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ]; |
|
| 1720 | - } |
|
| 1721 | - } |
|
| 1722 | - } |
|
| 1723 | - break; |
|
| 1724 | - } |
|
| 1725 | - } |
|
| 1726 | - return $running_totals; |
|
| 1727 | - } |
|
| 1728 | - |
|
| 1729 | - |
|
| 1730 | - /** |
|
| 1731 | - * @param EE_Line_Item $total_line_item |
|
| 1732 | - * @param EE_Line_Item $ticket_line_item |
|
| 1733 | - * @return float | null |
|
| 1734 | - * @throws EE_Error |
|
| 1735 | - * @throws InvalidArgumentException |
|
| 1736 | - * @throws InvalidDataTypeException |
|
| 1737 | - * @throws InvalidInterfaceException |
|
| 1738 | - * @throws OutOfRangeException |
|
| 1739 | - * @throws ReflectionException |
|
| 1740 | - */ |
|
| 1741 | - public static function calculate_final_price_for_ticket_line_item( |
|
| 1742 | - EE_Line_Item $total_line_item, |
|
| 1743 | - EE_Line_Item $ticket_line_item |
|
| 1744 | - ) { |
|
| 1745 | - static $final_prices_per_ticket_line_item = array(); |
|
| 1746 | - if (empty($final_prices_per_ticket_line_item)) { |
|
| 1747 | - $final_prices_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
| 1748 | - $total_line_item |
|
| 1749 | - ); |
|
| 1750 | - } |
|
| 1751 | - // ok now find this new registration's final price |
|
| 1752 | - if (isset($final_prices_per_ticket_line_item[ $ticket_line_item->ID() ])) { |
|
| 1753 | - return $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ]; |
|
| 1754 | - } |
|
| 1755 | - $message = sprintf( |
|
| 1756 | - esc_html__( |
|
| 1757 | - 'The final price for the ticket line item (ID:%1$d) could not be calculated.', |
|
| 1758 | - 'event_espresso' |
|
| 1759 | - ), |
|
| 1760 | - $ticket_line_item->ID() |
|
| 1761 | - ); |
|
| 1762 | - if (WP_DEBUG) { |
|
| 1763 | - $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true); |
|
| 1764 | - throw new OutOfRangeException($message); |
|
| 1765 | - } |
|
| 1766 | - EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message); |
|
| 1767 | - return null; |
|
| 1768 | - } |
|
| 1769 | - |
|
| 1770 | - |
|
| 1771 | - /** |
|
| 1772 | - * Creates a duplicate of the line item tree, except only includes billable items |
|
| 1773 | - * and the portion of line items attributed to billable things |
|
| 1774 | - * |
|
| 1775 | - * @param EE_Line_Item $line_item |
|
| 1776 | - * @param EE_Registration[] $registrations |
|
| 1777 | - * @return EE_Line_Item |
|
| 1778 | - * @throws EE_Error |
|
| 1779 | - * @throws InvalidArgumentException |
|
| 1780 | - * @throws InvalidDataTypeException |
|
| 1781 | - * @throws InvalidInterfaceException |
|
| 1782 | - * @throws ReflectionException |
|
| 1783 | - */ |
|
| 1784 | - public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations) |
|
| 1785 | - { |
|
| 1786 | - $copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations); |
|
| 1787 | - foreach ($line_item->children() as $child_li) { |
|
| 1788 | - $copy_li->add_child_line_item( |
|
| 1789 | - EEH_Line_Item::billable_line_item_tree($child_li, $registrations) |
|
| 1790 | - ); |
|
| 1791 | - } |
|
| 1792 | - // if this is the grand total line item, make sure the totals all add up |
|
| 1793 | - // (we could have duplicated this logic AS we copied the line items, but |
|
| 1794 | - // it seems DRYer this way) |
|
| 1795 | - if ($copy_li->type() === EEM_Line_Item::type_total) { |
|
| 1796 | - $copy_li->recalculate_total_including_taxes(); |
|
| 1797 | - } |
|
| 1798 | - return $copy_li; |
|
| 1799 | - } |
|
| 1800 | - |
|
| 1801 | - |
|
| 1802 | - /** |
|
| 1803 | - * Creates a new, unsaved line item from $line_item that factors in the |
|
| 1804 | - * number of billable registrations on $registrations. |
|
| 1805 | - * |
|
| 1806 | - * @param EE_Line_Item $line_item |
|
| 1807 | - * @param EE_Registration[] $registrations |
|
| 1808 | - * @return EE_Line_Item |
|
| 1809 | - * @throws EE_Error |
|
| 1810 | - * @throws InvalidArgumentException |
|
| 1811 | - * @throws InvalidDataTypeException |
|
| 1812 | - * @throws InvalidInterfaceException |
|
| 1813 | - * @throws ReflectionException |
|
| 1814 | - */ |
|
| 1815 | - public static function billable_line_item(EE_Line_Item $line_item, $registrations) |
|
| 1816 | - { |
|
| 1817 | - $new_li_fields = $line_item->model_field_array(); |
|
| 1818 | - if ($line_item->type() === EEM_Line_Item::type_line_item && |
|
| 1819 | - $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1820 | - ) { |
|
| 1821 | - $count = 0; |
|
| 1822 | - foreach ($registrations as $registration) { |
|
| 1823 | - if ($line_item->OBJ_ID() === $registration->ticket_ID() && |
|
| 1824 | - in_array( |
|
| 1825 | - $registration->status_ID(), |
|
| 1826 | - EEM_Registration::reg_statuses_that_allow_payment(), |
|
| 1827 | - true |
|
| 1828 | - ) |
|
| 1829 | - ) { |
|
| 1830 | - $count++; |
|
| 1831 | - } |
|
| 1832 | - } |
|
| 1833 | - $new_li_fields['LIN_quantity'] = $count; |
|
| 1834 | - } |
|
| 1835 | - // don't set the total. We'll leave that up to the code that calculates it |
|
| 1836 | - unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']); |
|
| 1837 | - return EE_Line_Item::new_instance($new_li_fields); |
|
| 1838 | - } |
|
| 1839 | - |
|
| 1840 | - |
|
| 1841 | - /** |
|
| 1842 | - * Returns a modified line item tree where all the subtotals which have a total of 0 |
|
| 1843 | - * are removed, and line items with a quantity of 0 |
|
| 1844 | - * |
|
| 1845 | - * @param EE_Line_Item $line_item |null |
|
| 1846 | - * @return EE_Line_Item|null |
|
| 1847 | - * @throws EE_Error |
|
| 1848 | - * @throws InvalidArgumentException |
|
| 1849 | - * @throws InvalidDataTypeException |
|
| 1850 | - * @throws InvalidInterfaceException |
|
| 1851 | - * @throws ReflectionException |
|
| 1852 | - */ |
|
| 1853 | - public static function non_empty_line_items(EE_Line_Item $line_item) |
|
| 1854 | - { |
|
| 1855 | - $copied_li = EEH_Line_Item::non_empty_line_item($line_item); |
|
| 1856 | - if ($copied_li === null) { |
|
| 1857 | - return null; |
|
| 1858 | - } |
|
| 1859 | - // if this is an event subtotal, we want to only include it if it |
|
| 1860 | - // has a non-zero total and at least one ticket line item child |
|
| 1861 | - $ticket_children = 0; |
|
| 1862 | - foreach ($line_item->children() as $child_li) { |
|
| 1863 | - $child_li_copy = EEH_Line_Item::non_empty_line_items($child_li); |
|
| 1864 | - if ($child_li_copy !== null) { |
|
| 1865 | - $copied_li->add_child_line_item($child_li_copy); |
|
| 1866 | - if ($child_li_copy->type() === EEM_Line_Item::type_line_item && |
|
| 1867 | - $child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1868 | - ) { |
|
| 1869 | - $ticket_children++; |
|
| 1870 | - } |
|
| 1871 | - } |
|
| 1872 | - } |
|
| 1873 | - // if this is an event subtotal with NO ticket children |
|
| 1874 | - // we basically want to ignore it |
|
| 1875 | - if ($ticket_children === 0 |
|
| 1876 | - && $line_item->type() === EEM_Line_Item::type_sub_total |
|
| 1877 | - && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
| 1878 | - && $line_item->total() === 0 |
|
| 1879 | - ) { |
|
| 1880 | - return null; |
|
| 1881 | - } |
|
| 1882 | - return $copied_li; |
|
| 1883 | - } |
|
| 1884 | - |
|
| 1885 | - |
|
| 1886 | - /** |
|
| 1887 | - * Creates a new, unsaved line item, but if it's a ticket line item |
|
| 1888 | - * with a total of 0, or a subtotal of 0, returns null instead |
|
| 1889 | - * |
|
| 1890 | - * @param EE_Line_Item $line_item |
|
| 1891 | - * @return EE_Line_Item |
|
| 1892 | - * @throws EE_Error |
|
| 1893 | - * @throws InvalidArgumentException |
|
| 1894 | - * @throws InvalidDataTypeException |
|
| 1895 | - * @throws InvalidInterfaceException |
|
| 1896 | - * @throws ReflectionException |
|
| 1897 | - */ |
|
| 1898 | - public static function non_empty_line_item(EE_Line_Item $line_item) |
|
| 1899 | - { |
|
| 1900 | - if ($line_item->type() === EEM_Line_Item::type_line_item |
|
| 1901 | - && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1902 | - && $line_item->quantity() === 0 |
|
| 1903 | - ) { |
|
| 1904 | - return null; |
|
| 1905 | - } |
|
| 1906 | - $new_li_fields = $line_item->model_field_array(); |
|
| 1907 | - // don't set the total. We'll leave that up to the code that calculates it |
|
| 1908 | - unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']); |
|
| 1909 | - return EE_Line_Item::new_instance($new_li_fields); |
|
| 1910 | - } |
|
| 1911 | - |
|
| 1912 | - |
|
| 1913 | - /** |
|
| 1914 | - * Cycles through all of the ticket line items for the supplied total line item |
|
| 1915 | - * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket |
|
| 1916 | - * |
|
| 1917 | - * @param EE_Line_Item $total_line_item |
|
| 1918 | - * @since $VID:$ |
|
| 1919 | - * @throws EE_Error |
|
| 1920 | - * @throws InvalidArgumentException |
|
| 1921 | - * @throws InvalidDataTypeException |
|
| 1922 | - * @throws InvalidInterfaceException |
|
| 1923 | - * @throws ReflectionException |
|
| 1924 | - */ |
|
| 1925 | - public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item) |
|
| 1926 | - { |
|
| 1927 | - $ticket_line_items = self::get_ticket_line_items($total_line_item); |
|
| 1928 | - foreach ($ticket_line_items as $ticket_line_item) { |
|
| 1929 | - if ($ticket_line_item instanceof EE_Line_Item |
|
| 1930 | - && $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1931 | - ) { |
|
| 1932 | - $ticket = $ticket_line_item->ticket(); |
|
| 1933 | - if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) { |
|
| 1934 | - $ticket_line_item->set_is_taxable($ticket->taxable()); |
|
| 1935 | - $ticket_line_item->save(); |
|
| 1936 | - } |
|
| 1937 | - } |
|
| 1938 | - } |
|
| 1939 | - } |
|
| 1940 | - |
|
| 1941 | - |
|
| 1942 | - |
|
| 1943 | - /**************************************** @DEPRECATED METHODS *************************************** */ |
|
| 1944 | - /** |
|
| 1945 | - * @deprecated |
|
| 1946 | - * @param EE_Line_Item $total_line_item |
|
| 1947 | - * @return EE_Line_Item |
|
| 1948 | - * @throws EE_Error |
|
| 1949 | - * @throws InvalidArgumentException |
|
| 1950 | - * @throws InvalidDataTypeException |
|
| 1951 | - * @throws InvalidInterfaceException |
|
| 1952 | - * @throws ReflectionException |
|
| 1953 | - */ |
|
| 1954 | - public static function get_items_subtotal(EE_Line_Item $total_line_item) |
|
| 1955 | - { |
|
| 1956 | - EE_Error::doing_it_wrong( |
|
| 1957 | - 'EEH_Line_Item::get_items_subtotal()', |
|
| 1958 | - sprintf( |
|
| 1959 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1960 | - 'EEH_Line_Item::get_pre_tax_subtotal()' |
|
| 1961 | - ), |
|
| 1962 | - '4.6.0' |
|
| 1963 | - ); |
|
| 1964 | - return self::get_pre_tax_subtotal($total_line_item); |
|
| 1965 | - } |
|
| 1966 | - |
|
| 1967 | - |
|
| 1968 | - /** |
|
| 1969 | - * @deprecated |
|
| 1970 | - * @param EE_Transaction $transaction |
|
| 1971 | - * @return EE_Line_Item |
|
| 1972 | - * @throws EE_Error |
|
| 1973 | - * @throws InvalidArgumentException |
|
| 1974 | - * @throws InvalidDataTypeException |
|
| 1975 | - * @throws InvalidInterfaceException |
|
| 1976 | - * @throws ReflectionException |
|
| 1977 | - */ |
|
| 1978 | - public static function create_default_total_line_item($transaction = null) |
|
| 1979 | - { |
|
| 1980 | - EE_Error::doing_it_wrong( |
|
| 1981 | - 'EEH_Line_Item::create_default_total_line_item()', |
|
| 1982 | - sprintf( |
|
| 1983 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1984 | - 'EEH_Line_Item::create_total_line_item()' |
|
| 1985 | - ), |
|
| 1986 | - '4.6.0' |
|
| 1987 | - ); |
|
| 1988 | - return self::create_total_line_item($transaction); |
|
| 1989 | - } |
|
| 1990 | - |
|
| 1991 | - |
|
| 1992 | - /** |
|
| 1993 | - * @deprecated |
|
| 1994 | - * @param EE_Line_Item $total_line_item |
|
| 1995 | - * @param EE_Transaction $transaction |
|
| 1996 | - * @return EE_Line_Item |
|
| 1997 | - * @throws EE_Error |
|
| 1998 | - * @throws InvalidArgumentException |
|
| 1999 | - * @throws InvalidDataTypeException |
|
| 2000 | - * @throws InvalidInterfaceException |
|
| 2001 | - * @throws ReflectionException |
|
| 2002 | - */ |
|
| 2003 | - public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 2004 | - { |
|
| 2005 | - EE_Error::doing_it_wrong( |
|
| 2006 | - 'EEH_Line_Item::create_default_tickets_subtotal()', |
|
| 2007 | - sprintf( |
|
| 2008 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 2009 | - 'EEH_Line_Item::create_pre_tax_subtotal()' |
|
| 2010 | - ), |
|
| 2011 | - '4.6.0' |
|
| 2012 | - ); |
|
| 2013 | - return self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
| 2014 | - } |
|
| 2015 | - |
|
| 2016 | - |
|
| 2017 | - /** |
|
| 2018 | - * @deprecated |
|
| 2019 | - * @param EE_Line_Item $total_line_item |
|
| 2020 | - * @param EE_Transaction $transaction |
|
| 2021 | - * @return EE_Line_Item |
|
| 2022 | - * @throws EE_Error |
|
| 2023 | - * @throws InvalidArgumentException |
|
| 2024 | - * @throws InvalidDataTypeException |
|
| 2025 | - * @throws InvalidInterfaceException |
|
| 2026 | - * @throws ReflectionException |
|
| 2027 | - */ |
|
| 2028 | - public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 2029 | - { |
|
| 2030 | - EE_Error::doing_it_wrong( |
|
| 2031 | - 'EEH_Line_Item::create_default_taxes_subtotal()', |
|
| 2032 | - sprintf( |
|
| 2033 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 2034 | - 'EEH_Line_Item::create_taxes_subtotal()' |
|
| 2035 | - ), |
|
| 2036 | - '4.6.0' |
|
| 2037 | - ); |
|
| 2038 | - return self::create_taxes_subtotal($total_line_item, $transaction); |
|
| 2039 | - } |
|
| 2040 | - |
|
| 2041 | - |
|
| 2042 | - /** |
|
| 2043 | - * @deprecated |
|
| 2044 | - * @param EE_Line_Item $total_line_item |
|
| 2045 | - * @param EE_Transaction $transaction |
|
| 2046 | - * @return EE_Line_Item |
|
| 2047 | - * @throws EE_Error |
|
| 2048 | - * @throws InvalidArgumentException |
|
| 2049 | - * @throws InvalidDataTypeException |
|
| 2050 | - * @throws InvalidInterfaceException |
|
| 2051 | - * @throws ReflectionException |
|
| 2052 | - */ |
|
| 2053 | - public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 2054 | - { |
|
| 2055 | - EE_Error::doing_it_wrong( |
|
| 2056 | - 'EEH_Line_Item::create_default_event_subtotal()', |
|
| 2057 | - sprintf( |
|
| 2058 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 2059 | - 'EEH_Line_Item::create_event_subtotal()' |
|
| 2060 | - ), |
|
| 2061 | - '4.6.0' |
|
| 2062 | - ); |
|
| 2063 | - return self::create_event_subtotal($total_line_item, $transaction); |
|
| 2064 | - } |
|
| 24 | + /** |
|
| 25 | + * Adds a simple item (unrelated to any other model object) to the provided PARENT line item. |
|
| 26 | + * Does NOT automatically re-calculate the line item totals or update the related transaction. |
|
| 27 | + * You should call recalculate_total_including_taxes() on the grant total line item after this |
|
| 28 | + * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 29 | + * to keep the registration final prices in-sync with the transaction's total. |
|
| 30 | + * |
|
| 31 | + * @param EE_Line_Item $parent_line_item |
|
| 32 | + * @param string $name |
|
| 33 | + * @param float $unit_price |
|
| 34 | + * @param string $description |
|
| 35 | + * @param int $quantity |
|
| 36 | + * @param boolean $taxable |
|
| 37 | + * @param boolean $code if set to a value, ensures there is only one line item with that code |
|
| 38 | + * @return boolean success |
|
| 39 | + * @throws EE_Error |
|
| 40 | + * @throws InvalidArgumentException |
|
| 41 | + * @throws InvalidDataTypeException |
|
| 42 | + * @throws InvalidInterfaceException |
|
| 43 | + * @throws ReflectionException |
|
| 44 | + */ |
|
| 45 | + public static function add_unrelated_item( |
|
| 46 | + EE_Line_Item $parent_line_item, |
|
| 47 | + $name, |
|
| 48 | + $unit_price, |
|
| 49 | + $description = '', |
|
| 50 | + $quantity = 1, |
|
| 51 | + $taxable = false, |
|
| 52 | + $code = null |
|
| 53 | + ) { |
|
| 54 | + $items_subtotal = self::get_pre_tax_subtotal($parent_line_item); |
|
| 55 | + $line_item = EE_Line_Item::new_instance(array( |
|
| 56 | + 'LIN_name' => $name, |
|
| 57 | + 'LIN_desc' => $description, |
|
| 58 | + 'LIN_unit_price' => $unit_price, |
|
| 59 | + 'LIN_quantity' => $quantity, |
|
| 60 | + 'LIN_percent' => null, |
|
| 61 | + 'LIN_is_taxable' => $taxable, |
|
| 62 | + 'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0, |
|
| 63 | + 'LIN_total' => (float) $unit_price * (int) $quantity, |
|
| 64 | + 'LIN_type' => EEM_Line_Item::type_line_item, |
|
| 65 | + 'LIN_code' => $code, |
|
| 66 | + )); |
|
| 67 | + $line_item = apply_filters( |
|
| 68 | + 'FHEE__EEH_Line_Item__add_unrelated_item__line_item', |
|
| 69 | + $line_item, |
|
| 70 | + $parent_line_item |
|
| 71 | + ); |
|
| 72 | + return self::add_item($parent_line_item, $line_item); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Adds a simple item ( unrelated to any other model object) to the total line item, |
|
| 78 | + * in the correct spot in the line item tree. Automatically |
|
| 79 | + * re-calculates the line item totals and updates the related transaction. But |
|
| 80 | + * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 81 | + * should probably change because of this). |
|
| 82 | + * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 83 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 84 | + * |
|
| 85 | + * @param EE_Line_Item $parent_line_item |
|
| 86 | + * @param string $name |
|
| 87 | + * @param float $percentage_amount |
|
| 88 | + * @param string $description |
|
| 89 | + * @param boolean $taxable |
|
| 90 | + * @return boolean success |
|
| 91 | + * @throws EE_Error |
|
| 92 | + */ |
|
| 93 | + public static function add_percentage_based_item( |
|
| 94 | + EE_Line_Item $parent_line_item, |
|
| 95 | + $name, |
|
| 96 | + $percentage_amount, |
|
| 97 | + $description = '', |
|
| 98 | + $taxable = false |
|
| 99 | + ) { |
|
| 100 | + $line_item = EE_Line_Item::new_instance(array( |
|
| 101 | + 'LIN_name' => $name, |
|
| 102 | + 'LIN_desc' => $description, |
|
| 103 | + 'LIN_unit_price' => 0, |
|
| 104 | + 'LIN_percent' => $percentage_amount, |
|
| 105 | + 'LIN_quantity' => 1, |
|
| 106 | + 'LIN_is_taxable' => $taxable, |
|
| 107 | + 'LIN_total' => (float) ($percentage_amount * ($parent_line_item->total() / 100)), |
|
| 108 | + 'LIN_type' => EEM_Line_Item::type_line_item, |
|
| 109 | + 'LIN_parent' => $parent_line_item->ID(), |
|
| 110 | + )); |
|
| 111 | + $line_item = apply_filters( |
|
| 112 | + 'FHEE__EEH_Line_Item__add_percentage_based_item__line_item', |
|
| 113 | + $line_item |
|
| 114 | + ); |
|
| 115 | + return $parent_line_item->add_child_line_item($line_item, false); |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * Returns the new line item created by adding a purchase of the ticket |
|
| 121 | + * ensures that ticket line item is saved, and that cart total has been recalculated. |
|
| 122 | + * If this ticket has already been purchased, just increments its count. |
|
| 123 | + * Automatically re-calculates the line item totals and updates the related transaction. But |
|
| 124 | + * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 125 | + * should probably change because of this). |
|
| 126 | + * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 127 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 128 | + * |
|
| 129 | + * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total |
|
| 130 | + * @param EE_Ticket $ticket |
|
| 131 | + * @param int $qty |
|
| 132 | + * @return EE_Line_Item |
|
| 133 | + * @throws EE_Error |
|
| 134 | + * @throws InvalidArgumentException |
|
| 135 | + * @throws InvalidDataTypeException |
|
| 136 | + * @throws InvalidInterfaceException |
|
| 137 | + * @throws ReflectionException |
|
| 138 | + */ |
|
| 139 | + public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
| 140 | + { |
|
| 141 | + if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) { |
|
| 142 | + throw new EE_Error( |
|
| 143 | + sprintf( |
|
| 144 | + esc_html__( |
|
| 145 | + 'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', |
|
| 146 | + 'event_espresso' |
|
| 147 | + ), |
|
| 148 | + $ticket->ID(), |
|
| 149 | + $total_line_item->ID() |
|
| 150 | + ) |
|
| 151 | + ); |
|
| 152 | + } |
|
| 153 | + // either increment the qty for an existing ticket |
|
| 154 | + $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty); |
|
| 155 | + // or add a new one |
|
| 156 | + if (! $line_item instanceof EE_Line_Item) { |
|
| 157 | + $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty); |
|
| 158 | + } |
|
| 159 | + $total_line_item->recalculate_total_including_taxes(); |
|
| 160 | + return $line_item; |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Returns the new line item created by adding a purchase of the ticket |
|
| 166 | + * |
|
| 167 | + * @param EE_Line_Item $total_line_item |
|
| 168 | + * @param EE_Ticket $ticket |
|
| 169 | + * @param int $qty |
|
| 170 | + * @return EE_Line_Item |
|
| 171 | + * @throws EE_Error |
|
| 172 | + * @throws InvalidArgumentException |
|
| 173 | + * @throws InvalidDataTypeException |
|
| 174 | + * @throws InvalidInterfaceException |
|
| 175 | + * @throws ReflectionException |
|
| 176 | + */ |
|
| 177 | + public static function increment_ticket_qty_if_already_in_cart( |
|
| 178 | + EE_Line_Item $total_line_item, |
|
| 179 | + EE_Ticket $ticket, |
|
| 180 | + $qty = 1 |
|
| 181 | + ) { |
|
| 182 | + $line_item = null; |
|
| 183 | + if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) { |
|
| 184 | + $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item); |
|
| 185 | + foreach ((array) $ticket_line_items as $ticket_line_item) { |
|
| 186 | + if ($ticket_line_item instanceof EE_Line_Item |
|
| 187 | + && (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID() |
|
| 188 | + ) { |
|
| 189 | + $line_item = $ticket_line_item; |
|
| 190 | + break; |
|
| 191 | + } |
|
| 192 | + } |
|
| 193 | + } |
|
| 194 | + if ($line_item instanceof EE_Line_Item) { |
|
| 195 | + EEH_Line_Item::increment_quantity($line_item, $qty); |
|
| 196 | + return $line_item; |
|
| 197 | + } |
|
| 198 | + return null; |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
| 204 | + * Does NOT save or recalculate other line items totals |
|
| 205 | + * |
|
| 206 | + * @param EE_Line_Item $line_item |
|
| 207 | + * @param int $qty |
|
| 208 | + * @return void |
|
| 209 | + * @throws EE_Error |
|
| 210 | + * @throws InvalidArgumentException |
|
| 211 | + * @throws InvalidDataTypeException |
|
| 212 | + * @throws InvalidInterfaceException |
|
| 213 | + * @throws ReflectionException |
|
| 214 | + */ |
|
| 215 | + public static function increment_quantity(EE_Line_Item $line_item, $qty = 1) |
|
| 216 | + { |
|
| 217 | + if (! $line_item->is_percent()) { |
|
| 218 | + $qty += $line_item->quantity(); |
|
| 219 | + $line_item->set_quantity($qty); |
|
| 220 | + $line_item->set_total($line_item->unit_price() * $qty); |
|
| 221 | + $line_item->save(); |
|
| 222 | + } |
|
| 223 | + foreach ($line_item->children() as $child) { |
|
| 224 | + if ($child->is_sub_line_item()) { |
|
| 225 | + EEH_Line_Item::update_quantity($child, $qty); |
|
| 226 | + } |
|
| 227 | + } |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
| 233 | + * Does NOT save or recalculate other line items totals |
|
| 234 | + * |
|
| 235 | + * @param EE_Line_Item $line_item |
|
| 236 | + * @param int $qty |
|
| 237 | + * @return void |
|
| 238 | + * @throws EE_Error |
|
| 239 | + * @throws InvalidArgumentException |
|
| 240 | + * @throws InvalidDataTypeException |
|
| 241 | + * @throws InvalidInterfaceException |
|
| 242 | + * @throws ReflectionException |
|
| 243 | + */ |
|
| 244 | + public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1) |
|
| 245 | + { |
|
| 246 | + if (! $line_item->is_percent()) { |
|
| 247 | + $qty = $line_item->quantity() - $qty; |
|
| 248 | + $qty = max($qty, 0); |
|
| 249 | + $line_item->set_quantity($qty); |
|
| 250 | + $line_item->set_total($line_item->unit_price() * $qty); |
|
| 251 | + $line_item->save(); |
|
| 252 | + } |
|
| 253 | + foreach ($line_item->children() as $child) { |
|
| 254 | + if ($child->is_sub_line_item()) { |
|
| 255 | + EEH_Line_Item::update_quantity($child, $qty); |
|
| 256 | + } |
|
| 257 | + } |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + |
|
| 261 | + /** |
|
| 262 | + * Updates the line item and its children's quantities to the specified number. |
|
| 263 | + * Does NOT save them or recalculate totals. |
|
| 264 | + * |
|
| 265 | + * @param EE_Line_Item $line_item |
|
| 266 | + * @param int $new_quantity |
|
| 267 | + * @throws EE_Error |
|
| 268 | + * @throws InvalidArgumentException |
|
| 269 | + * @throws InvalidDataTypeException |
|
| 270 | + * @throws InvalidInterfaceException |
|
| 271 | + * @throws ReflectionException |
|
| 272 | + */ |
|
| 273 | + public static function update_quantity(EE_Line_Item $line_item, $new_quantity) |
|
| 274 | + { |
|
| 275 | + if (! $line_item->is_percent()) { |
|
| 276 | + $line_item->set_quantity($new_quantity); |
|
| 277 | + $line_item->set_total($line_item->unit_price() * $new_quantity); |
|
| 278 | + $line_item->save(); |
|
| 279 | + } |
|
| 280 | + foreach ($line_item->children() as $child) { |
|
| 281 | + if ($child->is_sub_line_item()) { |
|
| 282 | + EEH_Line_Item::update_quantity($child, $new_quantity); |
|
| 283 | + } |
|
| 284 | + } |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Returns the new line item created by adding a purchase of the ticket |
|
| 290 | + * |
|
| 291 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 292 | + * @param EE_Ticket $ticket |
|
| 293 | + * @param int $qty |
|
| 294 | + * @return EE_Line_Item |
|
| 295 | + * @throws EE_Error |
|
| 296 | + * @throws InvalidArgumentException |
|
| 297 | + * @throws InvalidDataTypeException |
|
| 298 | + * @throws InvalidInterfaceException |
|
| 299 | + * @throws ReflectionException |
|
| 300 | + */ |
|
| 301 | + public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
| 302 | + { |
|
| 303 | + $datetimes = $ticket->datetimes(); |
|
| 304 | + $first_datetime = reset($datetimes); |
|
| 305 | + $first_datetime_name = esc_html__('Event', 'event_espresso'); |
|
| 306 | + if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) { |
|
| 307 | + $first_datetime_name = $first_datetime->event()->name(); |
|
| 308 | + } |
|
| 309 | + $event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name); |
|
| 310 | + // get event subtotal line |
|
| 311 | + $events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket); |
|
| 312 | + // add $ticket to cart |
|
| 313 | + $line_item = EE_Line_Item::new_instance(array( |
|
| 314 | + 'LIN_name' => $ticket->name(), |
|
| 315 | + 'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event, |
|
| 316 | + 'LIN_unit_price' => $ticket->price(), |
|
| 317 | + 'LIN_quantity' => $qty, |
|
| 318 | + 'LIN_is_taxable' => $ticket->taxable(), |
|
| 319 | + 'LIN_order' => count($events_sub_total->children()), |
|
| 320 | + 'LIN_total' => $ticket->price() * $qty, |
|
| 321 | + 'LIN_type' => EEM_Line_Item::type_line_item, |
|
| 322 | + 'OBJ_ID' => $ticket->ID(), |
|
| 323 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 324 | + )); |
|
| 325 | + $line_item = apply_filters( |
|
| 326 | + 'FHEE__EEH_Line_Item__create_ticket_line_item__line_item', |
|
| 327 | + $line_item |
|
| 328 | + ); |
|
| 329 | + $events_sub_total->add_child_line_item($line_item); |
|
| 330 | + // now add the sub-line items |
|
| 331 | + $running_total_for_ticket = 0; |
|
| 332 | + foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) { |
|
| 333 | + $sign = $price->is_discount() ? -1 : 1; |
|
| 334 | + $price_total = $price->is_percent() |
|
| 335 | + ? $running_total_for_ticket * $price->amount() / 100 |
|
| 336 | + : $price->amount() * $qty; |
|
| 337 | + $sub_line_item = EE_Line_Item::new_instance(array( |
|
| 338 | + 'LIN_name' => $price->name(), |
|
| 339 | + 'LIN_desc' => $price->desc(), |
|
| 340 | + 'LIN_quantity' => $price->is_percent() ? null : $qty, |
|
| 341 | + 'LIN_is_taxable' => false, |
|
| 342 | + 'LIN_order' => $price->order(), |
|
| 343 | + 'LIN_total' => $sign * $price_total, |
|
| 344 | + 'LIN_type' => EEM_Line_Item::type_sub_line_item, |
|
| 345 | + 'OBJ_ID' => $price->ID(), |
|
| 346 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
| 347 | + )); |
|
| 348 | + $sub_line_item = apply_filters( |
|
| 349 | + 'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item', |
|
| 350 | + $sub_line_item |
|
| 351 | + ); |
|
| 352 | + if ($price->is_percent()) { |
|
| 353 | + $sub_line_item->set_percent($sign * $price->amount()); |
|
| 354 | + } else { |
|
| 355 | + $sub_line_item->set_unit_price($sign * $price->amount()); |
|
| 356 | + } |
|
| 357 | + $running_total_for_ticket += $price_total; |
|
| 358 | + $line_item->add_child_line_item($sub_line_item); |
|
| 359 | + } |
|
| 360 | + return $line_item; |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * Adds the specified item under the pre-tax-sub-total line item. Automatically |
|
| 366 | + * re-calculates the line item totals and updates the related transaction. But |
|
| 367 | + * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 368 | + * should probably change because of this). |
|
| 369 | + * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 370 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 371 | + * |
|
| 372 | + * @param EE_Line_Item $total_line_item |
|
| 373 | + * @param EE_Line_Item $item to be added |
|
| 374 | + * @return boolean |
|
| 375 | + * @throws EE_Error |
|
| 376 | + * @throws InvalidArgumentException |
|
| 377 | + * @throws InvalidDataTypeException |
|
| 378 | + * @throws InvalidInterfaceException |
|
| 379 | + * @throws ReflectionException |
|
| 380 | + */ |
|
| 381 | + public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item) |
|
| 382 | + { |
|
| 383 | + $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item); |
|
| 384 | + if ($pre_tax_subtotal instanceof EE_Line_Item) { |
|
| 385 | + $success = $pre_tax_subtotal->add_child_line_item($item); |
|
| 386 | + } else { |
|
| 387 | + return false; |
|
| 388 | + } |
|
| 389 | + $total_line_item->recalculate_total_including_taxes(); |
|
| 390 | + return $success; |
|
| 391 | + } |
|
| 392 | + |
|
| 393 | + |
|
| 394 | + /** |
|
| 395 | + * cancels an existing ticket line item, |
|
| 396 | + * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item. |
|
| 397 | + * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
| 398 | + * |
|
| 399 | + * @param EE_Line_Item $ticket_line_item |
|
| 400 | + * @param int $qty |
|
| 401 | + * @return bool success |
|
| 402 | + * @throws EE_Error |
|
| 403 | + * @throws InvalidArgumentException |
|
| 404 | + * @throws InvalidDataTypeException |
|
| 405 | + * @throws InvalidInterfaceException |
|
| 406 | + * @throws ReflectionException |
|
| 407 | + */ |
|
| 408 | + public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
| 409 | + { |
|
| 410 | + // validate incoming line_item |
|
| 411 | + if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 412 | + throw new EE_Error( |
|
| 413 | + sprintf( |
|
| 414 | + esc_html__( |
|
| 415 | + 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
| 416 | + 'event_espresso' |
|
| 417 | + ), |
|
| 418 | + $ticket_line_item->type() |
|
| 419 | + ) |
|
| 420 | + ); |
|
| 421 | + } |
|
| 422 | + if ($ticket_line_item->quantity() < $qty) { |
|
| 423 | + throw new EE_Error( |
|
| 424 | + sprintf( |
|
| 425 | + esc_html__( |
|
| 426 | + 'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', |
|
| 427 | + 'event_espresso' |
|
| 428 | + ), |
|
| 429 | + $qty, |
|
| 430 | + $ticket_line_item->quantity() |
|
| 431 | + ) |
|
| 432 | + ); |
|
| 433 | + } |
|
| 434 | + // decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this |
|
| 435 | + $ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty); |
|
| 436 | + foreach ($ticket_line_item->children() as $child_line_item) { |
|
| 437 | + if ($child_line_item->is_sub_line_item() |
|
| 438 | + && ! $child_line_item->is_percent() |
|
| 439 | + && ! $child_line_item->is_cancellation() |
|
| 440 | + ) { |
|
| 441 | + $child_line_item->set_quantity($child_line_item->quantity() - $qty); |
|
| 442 | + } |
|
| 443 | + } |
|
| 444 | + // get cancellation sub line item |
|
| 445 | + $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
| 446 | + $ticket_line_item, |
|
| 447 | + EEM_Line_Item::type_cancellation |
|
| 448 | + ); |
|
| 449 | + $cancellation_line_item = reset($cancellation_line_item); |
|
| 450 | + // verify that this ticket was indeed previously cancelled |
|
| 451 | + if ($cancellation_line_item instanceof EE_Line_Item) { |
|
| 452 | + // increment cancelled quantity |
|
| 453 | + $cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty); |
|
| 454 | + } else { |
|
| 455 | + // create cancellation sub line item |
|
| 456 | + $cancellation_line_item = EE_Line_Item::new_instance(array( |
|
| 457 | + 'LIN_name' => esc_html__('Cancellation', 'event_espresso'), |
|
| 458 | + 'LIN_desc' => sprintf( |
|
| 459 | + esc_html_x( |
|
| 460 | + 'Cancelled %1$s : %2$s', |
|
| 461 | + 'Cancelled Ticket Name : 2015-01-01 11:11', |
|
| 462 | + 'event_espresso' |
|
| 463 | + ), |
|
| 464 | + $ticket_line_item->name(), |
|
| 465 | + current_time(get_option('date_format') . ' ' . get_option('time_format')) |
|
| 466 | + ), |
|
| 467 | + 'LIN_unit_price' => 0, // $ticket_line_item->unit_price() |
|
| 468 | + 'LIN_quantity' => $qty, |
|
| 469 | + 'LIN_is_taxable' => $ticket_line_item->is_taxable(), |
|
| 470 | + 'LIN_order' => count($ticket_line_item->children()), |
|
| 471 | + 'LIN_total' => 0, // $ticket_line_item->unit_price() |
|
| 472 | + 'LIN_type' => EEM_Line_Item::type_cancellation, |
|
| 473 | + )); |
|
| 474 | + $ticket_line_item->add_child_line_item($cancellation_line_item); |
|
| 475 | + } |
|
| 476 | + if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
| 477 | + // decrement parent line item quantity |
|
| 478 | + $event_line_item = $ticket_line_item->parent(); |
|
| 479 | + if ($event_line_item instanceof EE_Line_Item |
|
| 480 | + && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
| 481 | + ) { |
|
| 482 | + $event_line_item->set_quantity($event_line_item->quantity() - $qty); |
|
| 483 | + $event_line_item->save(); |
|
| 484 | + } |
|
| 485 | + EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
| 486 | + return true; |
|
| 487 | + } |
|
| 488 | + return false; |
|
| 489 | + } |
|
| 490 | + |
|
| 491 | + |
|
| 492 | + /** |
|
| 493 | + * reinstates (un-cancels?) a previously canceled ticket line item, |
|
| 494 | + * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item. |
|
| 495 | + * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
| 496 | + * |
|
| 497 | + * @param EE_Line_Item $ticket_line_item |
|
| 498 | + * @param int $qty |
|
| 499 | + * @return bool success |
|
| 500 | + * @throws EE_Error |
|
| 501 | + * @throws InvalidArgumentException |
|
| 502 | + * @throws InvalidDataTypeException |
|
| 503 | + * @throws InvalidInterfaceException |
|
| 504 | + * @throws ReflectionException |
|
| 505 | + */ |
|
| 506 | + public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
| 507 | + { |
|
| 508 | + // validate incoming line_item |
|
| 509 | + if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 510 | + throw new EE_Error( |
|
| 511 | + sprintf( |
|
| 512 | + esc_html__( |
|
| 513 | + 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
| 514 | + 'event_espresso' |
|
| 515 | + ), |
|
| 516 | + $ticket_line_item->type() |
|
| 517 | + ) |
|
| 518 | + ); |
|
| 519 | + } |
|
| 520 | + // get cancellation sub line item |
|
| 521 | + $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
| 522 | + $ticket_line_item, |
|
| 523 | + EEM_Line_Item::type_cancellation |
|
| 524 | + ); |
|
| 525 | + $cancellation_line_item = reset($cancellation_line_item); |
|
| 526 | + // verify that this ticket was indeed previously cancelled |
|
| 527 | + if (! $cancellation_line_item instanceof EE_Line_Item) { |
|
| 528 | + return false; |
|
| 529 | + } |
|
| 530 | + if ($cancellation_line_item->quantity() > $qty) { |
|
| 531 | + // decrement cancelled quantity |
|
| 532 | + $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
| 533 | + } elseif ($cancellation_line_item->quantity() === $qty) { |
|
| 534 | + // decrement cancelled quantity in case anyone still has the object kicking around |
|
| 535 | + $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
| 536 | + // delete because quantity will end up as 0 |
|
| 537 | + $cancellation_line_item->delete(); |
|
| 538 | + // and attempt to destroy the object, |
|
| 539 | + // even though PHP won't actually destroy it until it needs the memory |
|
| 540 | + unset($cancellation_line_item); |
|
| 541 | + } else { |
|
| 542 | + // what ?!?! negative quantity ?!?! |
|
| 543 | + throw new EE_Error( |
|
| 544 | + sprintf( |
|
| 545 | + esc_html__( |
|
| 546 | + 'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.', |
|
| 547 | + 'event_espresso' |
|
| 548 | + ), |
|
| 549 | + $qty, |
|
| 550 | + $cancellation_line_item->quantity() |
|
| 551 | + ) |
|
| 552 | + ); |
|
| 553 | + } |
|
| 554 | + // increment ticket quantity |
|
| 555 | + $ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty); |
|
| 556 | + if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
| 557 | + // increment parent line item quantity |
|
| 558 | + $event_line_item = $ticket_line_item->parent(); |
|
| 559 | + if ($event_line_item instanceof EE_Line_Item |
|
| 560 | + && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
| 561 | + ) { |
|
| 562 | + $event_line_item->set_quantity($event_line_item->quantity() + $qty); |
|
| 563 | + } |
|
| 564 | + EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
| 565 | + return true; |
|
| 566 | + } |
|
| 567 | + return false; |
|
| 568 | + } |
|
| 569 | + |
|
| 570 | + |
|
| 571 | + /** |
|
| 572 | + * calls EEH_Line_Item::find_transaction_grand_total_for_line_item() |
|
| 573 | + * then EE_Line_Item::recalculate_total_including_taxes() on the result |
|
| 574 | + * |
|
| 575 | + * @param EE_Line_Item $line_item |
|
| 576 | + * @return float |
|
| 577 | + * @throws EE_Error |
|
| 578 | + * @throws InvalidArgumentException |
|
| 579 | + * @throws InvalidDataTypeException |
|
| 580 | + * @throws InvalidInterfaceException |
|
| 581 | + * @throws ReflectionException |
|
| 582 | + */ |
|
| 583 | + public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item) |
|
| 584 | + { |
|
| 585 | + $grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item); |
|
| 586 | + return $grand_total_line_item->recalculate_total_including_taxes(); |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + |
|
| 590 | + /** |
|
| 591 | + * Gets the line item which contains the subtotal of all the items |
|
| 592 | + * |
|
| 593 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 594 | + * @return EE_Line_Item |
|
| 595 | + * @throws EE_Error |
|
| 596 | + * @throws InvalidArgumentException |
|
| 597 | + * @throws InvalidDataTypeException |
|
| 598 | + * @throws InvalidInterfaceException |
|
| 599 | + * @throws ReflectionException |
|
| 600 | + */ |
|
| 601 | + public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item) |
|
| 602 | + { |
|
| 603 | + $pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal'); |
|
| 604 | + return $pre_tax_subtotal instanceof EE_Line_Item |
|
| 605 | + ? $pre_tax_subtotal |
|
| 606 | + : self::create_pre_tax_subtotal($total_line_item); |
|
| 607 | + } |
|
| 608 | + |
|
| 609 | + |
|
| 610 | + /** |
|
| 611 | + * Gets the line item for the taxes subtotal |
|
| 612 | + * |
|
| 613 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 614 | + * @return EE_Line_Item |
|
| 615 | + * @throws EE_Error |
|
| 616 | + * @throws InvalidArgumentException |
|
| 617 | + * @throws InvalidDataTypeException |
|
| 618 | + * @throws InvalidInterfaceException |
|
| 619 | + * @throws ReflectionException |
|
| 620 | + */ |
|
| 621 | + public static function get_taxes_subtotal(EE_Line_Item $total_line_item) |
|
| 622 | + { |
|
| 623 | + $taxes = $total_line_item->get_child_line_item('taxes'); |
|
| 624 | + return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + |
|
| 628 | + /** |
|
| 629 | + * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object |
|
| 630 | + * |
|
| 631 | + * @param EE_Line_Item $line_item |
|
| 632 | + * @param EE_Transaction $transaction |
|
| 633 | + * @return void |
|
| 634 | + * @throws EE_Error |
|
| 635 | + * @throws InvalidArgumentException |
|
| 636 | + * @throws InvalidDataTypeException |
|
| 637 | + * @throws InvalidInterfaceException |
|
| 638 | + * @throws ReflectionException |
|
| 639 | + */ |
|
| 640 | + public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = null) |
|
| 641 | + { |
|
| 642 | + if ($transaction) { |
|
| 643 | + /** @type EEM_Transaction $EEM_Transaction */ |
|
| 644 | + $EEM_Transaction = EE_Registry::instance()->load_model('Transaction'); |
|
| 645 | + $TXN_ID = $EEM_Transaction->ensure_is_ID($transaction); |
|
| 646 | + $line_item->set_TXN_ID($TXN_ID); |
|
| 647 | + } |
|
| 648 | + } |
|
| 649 | + |
|
| 650 | + |
|
| 651 | + /** |
|
| 652 | + * Creates a new default total line item for the transaction, |
|
| 653 | + * and its tickets subtotal and taxes subtotal line items (and adds the |
|
| 654 | + * existing taxes as children of the taxes subtotal line item) |
|
| 655 | + * |
|
| 656 | + * @param EE_Transaction $transaction |
|
| 657 | + * @return EE_Line_Item of type total |
|
| 658 | + * @throws EE_Error |
|
| 659 | + * @throws InvalidArgumentException |
|
| 660 | + * @throws InvalidDataTypeException |
|
| 661 | + * @throws InvalidInterfaceException |
|
| 662 | + * @throws ReflectionException |
|
| 663 | + */ |
|
| 664 | + public static function create_total_line_item($transaction = null) |
|
| 665 | + { |
|
| 666 | + $total_line_item = EE_Line_Item::new_instance(array( |
|
| 667 | + 'LIN_code' => 'total', |
|
| 668 | + 'LIN_name' => esc_html__('Grand Total', 'event_espresso'), |
|
| 669 | + 'LIN_type' => EEM_Line_Item::type_total, |
|
| 670 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION, |
|
| 671 | + )); |
|
| 672 | + $total_line_item = apply_filters( |
|
| 673 | + 'FHEE__EEH_Line_Item__create_total_line_item__total_line_item', |
|
| 674 | + $total_line_item |
|
| 675 | + ); |
|
| 676 | + self::set_TXN_ID($total_line_item, $transaction); |
|
| 677 | + self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
| 678 | + self::create_taxes_subtotal($total_line_item, $transaction); |
|
| 679 | + return $total_line_item; |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + |
|
| 683 | + /** |
|
| 684 | + * Creates a default items subtotal line item |
|
| 685 | + * |
|
| 686 | + * @param EE_Line_Item $total_line_item |
|
| 687 | + * @param EE_Transaction $transaction |
|
| 688 | + * @return EE_Line_Item |
|
| 689 | + * @throws EE_Error |
|
| 690 | + * @throws InvalidArgumentException |
|
| 691 | + * @throws InvalidDataTypeException |
|
| 692 | + * @throws InvalidInterfaceException |
|
| 693 | + * @throws ReflectionException |
|
| 694 | + */ |
|
| 695 | + protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 696 | + { |
|
| 697 | + $pre_tax_line_item = EE_Line_Item::new_instance(array( |
|
| 698 | + 'LIN_code' => 'pre-tax-subtotal', |
|
| 699 | + 'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'), |
|
| 700 | + 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
| 701 | + )); |
|
| 702 | + $pre_tax_line_item = apply_filters( |
|
| 703 | + 'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item', |
|
| 704 | + $pre_tax_line_item |
|
| 705 | + ); |
|
| 706 | + self::set_TXN_ID($pre_tax_line_item, $transaction); |
|
| 707 | + $total_line_item->add_child_line_item($pre_tax_line_item); |
|
| 708 | + self::create_event_subtotal($pre_tax_line_item, $transaction); |
|
| 709 | + return $pre_tax_line_item; |
|
| 710 | + } |
|
| 711 | + |
|
| 712 | + |
|
| 713 | + /** |
|
| 714 | + * Creates a line item for the taxes subtotal and finds all the tax prices |
|
| 715 | + * and applies taxes to it |
|
| 716 | + * |
|
| 717 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 718 | + * @param EE_Transaction $transaction |
|
| 719 | + * @return EE_Line_Item |
|
| 720 | + * @throws EE_Error |
|
| 721 | + * @throws InvalidArgumentException |
|
| 722 | + * @throws InvalidDataTypeException |
|
| 723 | + * @throws InvalidInterfaceException |
|
| 724 | + * @throws ReflectionException |
|
| 725 | + */ |
|
| 726 | + protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 727 | + { |
|
| 728 | + $tax_line_item = EE_Line_Item::new_instance(array( |
|
| 729 | + 'LIN_code' => 'taxes', |
|
| 730 | + 'LIN_name' => esc_html__('Taxes', 'event_espresso'), |
|
| 731 | + 'LIN_type' => EEM_Line_Item::type_tax_sub_total, |
|
| 732 | + 'LIN_order' => 1000,// this should always come last |
|
| 733 | + )); |
|
| 734 | + $tax_line_item = apply_filters( |
|
| 735 | + 'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item', |
|
| 736 | + $tax_line_item |
|
| 737 | + ); |
|
| 738 | + self::set_TXN_ID($tax_line_item, $transaction); |
|
| 739 | + $total_line_item->add_child_line_item($tax_line_item); |
|
| 740 | + // and lastly, add the actual taxes |
|
| 741 | + self::apply_taxes($total_line_item); |
|
| 742 | + return $tax_line_item; |
|
| 743 | + } |
|
| 744 | + |
|
| 745 | + |
|
| 746 | + /** |
|
| 747 | + * Creates a default items subtotal line item |
|
| 748 | + * |
|
| 749 | + * @param EE_Line_Item $pre_tax_line_item |
|
| 750 | + * @param EE_Transaction $transaction |
|
| 751 | + * @param EE_Event $event |
|
| 752 | + * @return EE_Line_Item |
|
| 753 | + * @throws EE_Error |
|
| 754 | + * @throws InvalidArgumentException |
|
| 755 | + * @throws InvalidDataTypeException |
|
| 756 | + * @throws InvalidInterfaceException |
|
| 757 | + * @throws ReflectionException |
|
| 758 | + */ |
|
| 759 | + public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = null, $event = null) |
|
| 760 | + { |
|
| 761 | + $event_line_item = EE_Line_Item::new_instance(array( |
|
| 762 | + 'LIN_code' => self::get_event_code($event), |
|
| 763 | + 'LIN_name' => self::get_event_name($event), |
|
| 764 | + 'LIN_desc' => self::get_event_desc($event), |
|
| 765 | + 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
| 766 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT, |
|
| 767 | + 'OBJ_ID' => $event instanceof EE_Event ? $event->ID() : 0, |
|
| 768 | + )); |
|
| 769 | + $event_line_item = apply_filters( |
|
| 770 | + 'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item', |
|
| 771 | + $event_line_item |
|
| 772 | + ); |
|
| 773 | + self::set_TXN_ID($event_line_item, $transaction); |
|
| 774 | + $pre_tax_line_item->add_child_line_item($event_line_item); |
|
| 775 | + return $event_line_item; |
|
| 776 | + } |
|
| 777 | + |
|
| 778 | + |
|
| 779 | + /** |
|
| 780 | + * Gets what the event ticket's code SHOULD be |
|
| 781 | + * |
|
| 782 | + * @param EE_Event $event |
|
| 783 | + * @return string |
|
| 784 | + * @throws EE_Error |
|
| 785 | + */ |
|
| 786 | + public static function get_event_code($event) |
|
| 787 | + { |
|
| 788 | + return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0'); |
|
| 789 | + } |
|
| 790 | + |
|
| 791 | + |
|
| 792 | + /** |
|
| 793 | + * Gets the event name |
|
| 794 | + * |
|
| 795 | + * @param EE_Event $event |
|
| 796 | + * @return string |
|
| 797 | + * @throws EE_Error |
|
| 798 | + */ |
|
| 799 | + public static function get_event_name($event) |
|
| 800 | + { |
|
| 801 | + return $event instanceof EE_Event |
|
| 802 | + ? mb_substr($event->name(), 0, 245) |
|
| 803 | + : esc_html__('Event', 'event_espresso'); |
|
| 804 | + } |
|
| 805 | + |
|
| 806 | + |
|
| 807 | + /** |
|
| 808 | + * Gets the event excerpt |
|
| 809 | + * |
|
| 810 | + * @param EE_Event $event |
|
| 811 | + * @return string |
|
| 812 | + * @throws EE_Error |
|
| 813 | + */ |
|
| 814 | + public static function get_event_desc($event) |
|
| 815 | + { |
|
| 816 | + return $event instanceof EE_Event ? $event->short_description() : ''; |
|
| 817 | + } |
|
| 818 | + |
|
| 819 | + |
|
| 820 | + /** |
|
| 821 | + * Given the grand total line item and a ticket, finds the event sub-total |
|
| 822 | + * line item the ticket's purchase should be added onto |
|
| 823 | + * |
|
| 824 | + * @access public |
|
| 825 | + * @param EE_Line_Item $grand_total the grand total line item |
|
| 826 | + * @param EE_Ticket $ticket |
|
| 827 | + * @return EE_Line_Item |
|
| 828 | + * @throws EE_Error |
|
| 829 | + * @throws InvalidArgumentException |
|
| 830 | + * @throws InvalidDataTypeException |
|
| 831 | + * @throws InvalidInterfaceException |
|
| 832 | + * @throws ReflectionException |
|
| 833 | + */ |
|
| 834 | + public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket) |
|
| 835 | + { |
|
| 836 | + $first_datetime = $ticket->first_datetime(); |
|
| 837 | + if (! $first_datetime instanceof EE_Datetime) { |
|
| 838 | + throw new EE_Error( |
|
| 839 | + sprintf( |
|
| 840 | + __('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), |
|
| 841 | + $ticket->ID() |
|
| 842 | + ) |
|
| 843 | + ); |
|
| 844 | + } |
|
| 845 | + $event = $first_datetime->event(); |
|
| 846 | + if (! $event instanceof EE_Event) { |
|
| 847 | + throw new EE_Error( |
|
| 848 | + sprintf( |
|
| 849 | + esc_html__( |
|
| 850 | + 'The supplied ticket (ID %d) has no event data associated with it.', |
|
| 851 | + 'event_espresso' |
|
| 852 | + ), |
|
| 853 | + $ticket->ID() |
|
| 854 | + ) |
|
| 855 | + ); |
|
| 856 | + } |
|
| 857 | + $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event); |
|
| 858 | + if (! $events_sub_total instanceof EE_Line_Item) { |
|
| 859 | + throw new EE_Error( |
|
| 860 | + sprintf( |
|
| 861 | + esc_html__( |
|
| 862 | + 'There is no events sub-total for ticket %s on total line item %d', |
|
| 863 | + 'event_espresso' |
|
| 864 | + ), |
|
| 865 | + $ticket->ID(), |
|
| 866 | + $grand_total->ID() |
|
| 867 | + ) |
|
| 868 | + ); |
|
| 869 | + } |
|
| 870 | + return $events_sub_total; |
|
| 871 | + } |
|
| 872 | + |
|
| 873 | + |
|
| 874 | + /** |
|
| 875 | + * Gets the event line item |
|
| 876 | + * |
|
| 877 | + * @param EE_Line_Item $grand_total |
|
| 878 | + * @param EE_Event $event |
|
| 879 | + * @return EE_Line_Item for the event subtotal which is a child of $grand_total |
|
| 880 | + * @throws EE_Error |
|
| 881 | + * @throws InvalidArgumentException |
|
| 882 | + * @throws InvalidDataTypeException |
|
| 883 | + * @throws InvalidInterfaceException |
|
| 884 | + * @throws ReflectionException |
|
| 885 | + */ |
|
| 886 | + public static function get_event_line_item(EE_Line_Item $grand_total, $event) |
|
| 887 | + { |
|
| 888 | + /** @type EE_Event $event */ |
|
| 889 | + $event = EEM_Event::instance()->ensure_is_obj($event, true); |
|
| 890 | + $event_line_item = null; |
|
| 891 | + $found = false; |
|
| 892 | + foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) { |
|
| 893 | + // default event subtotal, we should only ever find this the first time this method is called |
|
| 894 | + if (! $event_line_item->OBJ_ID()) { |
|
| 895 | + // let's use this! but first... set the event details |
|
| 896 | + EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
| 897 | + $found = true; |
|
| 898 | + break; |
|
| 899 | + } |
|
| 900 | + if ($event_line_item->OBJ_ID() === $event->ID()) { |
|
| 901 | + // found existing line item for this event in the cart, so break out of loop and use this one |
|
| 902 | + $found = true; |
|
| 903 | + break; |
|
| 904 | + } |
|
| 905 | + } |
|
| 906 | + if (! $found) { |
|
| 907 | + // there is no event sub-total yet, so add it |
|
| 908 | + $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total); |
|
| 909 | + // create a new "event" subtotal below that |
|
| 910 | + $event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event); |
|
| 911 | + // and set the event details |
|
| 912 | + EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
| 913 | + } |
|
| 914 | + return $event_line_item; |
|
| 915 | + } |
|
| 916 | + |
|
| 917 | + |
|
| 918 | + /** |
|
| 919 | + * Creates a default items subtotal line item |
|
| 920 | + * |
|
| 921 | + * @param EE_Line_Item $event_line_item |
|
| 922 | + * @param EE_Event $event |
|
| 923 | + * @param EE_Transaction $transaction |
|
| 924 | + * @return void |
|
| 925 | + * @throws EE_Error |
|
| 926 | + * @throws InvalidArgumentException |
|
| 927 | + * @throws InvalidDataTypeException |
|
| 928 | + * @throws InvalidInterfaceException |
|
| 929 | + * @throws ReflectionException |
|
| 930 | + */ |
|
| 931 | + public static function set_event_subtotal_details( |
|
| 932 | + EE_Line_Item $event_line_item, |
|
| 933 | + EE_Event $event, |
|
| 934 | + $transaction = null |
|
| 935 | + ) { |
|
| 936 | + if ($event instanceof EE_Event) { |
|
| 937 | + $event_line_item->set_code(self::get_event_code($event)); |
|
| 938 | + $event_line_item->set_name(self::get_event_name($event)); |
|
| 939 | + $event_line_item->set_desc(self::get_event_desc($event)); |
|
| 940 | + $event_line_item->set_OBJ_ID($event->ID()); |
|
| 941 | + } |
|
| 942 | + self::set_TXN_ID($event_line_item, $transaction); |
|
| 943 | + } |
|
| 944 | + |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Finds what taxes should apply, adds them as tax line items under the taxes sub-total, |
|
| 948 | + * and recalculates the taxes sub-total and the grand total. Resets the taxes, so |
|
| 949 | + * any old taxes are removed |
|
| 950 | + * |
|
| 951 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 952 | + * @param bool $update_txn_status |
|
| 953 | + * @return bool |
|
| 954 | + * @throws EE_Error |
|
| 955 | + * @throws InvalidArgumentException |
|
| 956 | + * @throws InvalidDataTypeException |
|
| 957 | + * @throws InvalidInterfaceException |
|
| 958 | + * @throws ReflectionException |
|
| 959 | + * @throws RuntimeException |
|
| 960 | + */ |
|
| 961 | + public static function apply_taxes(EE_Line_Item $total_line_item, $update_txn_status = false) |
|
| 962 | + { |
|
| 963 | + /** @type EEM_Price $EEM_Price */ |
|
| 964 | + $EEM_Price = EE_Registry::instance()->load_model('Price'); |
|
| 965 | + // get array of taxes via Price Model |
|
| 966 | + $ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes(); |
|
| 967 | + ksort($ordered_taxes); |
|
| 968 | + $taxes_line_item = self::get_taxes_subtotal($total_line_item); |
|
| 969 | + // just to be safe, remove its old tax line items |
|
| 970 | + $deleted = $taxes_line_item->delete_children_line_items(); |
|
| 971 | + $updates = false; |
|
| 972 | + // loop thru taxes |
|
| 973 | + foreach ($ordered_taxes as $order => $taxes) { |
|
| 974 | + foreach ($taxes as $tax) { |
|
| 975 | + if ($tax instanceof EE_Price) { |
|
| 976 | + $tax_line_item = EE_Line_Item::new_instance( |
|
| 977 | + array( |
|
| 978 | + 'LIN_name' => $tax->name(), |
|
| 979 | + 'LIN_desc' => $tax->desc(), |
|
| 980 | + 'LIN_percent' => $tax->amount(), |
|
| 981 | + 'LIN_is_taxable' => false, |
|
| 982 | + 'LIN_order' => $order, |
|
| 983 | + 'LIN_total' => 0, |
|
| 984 | + 'LIN_type' => EEM_Line_Item::type_tax, |
|
| 985 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
| 986 | + 'OBJ_ID' => $tax->ID(), |
|
| 987 | + ) |
|
| 988 | + ); |
|
| 989 | + $tax_line_item = apply_filters( |
|
| 990 | + 'FHEE__EEH_Line_Item__apply_taxes__tax_line_item', |
|
| 991 | + $tax_line_item |
|
| 992 | + ); |
|
| 993 | + $updates = $taxes_line_item->add_child_line_item($tax_line_item) ? |
|
| 994 | + true : |
|
| 995 | + $updates; |
|
| 996 | + } |
|
| 997 | + } |
|
| 998 | + } |
|
| 999 | + // only recalculate totals if something changed |
|
| 1000 | + if ($deleted || $updates) { |
|
| 1001 | + $total_line_item->recalculate_total_including_taxes($update_txn_status); |
|
| 1002 | + return true; |
|
| 1003 | + } |
|
| 1004 | + return false; |
|
| 1005 | + } |
|
| 1006 | + |
|
| 1007 | + |
|
| 1008 | + /** |
|
| 1009 | + * Ensures that taxes have been applied to the order, if not applies them. |
|
| 1010 | + * Returns the total amount of tax |
|
| 1011 | + * |
|
| 1012 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 1013 | + * @return float |
|
| 1014 | + * @throws EE_Error |
|
| 1015 | + * @throws InvalidArgumentException |
|
| 1016 | + * @throws InvalidDataTypeException |
|
| 1017 | + * @throws InvalidInterfaceException |
|
| 1018 | + * @throws ReflectionException |
|
| 1019 | + */ |
|
| 1020 | + public static function ensure_taxes_applied($total_line_item) |
|
| 1021 | + { |
|
| 1022 | + $taxes_subtotal = self::get_taxes_subtotal($total_line_item); |
|
| 1023 | + if (! $taxes_subtotal->children()) { |
|
| 1024 | + self::apply_taxes($total_line_item); |
|
| 1025 | + } |
|
| 1026 | + return $taxes_subtotal->total(); |
|
| 1027 | + } |
|
| 1028 | + |
|
| 1029 | + |
|
| 1030 | + /** |
|
| 1031 | + * Deletes ALL children of the passed line item |
|
| 1032 | + * |
|
| 1033 | + * @param EE_Line_Item $parent_line_item |
|
| 1034 | + * @return bool |
|
| 1035 | + * @throws EE_Error |
|
| 1036 | + * @throws InvalidArgumentException |
|
| 1037 | + * @throws InvalidDataTypeException |
|
| 1038 | + * @throws InvalidInterfaceException |
|
| 1039 | + * @throws ReflectionException |
|
| 1040 | + */ |
|
| 1041 | + public static function delete_all_child_items(EE_Line_Item $parent_line_item) |
|
| 1042 | + { |
|
| 1043 | + $deleted = 0; |
|
| 1044 | + foreach ($parent_line_item->children() as $child_line_item) { |
|
| 1045 | + if ($child_line_item instanceof EE_Line_Item) { |
|
| 1046 | + $deleted += EEH_Line_Item::delete_all_child_items($child_line_item); |
|
| 1047 | + if ($child_line_item->ID()) { |
|
| 1048 | + $child_line_item->delete(); |
|
| 1049 | + unset($child_line_item); |
|
| 1050 | + } else { |
|
| 1051 | + $parent_line_item->delete_child_line_item($child_line_item->code()); |
|
| 1052 | + } |
|
| 1053 | + $deleted++; |
|
| 1054 | + } |
|
| 1055 | + } |
|
| 1056 | + return $deleted; |
|
| 1057 | + } |
|
| 1058 | + |
|
| 1059 | + |
|
| 1060 | + /** |
|
| 1061 | + * Deletes the line items as indicated by the line item code(s) provided, |
|
| 1062 | + * regardless of where they're found in the line item tree. Automatically |
|
| 1063 | + * re-calculates the line item totals and updates the related transaction. But |
|
| 1064 | + * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
| 1065 | + * should probably change because of this). |
|
| 1066 | + * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
| 1067 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
| 1068 | + * |
|
| 1069 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 1070 | + * @param array|bool|string $line_item_codes |
|
| 1071 | + * @return int number of items successfully removed |
|
| 1072 | + * @throws EE_Error |
|
| 1073 | + */ |
|
| 1074 | + public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false) |
|
| 1075 | + { |
|
| 1076 | + |
|
| 1077 | + if ($total_line_item->type() !== EEM_Line_Item::type_total) { |
|
| 1078 | + EE_Error::doing_it_wrong( |
|
| 1079 | + 'EEH_Line_Item::delete_items', |
|
| 1080 | + esc_html__( |
|
| 1081 | + 'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly', |
|
| 1082 | + 'event_espresso' |
|
| 1083 | + ), |
|
| 1084 | + '4.6.18' |
|
| 1085 | + ); |
|
| 1086 | + } |
|
| 1087 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 1088 | + |
|
| 1089 | + // check if only a single line_item_id was passed |
|
| 1090 | + if (! empty($line_item_codes) && ! is_array($line_item_codes)) { |
|
| 1091 | + // place single line_item_id in an array to appear as multiple line_item_ids |
|
| 1092 | + $line_item_codes = array($line_item_codes); |
|
| 1093 | + } |
|
| 1094 | + $removals = 0; |
|
| 1095 | + // cycle thru line_item_ids |
|
| 1096 | + foreach ($line_item_codes as $line_item_id) { |
|
| 1097 | + $removals += $total_line_item->delete_child_line_item($line_item_id); |
|
| 1098 | + } |
|
| 1099 | + |
|
| 1100 | + if ($removals > 0) { |
|
| 1101 | + $total_line_item->recalculate_taxes_and_tax_total(); |
|
| 1102 | + return $removals; |
|
| 1103 | + } else { |
|
| 1104 | + return false; |
|
| 1105 | + } |
|
| 1106 | + } |
|
| 1107 | + |
|
| 1108 | + |
|
| 1109 | + /** |
|
| 1110 | + * Overwrites the previous tax by clearing out the old taxes, and creates a new |
|
| 1111 | + * tax and updates the total line item accordingly |
|
| 1112 | + * |
|
| 1113 | + * @param EE_Line_Item $total_line_item |
|
| 1114 | + * @param float $amount |
|
| 1115 | + * @param string $name |
|
| 1116 | + * @param string $description |
|
| 1117 | + * @param string $code |
|
| 1118 | + * @param boolean $add_to_existing_line_item |
|
| 1119 | + * if true, and a duplicate line item with the same code is found, |
|
| 1120 | + * $amount will be added onto it; otherwise will simply set the taxes to match $amount |
|
| 1121 | + * @return EE_Line_Item the new tax line item created |
|
| 1122 | + * @throws EE_Error |
|
| 1123 | + * @throws InvalidArgumentException |
|
| 1124 | + * @throws InvalidDataTypeException |
|
| 1125 | + * @throws InvalidInterfaceException |
|
| 1126 | + * @throws ReflectionException |
|
| 1127 | + */ |
|
| 1128 | + public static function set_total_tax_to( |
|
| 1129 | + EE_Line_Item $total_line_item, |
|
| 1130 | + $amount, |
|
| 1131 | + $name = null, |
|
| 1132 | + $description = null, |
|
| 1133 | + $code = null, |
|
| 1134 | + $add_to_existing_line_item = false |
|
| 1135 | + ) { |
|
| 1136 | + $tax_subtotal = self::get_taxes_subtotal($total_line_item); |
|
| 1137 | + $taxable_total = $total_line_item->taxable_total(); |
|
| 1138 | + |
|
| 1139 | + if ($add_to_existing_line_item) { |
|
| 1140 | + $new_tax = $tax_subtotal->get_child_line_item($code); |
|
| 1141 | + EEM_Line_Item::instance()->delete( |
|
| 1142 | + array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID())) |
|
| 1143 | + ); |
|
| 1144 | + } else { |
|
| 1145 | + $new_tax = null; |
|
| 1146 | + $tax_subtotal->delete_children_line_items(); |
|
| 1147 | + } |
|
| 1148 | + if ($new_tax) { |
|
| 1149 | + $new_tax->set_total($new_tax->total() + $amount); |
|
| 1150 | + $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0); |
|
| 1151 | + } else { |
|
| 1152 | + // no existing tax item. Create it |
|
| 1153 | + $new_tax = EE_Line_Item::new_instance(array( |
|
| 1154 | + 'TXN_ID' => $total_line_item->TXN_ID(), |
|
| 1155 | + 'LIN_name' => $name ? $name : esc_html__('Tax', 'event_espresso'), |
|
| 1156 | + 'LIN_desc' => $description ? $description : '', |
|
| 1157 | + 'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0, |
|
| 1158 | + 'LIN_total' => $amount, |
|
| 1159 | + 'LIN_parent' => $tax_subtotal->ID(), |
|
| 1160 | + 'LIN_type' => EEM_Line_Item::type_tax, |
|
| 1161 | + 'LIN_code' => $code, |
|
| 1162 | + )); |
|
| 1163 | + } |
|
| 1164 | + |
|
| 1165 | + $new_tax = apply_filters( |
|
| 1166 | + 'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal', |
|
| 1167 | + $new_tax, |
|
| 1168 | + $total_line_item |
|
| 1169 | + ); |
|
| 1170 | + $new_tax->save(); |
|
| 1171 | + $tax_subtotal->set_total($new_tax->total()); |
|
| 1172 | + $tax_subtotal->save(); |
|
| 1173 | + $total_line_item->recalculate_total_including_taxes(); |
|
| 1174 | + return $new_tax; |
|
| 1175 | + } |
|
| 1176 | + |
|
| 1177 | + |
|
| 1178 | + /** |
|
| 1179 | + * Makes all the line items which are children of $line_item taxable (or not). |
|
| 1180 | + * Does NOT save the line items |
|
| 1181 | + * |
|
| 1182 | + * @param EE_Line_Item $line_item |
|
| 1183 | + * @param boolean $taxable |
|
| 1184 | + * @param string $code_substring_for_whitelist if this string is part of the line item's code |
|
| 1185 | + * it will be whitelisted (ie, except from becoming taxable) |
|
| 1186 | + * @throws EE_Error |
|
| 1187 | + */ |
|
| 1188 | + public static function set_line_items_taxable( |
|
| 1189 | + EE_Line_Item $line_item, |
|
| 1190 | + $taxable = true, |
|
| 1191 | + $code_substring_for_whitelist = null |
|
| 1192 | + ) { |
|
| 1193 | + $whitelisted = false; |
|
| 1194 | + if ($code_substring_for_whitelist !== null) { |
|
| 1195 | + $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false; |
|
| 1196 | + } |
|
| 1197 | + if (! $whitelisted && $line_item->is_line_item()) { |
|
| 1198 | + $line_item->set_is_taxable($taxable); |
|
| 1199 | + } |
|
| 1200 | + foreach ($line_item->children() as $child_line_item) { |
|
| 1201 | + EEH_Line_Item::set_line_items_taxable( |
|
| 1202 | + $child_line_item, |
|
| 1203 | + $taxable, |
|
| 1204 | + $code_substring_for_whitelist |
|
| 1205 | + ); |
|
| 1206 | + } |
|
| 1207 | + } |
|
| 1208 | + |
|
| 1209 | + |
|
| 1210 | + /** |
|
| 1211 | + * Gets all descendants that are event subtotals |
|
| 1212 | + * |
|
| 1213 | + * @uses EEH_Line_Item::get_subtotals_of_object_type() |
|
| 1214 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1215 | + * @return EE_Line_Item[] |
|
| 1216 | + * @throws EE_Error |
|
| 1217 | + */ |
|
| 1218 | + public static function get_event_subtotals(EE_Line_Item $parent_line_item) |
|
| 1219 | + { |
|
| 1220 | + return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT); |
|
| 1221 | + } |
|
| 1222 | + |
|
| 1223 | + |
|
| 1224 | + /** |
|
| 1225 | + * Gets all descendants subtotals that match the supplied object type |
|
| 1226 | + * |
|
| 1227 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1228 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1229 | + * @param string $obj_type |
|
| 1230 | + * @return EE_Line_Item[] |
|
| 1231 | + * @throws EE_Error |
|
| 1232 | + */ |
|
| 1233 | + public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
| 1234 | + { |
|
| 1235 | + return self::_get_descendants_by_type_and_object_type( |
|
| 1236 | + $parent_line_item, |
|
| 1237 | + EEM_Line_Item::type_sub_total, |
|
| 1238 | + $obj_type |
|
| 1239 | + ); |
|
| 1240 | + } |
|
| 1241 | + |
|
| 1242 | + |
|
| 1243 | + /** |
|
| 1244 | + * Gets all descendants that are tickets |
|
| 1245 | + * |
|
| 1246 | + * @uses EEH_Line_Item::get_line_items_of_object_type() |
|
| 1247 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1248 | + * @return EE_Line_Item[] |
|
| 1249 | + * @throws EE_Error |
|
| 1250 | + */ |
|
| 1251 | + public static function get_ticket_line_items(EE_Line_Item $parent_line_item) |
|
| 1252 | + { |
|
| 1253 | + return self::get_line_items_of_object_type( |
|
| 1254 | + $parent_line_item, |
|
| 1255 | + EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1256 | + ); |
|
| 1257 | + } |
|
| 1258 | + |
|
| 1259 | + |
|
| 1260 | + /** |
|
| 1261 | + * Gets all descendants subtotals that match the supplied object type |
|
| 1262 | + * |
|
| 1263 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1264 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1265 | + * @param string $obj_type |
|
| 1266 | + * @return EE_Line_Item[] |
|
| 1267 | + * @throws EE_Error |
|
| 1268 | + */ |
|
| 1269 | + public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
| 1270 | + { |
|
| 1271 | + return self::_get_descendants_by_type_and_object_type( |
|
| 1272 | + $parent_line_item, |
|
| 1273 | + EEM_Line_Item::type_line_item, |
|
| 1274 | + $obj_type |
|
| 1275 | + ); |
|
| 1276 | + } |
|
| 1277 | + |
|
| 1278 | + |
|
| 1279 | + /** |
|
| 1280 | + * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax' |
|
| 1281 | + * |
|
| 1282 | + * @uses EEH_Line_Item::get_descendants_of_type() |
|
| 1283 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1284 | + * @return EE_Line_Item[] |
|
| 1285 | + * @throws EE_Error |
|
| 1286 | + */ |
|
| 1287 | + public static function get_tax_descendants(EE_Line_Item $parent_line_item) |
|
| 1288 | + { |
|
| 1289 | + return EEH_Line_Item::get_descendants_of_type( |
|
| 1290 | + $parent_line_item, |
|
| 1291 | + EEM_Line_Item::type_tax |
|
| 1292 | + ); |
|
| 1293 | + } |
|
| 1294 | + |
|
| 1295 | + |
|
| 1296 | + /** |
|
| 1297 | + * Gets all the real items purchased which are children of this item |
|
| 1298 | + * |
|
| 1299 | + * @uses EEH_Line_Item::get_descendants_of_type() |
|
| 1300 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1301 | + * @return EE_Line_Item[] |
|
| 1302 | + * @throws EE_Error |
|
| 1303 | + */ |
|
| 1304 | + public static function get_line_item_descendants(EE_Line_Item $parent_line_item) |
|
| 1305 | + { |
|
| 1306 | + return EEH_Line_Item::get_descendants_of_type( |
|
| 1307 | + $parent_line_item, |
|
| 1308 | + EEM_Line_Item::type_line_item |
|
| 1309 | + ); |
|
| 1310 | + } |
|
| 1311 | + |
|
| 1312 | + |
|
| 1313 | + /** |
|
| 1314 | + * Gets all descendants of supplied line item that match the supplied line item type |
|
| 1315 | + * |
|
| 1316 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1317 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1318 | + * @param string $line_item_type one of the EEM_Line_Item constants |
|
| 1319 | + * @return EE_Line_Item[] |
|
| 1320 | + * @throws EE_Error |
|
| 1321 | + */ |
|
| 1322 | + public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type) |
|
| 1323 | + { |
|
| 1324 | + return self::_get_descendants_by_type_and_object_type( |
|
| 1325 | + $parent_line_item, |
|
| 1326 | + $line_item_type, |
|
| 1327 | + null |
|
| 1328 | + ); |
|
| 1329 | + } |
|
| 1330 | + |
|
| 1331 | + |
|
| 1332 | + /** |
|
| 1333 | + * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
| 1334 | + * as well |
|
| 1335 | + * |
|
| 1336 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1337 | + * @param string $line_item_type one of the EEM_Line_Item constants |
|
| 1338 | + * @param string | NULL $obj_type object model class name (minus prefix) or NULL to ignore object type when |
|
| 1339 | + * searching |
|
| 1340 | + * @return EE_Line_Item[] |
|
| 1341 | + * @throws EE_Error |
|
| 1342 | + */ |
|
| 1343 | + protected static function _get_descendants_by_type_and_object_type( |
|
| 1344 | + EE_Line_Item $parent_line_item, |
|
| 1345 | + $line_item_type, |
|
| 1346 | + $obj_type = null |
|
| 1347 | + ) { |
|
| 1348 | + $objects = array(); |
|
| 1349 | + foreach ($parent_line_item->children() as $child_line_item) { |
|
| 1350 | + if ($child_line_item instanceof EE_Line_Item) { |
|
| 1351 | + if ($child_line_item->type() === $line_item_type |
|
| 1352 | + && ( |
|
| 1353 | + $child_line_item->OBJ_type() === $obj_type || $obj_type === null |
|
| 1354 | + ) |
|
| 1355 | + ) { |
|
| 1356 | + $objects[] = $child_line_item; |
|
| 1357 | + } else { |
|
| 1358 | + // go-through-all-its children looking for more matches |
|
| 1359 | + $objects = array_merge( |
|
| 1360 | + $objects, |
|
| 1361 | + self::_get_descendants_by_type_and_object_type( |
|
| 1362 | + $child_line_item, |
|
| 1363 | + $line_item_type, |
|
| 1364 | + $obj_type |
|
| 1365 | + ) |
|
| 1366 | + ); |
|
| 1367 | + } |
|
| 1368 | + } |
|
| 1369 | + } |
|
| 1370 | + return $objects; |
|
| 1371 | + } |
|
| 1372 | + |
|
| 1373 | + |
|
| 1374 | + /** |
|
| 1375 | + * Gets all descendants subtotals that match the supplied object type |
|
| 1376 | + * |
|
| 1377 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
| 1378 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1379 | + * @param string $OBJ_type object type (like Event) |
|
| 1380 | + * @param array $OBJ_IDs array of OBJ_IDs |
|
| 1381 | + * @return EE_Line_Item[] |
|
| 1382 | + * @throws EE_Error |
|
| 1383 | + */ |
|
| 1384 | + public static function get_line_items_by_object_type_and_IDs( |
|
| 1385 | + EE_Line_Item $parent_line_item, |
|
| 1386 | + $OBJ_type = '', |
|
| 1387 | + $OBJ_IDs = array() |
|
| 1388 | + ) { |
|
| 1389 | + return self::_get_descendants_by_object_type_and_object_ID( |
|
| 1390 | + $parent_line_item, |
|
| 1391 | + $OBJ_type, |
|
| 1392 | + $OBJ_IDs |
|
| 1393 | + ); |
|
| 1394 | + } |
|
| 1395 | + |
|
| 1396 | + |
|
| 1397 | + /** |
|
| 1398 | + * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
| 1399 | + * as well |
|
| 1400 | + * |
|
| 1401 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1402 | + * @param string $OBJ_type object type (like Event) |
|
| 1403 | + * @param array $OBJ_IDs array of OBJ_IDs |
|
| 1404 | + * @return EE_Line_Item[] |
|
| 1405 | + * @throws EE_Error |
|
| 1406 | + */ |
|
| 1407 | + protected static function _get_descendants_by_object_type_and_object_ID( |
|
| 1408 | + EE_Line_Item $parent_line_item, |
|
| 1409 | + $OBJ_type, |
|
| 1410 | + $OBJ_IDs |
|
| 1411 | + ) { |
|
| 1412 | + $objects = array(); |
|
| 1413 | + foreach ($parent_line_item->children() as $child_line_item) { |
|
| 1414 | + if ($child_line_item instanceof EE_Line_Item) { |
|
| 1415 | + if ($child_line_item->OBJ_type() === $OBJ_type |
|
| 1416 | + && is_array($OBJ_IDs) |
|
| 1417 | + && in_array($child_line_item->OBJ_ID(), $OBJ_IDs) |
|
| 1418 | + ) { |
|
| 1419 | + $objects[] = $child_line_item; |
|
| 1420 | + } else { |
|
| 1421 | + // go-through-all-its children looking for more matches |
|
| 1422 | + $objects = array_merge( |
|
| 1423 | + $objects, |
|
| 1424 | + self::_get_descendants_by_object_type_and_object_ID( |
|
| 1425 | + $child_line_item, |
|
| 1426 | + $OBJ_type, |
|
| 1427 | + $OBJ_IDs |
|
| 1428 | + ) |
|
| 1429 | + ); |
|
| 1430 | + } |
|
| 1431 | + } |
|
| 1432 | + } |
|
| 1433 | + return $objects; |
|
| 1434 | + } |
|
| 1435 | + |
|
| 1436 | + |
|
| 1437 | + /** |
|
| 1438 | + * Uses a breadth-first-search in order to find the nearest descendant of |
|
| 1439 | + * the specified type and returns it, else NULL |
|
| 1440 | + * |
|
| 1441 | + * @uses EEH_Line_Item::_get_nearest_descendant() |
|
| 1442 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1443 | + * @param string $type like one of the EEM_Line_Item::type_* |
|
| 1444 | + * @return EE_Line_Item |
|
| 1445 | + * @throws EE_Error |
|
| 1446 | + * @throws InvalidArgumentException |
|
| 1447 | + * @throws InvalidDataTypeException |
|
| 1448 | + * @throws InvalidInterfaceException |
|
| 1449 | + * @throws ReflectionException |
|
| 1450 | + */ |
|
| 1451 | + public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type) |
|
| 1452 | + { |
|
| 1453 | + return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type); |
|
| 1454 | + } |
|
| 1455 | + |
|
| 1456 | + |
|
| 1457 | + /** |
|
| 1458 | + * Uses a breadth-first-search in order to find the nearest descendant |
|
| 1459 | + * having the specified LIN_code and returns it, else NULL |
|
| 1460 | + * |
|
| 1461 | + * @uses EEH_Line_Item::_get_nearest_descendant() |
|
| 1462 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1463 | + * @param string $code any value used for LIN_code |
|
| 1464 | + * @return EE_Line_Item |
|
| 1465 | + * @throws EE_Error |
|
| 1466 | + * @throws InvalidArgumentException |
|
| 1467 | + * @throws InvalidDataTypeException |
|
| 1468 | + * @throws InvalidInterfaceException |
|
| 1469 | + * @throws ReflectionException |
|
| 1470 | + */ |
|
| 1471 | + public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code) |
|
| 1472 | + { |
|
| 1473 | + return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code); |
|
| 1474 | + } |
|
| 1475 | + |
|
| 1476 | + |
|
| 1477 | + /** |
|
| 1478 | + * Uses a breadth-first-search in order to find the nearest descendant |
|
| 1479 | + * having the specified LIN_code and returns it, else NULL |
|
| 1480 | + * |
|
| 1481 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
| 1482 | + * @param string $search_field name of EE_Line_Item property |
|
| 1483 | + * @param string $value any value stored in $search_field |
|
| 1484 | + * @return EE_Line_Item |
|
| 1485 | + * @throws EE_Error |
|
| 1486 | + * @throws InvalidArgumentException |
|
| 1487 | + * @throws InvalidDataTypeException |
|
| 1488 | + * @throws InvalidInterfaceException |
|
| 1489 | + * @throws ReflectionException |
|
| 1490 | + */ |
|
| 1491 | + protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value) |
|
| 1492 | + { |
|
| 1493 | + foreach ($parent_line_item->children() as $child) { |
|
| 1494 | + if ($child->get($search_field) == $value) { |
|
| 1495 | + return $child; |
|
| 1496 | + } |
|
| 1497 | + } |
|
| 1498 | + foreach ($parent_line_item->children() as $child) { |
|
| 1499 | + $descendant_found = self::_get_nearest_descendant( |
|
| 1500 | + $child, |
|
| 1501 | + $search_field, |
|
| 1502 | + $value |
|
| 1503 | + ); |
|
| 1504 | + if ($descendant_found) { |
|
| 1505 | + return $descendant_found; |
|
| 1506 | + } |
|
| 1507 | + } |
|
| 1508 | + return null; |
|
| 1509 | + } |
|
| 1510 | + |
|
| 1511 | + |
|
| 1512 | + /** |
|
| 1513 | + * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction, |
|
| 1514 | + * else recursively walks up the line item tree until a parent of type total is found, |
|
| 1515 | + * |
|
| 1516 | + * @param EE_Line_Item $line_item |
|
| 1517 | + * @return EE_Line_Item |
|
| 1518 | + * @throws EE_Error |
|
| 1519 | + */ |
|
| 1520 | + public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item) |
|
| 1521 | + { |
|
| 1522 | + if ($line_item->TXN_ID()) { |
|
| 1523 | + $total_line_item = $line_item->transaction()->total_line_item(false); |
|
| 1524 | + if ($total_line_item instanceof EE_Line_Item) { |
|
| 1525 | + return $total_line_item; |
|
| 1526 | + } |
|
| 1527 | + } else { |
|
| 1528 | + $line_item_parent = $line_item->parent(); |
|
| 1529 | + if ($line_item_parent instanceof EE_Line_Item) { |
|
| 1530 | + if ($line_item_parent->is_total()) { |
|
| 1531 | + return $line_item_parent; |
|
| 1532 | + } |
|
| 1533 | + return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent); |
|
| 1534 | + } |
|
| 1535 | + } |
|
| 1536 | + throw new EE_Error( |
|
| 1537 | + sprintf( |
|
| 1538 | + esc_html__( |
|
| 1539 | + 'A valid grand total for line item %1$d was not found.', |
|
| 1540 | + 'event_espresso' |
|
| 1541 | + ), |
|
| 1542 | + $line_item->ID() |
|
| 1543 | + ) |
|
| 1544 | + ); |
|
| 1545 | + } |
|
| 1546 | + |
|
| 1547 | + |
|
| 1548 | + /** |
|
| 1549 | + * Prints out a representation of the line item tree |
|
| 1550 | + * |
|
| 1551 | + * @param EE_Line_Item $line_item |
|
| 1552 | + * @param int $indentation |
|
| 1553 | + * @return void |
|
| 1554 | + * @throws EE_Error |
|
| 1555 | + */ |
|
| 1556 | + public static function visualize(EE_Line_Item $line_item, $indentation = 0) |
|
| 1557 | + { |
|
| 1558 | + echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
| 1559 | + if (! $indentation) { |
|
| 1560 | + echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
| 1561 | + } |
|
| 1562 | + for ($i = 0; $i < $indentation; $i++) { |
|
| 1563 | + echo '. '; |
|
| 1564 | + } |
|
| 1565 | + $breakdown = ''; |
|
| 1566 | + if ($line_item->is_line_item()) { |
|
| 1567 | + if ($line_item->is_percent()) { |
|
| 1568 | + $breakdown = "{$line_item->percent()}%"; |
|
| 1569 | + } else { |
|
| 1570 | + $breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}"; |
|
| 1571 | + } |
|
| 1572 | + } |
|
| 1573 | + echo $line_item->name(); |
|
| 1574 | + echo " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : "; |
|
| 1575 | + echo '$' . (string) $line_item->total(); |
|
| 1576 | + if ($breakdown) { |
|
| 1577 | + echo " ( {$breakdown} )"; |
|
| 1578 | + } |
|
| 1579 | + if ($line_item->is_taxable()) { |
|
| 1580 | + echo ' * taxable'; |
|
| 1581 | + } |
|
| 1582 | + if ($line_item->children()) { |
|
| 1583 | + foreach ($line_item->children() as $child) { |
|
| 1584 | + self::visualize($child, $indentation + 1); |
|
| 1585 | + } |
|
| 1586 | + } |
|
| 1587 | + } |
|
| 1588 | + |
|
| 1589 | + |
|
| 1590 | + /** |
|
| 1591 | + * Calculates the registration's final price, taking into account that they |
|
| 1592 | + * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes, |
|
| 1593 | + * and receive a portion of any transaction-wide discounts. |
|
| 1594 | + * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount |
|
| 1595 | + * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get |
|
| 1596 | + * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50 |
|
| 1597 | + * and brent's final price should be $5.50. |
|
| 1598 | + * In order to do this, we basically need to traverse the line item tree calculating |
|
| 1599 | + * the running totals (just as if we were recalculating the total), but when we identify |
|
| 1600 | + * regular line items, we need to keep track of their share of the grand total. |
|
| 1601 | + * Also, we need to keep track of the TAXABLE total for each ticket purchase, so |
|
| 1602 | + * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total" |
|
| 1603 | + * when there are non-taxable items; otherwise they would be the same) |
|
| 1604 | + * |
|
| 1605 | + * @param EE_Line_Item $line_item |
|
| 1606 | + * @param array $billable_ticket_quantities array of EE_Ticket IDs and their corresponding quantity that |
|
| 1607 | + * can be included in price calculations at this moment |
|
| 1608 | + * @return array keys are line items for tickets IDs and values are their share of the running total, |
|
| 1609 | + * plus the key 'total', and 'taxable' which also has keys of all |
|
| 1610 | + * the ticket IDs. |
|
| 1611 | + * Eg array( |
|
| 1612 | + * 12 => 4.3 |
|
| 1613 | + * 23 => 8.0 |
|
| 1614 | + * 'total' => 16.6, |
|
| 1615 | + * 'taxable' => array( |
|
| 1616 | + * 12 => 10, |
|
| 1617 | + * 23 => 4 |
|
| 1618 | + * ). |
|
| 1619 | + * So to find which registrations have which final price, we need |
|
| 1620 | + * to find which line item is theirs, which can be done with |
|
| 1621 | + * `EEM_Line_Item::instance()->get_line_item_for_registration( |
|
| 1622 | + * $registration );` |
|
| 1623 | + * @throws EE_Error |
|
| 1624 | + * @throws InvalidArgumentException |
|
| 1625 | + * @throws InvalidDataTypeException |
|
| 1626 | + * @throws InvalidInterfaceException |
|
| 1627 | + * @throws ReflectionException |
|
| 1628 | + */ |
|
| 1629 | + public static function calculate_reg_final_prices_per_line_item( |
|
| 1630 | + EE_Line_Item $line_item, |
|
| 1631 | + $billable_ticket_quantities = array() |
|
| 1632 | + ) { |
|
| 1633 | + $running_totals = [ |
|
| 1634 | + 'total' => 0, |
|
| 1635 | + 'taxable' => ['total' => 0] |
|
| 1636 | + ]; |
|
| 1637 | + foreach ($line_item->children() as $child_line_item) { |
|
| 1638 | + switch ($child_line_item->type()) { |
|
| 1639 | + case EEM_Line_Item::type_sub_total: |
|
| 1640 | + $running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
| 1641 | + $child_line_item, |
|
| 1642 | + $billable_ticket_quantities |
|
| 1643 | + ); |
|
| 1644 | + // combine arrays but preserve numeric keys |
|
| 1645 | + $running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals); |
|
| 1646 | + $running_totals['total'] += $running_totals_from_subtotal['total']; |
|
| 1647 | + $running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total']; |
|
| 1648 | + break; |
|
| 1649 | + |
|
| 1650 | + case EEM_Line_Item::type_tax_sub_total: |
|
| 1651 | + // find how much the taxes percentage is |
|
| 1652 | + if ($child_line_item->percent() !== 0) { |
|
| 1653 | + $tax_percent_decimal = $child_line_item->percent() / 100; |
|
| 1654 | + } else { |
|
| 1655 | + $tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100; |
|
| 1656 | + } |
|
| 1657 | + // and apply to all the taxable totals, and add to the pretax totals |
|
| 1658 | + foreach ($running_totals as $line_item_id => $this_running_total) { |
|
| 1659 | + // "total" and "taxable" array key is an exception |
|
| 1660 | + if ($line_item_id === 'taxable') { |
|
| 1661 | + continue; |
|
| 1662 | + } |
|
| 1663 | + $taxable_total = $running_totals['taxable'][ $line_item_id ]; |
|
| 1664 | + $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal); |
|
| 1665 | + } |
|
| 1666 | + break; |
|
| 1667 | + |
|
| 1668 | + case EEM_Line_Item::type_line_item: |
|
| 1669 | + // ticket line items or ???? |
|
| 1670 | + if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
| 1671 | + // kk it's a ticket |
|
| 1672 | + if (isset($running_totals[ $child_line_item->ID() ])) { |
|
| 1673 | + // huh? that shouldn't happen. |
|
| 1674 | + $running_totals['total'] += $child_line_item->total(); |
|
| 1675 | + } else { |
|
| 1676 | + // its not in our running totals yet. great. |
|
| 1677 | + if ($child_line_item->is_taxable()) { |
|
| 1678 | + $taxable_amount = $child_line_item->unit_price(); |
|
| 1679 | + } else { |
|
| 1680 | + $taxable_amount = 0; |
|
| 1681 | + } |
|
| 1682 | + // are we only calculating totals for some tickets? |
|
| 1683 | + if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) { |
|
| 1684 | + $quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ]; |
|
| 1685 | + $running_totals[ $child_line_item->ID() ] = $quantity |
|
| 1686 | + ? $child_line_item->unit_price() |
|
| 1687 | + : 0; |
|
| 1688 | + $running_totals['taxable'][ $child_line_item->ID() ] = $quantity |
|
| 1689 | + ? $taxable_amount |
|
| 1690 | + : 0; |
|
| 1691 | + } else { |
|
| 1692 | + $quantity = $child_line_item->quantity(); |
|
| 1693 | + $running_totals[ $child_line_item->ID() ] = $child_line_item->unit_price(); |
|
| 1694 | + $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount; |
|
| 1695 | + } |
|
| 1696 | + $running_totals['taxable']['total'] += $taxable_amount * $quantity; |
|
| 1697 | + $running_totals['total'] += $child_line_item->unit_price() * $quantity; |
|
| 1698 | + } |
|
| 1699 | + } else { |
|
| 1700 | + // it's some other type of item added to the cart |
|
| 1701 | + // it should affect the running totals |
|
| 1702 | + // basically we want to convert it into a PERCENT modifier. Because |
|
| 1703 | + // more clearly affect all registration's final price equally |
|
| 1704 | + $line_items_percent_of_running_total = $running_totals['total'] > 0 |
|
| 1705 | + ? ($child_line_item->total() / $running_totals['total']) + 1 |
|
| 1706 | + : 1; |
|
| 1707 | + foreach ($running_totals as $line_item_id => $this_running_total) { |
|
| 1708 | + // the "taxable" array key is an exception |
|
| 1709 | + if ($line_item_id === 'taxable') { |
|
| 1710 | + continue; |
|
| 1711 | + } |
|
| 1712 | + // update the running totals |
|
| 1713 | + // yes this actually even works for the running grand total! |
|
| 1714 | + $running_totals[ $line_item_id ] = |
|
| 1715 | + $line_items_percent_of_running_total * $this_running_total; |
|
| 1716 | + |
|
| 1717 | + if ($child_line_item->is_taxable()) { |
|
| 1718 | + $running_totals['taxable'][ $line_item_id ] = |
|
| 1719 | + $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ]; |
|
| 1720 | + } |
|
| 1721 | + } |
|
| 1722 | + } |
|
| 1723 | + break; |
|
| 1724 | + } |
|
| 1725 | + } |
|
| 1726 | + return $running_totals; |
|
| 1727 | + } |
|
| 1728 | + |
|
| 1729 | + |
|
| 1730 | + /** |
|
| 1731 | + * @param EE_Line_Item $total_line_item |
|
| 1732 | + * @param EE_Line_Item $ticket_line_item |
|
| 1733 | + * @return float | null |
|
| 1734 | + * @throws EE_Error |
|
| 1735 | + * @throws InvalidArgumentException |
|
| 1736 | + * @throws InvalidDataTypeException |
|
| 1737 | + * @throws InvalidInterfaceException |
|
| 1738 | + * @throws OutOfRangeException |
|
| 1739 | + * @throws ReflectionException |
|
| 1740 | + */ |
|
| 1741 | + public static function calculate_final_price_for_ticket_line_item( |
|
| 1742 | + EE_Line_Item $total_line_item, |
|
| 1743 | + EE_Line_Item $ticket_line_item |
|
| 1744 | + ) { |
|
| 1745 | + static $final_prices_per_ticket_line_item = array(); |
|
| 1746 | + if (empty($final_prices_per_ticket_line_item)) { |
|
| 1747 | + $final_prices_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
| 1748 | + $total_line_item |
|
| 1749 | + ); |
|
| 1750 | + } |
|
| 1751 | + // ok now find this new registration's final price |
|
| 1752 | + if (isset($final_prices_per_ticket_line_item[ $ticket_line_item->ID() ])) { |
|
| 1753 | + return $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ]; |
|
| 1754 | + } |
|
| 1755 | + $message = sprintf( |
|
| 1756 | + esc_html__( |
|
| 1757 | + 'The final price for the ticket line item (ID:%1$d) could not be calculated.', |
|
| 1758 | + 'event_espresso' |
|
| 1759 | + ), |
|
| 1760 | + $ticket_line_item->ID() |
|
| 1761 | + ); |
|
| 1762 | + if (WP_DEBUG) { |
|
| 1763 | + $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true); |
|
| 1764 | + throw new OutOfRangeException($message); |
|
| 1765 | + } |
|
| 1766 | + EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message); |
|
| 1767 | + return null; |
|
| 1768 | + } |
|
| 1769 | + |
|
| 1770 | + |
|
| 1771 | + /** |
|
| 1772 | + * Creates a duplicate of the line item tree, except only includes billable items |
|
| 1773 | + * and the portion of line items attributed to billable things |
|
| 1774 | + * |
|
| 1775 | + * @param EE_Line_Item $line_item |
|
| 1776 | + * @param EE_Registration[] $registrations |
|
| 1777 | + * @return EE_Line_Item |
|
| 1778 | + * @throws EE_Error |
|
| 1779 | + * @throws InvalidArgumentException |
|
| 1780 | + * @throws InvalidDataTypeException |
|
| 1781 | + * @throws InvalidInterfaceException |
|
| 1782 | + * @throws ReflectionException |
|
| 1783 | + */ |
|
| 1784 | + public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations) |
|
| 1785 | + { |
|
| 1786 | + $copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations); |
|
| 1787 | + foreach ($line_item->children() as $child_li) { |
|
| 1788 | + $copy_li->add_child_line_item( |
|
| 1789 | + EEH_Line_Item::billable_line_item_tree($child_li, $registrations) |
|
| 1790 | + ); |
|
| 1791 | + } |
|
| 1792 | + // if this is the grand total line item, make sure the totals all add up |
|
| 1793 | + // (we could have duplicated this logic AS we copied the line items, but |
|
| 1794 | + // it seems DRYer this way) |
|
| 1795 | + if ($copy_li->type() === EEM_Line_Item::type_total) { |
|
| 1796 | + $copy_li->recalculate_total_including_taxes(); |
|
| 1797 | + } |
|
| 1798 | + return $copy_li; |
|
| 1799 | + } |
|
| 1800 | + |
|
| 1801 | + |
|
| 1802 | + /** |
|
| 1803 | + * Creates a new, unsaved line item from $line_item that factors in the |
|
| 1804 | + * number of billable registrations on $registrations. |
|
| 1805 | + * |
|
| 1806 | + * @param EE_Line_Item $line_item |
|
| 1807 | + * @param EE_Registration[] $registrations |
|
| 1808 | + * @return EE_Line_Item |
|
| 1809 | + * @throws EE_Error |
|
| 1810 | + * @throws InvalidArgumentException |
|
| 1811 | + * @throws InvalidDataTypeException |
|
| 1812 | + * @throws InvalidInterfaceException |
|
| 1813 | + * @throws ReflectionException |
|
| 1814 | + */ |
|
| 1815 | + public static function billable_line_item(EE_Line_Item $line_item, $registrations) |
|
| 1816 | + { |
|
| 1817 | + $new_li_fields = $line_item->model_field_array(); |
|
| 1818 | + if ($line_item->type() === EEM_Line_Item::type_line_item && |
|
| 1819 | + $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1820 | + ) { |
|
| 1821 | + $count = 0; |
|
| 1822 | + foreach ($registrations as $registration) { |
|
| 1823 | + if ($line_item->OBJ_ID() === $registration->ticket_ID() && |
|
| 1824 | + in_array( |
|
| 1825 | + $registration->status_ID(), |
|
| 1826 | + EEM_Registration::reg_statuses_that_allow_payment(), |
|
| 1827 | + true |
|
| 1828 | + ) |
|
| 1829 | + ) { |
|
| 1830 | + $count++; |
|
| 1831 | + } |
|
| 1832 | + } |
|
| 1833 | + $new_li_fields['LIN_quantity'] = $count; |
|
| 1834 | + } |
|
| 1835 | + // don't set the total. We'll leave that up to the code that calculates it |
|
| 1836 | + unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']); |
|
| 1837 | + return EE_Line_Item::new_instance($new_li_fields); |
|
| 1838 | + } |
|
| 1839 | + |
|
| 1840 | + |
|
| 1841 | + /** |
|
| 1842 | + * Returns a modified line item tree where all the subtotals which have a total of 0 |
|
| 1843 | + * are removed, and line items with a quantity of 0 |
|
| 1844 | + * |
|
| 1845 | + * @param EE_Line_Item $line_item |null |
|
| 1846 | + * @return EE_Line_Item|null |
|
| 1847 | + * @throws EE_Error |
|
| 1848 | + * @throws InvalidArgumentException |
|
| 1849 | + * @throws InvalidDataTypeException |
|
| 1850 | + * @throws InvalidInterfaceException |
|
| 1851 | + * @throws ReflectionException |
|
| 1852 | + */ |
|
| 1853 | + public static function non_empty_line_items(EE_Line_Item $line_item) |
|
| 1854 | + { |
|
| 1855 | + $copied_li = EEH_Line_Item::non_empty_line_item($line_item); |
|
| 1856 | + if ($copied_li === null) { |
|
| 1857 | + return null; |
|
| 1858 | + } |
|
| 1859 | + // if this is an event subtotal, we want to only include it if it |
|
| 1860 | + // has a non-zero total and at least one ticket line item child |
|
| 1861 | + $ticket_children = 0; |
|
| 1862 | + foreach ($line_item->children() as $child_li) { |
|
| 1863 | + $child_li_copy = EEH_Line_Item::non_empty_line_items($child_li); |
|
| 1864 | + if ($child_li_copy !== null) { |
|
| 1865 | + $copied_li->add_child_line_item($child_li_copy); |
|
| 1866 | + if ($child_li_copy->type() === EEM_Line_Item::type_line_item && |
|
| 1867 | + $child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1868 | + ) { |
|
| 1869 | + $ticket_children++; |
|
| 1870 | + } |
|
| 1871 | + } |
|
| 1872 | + } |
|
| 1873 | + // if this is an event subtotal with NO ticket children |
|
| 1874 | + // we basically want to ignore it |
|
| 1875 | + if ($ticket_children === 0 |
|
| 1876 | + && $line_item->type() === EEM_Line_Item::type_sub_total |
|
| 1877 | + && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
| 1878 | + && $line_item->total() === 0 |
|
| 1879 | + ) { |
|
| 1880 | + return null; |
|
| 1881 | + } |
|
| 1882 | + return $copied_li; |
|
| 1883 | + } |
|
| 1884 | + |
|
| 1885 | + |
|
| 1886 | + /** |
|
| 1887 | + * Creates a new, unsaved line item, but if it's a ticket line item |
|
| 1888 | + * with a total of 0, or a subtotal of 0, returns null instead |
|
| 1889 | + * |
|
| 1890 | + * @param EE_Line_Item $line_item |
|
| 1891 | + * @return EE_Line_Item |
|
| 1892 | + * @throws EE_Error |
|
| 1893 | + * @throws InvalidArgumentException |
|
| 1894 | + * @throws InvalidDataTypeException |
|
| 1895 | + * @throws InvalidInterfaceException |
|
| 1896 | + * @throws ReflectionException |
|
| 1897 | + */ |
|
| 1898 | + public static function non_empty_line_item(EE_Line_Item $line_item) |
|
| 1899 | + { |
|
| 1900 | + if ($line_item->type() === EEM_Line_Item::type_line_item |
|
| 1901 | + && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1902 | + && $line_item->quantity() === 0 |
|
| 1903 | + ) { |
|
| 1904 | + return null; |
|
| 1905 | + } |
|
| 1906 | + $new_li_fields = $line_item->model_field_array(); |
|
| 1907 | + // don't set the total. We'll leave that up to the code that calculates it |
|
| 1908 | + unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']); |
|
| 1909 | + return EE_Line_Item::new_instance($new_li_fields); |
|
| 1910 | + } |
|
| 1911 | + |
|
| 1912 | + |
|
| 1913 | + /** |
|
| 1914 | + * Cycles through all of the ticket line items for the supplied total line item |
|
| 1915 | + * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket |
|
| 1916 | + * |
|
| 1917 | + * @param EE_Line_Item $total_line_item |
|
| 1918 | + * @since $VID:$ |
|
| 1919 | + * @throws EE_Error |
|
| 1920 | + * @throws InvalidArgumentException |
|
| 1921 | + * @throws InvalidDataTypeException |
|
| 1922 | + * @throws InvalidInterfaceException |
|
| 1923 | + * @throws ReflectionException |
|
| 1924 | + */ |
|
| 1925 | + public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item) |
|
| 1926 | + { |
|
| 1927 | + $ticket_line_items = self::get_ticket_line_items($total_line_item); |
|
| 1928 | + foreach ($ticket_line_items as $ticket_line_item) { |
|
| 1929 | + if ($ticket_line_item instanceof EE_Line_Item |
|
| 1930 | + && $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
| 1931 | + ) { |
|
| 1932 | + $ticket = $ticket_line_item->ticket(); |
|
| 1933 | + if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) { |
|
| 1934 | + $ticket_line_item->set_is_taxable($ticket->taxable()); |
|
| 1935 | + $ticket_line_item->save(); |
|
| 1936 | + } |
|
| 1937 | + } |
|
| 1938 | + } |
|
| 1939 | + } |
|
| 1940 | + |
|
| 1941 | + |
|
| 1942 | + |
|
| 1943 | + /**************************************** @DEPRECATED METHODS *************************************** */ |
|
| 1944 | + /** |
|
| 1945 | + * @deprecated |
|
| 1946 | + * @param EE_Line_Item $total_line_item |
|
| 1947 | + * @return EE_Line_Item |
|
| 1948 | + * @throws EE_Error |
|
| 1949 | + * @throws InvalidArgumentException |
|
| 1950 | + * @throws InvalidDataTypeException |
|
| 1951 | + * @throws InvalidInterfaceException |
|
| 1952 | + * @throws ReflectionException |
|
| 1953 | + */ |
|
| 1954 | + public static function get_items_subtotal(EE_Line_Item $total_line_item) |
|
| 1955 | + { |
|
| 1956 | + EE_Error::doing_it_wrong( |
|
| 1957 | + 'EEH_Line_Item::get_items_subtotal()', |
|
| 1958 | + sprintf( |
|
| 1959 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1960 | + 'EEH_Line_Item::get_pre_tax_subtotal()' |
|
| 1961 | + ), |
|
| 1962 | + '4.6.0' |
|
| 1963 | + ); |
|
| 1964 | + return self::get_pre_tax_subtotal($total_line_item); |
|
| 1965 | + } |
|
| 1966 | + |
|
| 1967 | + |
|
| 1968 | + /** |
|
| 1969 | + * @deprecated |
|
| 1970 | + * @param EE_Transaction $transaction |
|
| 1971 | + * @return EE_Line_Item |
|
| 1972 | + * @throws EE_Error |
|
| 1973 | + * @throws InvalidArgumentException |
|
| 1974 | + * @throws InvalidDataTypeException |
|
| 1975 | + * @throws InvalidInterfaceException |
|
| 1976 | + * @throws ReflectionException |
|
| 1977 | + */ |
|
| 1978 | + public static function create_default_total_line_item($transaction = null) |
|
| 1979 | + { |
|
| 1980 | + EE_Error::doing_it_wrong( |
|
| 1981 | + 'EEH_Line_Item::create_default_total_line_item()', |
|
| 1982 | + sprintf( |
|
| 1983 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 1984 | + 'EEH_Line_Item::create_total_line_item()' |
|
| 1985 | + ), |
|
| 1986 | + '4.6.0' |
|
| 1987 | + ); |
|
| 1988 | + return self::create_total_line_item($transaction); |
|
| 1989 | + } |
|
| 1990 | + |
|
| 1991 | + |
|
| 1992 | + /** |
|
| 1993 | + * @deprecated |
|
| 1994 | + * @param EE_Line_Item $total_line_item |
|
| 1995 | + * @param EE_Transaction $transaction |
|
| 1996 | + * @return EE_Line_Item |
|
| 1997 | + * @throws EE_Error |
|
| 1998 | + * @throws InvalidArgumentException |
|
| 1999 | + * @throws InvalidDataTypeException |
|
| 2000 | + * @throws InvalidInterfaceException |
|
| 2001 | + * @throws ReflectionException |
|
| 2002 | + */ |
|
| 2003 | + public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 2004 | + { |
|
| 2005 | + EE_Error::doing_it_wrong( |
|
| 2006 | + 'EEH_Line_Item::create_default_tickets_subtotal()', |
|
| 2007 | + sprintf( |
|
| 2008 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 2009 | + 'EEH_Line_Item::create_pre_tax_subtotal()' |
|
| 2010 | + ), |
|
| 2011 | + '4.6.0' |
|
| 2012 | + ); |
|
| 2013 | + return self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
| 2014 | + } |
|
| 2015 | + |
|
| 2016 | + |
|
| 2017 | + /** |
|
| 2018 | + * @deprecated |
|
| 2019 | + * @param EE_Line_Item $total_line_item |
|
| 2020 | + * @param EE_Transaction $transaction |
|
| 2021 | + * @return EE_Line_Item |
|
| 2022 | + * @throws EE_Error |
|
| 2023 | + * @throws InvalidArgumentException |
|
| 2024 | + * @throws InvalidDataTypeException |
|
| 2025 | + * @throws InvalidInterfaceException |
|
| 2026 | + * @throws ReflectionException |
|
| 2027 | + */ |
|
| 2028 | + public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 2029 | + { |
|
| 2030 | + EE_Error::doing_it_wrong( |
|
| 2031 | + 'EEH_Line_Item::create_default_taxes_subtotal()', |
|
| 2032 | + sprintf( |
|
| 2033 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 2034 | + 'EEH_Line_Item::create_taxes_subtotal()' |
|
| 2035 | + ), |
|
| 2036 | + '4.6.0' |
|
| 2037 | + ); |
|
| 2038 | + return self::create_taxes_subtotal($total_line_item, $transaction); |
|
| 2039 | + } |
|
| 2040 | + |
|
| 2041 | + |
|
| 2042 | + /** |
|
| 2043 | + * @deprecated |
|
| 2044 | + * @param EE_Line_Item $total_line_item |
|
| 2045 | + * @param EE_Transaction $transaction |
|
| 2046 | + * @return EE_Line_Item |
|
| 2047 | + * @throws EE_Error |
|
| 2048 | + * @throws InvalidArgumentException |
|
| 2049 | + * @throws InvalidDataTypeException |
|
| 2050 | + * @throws InvalidInterfaceException |
|
| 2051 | + * @throws ReflectionException |
|
| 2052 | + */ |
|
| 2053 | + public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
| 2054 | + { |
|
| 2055 | + EE_Error::doing_it_wrong( |
|
| 2056 | + 'EEH_Line_Item::create_default_event_subtotal()', |
|
| 2057 | + sprintf( |
|
| 2058 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
| 2059 | + 'EEH_Line_Item::create_event_subtotal()' |
|
| 2060 | + ), |
|
| 2061 | + '4.6.0' |
|
| 2062 | + ); |
|
| 2063 | + return self::create_event_subtotal($total_line_item, $transaction); |
|
| 2064 | + } |
|
| 2065 | 2065 | } |
@@ -324,8 +324,8 @@ discard block |
||
| 324 | 324 | ); |
| 325 | 325 | $query = $wpdb->prepare( |
| 326 | 326 | 'DELETE li |
| 327 | - FROM ' . $this->table() . ' li |
|
| 328 | - LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID |
|
| 327 | + FROM ' . $this->table().' li |
|
| 328 | + LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID |
|
| 329 | 329 | WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s', |
| 330 | 330 | // use GMT time because that's what TXN_timestamps are in |
| 331 | 331 | date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
@@ -598,7 +598,7 @@ discard block |
||
| 598 | 598 | */ |
| 599 | 599 | public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
| 600 | 600 | { |
| 601 | - if (! absint($timestamp)) { |
|
| 601 | + if ( ! absint($timestamp)) { |
|
| 602 | 602 | /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
| 603 | 603 | $session_lifespan = LoaderFactory::getLoader()->getShared( |
| 604 | 604 | 'EventEspresso\core\domain\values\session\SessionLifespan' |
@@ -28,601 +28,601 @@ |
||
| 28 | 28 | class EEM_Line_Item extends EEM_Base |
| 29 | 29 | { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Tax sub-total is just the total of all the taxes, which should be children |
|
| 33 | - * of this line item. There should only ever be one tax sub-total, and it should |
|
| 34 | - * be a direct child of. Its quantity and LIN_unit_price = 1. |
|
| 35 | - */ |
|
| 36 | - const type_tax_sub_total = 'tax-sub-total'; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * Tax line items indicate a tax applied to all the taxable line items. |
|
| 40 | - * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
| 41 | - * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
| 42 | - */ |
|
| 43 | - const type_tax = 'tax'; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * Indicating individual items purchased, or discounts or surcharges. |
|
| 47 | - * The sum of all the regular line items plus the tax items should equal the grand total. |
|
| 48 | - * Possible children are sub-line-items and cancellations. |
|
| 49 | - * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children |
|
| 50 | - * LIN_totals. Its LIN_percent = 0. |
|
| 51 | - * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1). |
|
| 52 | - * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1. |
|
| 53 | - */ |
|
| 54 | - const type_line_item = 'line-item'; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * Line item indicating all the factors that make a single line item. |
|
| 58 | - * Sub-line items should have NO children line items. |
|
| 59 | - * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's |
|
| 60 | - * contribution towards the price of ONE of their parent items, and its LIN_total should be |
|
| 61 | - * = LIN_quantity * LIN_unit_price. Its LIN_percent = 0. |
|
| 62 | - * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should |
|
| 63 | - * = LIN_percent / 100 * sum of lower-priority sibling line items.. |
|
| 64 | - */ |
|
| 65 | - const type_sub_line_item = 'sub-item'; |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal). |
|
| 69 | - * Direct children should be event subtotals. |
|
| 70 | - * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals. |
|
| 71 | - */ |
|
| 72 | - const type_sub_total = 'sub-total'; |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Line item for the grand total of an order. |
|
| 76 | - * Its direct children should be tax subtotals and (pre-tax) subtotals, |
|
| 77 | - * and possibly a regular line item indicating a transaction-wide discount/surcharge. |
|
| 78 | - * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount. |
|
| 79 | - */ |
|
| 80 | - const type_total = 'total'; |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * When a line item is cancelled, a sub-line-item of type 'cancellation' |
|
| 84 | - * should be created, indicating the quantity that were cancelled |
|
| 85 | - * (because a line item could have a quantity of 1, and its cancellation item |
|
| 86 | - * could be for 3, indicating that originally 4 were purchased, but 3 have been |
|
| 87 | - * cancelled, and only one remains). |
|
| 88 | - * When items are refunded, a cancellation line item should be made, which points |
|
| 89 | - * to teh payment model object which actually refunded the payment. |
|
| 90 | - * Cancellations should NOT have any children line items; the should NOT affect |
|
| 91 | - * any calculations, and are only meant as a record that cancellations have occurred. |
|
| 92 | - * Their LIN_percent should be 0. |
|
| 93 | - */ |
|
| 94 | - const type_cancellation = 'cancellation'; |
|
| 95 | - |
|
| 96 | - // various line item object types |
|
| 97 | - const OBJ_TYPE_EVENT = 'Event'; |
|
| 98 | - |
|
| 99 | - const OBJ_TYPE_PRICE = 'Price'; |
|
| 100 | - |
|
| 101 | - const OBJ_TYPE_PROMOTION = 'Promotion'; |
|
| 102 | - |
|
| 103 | - const OBJ_TYPE_TICKET = 'Ticket'; |
|
| 104 | - |
|
| 105 | - const OBJ_TYPE_TRANSACTION = 'Transaction'; |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * @var EEM_Line_Item $_instance |
|
| 109 | - */ |
|
| 110 | - protected static $_instance; |
|
| 111 | - |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * private constructor to prevent direct creation |
|
| 115 | - * |
|
| 116 | - * @Constructor |
|
| 117 | - * @param string $timezone string representing the timezone we want to set for returned Date Time Strings |
|
| 118 | - * (and any incoming timezone data that gets saved). |
|
| 119 | - * Note this just sends the timezone info to the date time model field objects. |
|
| 120 | - * Default is NULL |
|
| 121 | - * (and will be assumed using the set timezone in the 'timezone_string' wp option) |
|
| 122 | - * @throws EE_Error |
|
| 123 | - * @throws InvalidArgumentException |
|
| 124 | - */ |
|
| 125 | - protected function __construct($timezone) |
|
| 126 | - { |
|
| 127 | - $this->singular_item = esc_html__('Line Item', 'event_espresso'); |
|
| 128 | - $this->plural_item = esc_html__('Line Items', 'event_espresso'); |
|
| 129 | - |
|
| 130 | - $this->_tables = array( |
|
| 131 | - 'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'), |
|
| 132 | - ); |
|
| 133 | - $line_items_can_be_for = apply_filters( |
|
| 134 | - 'FHEE__EEM_Line_Item__line_items_can_be_for', |
|
| 135 | - array('Ticket', 'Price', 'Event') |
|
| 136 | - ); |
|
| 137 | - $this->_fields = array( |
|
| 138 | - 'Line_Item' => array( |
|
| 139 | - 'LIN_ID' => new EE_Primary_Key_Int_Field( |
|
| 140 | - 'LIN_ID', |
|
| 141 | - esc_html__('ID', 'event_espresso') |
|
| 142 | - ), |
|
| 143 | - 'LIN_code' => new EE_Slug_Field( |
|
| 144 | - 'LIN_code', |
|
| 145 | - esc_html__('Code for index into Cart', 'event_espresso'), |
|
| 146 | - true |
|
| 147 | - ), |
|
| 148 | - 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
| 149 | - 'TXN_ID', |
|
| 150 | - esc_html__('Transaction ID', 'event_espresso'), |
|
| 151 | - true, |
|
| 152 | - null, |
|
| 153 | - 'Transaction' |
|
| 154 | - ), |
|
| 155 | - 'LIN_name' => new EE_Full_HTML_Field( |
|
| 156 | - 'LIN_name', |
|
| 157 | - esc_html__('Line Item Name', 'event_espresso'), |
|
| 158 | - false, |
|
| 159 | - '' |
|
| 160 | - ), |
|
| 161 | - 'LIN_desc' => new EE_Full_HTML_Field( |
|
| 162 | - 'LIN_desc', |
|
| 163 | - esc_html__('Line Item Description', 'event_espresso'), |
|
| 164 | - true |
|
| 165 | - ), |
|
| 166 | - 'LIN_unit_price' => new EE_Money_Field( |
|
| 167 | - 'LIN_unit_price', |
|
| 168 | - esc_html__('Unit Price', 'event_espresso'), |
|
| 169 | - false, |
|
| 170 | - 0 |
|
| 171 | - ), |
|
| 172 | - 'LIN_percent' => new EE_Float_Field( |
|
| 173 | - 'LIN_percent', |
|
| 174 | - esc_html__('Percent', 'event_espresso'), |
|
| 175 | - false, |
|
| 176 | - 0 |
|
| 177 | - ), |
|
| 178 | - 'LIN_is_taxable' => new EE_Boolean_Field( |
|
| 179 | - 'LIN_is_taxable', |
|
| 180 | - esc_html__('Taxable', 'event_espresso'), |
|
| 181 | - false, |
|
| 182 | - false |
|
| 183 | - ), |
|
| 184 | - 'LIN_order' => new EE_Integer_Field( |
|
| 185 | - 'LIN_order', |
|
| 186 | - esc_html__('Order of Application towards total of parent', 'event_espresso'), |
|
| 187 | - false, |
|
| 188 | - 1 |
|
| 189 | - ), |
|
| 190 | - 'LIN_total' => new EE_Money_Field( |
|
| 191 | - 'LIN_total', |
|
| 192 | - esc_html__('Total (unit price x quantity)', 'event_espresso'), |
|
| 193 | - false, |
|
| 194 | - 0 |
|
| 195 | - ), |
|
| 196 | - 'LIN_quantity' => new EE_Integer_Field( |
|
| 197 | - 'LIN_quantity', |
|
| 198 | - esc_html__('Quantity', 'event_espresso'), |
|
| 199 | - true, |
|
| 200 | - 1 |
|
| 201 | - ), |
|
| 202 | - 'LIN_parent' => new EE_Integer_Field( |
|
| 203 | - 'LIN_parent', |
|
| 204 | - esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'), |
|
| 205 | - true, |
|
| 206 | - null |
|
| 207 | - ), |
|
| 208 | - 'LIN_type' => new EE_Enum_Text_Field( |
|
| 209 | - 'LIN_type', |
|
| 210 | - esc_html__('Type', 'event_espresso'), |
|
| 211 | - false, |
|
| 212 | - 'line-item', |
|
| 213 | - array( |
|
| 214 | - self::type_line_item => esc_html__('Line Item', 'event_espresso'), |
|
| 215 | - self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'), |
|
| 216 | - self::type_sub_total => esc_html__('Subtotal', 'event_espresso'), |
|
| 217 | - self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'), |
|
| 218 | - self::type_tax => esc_html__('Tax', 'event_espresso'), |
|
| 219 | - self::type_total => esc_html__('Total', 'event_espresso'), |
|
| 220 | - self::type_cancellation => esc_html__('Cancellation', 'event_espresso'), |
|
| 221 | - ) |
|
| 222 | - ), |
|
| 223 | - 'OBJ_ID' => new EE_Foreign_Key_Int_Field( |
|
| 224 | - 'OBJ_ID', |
|
| 225 | - esc_html__('ID of Item purchased.', 'event_espresso'), |
|
| 226 | - true, |
|
| 227 | - null, |
|
| 228 | - $line_items_can_be_for |
|
| 229 | - ), |
|
| 230 | - 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
| 231 | - 'OBJ_type', |
|
| 232 | - esc_html__('Model Name this Line Item is for', 'event_espresso'), |
|
| 233 | - true, |
|
| 234 | - null, |
|
| 235 | - $line_items_can_be_for |
|
| 236 | - ), |
|
| 237 | - 'LIN_timestamp' => new EE_Datetime_Field( |
|
| 238 | - 'LIN_timestamp', |
|
| 239 | - esc_html__('When the line item was created', 'event_espresso'), |
|
| 240 | - false, |
|
| 241 | - EE_Datetime_Field::now, |
|
| 242 | - $timezone |
|
| 243 | - ), |
|
| 244 | - ), |
|
| 245 | - ); |
|
| 246 | - $this->_model_relations = array( |
|
| 247 | - 'Transaction' => new EE_Belongs_To_Relation(), |
|
| 248 | - 'Ticket' => new EE_Belongs_To_Any_Relation(), |
|
| 249 | - 'Price' => new EE_Belongs_To_Any_Relation(), |
|
| 250 | - 'Event' => new EE_Belongs_To_Any_Relation(), |
|
| 251 | - ); |
|
| 252 | - $this->_model_chain_to_wp_user = 'Transaction.Registration.Event'; |
|
| 253 | - $this->_caps_slug = 'transactions'; |
|
| 254 | - parent::__construct($timezone); |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * Gets all the line items for this transaction of the given type |
|
| 260 | - * |
|
| 261 | - * @param string $line_item_type like one of EEM_Line_Item::type_* |
|
| 262 | - * @param EE_Transaction|int $transaction |
|
| 263 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 264 | - * @throws EE_Error |
|
| 265 | - * @throws InvalidArgumentException |
|
| 266 | - * @throws InvalidDataTypeException |
|
| 267 | - * @throws InvalidInterfaceException |
|
| 268 | - */ |
|
| 269 | - public function get_all_of_type_for_transaction($line_item_type, $transaction) |
|
| 270 | - { |
|
| 271 | - $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
| 272 | - return $this->get_all(array( |
|
| 273 | - array( |
|
| 274 | - 'LIN_type' => $line_item_type, |
|
| 275 | - 'TXN_ID' => $transaction, |
|
| 276 | - ), |
|
| 277 | - )); |
|
| 278 | - } |
|
| 279 | - |
|
| 280 | - |
|
| 281 | - /** |
|
| 282 | - * Gets all line items unrelated to tickets that are normal line items |
|
| 283 | - * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category) |
|
| 284 | - * |
|
| 285 | - * @param EE_Transaction|int $transaction |
|
| 286 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 287 | - * @throws EE_Error |
|
| 288 | - * @throws InvalidArgumentException |
|
| 289 | - * @throws InvalidDataTypeException |
|
| 290 | - * @throws InvalidInterfaceException |
|
| 291 | - */ |
|
| 292 | - public function get_all_non_ticket_line_items_for_transaction($transaction) |
|
| 293 | - { |
|
| 294 | - $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
| 295 | - return $this->get_all(array( |
|
| 296 | - array( |
|
| 297 | - 'LIN_type' => self::type_line_item, |
|
| 298 | - 'TXN_ID' => $transaction, |
|
| 299 | - 'OR' => array( |
|
| 300 | - 'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET), |
|
| 301 | - 'OBJ_type*null' => array('IS_NULL'), |
|
| 302 | - ), |
|
| 303 | - ), |
|
| 304 | - )); |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * Deletes line items with no transaction who have passed the transaction cutoff time. |
|
| 310 | - * This needs to be very efficient |
|
| 311 | - * because if there are spam bots afoot there will be LOTS of line items |
|
| 312 | - * |
|
| 313 | - * @return int count of how many deleted |
|
| 314 | - * @throws EE_Error |
|
| 315 | - * @throws InvalidArgumentException |
|
| 316 | - * @throws InvalidDataTypeException |
|
| 317 | - * @throws InvalidInterfaceException |
|
| 318 | - */ |
|
| 319 | - public function delete_line_items_with_no_transaction() |
|
| 320 | - { |
|
| 321 | - /** @type WPDB $wpdb */ |
|
| 322 | - global $wpdb; |
|
| 323 | - $time_to_leave_alone = apply_filters( |
|
| 324 | - 'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', |
|
| 325 | - WEEK_IN_SECONDS |
|
| 326 | - ); |
|
| 327 | - $query = $wpdb->prepare( |
|
| 328 | - 'DELETE li |
|
| 31 | + /** |
|
| 32 | + * Tax sub-total is just the total of all the taxes, which should be children |
|
| 33 | + * of this line item. There should only ever be one tax sub-total, and it should |
|
| 34 | + * be a direct child of. Its quantity and LIN_unit_price = 1. |
|
| 35 | + */ |
|
| 36 | + const type_tax_sub_total = 'tax-sub-total'; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * Tax line items indicate a tax applied to all the taxable line items. |
|
| 40 | + * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
| 41 | + * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
| 42 | + */ |
|
| 43 | + const type_tax = 'tax'; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * Indicating individual items purchased, or discounts or surcharges. |
|
| 47 | + * The sum of all the regular line items plus the tax items should equal the grand total. |
|
| 48 | + * Possible children are sub-line-items and cancellations. |
|
| 49 | + * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children |
|
| 50 | + * LIN_totals. Its LIN_percent = 0. |
|
| 51 | + * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1). |
|
| 52 | + * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1. |
|
| 53 | + */ |
|
| 54 | + const type_line_item = 'line-item'; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * Line item indicating all the factors that make a single line item. |
|
| 58 | + * Sub-line items should have NO children line items. |
|
| 59 | + * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's |
|
| 60 | + * contribution towards the price of ONE of their parent items, and its LIN_total should be |
|
| 61 | + * = LIN_quantity * LIN_unit_price. Its LIN_percent = 0. |
|
| 62 | + * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should |
|
| 63 | + * = LIN_percent / 100 * sum of lower-priority sibling line items.. |
|
| 64 | + */ |
|
| 65 | + const type_sub_line_item = 'sub-item'; |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal). |
|
| 69 | + * Direct children should be event subtotals. |
|
| 70 | + * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals. |
|
| 71 | + */ |
|
| 72 | + const type_sub_total = 'sub-total'; |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Line item for the grand total of an order. |
|
| 76 | + * Its direct children should be tax subtotals and (pre-tax) subtotals, |
|
| 77 | + * and possibly a regular line item indicating a transaction-wide discount/surcharge. |
|
| 78 | + * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount. |
|
| 79 | + */ |
|
| 80 | + const type_total = 'total'; |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * When a line item is cancelled, a sub-line-item of type 'cancellation' |
|
| 84 | + * should be created, indicating the quantity that were cancelled |
|
| 85 | + * (because a line item could have a quantity of 1, and its cancellation item |
|
| 86 | + * could be for 3, indicating that originally 4 were purchased, but 3 have been |
|
| 87 | + * cancelled, and only one remains). |
|
| 88 | + * When items are refunded, a cancellation line item should be made, which points |
|
| 89 | + * to teh payment model object which actually refunded the payment. |
|
| 90 | + * Cancellations should NOT have any children line items; the should NOT affect |
|
| 91 | + * any calculations, and are only meant as a record that cancellations have occurred. |
|
| 92 | + * Their LIN_percent should be 0. |
|
| 93 | + */ |
|
| 94 | + const type_cancellation = 'cancellation'; |
|
| 95 | + |
|
| 96 | + // various line item object types |
|
| 97 | + const OBJ_TYPE_EVENT = 'Event'; |
|
| 98 | + |
|
| 99 | + const OBJ_TYPE_PRICE = 'Price'; |
|
| 100 | + |
|
| 101 | + const OBJ_TYPE_PROMOTION = 'Promotion'; |
|
| 102 | + |
|
| 103 | + const OBJ_TYPE_TICKET = 'Ticket'; |
|
| 104 | + |
|
| 105 | + const OBJ_TYPE_TRANSACTION = 'Transaction'; |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * @var EEM_Line_Item $_instance |
|
| 109 | + */ |
|
| 110 | + protected static $_instance; |
|
| 111 | + |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * private constructor to prevent direct creation |
|
| 115 | + * |
|
| 116 | + * @Constructor |
|
| 117 | + * @param string $timezone string representing the timezone we want to set for returned Date Time Strings |
|
| 118 | + * (and any incoming timezone data that gets saved). |
|
| 119 | + * Note this just sends the timezone info to the date time model field objects. |
|
| 120 | + * Default is NULL |
|
| 121 | + * (and will be assumed using the set timezone in the 'timezone_string' wp option) |
|
| 122 | + * @throws EE_Error |
|
| 123 | + * @throws InvalidArgumentException |
|
| 124 | + */ |
|
| 125 | + protected function __construct($timezone) |
|
| 126 | + { |
|
| 127 | + $this->singular_item = esc_html__('Line Item', 'event_espresso'); |
|
| 128 | + $this->plural_item = esc_html__('Line Items', 'event_espresso'); |
|
| 129 | + |
|
| 130 | + $this->_tables = array( |
|
| 131 | + 'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'), |
|
| 132 | + ); |
|
| 133 | + $line_items_can_be_for = apply_filters( |
|
| 134 | + 'FHEE__EEM_Line_Item__line_items_can_be_for', |
|
| 135 | + array('Ticket', 'Price', 'Event') |
|
| 136 | + ); |
|
| 137 | + $this->_fields = array( |
|
| 138 | + 'Line_Item' => array( |
|
| 139 | + 'LIN_ID' => new EE_Primary_Key_Int_Field( |
|
| 140 | + 'LIN_ID', |
|
| 141 | + esc_html__('ID', 'event_espresso') |
|
| 142 | + ), |
|
| 143 | + 'LIN_code' => new EE_Slug_Field( |
|
| 144 | + 'LIN_code', |
|
| 145 | + esc_html__('Code for index into Cart', 'event_espresso'), |
|
| 146 | + true |
|
| 147 | + ), |
|
| 148 | + 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
| 149 | + 'TXN_ID', |
|
| 150 | + esc_html__('Transaction ID', 'event_espresso'), |
|
| 151 | + true, |
|
| 152 | + null, |
|
| 153 | + 'Transaction' |
|
| 154 | + ), |
|
| 155 | + 'LIN_name' => new EE_Full_HTML_Field( |
|
| 156 | + 'LIN_name', |
|
| 157 | + esc_html__('Line Item Name', 'event_espresso'), |
|
| 158 | + false, |
|
| 159 | + '' |
|
| 160 | + ), |
|
| 161 | + 'LIN_desc' => new EE_Full_HTML_Field( |
|
| 162 | + 'LIN_desc', |
|
| 163 | + esc_html__('Line Item Description', 'event_espresso'), |
|
| 164 | + true |
|
| 165 | + ), |
|
| 166 | + 'LIN_unit_price' => new EE_Money_Field( |
|
| 167 | + 'LIN_unit_price', |
|
| 168 | + esc_html__('Unit Price', 'event_espresso'), |
|
| 169 | + false, |
|
| 170 | + 0 |
|
| 171 | + ), |
|
| 172 | + 'LIN_percent' => new EE_Float_Field( |
|
| 173 | + 'LIN_percent', |
|
| 174 | + esc_html__('Percent', 'event_espresso'), |
|
| 175 | + false, |
|
| 176 | + 0 |
|
| 177 | + ), |
|
| 178 | + 'LIN_is_taxable' => new EE_Boolean_Field( |
|
| 179 | + 'LIN_is_taxable', |
|
| 180 | + esc_html__('Taxable', 'event_espresso'), |
|
| 181 | + false, |
|
| 182 | + false |
|
| 183 | + ), |
|
| 184 | + 'LIN_order' => new EE_Integer_Field( |
|
| 185 | + 'LIN_order', |
|
| 186 | + esc_html__('Order of Application towards total of parent', 'event_espresso'), |
|
| 187 | + false, |
|
| 188 | + 1 |
|
| 189 | + ), |
|
| 190 | + 'LIN_total' => new EE_Money_Field( |
|
| 191 | + 'LIN_total', |
|
| 192 | + esc_html__('Total (unit price x quantity)', 'event_espresso'), |
|
| 193 | + false, |
|
| 194 | + 0 |
|
| 195 | + ), |
|
| 196 | + 'LIN_quantity' => new EE_Integer_Field( |
|
| 197 | + 'LIN_quantity', |
|
| 198 | + esc_html__('Quantity', 'event_espresso'), |
|
| 199 | + true, |
|
| 200 | + 1 |
|
| 201 | + ), |
|
| 202 | + 'LIN_parent' => new EE_Integer_Field( |
|
| 203 | + 'LIN_parent', |
|
| 204 | + esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'), |
|
| 205 | + true, |
|
| 206 | + null |
|
| 207 | + ), |
|
| 208 | + 'LIN_type' => new EE_Enum_Text_Field( |
|
| 209 | + 'LIN_type', |
|
| 210 | + esc_html__('Type', 'event_espresso'), |
|
| 211 | + false, |
|
| 212 | + 'line-item', |
|
| 213 | + array( |
|
| 214 | + self::type_line_item => esc_html__('Line Item', 'event_espresso'), |
|
| 215 | + self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'), |
|
| 216 | + self::type_sub_total => esc_html__('Subtotal', 'event_espresso'), |
|
| 217 | + self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'), |
|
| 218 | + self::type_tax => esc_html__('Tax', 'event_espresso'), |
|
| 219 | + self::type_total => esc_html__('Total', 'event_espresso'), |
|
| 220 | + self::type_cancellation => esc_html__('Cancellation', 'event_espresso'), |
|
| 221 | + ) |
|
| 222 | + ), |
|
| 223 | + 'OBJ_ID' => new EE_Foreign_Key_Int_Field( |
|
| 224 | + 'OBJ_ID', |
|
| 225 | + esc_html__('ID of Item purchased.', 'event_espresso'), |
|
| 226 | + true, |
|
| 227 | + null, |
|
| 228 | + $line_items_can_be_for |
|
| 229 | + ), |
|
| 230 | + 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
| 231 | + 'OBJ_type', |
|
| 232 | + esc_html__('Model Name this Line Item is for', 'event_espresso'), |
|
| 233 | + true, |
|
| 234 | + null, |
|
| 235 | + $line_items_can_be_for |
|
| 236 | + ), |
|
| 237 | + 'LIN_timestamp' => new EE_Datetime_Field( |
|
| 238 | + 'LIN_timestamp', |
|
| 239 | + esc_html__('When the line item was created', 'event_espresso'), |
|
| 240 | + false, |
|
| 241 | + EE_Datetime_Field::now, |
|
| 242 | + $timezone |
|
| 243 | + ), |
|
| 244 | + ), |
|
| 245 | + ); |
|
| 246 | + $this->_model_relations = array( |
|
| 247 | + 'Transaction' => new EE_Belongs_To_Relation(), |
|
| 248 | + 'Ticket' => new EE_Belongs_To_Any_Relation(), |
|
| 249 | + 'Price' => new EE_Belongs_To_Any_Relation(), |
|
| 250 | + 'Event' => new EE_Belongs_To_Any_Relation(), |
|
| 251 | + ); |
|
| 252 | + $this->_model_chain_to_wp_user = 'Transaction.Registration.Event'; |
|
| 253 | + $this->_caps_slug = 'transactions'; |
|
| 254 | + parent::__construct($timezone); |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * Gets all the line items for this transaction of the given type |
|
| 260 | + * |
|
| 261 | + * @param string $line_item_type like one of EEM_Line_Item::type_* |
|
| 262 | + * @param EE_Transaction|int $transaction |
|
| 263 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 264 | + * @throws EE_Error |
|
| 265 | + * @throws InvalidArgumentException |
|
| 266 | + * @throws InvalidDataTypeException |
|
| 267 | + * @throws InvalidInterfaceException |
|
| 268 | + */ |
|
| 269 | + public function get_all_of_type_for_transaction($line_item_type, $transaction) |
|
| 270 | + { |
|
| 271 | + $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
| 272 | + return $this->get_all(array( |
|
| 273 | + array( |
|
| 274 | + 'LIN_type' => $line_item_type, |
|
| 275 | + 'TXN_ID' => $transaction, |
|
| 276 | + ), |
|
| 277 | + )); |
|
| 278 | + } |
|
| 279 | + |
|
| 280 | + |
|
| 281 | + /** |
|
| 282 | + * Gets all line items unrelated to tickets that are normal line items |
|
| 283 | + * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category) |
|
| 284 | + * |
|
| 285 | + * @param EE_Transaction|int $transaction |
|
| 286 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 287 | + * @throws EE_Error |
|
| 288 | + * @throws InvalidArgumentException |
|
| 289 | + * @throws InvalidDataTypeException |
|
| 290 | + * @throws InvalidInterfaceException |
|
| 291 | + */ |
|
| 292 | + public function get_all_non_ticket_line_items_for_transaction($transaction) |
|
| 293 | + { |
|
| 294 | + $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
| 295 | + return $this->get_all(array( |
|
| 296 | + array( |
|
| 297 | + 'LIN_type' => self::type_line_item, |
|
| 298 | + 'TXN_ID' => $transaction, |
|
| 299 | + 'OR' => array( |
|
| 300 | + 'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET), |
|
| 301 | + 'OBJ_type*null' => array('IS_NULL'), |
|
| 302 | + ), |
|
| 303 | + ), |
|
| 304 | + )); |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * Deletes line items with no transaction who have passed the transaction cutoff time. |
|
| 310 | + * This needs to be very efficient |
|
| 311 | + * because if there are spam bots afoot there will be LOTS of line items |
|
| 312 | + * |
|
| 313 | + * @return int count of how many deleted |
|
| 314 | + * @throws EE_Error |
|
| 315 | + * @throws InvalidArgumentException |
|
| 316 | + * @throws InvalidDataTypeException |
|
| 317 | + * @throws InvalidInterfaceException |
|
| 318 | + */ |
|
| 319 | + public function delete_line_items_with_no_transaction() |
|
| 320 | + { |
|
| 321 | + /** @type WPDB $wpdb */ |
|
| 322 | + global $wpdb; |
|
| 323 | + $time_to_leave_alone = apply_filters( |
|
| 324 | + 'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', |
|
| 325 | + WEEK_IN_SECONDS |
|
| 326 | + ); |
|
| 327 | + $query = $wpdb->prepare( |
|
| 328 | + 'DELETE li |
|
| 329 | 329 | FROM ' . $this->table() . ' li |
| 330 | 330 | LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID |
| 331 | 331 | WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s', |
| 332 | - // use GMT time because that's what TXN_timestamps are in |
|
| 333 | - date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
|
| 334 | - ); |
|
| 335 | - return $wpdb->query($query); |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - |
|
| 339 | - /** |
|
| 340 | - * get_line_item_for_transaction_object |
|
| 341 | - * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket |
|
| 342 | - * |
|
| 343 | - * @param int $TXN_ID |
|
| 344 | - * @param EE_Base_Class $object |
|
| 345 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 346 | - * @throws EE_Error |
|
| 347 | - * @throws InvalidArgumentException |
|
| 348 | - * @throws InvalidDataTypeException |
|
| 349 | - * @throws InvalidInterfaceException |
|
| 350 | - * @throws ReflectionException |
|
| 351 | - */ |
|
| 352 | - public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) |
|
| 353 | - { |
|
| 354 | - return $this->get_all(array( |
|
| 355 | - array( |
|
| 356 | - 'TXN_ID' => $TXN_ID, |
|
| 357 | - 'OBJ_type' => str_replace('EE_', '', get_class($object)), |
|
| 358 | - 'OBJ_ID' => $object->ID(), |
|
| 359 | - ), |
|
| 360 | - )); |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * get_object_line_items_for_transaction |
|
| 366 | - * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs |
|
| 367 | - * |
|
| 368 | - * @param int $TXN_ID |
|
| 369 | - * @param string $OBJ_type |
|
| 370 | - * @param array $OBJ_IDs |
|
| 371 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 372 | - * @throws EE_Error |
|
| 373 | - */ |
|
| 374 | - public function get_object_line_items_for_transaction( |
|
| 375 | - $TXN_ID, |
|
| 376 | - $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT, |
|
| 377 | - $OBJ_IDs = array() |
|
| 378 | - ) { |
|
| 379 | - $query_params = array( |
|
| 380 | - 'OBJ_type' => $OBJ_type, |
|
| 381 | - // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query |
|
| 382 | - 'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs, |
|
| 383 | - ); |
|
| 384 | - if ($TXN_ID) { |
|
| 385 | - $query_params['TXN_ID'] = $TXN_ID; |
|
| 386 | - } |
|
| 387 | - return $this->get_all(array($query_params)); |
|
| 388 | - } |
|
| 389 | - |
|
| 390 | - |
|
| 391 | - /** |
|
| 392 | - * get_all_ticket_line_items_for_transaction |
|
| 393 | - * |
|
| 394 | - * @param EE_Transaction $transaction |
|
| 395 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 396 | - * @throws EE_Error |
|
| 397 | - * @throws InvalidArgumentException |
|
| 398 | - * @throws InvalidDataTypeException |
|
| 399 | - * @throws InvalidInterfaceException |
|
| 400 | - * @throws ReflectionException |
|
| 401 | - */ |
|
| 402 | - public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) |
|
| 403 | - { |
|
| 404 | - return $this->get_all(array( |
|
| 405 | - array( |
|
| 406 | - 'TXN_ID' => $transaction->ID(), |
|
| 407 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 408 | - ), |
|
| 409 | - )); |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - |
|
| 413 | - /** |
|
| 414 | - * get_ticket_line_item_for_transaction |
|
| 415 | - * |
|
| 416 | - * @param int $TXN_ID |
|
| 417 | - * @param int $TKT_ID |
|
| 418 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 419 | - * @throws EE_Error |
|
| 420 | - * @throws InvalidArgumentException |
|
| 421 | - * @throws InvalidDataTypeException |
|
| 422 | - * @throws InvalidInterfaceException |
|
| 423 | - */ |
|
| 424 | - public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) |
|
| 425 | - { |
|
| 426 | - return $this->get_one(array( |
|
| 427 | - array( |
|
| 428 | - 'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID), |
|
| 429 | - 'OBJ_ID' => $TKT_ID, |
|
| 430 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 431 | - ), |
|
| 432 | - )); |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - |
|
| 436 | - /** |
|
| 437 | - * get_existing_promotion_line_item |
|
| 438 | - * searches the cart for existing line items for the specified promotion |
|
| 439 | - * |
|
| 440 | - * @since 1.0.0 |
|
| 441 | - * @param EE_Line_Item $parent_line_item |
|
| 442 | - * @param EE_Promotion $promotion |
|
| 443 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 444 | - * @throws EE_Error |
|
| 445 | - * @throws InvalidArgumentException |
|
| 446 | - * @throws InvalidDataTypeException |
|
| 447 | - * @throws InvalidInterfaceException |
|
| 448 | - * @throws ReflectionException |
|
| 449 | - */ |
|
| 450 | - public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) |
|
| 451 | - { |
|
| 452 | - return $this->get_one(array( |
|
| 453 | - array( |
|
| 454 | - 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
| 455 | - 'LIN_parent' => $parent_line_item->ID(), |
|
| 456 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
| 457 | - 'OBJ_ID' => $promotion->ID(), |
|
| 458 | - ), |
|
| 459 | - )); |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - |
|
| 463 | - /** |
|
| 464 | - * get_all_promotion_line_items |
|
| 465 | - * searches the cart for any and all existing promotion line items |
|
| 466 | - * |
|
| 467 | - * @since 1.0.0 |
|
| 468 | - * @param EE_Line_Item $parent_line_item |
|
| 469 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 470 | - * @throws EE_Error |
|
| 471 | - * @throws InvalidArgumentException |
|
| 472 | - * @throws InvalidDataTypeException |
|
| 473 | - * @throws InvalidInterfaceException |
|
| 474 | - * @throws ReflectionException |
|
| 475 | - */ |
|
| 476 | - public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) |
|
| 477 | - { |
|
| 478 | - return $this->get_all(array( |
|
| 479 | - array( |
|
| 480 | - 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
| 481 | - 'LIN_parent' => $parent_line_item->ID(), |
|
| 482 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
| 483 | - ), |
|
| 484 | - )); |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - |
|
| 488 | - /** |
|
| 489 | - * Gets the registration's corresponding line item. |
|
| 490 | - * Note: basically does NOT support having multiple line items for a single ticket, |
|
| 491 | - * which would happen if some of the registrations had a price modifier while others didn't. |
|
| 492 | - * In order to support that, we'd probably need a LIN_ID on registrations or something. |
|
| 493 | - * |
|
| 494 | - * @param EE_Registration $registration |
|
| 495 | - * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL |
|
| 496 | - * @throws EE_Error |
|
| 497 | - */ |
|
| 498 | - public function get_line_item_for_registration(EE_Registration $registration) |
|
| 499 | - { |
|
| 500 | - return $this->get_one($this->line_item_for_registration_query_params($registration)); |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - |
|
| 504 | - /** |
|
| 505 | - * Gets the query params used to retrieve a specific line item for the given registration |
|
| 506 | - * |
|
| 507 | - * @param EE_Registration $registration |
|
| 508 | - * @param array $original_query_params any extra query params you'd like to be merged with |
|
| 509 | - * @return array @see |
|
| 510 | - * https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 511 | - * @throws EE_Error |
|
| 512 | - */ |
|
| 513 | - public function line_item_for_registration_query_params( |
|
| 514 | - EE_Registration $registration, |
|
| 515 | - $original_query_params = array() |
|
| 516 | - ) { |
|
| 517 | - return array_replace_recursive($original_query_params, array( |
|
| 518 | - array( |
|
| 519 | - 'OBJ_ID' => $registration->ticket_ID(), |
|
| 520 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 521 | - 'TXN_ID' => $registration->transaction_ID(), |
|
| 522 | - ), |
|
| 523 | - )); |
|
| 524 | - } |
|
| 525 | - |
|
| 526 | - |
|
| 527 | - /** |
|
| 528 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 529 | - * @throws InvalidInterfaceException |
|
| 530 | - * @throws InvalidDataTypeException |
|
| 531 | - * @throws EE_Error |
|
| 532 | - * @throws InvalidArgumentException |
|
| 533 | - */ |
|
| 534 | - public function get_total_line_items_with_no_transaction() |
|
| 535 | - { |
|
| 536 | - return $this->get_total_line_items_for_carts(); |
|
| 537 | - } |
|
| 538 | - |
|
| 539 | - |
|
| 540 | - /** |
|
| 541 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 542 | - * @throws InvalidInterfaceException |
|
| 543 | - * @throws InvalidDataTypeException |
|
| 544 | - * @throws EE_Error |
|
| 545 | - * @throws InvalidArgumentException |
|
| 546 | - */ |
|
| 547 | - public function get_total_line_items_for_active_carts() |
|
| 548 | - { |
|
| 549 | - return $this->get_total_line_items_for_carts(false); |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - |
|
| 553 | - /** |
|
| 554 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 555 | - * @throws InvalidInterfaceException |
|
| 556 | - * @throws InvalidDataTypeException |
|
| 557 | - * @throws EE_Error |
|
| 558 | - * @throws InvalidArgumentException |
|
| 559 | - */ |
|
| 560 | - public function get_total_line_items_for_expired_carts() |
|
| 561 | - { |
|
| 562 | - return $this->get_total_line_items_for_carts(true); |
|
| 563 | - } |
|
| 564 | - |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Returns an array of grand total line items where the TXN_ID is 0. |
|
| 568 | - * If $expired is set to true, then only line items for expired sessions will be returned. |
|
| 569 | - * If $expired is set to false, then only line items for active sessions will be returned. |
|
| 570 | - * |
|
| 571 | - * @param null $expired |
|
| 572 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 573 | - * @throws EE_Error |
|
| 574 | - * @throws InvalidArgumentException |
|
| 575 | - * @throws InvalidDataTypeException |
|
| 576 | - * @throws InvalidInterfaceException |
|
| 577 | - */ |
|
| 578 | - private function get_total_line_items_for_carts($expired = null) |
|
| 579 | - { |
|
| 580 | - $where_params = array( |
|
| 581 | - 'TXN_ID' => 0, |
|
| 582 | - 'LIN_type' => 'total', |
|
| 583 | - ); |
|
| 584 | - if ($expired !== null) { |
|
| 585 | - /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
| 586 | - $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
| 587 | - 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
| 588 | - ); |
|
| 589 | - $where_params['LIN_timestamp'] = array( |
|
| 590 | - $expired ? '<=' : '>', |
|
| 591 | - $session_lifespan->expiration(), |
|
| 592 | - ); |
|
| 593 | - } |
|
| 594 | - return $this->get_all(array($where_params)); |
|
| 595 | - } |
|
| 596 | - |
|
| 597 | - |
|
| 598 | - /** |
|
| 599 | - * Returns an array of ticket total line items where the TXN_ID is 0 |
|
| 600 | - * AND the timestamp is older than the session lifespan. |
|
| 601 | - * |
|
| 602 | - * @param int $timestamp |
|
| 603 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 604 | - * @throws EE_Error |
|
| 605 | - * @throws InvalidArgumentException |
|
| 606 | - * @throws InvalidDataTypeException |
|
| 607 | - * @throws InvalidInterfaceException |
|
| 608 | - */ |
|
| 609 | - public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
|
| 610 | - { |
|
| 611 | - if (! absint($timestamp)) { |
|
| 612 | - /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
| 613 | - $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
| 614 | - 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
| 615 | - ); |
|
| 616 | - $timestamp = $session_lifespan->expiration(); |
|
| 617 | - } |
|
| 618 | - return $this->get_all( |
|
| 619 | - array( |
|
| 620 | - array( |
|
| 621 | - 'TXN_ID' => 0, |
|
| 622 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 623 | - 'LIN_timestamp' => array('<=', $timestamp), |
|
| 624 | - ), |
|
| 625 | - ) |
|
| 626 | - ); |
|
| 627 | - } |
|
| 332 | + // use GMT time because that's what TXN_timestamps are in |
|
| 333 | + date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
|
| 334 | + ); |
|
| 335 | + return $wpdb->query($query); |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + |
|
| 339 | + /** |
|
| 340 | + * get_line_item_for_transaction_object |
|
| 341 | + * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket |
|
| 342 | + * |
|
| 343 | + * @param int $TXN_ID |
|
| 344 | + * @param EE_Base_Class $object |
|
| 345 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 346 | + * @throws EE_Error |
|
| 347 | + * @throws InvalidArgumentException |
|
| 348 | + * @throws InvalidDataTypeException |
|
| 349 | + * @throws InvalidInterfaceException |
|
| 350 | + * @throws ReflectionException |
|
| 351 | + */ |
|
| 352 | + public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) |
|
| 353 | + { |
|
| 354 | + return $this->get_all(array( |
|
| 355 | + array( |
|
| 356 | + 'TXN_ID' => $TXN_ID, |
|
| 357 | + 'OBJ_type' => str_replace('EE_', '', get_class($object)), |
|
| 358 | + 'OBJ_ID' => $object->ID(), |
|
| 359 | + ), |
|
| 360 | + )); |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * get_object_line_items_for_transaction |
|
| 366 | + * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs |
|
| 367 | + * |
|
| 368 | + * @param int $TXN_ID |
|
| 369 | + * @param string $OBJ_type |
|
| 370 | + * @param array $OBJ_IDs |
|
| 371 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 372 | + * @throws EE_Error |
|
| 373 | + */ |
|
| 374 | + public function get_object_line_items_for_transaction( |
|
| 375 | + $TXN_ID, |
|
| 376 | + $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT, |
|
| 377 | + $OBJ_IDs = array() |
|
| 378 | + ) { |
|
| 379 | + $query_params = array( |
|
| 380 | + 'OBJ_type' => $OBJ_type, |
|
| 381 | + // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query |
|
| 382 | + 'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs, |
|
| 383 | + ); |
|
| 384 | + if ($TXN_ID) { |
|
| 385 | + $query_params['TXN_ID'] = $TXN_ID; |
|
| 386 | + } |
|
| 387 | + return $this->get_all(array($query_params)); |
|
| 388 | + } |
|
| 389 | + |
|
| 390 | + |
|
| 391 | + /** |
|
| 392 | + * get_all_ticket_line_items_for_transaction |
|
| 393 | + * |
|
| 394 | + * @param EE_Transaction $transaction |
|
| 395 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 396 | + * @throws EE_Error |
|
| 397 | + * @throws InvalidArgumentException |
|
| 398 | + * @throws InvalidDataTypeException |
|
| 399 | + * @throws InvalidInterfaceException |
|
| 400 | + * @throws ReflectionException |
|
| 401 | + */ |
|
| 402 | + public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) |
|
| 403 | + { |
|
| 404 | + return $this->get_all(array( |
|
| 405 | + array( |
|
| 406 | + 'TXN_ID' => $transaction->ID(), |
|
| 407 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 408 | + ), |
|
| 409 | + )); |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + |
|
| 413 | + /** |
|
| 414 | + * get_ticket_line_item_for_transaction |
|
| 415 | + * |
|
| 416 | + * @param int $TXN_ID |
|
| 417 | + * @param int $TKT_ID |
|
| 418 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 419 | + * @throws EE_Error |
|
| 420 | + * @throws InvalidArgumentException |
|
| 421 | + * @throws InvalidDataTypeException |
|
| 422 | + * @throws InvalidInterfaceException |
|
| 423 | + */ |
|
| 424 | + public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) |
|
| 425 | + { |
|
| 426 | + return $this->get_one(array( |
|
| 427 | + array( |
|
| 428 | + 'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID), |
|
| 429 | + 'OBJ_ID' => $TKT_ID, |
|
| 430 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 431 | + ), |
|
| 432 | + )); |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + |
|
| 436 | + /** |
|
| 437 | + * get_existing_promotion_line_item |
|
| 438 | + * searches the cart for existing line items for the specified promotion |
|
| 439 | + * |
|
| 440 | + * @since 1.0.0 |
|
| 441 | + * @param EE_Line_Item $parent_line_item |
|
| 442 | + * @param EE_Promotion $promotion |
|
| 443 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 444 | + * @throws EE_Error |
|
| 445 | + * @throws InvalidArgumentException |
|
| 446 | + * @throws InvalidDataTypeException |
|
| 447 | + * @throws InvalidInterfaceException |
|
| 448 | + * @throws ReflectionException |
|
| 449 | + */ |
|
| 450 | + public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) |
|
| 451 | + { |
|
| 452 | + return $this->get_one(array( |
|
| 453 | + array( |
|
| 454 | + 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
| 455 | + 'LIN_parent' => $parent_line_item->ID(), |
|
| 456 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
| 457 | + 'OBJ_ID' => $promotion->ID(), |
|
| 458 | + ), |
|
| 459 | + )); |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + |
|
| 463 | + /** |
|
| 464 | + * get_all_promotion_line_items |
|
| 465 | + * searches the cart for any and all existing promotion line items |
|
| 466 | + * |
|
| 467 | + * @since 1.0.0 |
|
| 468 | + * @param EE_Line_Item $parent_line_item |
|
| 469 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 470 | + * @throws EE_Error |
|
| 471 | + * @throws InvalidArgumentException |
|
| 472 | + * @throws InvalidDataTypeException |
|
| 473 | + * @throws InvalidInterfaceException |
|
| 474 | + * @throws ReflectionException |
|
| 475 | + */ |
|
| 476 | + public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) |
|
| 477 | + { |
|
| 478 | + return $this->get_all(array( |
|
| 479 | + array( |
|
| 480 | + 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
| 481 | + 'LIN_parent' => $parent_line_item->ID(), |
|
| 482 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
| 483 | + ), |
|
| 484 | + )); |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + |
|
| 488 | + /** |
|
| 489 | + * Gets the registration's corresponding line item. |
|
| 490 | + * Note: basically does NOT support having multiple line items for a single ticket, |
|
| 491 | + * which would happen if some of the registrations had a price modifier while others didn't. |
|
| 492 | + * In order to support that, we'd probably need a LIN_ID on registrations or something. |
|
| 493 | + * |
|
| 494 | + * @param EE_Registration $registration |
|
| 495 | + * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL |
|
| 496 | + * @throws EE_Error |
|
| 497 | + */ |
|
| 498 | + public function get_line_item_for_registration(EE_Registration $registration) |
|
| 499 | + { |
|
| 500 | + return $this->get_one($this->line_item_for_registration_query_params($registration)); |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + |
|
| 504 | + /** |
|
| 505 | + * Gets the query params used to retrieve a specific line item for the given registration |
|
| 506 | + * |
|
| 507 | + * @param EE_Registration $registration |
|
| 508 | + * @param array $original_query_params any extra query params you'd like to be merged with |
|
| 509 | + * @return array @see |
|
| 510 | + * https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 511 | + * @throws EE_Error |
|
| 512 | + */ |
|
| 513 | + public function line_item_for_registration_query_params( |
|
| 514 | + EE_Registration $registration, |
|
| 515 | + $original_query_params = array() |
|
| 516 | + ) { |
|
| 517 | + return array_replace_recursive($original_query_params, array( |
|
| 518 | + array( |
|
| 519 | + 'OBJ_ID' => $registration->ticket_ID(), |
|
| 520 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 521 | + 'TXN_ID' => $registration->transaction_ID(), |
|
| 522 | + ), |
|
| 523 | + )); |
|
| 524 | + } |
|
| 525 | + |
|
| 526 | + |
|
| 527 | + /** |
|
| 528 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 529 | + * @throws InvalidInterfaceException |
|
| 530 | + * @throws InvalidDataTypeException |
|
| 531 | + * @throws EE_Error |
|
| 532 | + * @throws InvalidArgumentException |
|
| 533 | + */ |
|
| 534 | + public function get_total_line_items_with_no_transaction() |
|
| 535 | + { |
|
| 536 | + return $this->get_total_line_items_for_carts(); |
|
| 537 | + } |
|
| 538 | + |
|
| 539 | + |
|
| 540 | + /** |
|
| 541 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 542 | + * @throws InvalidInterfaceException |
|
| 543 | + * @throws InvalidDataTypeException |
|
| 544 | + * @throws EE_Error |
|
| 545 | + * @throws InvalidArgumentException |
|
| 546 | + */ |
|
| 547 | + public function get_total_line_items_for_active_carts() |
|
| 548 | + { |
|
| 549 | + return $this->get_total_line_items_for_carts(false); |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + |
|
| 553 | + /** |
|
| 554 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 555 | + * @throws InvalidInterfaceException |
|
| 556 | + * @throws InvalidDataTypeException |
|
| 557 | + * @throws EE_Error |
|
| 558 | + * @throws InvalidArgumentException |
|
| 559 | + */ |
|
| 560 | + public function get_total_line_items_for_expired_carts() |
|
| 561 | + { |
|
| 562 | + return $this->get_total_line_items_for_carts(true); |
|
| 563 | + } |
|
| 564 | + |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Returns an array of grand total line items where the TXN_ID is 0. |
|
| 568 | + * If $expired is set to true, then only line items for expired sessions will be returned. |
|
| 569 | + * If $expired is set to false, then only line items for active sessions will be returned. |
|
| 570 | + * |
|
| 571 | + * @param null $expired |
|
| 572 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 573 | + * @throws EE_Error |
|
| 574 | + * @throws InvalidArgumentException |
|
| 575 | + * @throws InvalidDataTypeException |
|
| 576 | + * @throws InvalidInterfaceException |
|
| 577 | + */ |
|
| 578 | + private function get_total_line_items_for_carts($expired = null) |
|
| 579 | + { |
|
| 580 | + $where_params = array( |
|
| 581 | + 'TXN_ID' => 0, |
|
| 582 | + 'LIN_type' => 'total', |
|
| 583 | + ); |
|
| 584 | + if ($expired !== null) { |
|
| 585 | + /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
| 586 | + $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
| 587 | + 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
| 588 | + ); |
|
| 589 | + $where_params['LIN_timestamp'] = array( |
|
| 590 | + $expired ? '<=' : '>', |
|
| 591 | + $session_lifespan->expiration(), |
|
| 592 | + ); |
|
| 593 | + } |
|
| 594 | + return $this->get_all(array($where_params)); |
|
| 595 | + } |
|
| 596 | + |
|
| 597 | + |
|
| 598 | + /** |
|
| 599 | + * Returns an array of ticket total line items where the TXN_ID is 0 |
|
| 600 | + * AND the timestamp is older than the session lifespan. |
|
| 601 | + * |
|
| 602 | + * @param int $timestamp |
|
| 603 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 604 | + * @throws EE_Error |
|
| 605 | + * @throws InvalidArgumentException |
|
| 606 | + * @throws InvalidDataTypeException |
|
| 607 | + * @throws InvalidInterfaceException |
|
| 608 | + */ |
|
| 609 | + public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
|
| 610 | + { |
|
| 611 | + if (! absint($timestamp)) { |
|
| 612 | + /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
| 613 | + $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
| 614 | + 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
| 615 | + ); |
|
| 616 | + $timestamp = $session_lifespan->expiration(); |
|
| 617 | + } |
|
| 618 | + return $this->get_all( |
|
| 619 | + array( |
|
| 620 | + array( |
|
| 621 | + 'TXN_ID' => 0, |
|
| 622 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
| 623 | + 'LIN_timestamp' => array('<=', $timestamp), |
|
| 624 | + ), |
|
| 625 | + ) |
|
| 626 | + ); |
|
| 627 | + } |
|
| 628 | 628 | } |
@@ -356,7 +356,7 @@ discard block |
||
| 356 | 356 | // enqueue style |
| 357 | 357 | wp_register_style( |
| 358 | 358 | 'espresso_txn', |
| 359 | - TXN_ASSETS_URL . 'espresso_transactions_admin.css', |
|
| 359 | + TXN_ASSETS_URL.'espresso_transactions_admin.css', |
|
| 360 | 360 | array(), |
| 361 | 361 | EVENT_ESPRESSO_VERSION |
| 362 | 362 | ); |
@@ -364,7 +364,7 @@ discard block |
||
| 364 | 364 | // scripts |
| 365 | 365 | wp_register_script( |
| 366 | 366 | 'espresso_txn', |
| 367 | - TXN_ASSETS_URL . 'espresso_transactions_admin.js', |
|
| 367 | + TXN_ASSETS_URL.'espresso_transactions_admin.js', |
|
| 368 | 368 | array( |
| 369 | 369 | 'ee_admin_js', |
| 370 | 370 | 'ee-datepicker', |
@@ -492,7 +492,7 @@ discard block |
||
| 492 | 492 | $this->_transaction->verify_abandoned_transaction_status(); |
| 493 | 493 | } |
| 494 | 494 | |
| 495 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
| 495 | + if ( ! $this->_transaction instanceof EE_Transaction) { |
|
| 496 | 496 | $error_msg = sprintf( |
| 497 | 497 | esc_html__( |
| 498 | 498 | 'An error occurred and the details for the transaction with the ID # %d could not be retrieved.', |
@@ -585,7 +585,7 @@ discard block |
||
| 585 | 585 | 'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items', |
| 586 | 586 | array( |
| 587 | 587 | 'overpaid' => array( |
| 588 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code, |
|
| 588 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::overpaid_status_code, |
|
| 589 | 589 | 'desc' => EEH_Template::pretty_status( |
| 590 | 590 | EEM_Transaction::overpaid_status_code, |
| 591 | 591 | false, |
@@ -593,7 +593,7 @@ discard block |
||
| 593 | 593 | ), |
| 594 | 594 | ), |
| 595 | 595 | 'complete' => array( |
| 596 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code, |
|
| 596 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::complete_status_code, |
|
| 597 | 597 | 'desc' => EEH_Template::pretty_status( |
| 598 | 598 | EEM_Transaction::complete_status_code, |
| 599 | 599 | false, |
@@ -601,7 +601,7 @@ discard block |
||
| 601 | 601 | ), |
| 602 | 602 | ), |
| 603 | 603 | 'incomplete' => array( |
| 604 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code, |
|
| 604 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::incomplete_status_code, |
|
| 605 | 605 | 'desc' => EEH_Template::pretty_status( |
| 606 | 606 | EEM_Transaction::incomplete_status_code, |
| 607 | 607 | false, |
@@ -609,7 +609,7 @@ discard block |
||
| 609 | 609 | ), |
| 610 | 610 | ), |
| 611 | 611 | 'abandoned' => array( |
| 612 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code, |
|
| 612 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::abandoned_status_code, |
|
| 613 | 613 | 'desc' => EEH_Template::pretty_status( |
| 614 | 614 | EEM_Transaction::abandoned_status_code, |
| 615 | 615 | false, |
@@ -617,7 +617,7 @@ discard block |
||
| 617 | 617 | ), |
| 618 | 618 | ), |
| 619 | 619 | 'failed' => array( |
| 620 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code, |
|
| 620 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::failed_status_code, |
|
| 621 | 621 | 'desc' => EEH_Template::pretty_status( |
| 622 | 622 | EEM_Transaction::failed_status_code, |
| 623 | 623 | false, |
@@ -666,7 +666,7 @@ discard block |
||
| 666 | 666 | 'Click to Edit event', |
| 667 | 667 | 'event_espresso' |
| 668 | 668 | ) |
| 669 | - . '">' . $event->name() . '</a>', |
|
| 669 | + . '">'.$event->name().'</a>', |
|
| 670 | 670 | '</h3>' |
| 671 | 671 | ) |
| 672 | 672 | : ''; |
@@ -700,7 +700,7 @@ discard block |
||
| 700 | 700 | |
| 701 | 701 | $this->_set_transaction_object(); |
| 702 | 702 | |
| 703 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
| 703 | + if ( ! $this->_transaction instanceof EE_Transaction) { |
|
| 704 | 704 | return; |
| 705 | 705 | } |
| 706 | 706 | $primary_registration = $this->_transaction->primary_registration(); |
@@ -714,9 +714,9 @@ discard block |
||
| 714 | 714 | $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp'); |
| 715 | 715 | $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
| 716 | 716 | |
| 717 | - $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ]; |
|
| 717 | + $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->status_ID()]; |
|
| 718 | 718 | $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso'); |
| 719 | - $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->status_ID(); |
|
| 719 | + $this->_template_args['txn_status']['class'] = 'status-'.$this->_transaction->status_ID(); |
|
| 720 | 720 | |
| 721 | 721 | $this->_template_args['grand_total'] = $this->_transaction->total(); |
| 722 | 722 | $this->_template_args['total_paid'] = $this->_transaction->paid(); |
@@ -832,7 +832,7 @@ discard block |
||
| 832 | 832 | // grab messages at the last second |
| 833 | 833 | $this->_template_args['notices'] = EE_Error::get_notices(); |
| 834 | 834 | // path to template |
| 835 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php'; |
|
| 835 | + $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_header.template.php'; |
|
| 836 | 836 | $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
| 837 | 837 | $template_path, |
| 838 | 838 | $this->_template_args, |
@@ -861,7 +861,7 @@ discard block |
||
| 861 | 861 | |
| 862 | 862 | $this->_set_transaction_object(); |
| 863 | 863 | |
| 864 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
| 864 | + if ( ! $this->_transaction instanceof EE_Transaction) { |
|
| 865 | 865 | return; |
| 866 | 866 | } |
| 867 | 867 | add_meta_box( |
@@ -917,7 +917,7 @@ discard block |
||
| 917 | 917 | { |
| 918 | 918 | $content = ''; |
| 919 | 919 | $actions = array(); |
| 920 | - if (! $transaction instanceof EE_Transaction) { |
|
| 920 | + if ( ! $transaction instanceof EE_Transaction) { |
|
| 921 | 921 | return $content; |
| 922 | 922 | } |
| 923 | 923 | /** @var EE_Registration $primary_registration */ |
@@ -998,7 +998,7 @@ discard block |
||
| 998 | 998 | ); |
| 999 | 999 | if ($actions) { |
| 1000 | 1000 | $content = '<ul>'; |
| 1001 | - $content .= '<li>' . implode('</li><li>', $actions) . '</li>'; |
|
| 1001 | + $content .= '<li>'.implode('</li><li>', $actions).'</li>'; |
|
| 1002 | 1002 | $content .= '</uL>'; |
| 1003 | 1003 | } |
| 1004 | 1004 | return $content; |
@@ -1059,7 +1059,7 @@ discard block |
||
| 1059 | 1059 | |
| 1060 | 1060 | // process payment details |
| 1061 | 1061 | $payments = $this->_transaction->payments(); |
| 1062 | - if (! empty($payments)) { |
|
| 1062 | + if ( ! empty($payments)) { |
|
| 1063 | 1063 | $this->_template_args['payments'] = $payments; |
| 1064 | 1064 | $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments); |
| 1065 | 1065 | } else { |
@@ -1120,7 +1120,7 @@ discard block |
||
| 1120 | 1120 | esc_html__('%1$s : Initiated %2$s', 'event_espresso'), |
| 1121 | 1121 | ucwords(str_replace('_', ' ', $reg_step)), |
| 1122 | 1122 | date( |
| 1123 | - get_option('date_format') . ' ' . get_option('time_format'), |
|
| 1123 | + get_option('date_format').' '.get_option('time_format'), |
|
| 1124 | 1124 | $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS) |
| 1125 | 1125 | ) |
| 1126 | 1126 | ) |
@@ -1173,7 +1173,7 @@ discard block |
||
| 1173 | 1173 | |
| 1174 | 1174 | // 'espresso_delete_payment_nonce' |
| 1175 | 1175 | |
| 1176 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
| 1176 | + $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
| 1177 | 1177 | echo EEH_Template::display_template($template_path, $this->_template_args, true); |
| 1178 | 1178 | } |
| 1179 | 1179 | |
@@ -1205,18 +1205,18 @@ discard block |
||
| 1205 | 1205 | ), |
| 1206 | 1206 | ) |
| 1207 | 1207 | ); |
| 1208 | - if (! empty($reg_payments)) { |
|
| 1208 | + if ( ! empty($reg_payments)) { |
|
| 1209 | 1209 | foreach ($payments as $payment) { |
| 1210 | - if (! $payment instanceof EE_Payment) { |
|
| 1210 | + if ( ! $payment instanceof EE_Payment) { |
|
| 1211 | 1211 | continue; |
| 1212 | - } elseif (! isset($existing_reg_payments[ $payment->ID() ])) { |
|
| 1213 | - $existing_reg_payments[ $payment->ID() ] = array(); |
|
| 1212 | + } elseif ( ! isset($existing_reg_payments[$payment->ID()])) { |
|
| 1213 | + $existing_reg_payments[$payment->ID()] = array(); |
|
| 1214 | 1214 | } |
| 1215 | 1215 | foreach ($reg_payments as $reg_payment) { |
| 1216 | 1216 | if ($reg_payment instanceof EE_Registration_Payment |
| 1217 | 1217 | && $reg_payment->payment_ID() === $payment->ID() |
| 1218 | 1218 | ) { |
| 1219 | - $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID(); |
|
| 1219 | + $existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID(); |
|
| 1220 | 1220 | } |
| 1221 | 1221 | } |
| 1222 | 1222 | } |
@@ -1254,22 +1254,22 @@ discard block |
||
| 1254 | 1254 | ), |
| 1255 | 1255 | ), |
| 1256 | 1256 | ); |
| 1257 | - $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div( |
|
| 1257 | + $registrations_to_apply_payment_to = EEH_HTML::br().EEH_HTML::div( |
|
| 1258 | 1258 | '', |
| 1259 | 1259 | 'txn-admin-apply-payment-to-registrations-dv', |
| 1260 | 1260 | '', |
| 1261 | 1261 | 'clear: both; margin: 1.5em 0 0; display: none;' |
| 1262 | 1262 | ); |
| 1263 | - $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
| 1263 | + $registrations_to_apply_payment_to .= EEH_HTML::br().EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
| 1264 | 1264 | $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl'); |
| 1265 | 1265 | $registrations_to_apply_payment_to .= EEH_HTML::thead( |
| 1266 | 1266 | EEH_HTML::tr( |
| 1267 | - EEH_HTML::th(esc_html__('ID', 'event_espresso')) . |
|
| 1268 | - EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) . |
|
| 1269 | - EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) . |
|
| 1270 | - EEH_HTML::th(esc_html__('Event', 'event_espresso')) . |
|
| 1271 | - EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
| 1272 | - EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
| 1267 | + EEH_HTML::th(esc_html__('ID', 'event_espresso')). |
|
| 1268 | + EEH_HTML::th(esc_html__('Registrant', 'event_espresso')). |
|
| 1269 | + EEH_HTML::th(esc_html__('Ticket', 'event_espresso')). |
|
| 1270 | + EEH_HTML::th(esc_html__('Event', 'event_espresso')). |
|
| 1271 | + EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr'). |
|
| 1272 | + EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr'). |
|
| 1273 | 1273 | EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr') |
| 1274 | 1274 | ) |
| 1275 | 1275 | ); |
@@ -1284,7 +1284,7 @@ discard block |
||
| 1284 | 1284 | : esc_html__('Unknown Attendee', 'event_espresso'); |
| 1285 | 1285 | $owing = $registration->final_price() - $registration->paid(); |
| 1286 | 1286 | $taxable = $registration->ticket()->taxable() |
| 1287 | - ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>' |
|
| 1287 | + ? ' <span class="smaller-text lt-grey-text"> '.esc_html__('+ tax', 'event_espresso').'</span>' |
|
| 1288 | 1288 | : ''; |
| 1289 | 1289 | $checked = empty($existing_reg_payments) |
| 1290 | 1290 | || in_array($registration->ID(), $existing_reg_payments, true) |
@@ -1292,26 +1292,26 @@ discard block |
||
| 1292 | 1292 | : ''; |
| 1293 | 1293 | $disabled = $registration->final_price() > 0 ? '' : ' disabled'; |
| 1294 | 1294 | $registrations_to_apply_payment_to .= EEH_HTML::tr( |
| 1295 | - EEH_HTML::td($registration->ID()) . |
|
| 1296 | - EEH_HTML::td($attendee_name) . |
|
| 1295 | + EEH_HTML::td($registration->ID()). |
|
| 1296 | + EEH_HTML::td($attendee_name). |
|
| 1297 | 1297 | EEH_HTML::td( |
| 1298 | - $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable |
|
| 1299 | - ) . |
|
| 1300 | - EEH_HTML::td($registration->event_name()) . |
|
| 1301 | - EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
| 1298 | + $registration->ticket()->name().' : '.$registration->ticket()->pretty_price().$taxable |
|
| 1299 | + ). |
|
| 1300 | + EEH_HTML::td($registration->event_name()). |
|
| 1301 | + EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr'). |
|
| 1302 | 1302 | EEH_HTML::td( |
| 1303 | 1303 | EEH_Template::format_currency($owing), |
| 1304 | 1304 | '', |
| 1305 | 1305 | 'txn-admin-payment-owing-td jst-cntr' |
| 1306 | - ) . |
|
| 1306 | + ). |
|
| 1307 | 1307 | EEH_HTML::td( |
| 1308 | - '<input type="checkbox" value="' . $registration->ID() |
|
| 1308 | + '<input type="checkbox" value="'.$registration->ID() |
|
| 1309 | 1309 | . '" name="txn_admin_payment[registrations]"' |
| 1310 | - . $checked . $disabled . '>', |
|
| 1310 | + . $checked.$disabled.'>', |
|
| 1311 | 1311 | '', |
| 1312 | 1312 | 'jst-cntr' |
| 1313 | 1313 | ), |
| 1314 | - 'apply-payment-registration-row-' . $registration->ID() |
|
| 1314 | + 'apply-payment-registration-row-'.$registration->ID() |
|
| 1315 | 1315 | ); |
| 1316 | 1316 | } |
| 1317 | 1317 | } |
@@ -1392,12 +1392,12 @@ discard block |
||
| 1392 | 1392 | array( |
| 1393 | 1393 | 'OR*payment_method_for_payment' => array( |
| 1394 | 1394 | 'PMD_ID' => array('IN', $payment_methods_of_payments), |
| 1395 | - 'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'), |
|
| 1395 | + 'PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%'), |
|
| 1396 | 1396 | ), |
| 1397 | 1397 | ), |
| 1398 | 1398 | ); |
| 1399 | 1399 | } else { |
| 1400 | - $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'))); |
|
| 1400 | + $query_args = array(array('PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%'))); |
|
| 1401 | 1401 | } |
| 1402 | 1402 | $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args); |
| 1403 | 1403 | } |
@@ -1430,7 +1430,7 @@ discard block |
||
| 1430 | 1430 | 'Line_Item', |
| 1431 | 1431 | array(array('LIN_type' => 'line-item')) |
| 1432 | 1432 | ); |
| 1433 | - if (! empty($line_items)) { |
|
| 1433 | + if ( ! empty($line_items)) { |
|
| 1434 | 1434 | foreach ($line_items as $item) { |
| 1435 | 1435 | if ($item instanceof EE_Line_Item) { |
| 1436 | 1436 | switch ($item->OBJ_type()) { |
@@ -1440,7 +1440,7 @@ discard block |
||
| 1440 | 1440 | $ticket = $item->ticket(); |
| 1441 | 1441 | // right now we're only handling tickets here. |
| 1442 | 1442 | // Cause its expected that only tickets will have attendees right? |
| 1443 | - if (! $ticket instanceof EE_Ticket) { |
|
| 1443 | + if ( ! $ticket instanceof EE_Ticket) { |
|
| 1444 | 1444 | break; |
| 1445 | 1445 | } |
| 1446 | 1446 | try { |
@@ -1449,45 +1449,45 @@ discard block |
||
| 1449 | 1449 | EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
| 1450 | 1450 | $event_name = esc_html__('Unknown Event', 'event_espresso'); |
| 1451 | 1451 | } |
| 1452 | - $event_name .= ' - ' . $item->name(); |
|
| 1452 | + $event_name .= ' - '.$item->name(); |
|
| 1453 | 1453 | $ticket_price = EEH_Template::format_currency($item->unit_price()); |
| 1454 | 1454 | // now get all of the registrations for this transaction that use this ticket |
| 1455 | 1455 | $registrations = $ticket->registrations( |
| 1456 | 1456 | array(array('TXN_ID' => $this->_transaction->ID())) |
| 1457 | 1457 | ); |
| 1458 | 1458 | foreach ($registrations as $registration) { |
| 1459 | - if (! $registration instanceof EE_Registration) { |
|
| 1459 | + if ( ! $registration instanceof EE_Registration) { |
|
| 1460 | 1460 | break; |
| 1461 | 1461 | } |
| 1462 | - $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID'] |
|
| 1462 | + $this->_template_args['event_attendees'][$registration->ID()]['STS_ID'] |
|
| 1463 | 1463 | = $registration->status_ID(); |
| 1464 | - $this->_template_args['event_attendees'][ $registration->ID() ]['att_num'] |
|
| 1464 | + $this->_template_args['event_attendees'][$registration->ID()]['att_num'] |
|
| 1465 | 1465 | = $registration->count(); |
| 1466 | - $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name'] |
|
| 1466 | + $this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name'] |
|
| 1467 | 1467 | = $event_name; |
| 1468 | - $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price'] |
|
| 1468 | + $this->_template_args['event_attendees'][$registration->ID()]['ticket_price'] |
|
| 1469 | 1469 | = $ticket_price; |
| 1470 | 1470 | // attendee info |
| 1471 | 1471 | $attendee = $registration->get_first_related('Attendee'); |
| 1472 | 1472 | if ($attendee instanceof EE_Attendee) { |
| 1473 | - $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] |
|
| 1473 | + $this->_template_args['event_attendees'][$registration->ID()]['att_id'] |
|
| 1474 | 1474 | = $attendee->ID(); |
| 1475 | - $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] |
|
| 1475 | + $this->_template_args['event_attendees'][$registration->ID()]['attendee'] |
|
| 1476 | 1476 | = $attendee->full_name(); |
| 1477 | - $this->_template_args['event_attendees'][ $registration->ID() ]['email'] |
|
| 1478 | - = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name |
|
| 1477 | + $this->_template_args['event_attendees'][$registration->ID()]['email'] |
|
| 1478 | + = '<a href="mailto:'.$attendee->email().'?subject='.$event_name |
|
| 1479 | 1479 | . esc_html__( |
| 1480 | 1480 | ' Event', |
| 1481 | 1481 | 'event_espresso' |
| 1482 | 1482 | ) |
| 1483 | - . '">' . $attendee->email() . '</a>'; |
|
| 1484 | - $this->_template_args['event_attendees'][ $registration->ID() ]['address'] |
|
| 1483 | + . '">'.$attendee->email().'</a>'; |
|
| 1484 | + $this->_template_args['event_attendees'][$registration->ID()]['address'] |
|
| 1485 | 1485 | = EEH_Address::format($attendee, 'inline', false, false); |
| 1486 | 1486 | } else { |
| 1487 | - $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] = ''; |
|
| 1488 | - $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = ''; |
|
| 1489 | - $this->_template_args['event_attendees'][ $registration->ID() ]['email'] = ''; |
|
| 1490 | - $this->_template_args['event_attendees'][ $registration->ID() ]['address'] = ''; |
|
| 1487 | + $this->_template_args['event_attendees'][$registration->ID()]['att_id'] = ''; |
|
| 1488 | + $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = ''; |
|
| 1489 | + $this->_template_args['event_attendees'][$registration->ID()]['email'] = ''; |
|
| 1490 | + $this->_template_args['event_attendees'][$registration->ID()]['address'] = ''; |
|
| 1491 | 1491 | } |
| 1492 | 1492 | } |
| 1493 | 1493 | break; |
@@ -1503,7 +1503,7 @@ discard block |
||
| 1503 | 1503 | TXN_ADMIN_URL |
| 1504 | 1504 | ); |
| 1505 | 1505 | echo EEH_Template::display_template( |
| 1506 | - TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php', |
|
| 1506 | + TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_attendees.template.php', |
|
| 1507 | 1507 | $this->_template_args, |
| 1508 | 1508 | true |
| 1509 | 1509 | ); |
@@ -1538,7 +1538,7 @@ discard block |
||
| 1538 | 1538 | $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration |
| 1539 | 1539 | ? $this->_transaction->primary_registration()->get_first_related('Attendee') |
| 1540 | 1540 | : null; |
| 1541 | - if (! $primary_att instanceof EE_Attendee) { |
|
| 1541 | + if ( ! $primary_att instanceof EE_Attendee) { |
|
| 1542 | 1542 | $this->_template_args['no_attendee_message'] = esc_html__( |
| 1543 | 1543 | 'There is no attached contact for this transaction. The transaction either failed due to an error or was abandoned.', |
| 1544 | 1544 | 'event_espresso' |
@@ -1560,7 +1560,7 @@ discard block |
||
| 1560 | 1560 | // get formatted address for registrant |
| 1561 | 1561 | $this->_template_args['formatted_address'] = EEH_Address::format($primary_att); |
| 1562 | 1562 | echo EEH_Template::display_template( |
| 1563 | - TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php', |
|
| 1563 | + TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_registrant.template.php', |
|
| 1564 | 1564 | $this->_template_args, |
| 1565 | 1565 | true |
| 1566 | 1566 | ); |
@@ -1585,7 +1585,7 @@ discard block |
||
| 1585 | 1585 | TXN_ADMIN_URL |
| 1586 | 1586 | ); |
| 1587 | 1587 | |
| 1588 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
| 1588 | + $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
| 1589 | 1589 | echo EEH_Template::display_template($template_path, $this->_template_args, true); |
| 1590 | 1590 | } |
| 1591 | 1591 | |
@@ -1611,7 +1611,7 @@ discard block |
||
| 1611 | 1611 | 'ee_edit_payments', |
| 1612 | 1612 | 'apply_payment_or_refund_from_registration_details' |
| 1613 | 1613 | ); |
| 1614 | - if (! empty($valid_data) && $has_access) { |
|
| 1614 | + if ( ! empty($valid_data) && $has_access) { |
|
| 1615 | 1615 | $PAY_ID = $valid_data['PAY_ID']; |
| 1616 | 1616 | // save the new payment |
| 1617 | 1617 | $payment = $this->_create_payment_from_request_data($valid_data); |
@@ -1624,7 +1624,7 @@ discard block |
||
| 1624 | 1624 | $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment); |
| 1625 | 1625 | $this->_remove_existing_registration_payments($payment, $PAY_ID); |
| 1626 | 1626 | // apply payment to registrations (if applicable) |
| 1627 | - if (! empty($REG_IDs)) { |
|
| 1627 | + if ( ! empty($REG_IDs)) { |
|
| 1628 | 1628 | $this->_update_registration_payments($transaction, $payment, $REG_IDs); |
| 1629 | 1629 | $this->_maybe_send_notifications(); |
| 1630 | 1630 | // now process status changes for the same registrations |
@@ -1695,14 +1695,14 @@ discard block |
||
| 1695 | 1695 | */ |
| 1696 | 1696 | protected function _validate_payment_request_data() |
| 1697 | 1697 | { |
| 1698 | - if (! isset($this->_req_data['txn_admin_payment'])) { |
|
| 1698 | + if ( ! isset($this->_req_data['txn_admin_payment'])) { |
|
| 1699 | 1699 | return array(); |
| 1700 | 1700 | } |
| 1701 | 1701 | $payment_form = $this->_generate_payment_form_section(); |
| 1702 | 1702 | try { |
| 1703 | 1703 | if ($payment_form->was_submitted()) { |
| 1704 | 1704 | $payment_form->receive_form_submission(); |
| 1705 | - if (! $payment_form->is_valid()) { |
|
| 1705 | + if ( ! $payment_form->is_valid()) { |
|
| 1706 | 1706 | $submission_error_messages = array(); |
| 1707 | 1707 | foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) { |
| 1708 | 1708 | if ($validation_error instanceof EE_Validation_Error) { |
@@ -1883,7 +1883,7 @@ discard block |
||
| 1883 | 1883 | array('Y-m-d', 'g:i a') |
| 1884 | 1884 | ); |
| 1885 | 1885 | |
| 1886 | - if (! $payment->save()) { |
|
| 1886 | + if ( ! $payment->save()) { |
|
| 1887 | 1887 | EE_Error::add_error( |
| 1888 | 1888 | sprintf( |
| 1889 | 1889 | esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'), |
@@ -2088,12 +2088,12 @@ discard block |
||
| 2088 | 2088 | // but add in some conditions regarding payment, |
| 2089 | 2089 | // so that we don't apply payments to registrations that are free or have already been paid for |
| 2090 | 2090 | // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative ) |
| 2091 | - if (! $payment->is_a_refund()) { |
|
| 2091 | + if ( ! $payment->is_a_refund()) { |
|
| 2092 | 2092 | $registration_query_where_params['REG_final_price'] = array('!=', 0); |
| 2093 | 2093 | $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true); |
| 2094 | 2094 | } |
| 2095 | 2095 | $registrations = $transaction->registrations(array($registration_query_where_params)); |
| 2096 | - if (! empty($registrations)) { |
|
| 2096 | + if ( ! empty($registrations)) { |
|
| 2097 | 2097 | /** @type EE_Payment_Processor $payment_processor */ |
| 2098 | 2098 | $payment_processor = EE_Registry::instance()->load_core('Payment_Processor'); |
| 2099 | 2099 | $payment_processor->process_registration_payments($transaction, $payment, $registrations); |
@@ -2118,7 +2118,7 @@ discard block |
||
| 2118 | 2118 | protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array()) |
| 2119 | 2119 | { |
| 2120 | 2120 | // first if there is no change in status then we get out. |
| 2121 | - if (! isset($this->_req_data['txn_reg_status_change']['reg_status']) |
|
| 2121 | + if ( ! isset($this->_req_data['txn_reg_status_change']['reg_status']) |
|
| 2122 | 2122 | || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN' |
| 2123 | 2123 | ) { |
| 2124 | 2124 | // no error message, no change requested, just nothing to do man. |
@@ -2176,7 +2176,7 @@ discard block |
||
| 2176 | 2176 | 'pay_status' => $payment->STS_ID(), |
| 2177 | 2177 | 'PAY_ID' => $payment->ID(), |
| 2178 | 2178 | 'STS_ID' => $payment->STS_ID(), |
| 2179 | - 'status' => self::$_pay_status[ $payment->STS_ID() ], |
|
| 2179 | + 'status' => self::$_pay_status[$payment->STS_ID()], |
|
| 2180 | 2180 | 'date' => $payment->timestamp('Y-m-d', 'h:i a'), |
| 2181 | 2181 | 'method' => strtoupper($payment->source()), |
| 2182 | 2182 | 'PM_ID' => $payment->payment_method() ? $payment->payment_method()->ID() : 1, |
@@ -2296,11 +2296,11 @@ discard block |
||
| 2296 | 2296 | { |
| 2297 | 2297 | $registration_payment_data = array(); |
| 2298 | 2298 | // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows. |
| 2299 | - if (! empty($REG_IDs)) { |
|
| 2299 | + if ( ! empty($REG_IDs)) { |
|
| 2300 | 2300 | $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs)))); |
| 2301 | 2301 | foreach ($registrations as $registration) { |
| 2302 | 2302 | if ($registration instanceof EE_Registration) { |
| 2303 | - $registration_payment_data[ $registration->ID() ] = array( |
|
| 2303 | + $registration_payment_data[$registration->ID()] = array( |
|
| 2304 | 2304 | 'paid' => $registration->pretty_paid(), |
| 2305 | 2305 | 'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()), |
| 2306 | 2306 | ); |
@@ -2412,8 +2412,8 @@ discard block |
||
| 2412 | 2412 | : date('m/d/Y'); |
| 2413 | 2413 | |
| 2414 | 2414 | // make sure our timestamps start and end right at the boundaries for each day |
| 2415 | - $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
| 2416 | - $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
| 2415 | + $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00'; |
|
| 2416 | + $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59'; |
|
| 2417 | 2417 | |
| 2418 | 2418 | |
| 2419 | 2419 | // convert to timestamps |
@@ -2472,7 +2472,7 @@ discard block |
||
| 2472 | 2472 | } |
| 2473 | 2473 | |
| 2474 | 2474 | if (isset($this->_req_data['s'])) { |
| 2475 | - $search_string = '%' . $this->_req_data['s'] . '%'; |
|
| 2475 | + $search_string = '%'.$this->_req_data['s'].'%'; |
|
| 2476 | 2476 | $_where['OR'] = array( |
| 2477 | 2477 | 'Registration.Event.EVT_name' => array('LIKE', $search_string), |
| 2478 | 2478 | 'Registration.Event.EVT_desc' => array('LIKE', $search_string), |
@@ -2499,11 +2499,11 @@ discard block |
||
| 2499 | 2499 | } |
| 2500 | 2500 | |
| 2501 | 2501 | // failed transactions |
| 2502 | - $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
| 2502 | + $failed = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
| 2503 | 2503 | || ($count && $view === 'failed'); |
| 2504 | - $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
| 2504 | + $abandoned = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
| 2505 | 2505 | || ($count && $view === 'abandoned'); |
| 2506 | - $incomplete = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'incomplete' && ! $count) |
|
| 2506 | + $incomplete = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'incomplete' && ! $count) |
|
| 2507 | 2507 | || ($count && $view === 'incomplete'); |
| 2508 | 2508 | |
| 2509 | 2509 | if ($failed) { |
@@ -13,2562 +13,2562 @@ |
||
| 13 | 13 | class Transactions_Admin_Page extends EE_Admin_Page |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * @var EE_Transaction |
|
| 18 | - */ |
|
| 19 | - private $_transaction; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * @var EE_Session |
|
| 23 | - */ |
|
| 24 | - private $_session; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * @var array $_txn_status |
|
| 28 | - */ |
|
| 29 | - private static $_txn_status; |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * @var array $_pay_status |
|
| 33 | - */ |
|
| 34 | - private static $_pay_status; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var array $_existing_reg_payment_REG_IDs |
|
| 38 | - */ |
|
| 39 | - protected $_existing_reg_payment_REG_IDs; |
|
| 40 | - |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * _init_page_props |
|
| 44 | - * |
|
| 45 | - * @return void |
|
| 46 | - */ |
|
| 47 | - protected function _init_page_props() |
|
| 48 | - { |
|
| 49 | - $this->page_slug = TXN_PG_SLUG; |
|
| 50 | - $this->page_label = esc_html__('Transactions', 'event_espresso'); |
|
| 51 | - $this->_admin_base_url = TXN_ADMIN_URL; |
|
| 52 | - $this->_admin_base_path = TXN_ADMIN; |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * _ajax_hooks |
|
| 58 | - * |
|
| 59 | - * @return void |
|
| 60 | - */ |
|
| 61 | - protected function _ajax_hooks() |
|
| 62 | - { |
|
| 63 | - add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds')); |
|
| 64 | - add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds')); |
|
| 65 | - add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment')); |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * _define_page_props |
|
| 71 | - * |
|
| 72 | - * @return void |
|
| 73 | - */ |
|
| 74 | - protected function _define_page_props() |
|
| 75 | - { |
|
| 76 | - $this->_admin_page_title = $this->page_label; |
|
| 77 | - $this->_labels = array( |
|
| 78 | - 'buttons' => array( |
|
| 79 | - 'add' => esc_html__('Add New Transaction', 'event_espresso'), |
|
| 80 | - 'edit' => esc_html__('Edit Transaction', 'event_espresso'), |
|
| 81 | - 'delete' => esc_html__('Delete Transaction', 'event_espresso'), |
|
| 82 | - ), |
|
| 83 | - ); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * grab url requests and route them |
|
| 89 | - * |
|
| 90 | - * @access private |
|
| 91 | - * @return void |
|
| 92 | - * @throws EE_Error |
|
| 93 | - * @throws InvalidArgumentException |
|
| 94 | - * @throws InvalidDataTypeException |
|
| 95 | - * @throws InvalidInterfaceException |
|
| 96 | - */ |
|
| 97 | - public function _set_page_routes() |
|
| 98 | - { |
|
| 99 | - |
|
| 100 | - $this->_set_transaction_status_array(); |
|
| 101 | - |
|
| 102 | - $txn_id = ! empty($this->_req_data['TXN_ID']) |
|
| 103 | - && ! is_array($this->_req_data['TXN_ID']) |
|
| 104 | - ? $this->_req_data['TXN_ID'] |
|
| 105 | - : 0; |
|
| 106 | - |
|
| 107 | - $this->_page_routes = array( |
|
| 108 | - |
|
| 109 | - 'default' => array( |
|
| 110 | - 'func' => '_transactions_overview_list_table', |
|
| 111 | - 'capability' => 'ee_read_transactions', |
|
| 112 | - ), |
|
| 113 | - |
|
| 114 | - 'view_transaction' => array( |
|
| 115 | - 'func' => '_transaction_details', |
|
| 116 | - 'capability' => 'ee_read_transaction', |
|
| 117 | - 'obj_id' => $txn_id, |
|
| 118 | - ), |
|
| 119 | - |
|
| 120 | - 'send_payment_reminder' => array( |
|
| 121 | - 'func' => '_send_payment_reminder', |
|
| 122 | - 'noheader' => true, |
|
| 123 | - 'capability' => 'ee_send_message', |
|
| 124 | - ), |
|
| 125 | - |
|
| 126 | - 'espresso_apply_payment' => array( |
|
| 127 | - 'func' => 'apply_payments_or_refunds', |
|
| 128 | - 'noheader' => true, |
|
| 129 | - 'capability' => 'ee_edit_payments', |
|
| 130 | - ), |
|
| 131 | - |
|
| 132 | - 'espresso_apply_refund' => array( |
|
| 133 | - 'func' => 'apply_payments_or_refunds', |
|
| 134 | - 'noheader' => true, |
|
| 135 | - 'capability' => 'ee_edit_payments', |
|
| 136 | - ), |
|
| 137 | - |
|
| 138 | - 'espresso_delete_payment' => array( |
|
| 139 | - 'func' => 'delete_payment', |
|
| 140 | - 'noheader' => true, |
|
| 141 | - 'capability' => 'ee_delete_payments', |
|
| 142 | - ), |
|
| 143 | - |
|
| 144 | - 'espresso_recalculate_line_items' => array( |
|
| 145 | - 'func' => 'recalculateLineItems', |
|
| 146 | - 'noheader' => true, |
|
| 147 | - 'capability' => 'ee_edit_payments', |
|
| 148 | - ), |
|
| 149 | - |
|
| 150 | - ); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - |
|
| 154 | - protected function _set_page_config() |
|
| 155 | - { |
|
| 156 | - $this->_page_config = array( |
|
| 157 | - 'default' => array( |
|
| 158 | - 'nav' => array( |
|
| 159 | - 'label' => esc_html__('Overview', 'event_espresso'), |
|
| 160 | - 'order' => 10, |
|
| 161 | - ), |
|
| 162 | - 'list_table' => 'EE_Admin_Transactions_List_Table', |
|
| 163 | - 'help_tabs' => array( |
|
| 164 | - 'transactions_overview_help_tab' => array( |
|
| 165 | - 'title' => esc_html__('Transactions Overview', 'event_espresso'), |
|
| 166 | - 'filename' => 'transactions_overview', |
|
| 167 | - ), |
|
| 168 | - 'transactions_overview_table_column_headings_help_tab' => array( |
|
| 169 | - 'title' => esc_html__('Transactions Table Column Headings', 'event_espresso'), |
|
| 170 | - 'filename' => 'transactions_overview_table_column_headings', |
|
| 171 | - ), |
|
| 172 | - 'transactions_overview_views_filters_help_tab' => array( |
|
| 173 | - 'title' => esc_html__('Transaction Views & Filters & Search', 'event_espresso'), |
|
| 174 | - 'filename' => 'transactions_overview_views_filters_search', |
|
| 175 | - ), |
|
| 176 | - ), |
|
| 177 | - 'help_tour' => array('Transactions_Overview_Help_Tour'), |
|
| 178 | - /** |
|
| 179 | - * commented out because currently we are not displaying tips for transaction list table status but this |
|
| 180 | - * may change in a later iteration so want to keep the code for then. |
|
| 181 | - */ |
|
| 182 | - // 'qtips' => array( 'Transactions_List_Table_Tips' ), |
|
| 183 | - 'require_nonce' => false, |
|
| 184 | - ), |
|
| 185 | - 'view_transaction' => array( |
|
| 186 | - 'nav' => array( |
|
| 187 | - 'label' => esc_html__('View Transaction', 'event_espresso'), |
|
| 188 | - 'order' => 5, |
|
| 189 | - 'url' => isset($this->_req_data['TXN_ID']) |
|
| 190 | - ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url) |
|
| 191 | - : $this->_admin_base_url, |
|
| 192 | - 'persistent' => false, |
|
| 193 | - ), |
|
| 194 | - 'help_tabs' => array( |
|
| 195 | - 'transactions_view_transaction_help_tab' => array( |
|
| 196 | - 'title' => esc_html__('View Transaction', 'event_espresso'), |
|
| 197 | - 'filename' => 'transactions_view_transaction', |
|
| 198 | - ), |
|
| 199 | - 'transactions_view_transaction_transaction_details_table_help_tab' => array( |
|
| 200 | - 'title' => esc_html__('Transaction Details Table', 'event_espresso'), |
|
| 201 | - 'filename' => 'transactions_view_transaction_transaction_details_table', |
|
| 202 | - ), |
|
| 203 | - 'transactions_view_transaction_attendees_registered_help_tab' => array( |
|
| 204 | - 'title' => esc_html__('Attendees Registered', 'event_espresso'), |
|
| 205 | - 'filename' => 'transactions_view_transaction_attendees_registered', |
|
| 206 | - ), |
|
| 207 | - 'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array( |
|
| 208 | - 'title' => esc_html__('Primary Registrant & Billing Information', 'event_espresso'), |
|
| 209 | - 'filename' => 'transactions_view_transaction_primary_registrant_billing_information', |
|
| 210 | - ), |
|
| 211 | - ), |
|
| 212 | - 'qtips' => array('Transaction_Details_Tips'), |
|
| 213 | - 'help_tour' => array('Transaction_Details_Help_Tour'), |
|
| 214 | - 'metaboxes' => array('_transaction_details_metaboxes'), |
|
| 215 | - |
|
| 216 | - 'require_nonce' => false, |
|
| 217 | - ), |
|
| 218 | - ); |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * The below methods aren't used by this class currently |
|
| 224 | - */ |
|
| 225 | - protected function _add_screen_options() |
|
| 226 | - { |
|
| 227 | - // noop |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - |
|
| 231 | - protected function _add_feature_pointers() |
|
| 232 | - { |
|
| 233 | - // noop |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - |
|
| 237 | - public function admin_init() |
|
| 238 | - { |
|
| 239 | - // IF a registration was JUST added via the admin... |
|
| 240 | - if (isset( |
|
| 241 | - $this->_req_data['redirect_from'], |
|
| 242 | - $this->_req_data['EVT_ID'], |
|
| 243 | - $this->_req_data['event_name'] |
|
| 244 | - )) { |
|
| 245 | - // then set a cookie so that we can block any attempts to use |
|
| 246 | - // the back button as a way to enter another registration. |
|
| 247 | - setcookie( |
|
| 248 | - 'ee_registration_added', |
|
| 249 | - $this->_req_data['EVT_ID'], |
|
| 250 | - time() + WEEK_IN_SECONDS, |
|
| 251 | - '/' |
|
| 252 | - ); |
|
| 253 | - // and update the global |
|
| 254 | - $_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID']; |
|
| 255 | - } |
|
| 256 | - EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__( |
|
| 257 | - 'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.', |
|
| 258 | - 'event_espresso' |
|
| 259 | - ); |
|
| 260 | - EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__( |
|
| 261 | - 'An error occurred! Please refresh the page and try again.', |
|
| 262 | - 'event_espresso' |
|
| 263 | - ); |
|
| 264 | - EE_Registry::$i18n_js_strings['txn_status_array'] = self::$_txn_status; |
|
| 265 | - EE_Registry::$i18n_js_strings['pay_status_array'] = self::$_pay_status; |
|
| 266 | - EE_Registry::$i18n_js_strings['payments_total'] = esc_html__('Payments Total', 'event_espresso'); |
|
| 267 | - EE_Registry::$i18n_js_strings['transaction_overpaid'] = esc_html__( |
|
| 268 | - 'This transaction has been overpaid ! Payments Total', |
|
| 269 | - 'event_espresso' |
|
| 270 | - ); |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - |
|
| 274 | - public function admin_notices() |
|
| 275 | - { |
|
| 276 | - // noop |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - |
|
| 280 | - public function admin_footer_scripts() |
|
| 281 | - { |
|
| 282 | - // noop |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - |
|
| 286 | - /** |
|
| 287 | - * _set_transaction_status_array |
|
| 288 | - * sets list of transaction statuses |
|
| 289 | - * |
|
| 290 | - * @access private |
|
| 291 | - * @return void |
|
| 292 | - * @throws EE_Error |
|
| 293 | - * @throws InvalidArgumentException |
|
| 294 | - * @throws InvalidDataTypeException |
|
| 295 | - * @throws InvalidInterfaceException |
|
| 296 | - */ |
|
| 297 | - private function _set_transaction_status_array() |
|
| 298 | - { |
|
| 299 | - self::$_txn_status = EEM_Transaction::instance()->status_array(true); |
|
| 300 | - } |
|
| 301 | - |
|
| 302 | - |
|
| 303 | - /** |
|
| 304 | - * get_transaction_status_array |
|
| 305 | - * return the transaction status array for wp_list_table |
|
| 306 | - * |
|
| 307 | - * @access public |
|
| 308 | - * @return array |
|
| 309 | - */ |
|
| 310 | - public function get_transaction_status_array() |
|
| 311 | - { |
|
| 312 | - return self::$_txn_status; |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - |
|
| 316 | - /** |
|
| 317 | - * get list of payment statuses |
|
| 318 | - * |
|
| 319 | - * @access private |
|
| 320 | - * @return void |
|
| 321 | - * @throws EE_Error |
|
| 322 | - * @throws InvalidArgumentException |
|
| 323 | - * @throws InvalidDataTypeException |
|
| 324 | - * @throws InvalidInterfaceException |
|
| 325 | - */ |
|
| 326 | - private function _get_payment_status_array() |
|
| 327 | - { |
|
| 328 | - self::$_pay_status = EEM_Payment::instance()->status_array(true); |
|
| 329 | - $this->_template_args['payment_status'] = self::$_pay_status; |
|
| 330 | - } |
|
| 331 | - |
|
| 332 | - |
|
| 333 | - /** |
|
| 334 | - * _add_screen_options_default |
|
| 335 | - * |
|
| 336 | - * @access protected |
|
| 337 | - * @return void |
|
| 338 | - * @throws InvalidArgumentException |
|
| 339 | - * @throws InvalidDataTypeException |
|
| 340 | - * @throws InvalidInterfaceException |
|
| 341 | - */ |
|
| 342 | - protected function _add_screen_options_default() |
|
| 343 | - { |
|
| 344 | - $this->_per_page_screen_option(); |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - |
|
| 348 | - /** |
|
| 349 | - * load_scripts_styles |
|
| 350 | - * |
|
| 351 | - * @access public |
|
| 352 | - * @return void |
|
| 353 | - */ |
|
| 354 | - public function load_scripts_styles() |
|
| 355 | - { |
|
| 356 | - // enqueue style |
|
| 357 | - wp_register_style( |
|
| 358 | - 'espresso_txn', |
|
| 359 | - TXN_ASSETS_URL . 'espresso_transactions_admin.css', |
|
| 360 | - array(), |
|
| 361 | - EVENT_ESPRESSO_VERSION |
|
| 362 | - ); |
|
| 363 | - wp_enqueue_style('espresso_txn'); |
|
| 364 | - // scripts |
|
| 365 | - wp_register_script( |
|
| 366 | - 'espresso_txn', |
|
| 367 | - TXN_ASSETS_URL . 'espresso_transactions_admin.js', |
|
| 368 | - array( |
|
| 369 | - 'ee_admin_js', |
|
| 370 | - 'ee-datepicker', |
|
| 371 | - 'jquery-ui-datepicker', |
|
| 372 | - 'jquery-ui-draggable', |
|
| 373 | - 'ee-dialog', |
|
| 374 | - 'ee-accounting', |
|
| 375 | - 'ee-serialize-full-array', |
|
| 376 | - ), |
|
| 377 | - EVENT_ESPRESSO_VERSION, |
|
| 378 | - true |
|
| 379 | - ); |
|
| 380 | - wp_enqueue_script('espresso_txn'); |
|
| 381 | - } |
|
| 382 | - |
|
| 383 | - |
|
| 384 | - /** |
|
| 385 | - * load_scripts_styles_view_transaction |
|
| 386 | - * |
|
| 387 | - * @access public |
|
| 388 | - * @return void |
|
| 389 | - */ |
|
| 390 | - public function load_scripts_styles_view_transaction() |
|
| 391 | - { |
|
| 392 | - // styles |
|
| 393 | - wp_enqueue_style('espresso-ui-theme'); |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - |
|
| 397 | - /** |
|
| 398 | - * load_scripts_styles_default |
|
| 399 | - * |
|
| 400 | - * @access public |
|
| 401 | - * @return void |
|
| 402 | - */ |
|
| 403 | - public function load_scripts_styles_default() |
|
| 404 | - { |
|
| 405 | - // styles |
|
| 406 | - wp_enqueue_style('espresso-ui-theme'); |
|
| 407 | - } |
|
| 408 | - |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * _set_list_table_views_default |
|
| 412 | - * |
|
| 413 | - * @access protected |
|
| 414 | - * @return void |
|
| 415 | - */ |
|
| 416 | - protected function _set_list_table_views_default() |
|
| 417 | - { |
|
| 418 | - $this->_views = array( |
|
| 419 | - 'all' => array( |
|
| 420 | - 'slug' => 'all', |
|
| 421 | - 'label' => esc_html__('View All Transactions', 'event_espresso'), |
|
| 422 | - 'count' => 0, |
|
| 423 | - ), |
|
| 424 | - 'abandoned' => array( |
|
| 425 | - 'slug' => 'abandoned', |
|
| 426 | - 'label' => esc_html__('Abandoned Transactions', 'event_espresso'), |
|
| 427 | - 'count' => 0, |
|
| 428 | - ), |
|
| 429 | - 'incomplete' => array( |
|
| 430 | - 'slug' => 'incomplete', |
|
| 431 | - 'label' => esc_html__('Incomplete Transactions', 'event_espresso'), |
|
| 432 | - 'count' => 0, |
|
| 433 | - ), |
|
| 434 | - ); |
|
| 435 | - if (/** |
|
| 436 | - * Filters whether a link to the "Failed Transactions" list table |
|
| 437 | - * appears on the Transactions Admin Page list table. |
|
| 438 | - * List display can be turned back on via the following: |
|
| 439 | - * add_filter( |
|
| 440 | - * 'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list', |
|
| 441 | - * '__return_true' |
|
| 442 | - * ); |
|
| 443 | - * |
|
| 444 | - * @since 4.9.70.p |
|
| 445 | - * @param boolean $display_failed_txns_list |
|
| 446 | - * @param Transactions_Admin_Page $this |
|
| 447 | - */ |
|
| 448 | - apply_filters( |
|
| 449 | - 'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list', |
|
| 450 | - false, |
|
| 451 | - $this |
|
| 452 | - ) |
|
| 453 | - ) { |
|
| 454 | - $this->_views['failed'] = array( |
|
| 455 | - 'slug' => 'failed', |
|
| 456 | - 'label' => esc_html__('Failed Transactions', 'event_espresso'), |
|
| 457 | - 'count' => 0, |
|
| 458 | - ); |
|
| 459 | - } |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - |
|
| 463 | - /** |
|
| 464 | - * _set_transaction_object |
|
| 465 | - * This sets the _transaction property for the transaction details screen |
|
| 466 | - * |
|
| 467 | - * @access private |
|
| 468 | - * @return void |
|
| 469 | - * @throws EE_Error |
|
| 470 | - * @throws InvalidArgumentException |
|
| 471 | - * @throws RuntimeException |
|
| 472 | - * @throws InvalidDataTypeException |
|
| 473 | - * @throws InvalidInterfaceException |
|
| 474 | - * @throws ReflectionException |
|
| 475 | - */ |
|
| 476 | - private function _set_transaction_object() |
|
| 477 | - { |
|
| 478 | - if ($this->_transaction instanceof EE_Transaction) { |
|
| 479 | - return; |
|
| 480 | - } //get out we've already set the object |
|
| 481 | - |
|
| 482 | - $TXN_ID = ! empty($this->_req_data['TXN_ID']) |
|
| 483 | - ? absint($this->_req_data['TXN_ID']) |
|
| 484 | - : false; |
|
| 485 | - |
|
| 486 | - // get transaction object |
|
| 487 | - $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
| 488 | - $this->_session = $this->_transaction instanceof EE_Transaction |
|
| 489 | - ? $this->_transaction->session_data() |
|
| 490 | - : null; |
|
| 491 | - if ($this->_transaction instanceof EE_Transaction) { |
|
| 492 | - $this->_transaction->verify_abandoned_transaction_status(); |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
| 496 | - $error_msg = sprintf( |
|
| 497 | - esc_html__( |
|
| 498 | - 'An error occurred and the details for the transaction with the ID # %d could not be retrieved.', |
|
| 499 | - 'event_espresso' |
|
| 500 | - ), |
|
| 501 | - $TXN_ID |
|
| 502 | - ); |
|
| 503 | - EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 504 | - } |
|
| 505 | - } |
|
| 506 | - |
|
| 507 | - |
|
| 508 | - /** |
|
| 509 | - * _transaction_legend_items |
|
| 510 | - * |
|
| 511 | - * @access protected |
|
| 512 | - * @return array |
|
| 513 | - * @throws EE_Error |
|
| 514 | - * @throws InvalidArgumentException |
|
| 515 | - * @throws ReflectionException |
|
| 516 | - * @throws InvalidDataTypeException |
|
| 517 | - * @throws InvalidInterfaceException |
|
| 518 | - */ |
|
| 519 | - protected function _transaction_legend_items() |
|
| 520 | - { |
|
| 521 | - EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 522 | - $items = array(); |
|
| 523 | - |
|
| 524 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 525 | - 'ee_read_global_messages', |
|
| 526 | - 'view_filtered_messages' |
|
| 527 | - )) { |
|
| 528 | - $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
| 529 | - if (is_array($related_for_icon) |
|
| 530 | - && isset($related_for_icon['css_class'], $related_for_icon['label']) |
|
| 531 | - ) { |
|
| 532 | - $items['view_related_messages'] = array( |
|
| 533 | - 'class' => $related_for_icon['css_class'], |
|
| 534 | - 'desc' => $related_for_icon['label'], |
|
| 535 | - ); |
|
| 536 | - } |
|
| 537 | - } |
|
| 538 | - |
|
| 539 | - $items = apply_filters( |
|
| 540 | - 'FHEE__Transactions_Admin_Page___transaction_legend_items__items', |
|
| 541 | - array_merge( |
|
| 542 | - $items, |
|
| 543 | - array( |
|
| 544 | - 'view_details' => array( |
|
| 545 | - 'class' => 'dashicons dashicons-cart', |
|
| 546 | - 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
| 547 | - ), |
|
| 548 | - 'view_invoice' => array( |
|
| 549 | - 'class' => 'dashicons dashicons-media-spreadsheet', |
|
| 550 | - 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
| 551 | - ), |
|
| 552 | - 'view_receipt' => array( |
|
| 553 | - 'class' => 'dashicons dashicons-media-default', |
|
| 554 | - 'desc' => esc_html__('View Transaction Receipt', 'event_espresso'), |
|
| 555 | - ), |
|
| 556 | - 'view_registration' => array( |
|
| 557 | - 'class' => 'dashicons dashicons-clipboard', |
|
| 558 | - 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
| 559 | - ), |
|
| 560 | - 'payment_overview_link' => array( |
|
| 561 | - 'class' => 'dashicons dashicons-money', |
|
| 562 | - 'desc' => esc_html__('Make Payment on Frontend', 'event_espresso'), |
|
| 563 | - ), |
|
| 564 | - ) |
|
| 565 | - ) |
|
| 566 | - ); |
|
| 567 | - |
|
| 568 | - if (EEH_MSG_Template::is_mt_active('payment_reminder') |
|
| 569 | - && EE_Registry::instance()->CAP->current_user_can( |
|
| 570 | - 'ee_send_message', |
|
| 571 | - 'espresso_transactions_send_payment_reminder' |
|
| 572 | - ) |
|
| 573 | - ) { |
|
| 574 | - $items['send_payment_reminder'] = array( |
|
| 575 | - 'class' => 'dashicons dashicons-email-alt', |
|
| 576 | - 'desc' => esc_html__('Send Payment Reminder', 'event_espresso'), |
|
| 577 | - ); |
|
| 578 | - } else { |
|
| 579 | - $items['blank*'] = array( |
|
| 580 | - 'class' => '', |
|
| 581 | - 'desc' => '', |
|
| 582 | - ); |
|
| 583 | - } |
|
| 584 | - $more_items = apply_filters( |
|
| 585 | - 'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items', |
|
| 586 | - array( |
|
| 587 | - 'overpaid' => array( |
|
| 588 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code, |
|
| 589 | - 'desc' => EEH_Template::pretty_status( |
|
| 590 | - EEM_Transaction::overpaid_status_code, |
|
| 591 | - false, |
|
| 592 | - 'sentence' |
|
| 593 | - ), |
|
| 594 | - ), |
|
| 595 | - 'complete' => array( |
|
| 596 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code, |
|
| 597 | - 'desc' => EEH_Template::pretty_status( |
|
| 598 | - EEM_Transaction::complete_status_code, |
|
| 599 | - false, |
|
| 600 | - 'sentence' |
|
| 601 | - ), |
|
| 602 | - ), |
|
| 603 | - 'incomplete' => array( |
|
| 604 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code, |
|
| 605 | - 'desc' => EEH_Template::pretty_status( |
|
| 606 | - EEM_Transaction::incomplete_status_code, |
|
| 607 | - false, |
|
| 608 | - 'sentence' |
|
| 609 | - ), |
|
| 610 | - ), |
|
| 611 | - 'abandoned' => array( |
|
| 612 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code, |
|
| 613 | - 'desc' => EEH_Template::pretty_status( |
|
| 614 | - EEM_Transaction::abandoned_status_code, |
|
| 615 | - false, |
|
| 616 | - 'sentence' |
|
| 617 | - ), |
|
| 618 | - ), |
|
| 619 | - 'failed' => array( |
|
| 620 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code, |
|
| 621 | - 'desc' => EEH_Template::pretty_status( |
|
| 622 | - EEM_Transaction::failed_status_code, |
|
| 623 | - false, |
|
| 624 | - 'sentence' |
|
| 625 | - ), |
|
| 626 | - ), |
|
| 627 | - ) |
|
| 628 | - ); |
|
| 629 | - |
|
| 630 | - return array_merge($items, $more_items); |
|
| 631 | - } |
|
| 632 | - |
|
| 633 | - |
|
| 634 | - /** |
|
| 635 | - * _transactions_overview_list_table |
|
| 636 | - * |
|
| 637 | - * @access protected |
|
| 638 | - * @return void |
|
| 639 | - * @throws DomainException |
|
| 640 | - * @throws EE_Error |
|
| 641 | - * @throws InvalidArgumentException |
|
| 642 | - * @throws InvalidDataTypeException |
|
| 643 | - * @throws InvalidInterfaceException |
|
| 644 | - * @throws ReflectionException |
|
| 645 | - */ |
|
| 646 | - protected function _transactions_overview_list_table() |
|
| 647 | - { |
|
| 648 | - $this->_admin_page_title = esc_html__('Transactions', 'event_espresso'); |
|
| 649 | - $event = isset($this->_req_data['EVT_ID']) |
|
| 650 | - ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']) |
|
| 651 | - : null; |
|
| 652 | - $this->_template_args['admin_page_header'] = $event instanceof EE_Event |
|
| 653 | - ? sprintf( |
|
| 654 | - esc_html__( |
|
| 655 | - '%sViewing Transactions for the Event: %s%s', |
|
| 656 | - 'event_espresso' |
|
| 657 | - ), |
|
| 658 | - '<h3>', |
|
| 659 | - '<a href="' |
|
| 660 | - . EE_Admin_Page::add_query_args_and_nonce( |
|
| 661 | - array('action' => 'edit', 'post' => $event->ID()), |
|
| 662 | - EVENTS_ADMIN_URL |
|
| 663 | - ) |
|
| 664 | - . '" title="' |
|
| 665 | - . esc_attr__( |
|
| 666 | - 'Click to Edit event', |
|
| 667 | - 'event_espresso' |
|
| 668 | - ) |
|
| 669 | - . '">' . $event->name() . '</a>', |
|
| 670 | - '</h3>' |
|
| 671 | - ) |
|
| 672 | - : ''; |
|
| 673 | - $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items()); |
|
| 674 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 675 | - } |
|
| 676 | - |
|
| 677 | - |
|
| 678 | - /** |
|
| 679 | - * _transaction_details |
|
| 680 | - * generates HTML for the View Transaction Details Admin page |
|
| 681 | - * |
|
| 682 | - * @access protected |
|
| 683 | - * @return void |
|
| 684 | - * @throws DomainException |
|
| 685 | - * @throws EE_Error |
|
| 686 | - * @throws InvalidArgumentException |
|
| 687 | - * @throws InvalidDataTypeException |
|
| 688 | - * @throws InvalidInterfaceException |
|
| 689 | - * @throws RuntimeException |
|
| 690 | - * @throws ReflectionException |
|
| 691 | - */ |
|
| 692 | - protected function _transaction_details() |
|
| 693 | - { |
|
| 694 | - do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction); |
|
| 695 | - |
|
| 696 | - $this->_set_transaction_status_array(); |
|
| 697 | - |
|
| 698 | - $this->_template_args = array(); |
|
| 699 | - $this->_template_args['transactions_page'] = $this->_wp_page_slug; |
|
| 700 | - |
|
| 701 | - $this->_set_transaction_object(); |
|
| 702 | - |
|
| 703 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
| 704 | - return; |
|
| 705 | - } |
|
| 706 | - $primary_registration = $this->_transaction->primary_registration(); |
|
| 707 | - $attendee = $primary_registration instanceof EE_Registration |
|
| 708 | - ? $primary_registration->attendee() |
|
| 709 | - : null; |
|
| 710 | - |
|
| 711 | - $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID(); |
|
| 712 | - $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso'); |
|
| 713 | - |
|
| 714 | - $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp'); |
|
| 715 | - $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
| 716 | - |
|
| 717 | - $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ]; |
|
| 718 | - $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso'); |
|
| 719 | - $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->status_ID(); |
|
| 720 | - |
|
| 721 | - $this->_template_args['grand_total'] = $this->_transaction->total(); |
|
| 722 | - $this->_template_args['total_paid'] = $this->_transaction->paid(); |
|
| 723 | - |
|
| 724 | - $amount_due = $this->_transaction->total() - $this->_transaction->paid(); |
|
| 725 | - $this->_template_args['amount_due'] = EEH_Template::format_currency( |
|
| 726 | - $amount_due, |
|
| 727 | - true |
|
| 728 | - ); |
|
| 729 | - if (EE_Registry::instance()->CFG->currency->sign_b4) { |
|
| 730 | - $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign |
|
| 731 | - . $this->_template_args['amount_due']; |
|
| 732 | - } else { |
|
| 733 | - $this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign; |
|
| 734 | - } |
|
| 735 | - $this->_template_args['amount_due_class'] = ''; |
|
| 736 | - |
|
| 737 | - if ($this->_transaction->paid() === $this->_transaction->total()) { |
|
| 738 | - // paid in full |
|
| 739 | - $this->_template_args['amount_due'] = false; |
|
| 740 | - } elseif ($this->_transaction->paid() > $this->_transaction->total()) { |
|
| 741 | - // overpaid |
|
| 742 | - $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
| 743 | - } elseif ($this->_transaction->total() > (float) 0) { |
|
| 744 | - if ($this->_transaction->paid() > (float) 0) { |
|
| 745 | - // monies owing |
|
| 746 | - $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn'; |
|
| 747 | - } elseif ($this->_transaction->paid() === (float) 0) { |
|
| 748 | - // no payments made yet |
|
| 749 | - $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
| 750 | - } |
|
| 751 | - } elseif ($this->_transaction->total() === (float) 0) { |
|
| 752 | - // free event |
|
| 753 | - $this->_template_args['amount_due'] = false; |
|
| 754 | - } |
|
| 755 | - |
|
| 756 | - $payment_method = $this->_transaction->payment_method(); |
|
| 757 | - |
|
| 758 | - $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method |
|
| 759 | - ? $payment_method->admin_name() |
|
| 760 | - : esc_html__('Unknown', 'event_espresso'); |
|
| 761 | - |
|
| 762 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 763 | - // link back to overview |
|
| 764 | - $this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER']) |
|
| 765 | - ? $_SERVER['HTTP_REFERER'] |
|
| 766 | - : TXN_ADMIN_URL; |
|
| 767 | - |
|
| 768 | - |
|
| 769 | - // next link |
|
| 770 | - $next_txn = $this->_transaction->next( |
|
| 771 | - null, |
|
| 772 | - array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
| 773 | - 'TXN_ID' |
|
| 774 | - ); |
|
| 775 | - $this->_template_args['next_transaction'] = $next_txn |
|
| 776 | - ? $this->_next_link( |
|
| 777 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 778 | - array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']), |
|
| 779 | - TXN_ADMIN_URL |
|
| 780 | - ), |
|
| 781 | - 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
| 782 | - ) |
|
| 783 | - : ''; |
|
| 784 | - // previous link |
|
| 785 | - $previous_txn = $this->_transaction->previous( |
|
| 786 | - null, |
|
| 787 | - array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
| 788 | - 'TXN_ID' |
|
| 789 | - ); |
|
| 790 | - $this->_template_args['previous_transaction'] = $previous_txn |
|
| 791 | - ? $this->_previous_link( |
|
| 792 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 793 | - array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']), |
|
| 794 | - TXN_ADMIN_URL |
|
| 795 | - ), |
|
| 796 | - 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
| 797 | - ) |
|
| 798 | - : ''; |
|
| 799 | - |
|
| 800 | - // were we just redirected here after adding a new registration ??? |
|
| 801 | - if (isset( |
|
| 802 | - $this->_req_data['redirect_from'], |
|
| 803 | - $this->_req_data['EVT_ID'], |
|
| 804 | - $this->_req_data['event_name'] |
|
| 805 | - )) { |
|
| 806 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 807 | - 'ee_edit_registrations', |
|
| 808 | - 'espresso_registrations_new_registration', |
|
| 809 | - $this->_req_data['EVT_ID'] |
|
| 810 | - )) { |
|
| 811 | - $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="'; |
|
| 812 | - $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce( |
|
| 813 | - array( |
|
| 814 | - 'page' => 'espresso_registrations', |
|
| 815 | - 'action' => 'new_registration', |
|
| 816 | - 'return' => 'default', |
|
| 817 | - 'TXN_ID' => $this->_transaction->ID(), |
|
| 818 | - 'event_id' => $this->_req_data['EVT_ID'], |
|
| 819 | - ), |
|
| 820 | - REG_ADMIN_URL |
|
| 821 | - ); |
|
| 822 | - $this->_admin_page_title .= '">'; |
|
| 823 | - |
|
| 824 | - $this->_admin_page_title .= sprintf( |
|
| 825 | - esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'), |
|
| 826 | - htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8') |
|
| 827 | - ); |
|
| 828 | - $this->_admin_page_title .= '</a>'; |
|
| 829 | - } |
|
| 830 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 831 | - } |
|
| 832 | - // grab messages at the last second |
|
| 833 | - $this->_template_args['notices'] = EE_Error::get_notices(); |
|
| 834 | - // path to template |
|
| 835 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php'; |
|
| 836 | - $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
| 837 | - $template_path, |
|
| 838 | - $this->_template_args, |
|
| 839 | - true |
|
| 840 | - ); |
|
| 841 | - |
|
| 842 | - // the details template wrapper |
|
| 843 | - $this->display_admin_page_with_sidebar(); |
|
| 844 | - } |
|
| 845 | - |
|
| 846 | - |
|
| 847 | - /** |
|
| 848 | - * _transaction_details_metaboxes |
|
| 849 | - * |
|
| 850 | - * @access protected |
|
| 851 | - * @return void |
|
| 852 | - * @throws EE_Error |
|
| 853 | - * @throws InvalidArgumentException |
|
| 854 | - * @throws InvalidDataTypeException |
|
| 855 | - * @throws InvalidInterfaceException |
|
| 856 | - * @throws RuntimeException |
|
| 857 | - * @throws ReflectionException |
|
| 858 | - */ |
|
| 859 | - protected function _transaction_details_metaboxes() |
|
| 860 | - { |
|
| 861 | - |
|
| 862 | - $this->_set_transaction_object(); |
|
| 863 | - |
|
| 864 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
| 865 | - return; |
|
| 866 | - } |
|
| 867 | - add_meta_box( |
|
| 868 | - 'edit-txn-details-mbox', |
|
| 869 | - esc_html__('Transaction Details', 'event_espresso'), |
|
| 870 | - array($this, 'txn_details_meta_box'), |
|
| 871 | - $this->_wp_page_slug, |
|
| 872 | - 'normal', |
|
| 873 | - 'high' |
|
| 874 | - ); |
|
| 875 | - add_meta_box( |
|
| 876 | - 'edit-txn-attendees-mbox', |
|
| 877 | - esc_html__('Attendees Registered in this Transaction', 'event_espresso'), |
|
| 878 | - array($this, 'txn_attendees_meta_box'), |
|
| 879 | - $this->_wp_page_slug, |
|
| 880 | - 'normal', |
|
| 881 | - 'high', |
|
| 882 | - array('TXN_ID' => $this->_transaction->ID()) |
|
| 883 | - ); |
|
| 884 | - add_meta_box( |
|
| 885 | - 'edit-txn-registrant-mbox', |
|
| 886 | - esc_html__('Primary Contact', 'event_espresso'), |
|
| 887 | - array($this, 'txn_registrant_side_meta_box'), |
|
| 888 | - $this->_wp_page_slug, |
|
| 889 | - 'side', |
|
| 890 | - 'high' |
|
| 891 | - ); |
|
| 892 | - add_meta_box( |
|
| 893 | - 'edit-txn-billing-info-mbox', |
|
| 894 | - esc_html__('Billing Information', 'event_espresso'), |
|
| 895 | - array($this, 'txn_billing_info_side_meta_box'), |
|
| 896 | - $this->_wp_page_slug, |
|
| 897 | - 'side', |
|
| 898 | - 'high' |
|
| 899 | - ); |
|
| 900 | - } |
|
| 901 | - |
|
| 902 | - |
|
| 903 | - /** |
|
| 904 | - * Callback for transaction actions metabox. |
|
| 905 | - * |
|
| 906 | - * @param EE_Transaction|null $transaction |
|
| 907 | - * @return string |
|
| 908 | - * @throws DomainException |
|
| 909 | - * @throws EE_Error |
|
| 910 | - * @throws InvalidArgumentException |
|
| 911 | - * @throws InvalidDataTypeException |
|
| 912 | - * @throws InvalidInterfaceException |
|
| 913 | - * @throws ReflectionException |
|
| 914 | - * @throws RuntimeException |
|
| 915 | - */ |
|
| 916 | - public function getActionButtons(EE_Transaction $transaction = null) |
|
| 917 | - { |
|
| 918 | - $content = ''; |
|
| 919 | - $actions = array(); |
|
| 920 | - if (! $transaction instanceof EE_Transaction) { |
|
| 921 | - return $content; |
|
| 922 | - } |
|
| 923 | - /** @var EE_Registration $primary_registration */ |
|
| 924 | - $primary_registration = $transaction->primary_registration(); |
|
| 925 | - $attendee = $primary_registration instanceof EE_Registration |
|
| 926 | - ? $primary_registration->attendee() |
|
| 927 | - : null; |
|
| 928 | - |
|
| 929 | - if ($attendee instanceof EE_Attendee |
|
| 930 | - && EE_Registry::instance()->CAP->current_user_can( |
|
| 931 | - 'ee_send_message', |
|
| 932 | - 'espresso_transactions_send_payment_reminder' |
|
| 933 | - ) |
|
| 934 | - ) { |
|
| 935 | - $actions['payment_reminder'] = |
|
| 936 | - EEH_MSG_Template::is_mt_active('payment_reminder') |
|
| 937 | - && $this->_transaction->status_ID() !== EEM_Transaction::complete_status_code |
|
| 938 | - && $this->_transaction->status_ID() !== EEM_Transaction::overpaid_status_code |
|
| 939 | - ? EEH_Template::get_button_or_link( |
|
| 940 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 941 | - array( |
|
| 942 | - 'action' => 'send_payment_reminder', |
|
| 943 | - 'TXN_ID' => $this->_transaction->ID(), |
|
| 944 | - 'redirect_to' => 'view_transaction', |
|
| 945 | - ), |
|
| 946 | - TXN_ADMIN_URL |
|
| 947 | - ), |
|
| 948 | - esc_html__(' Send Payment Reminder', 'event_espresso'), |
|
| 949 | - 'button secondary-button', |
|
| 950 | - 'dashicons dashicons-email-alt' |
|
| 951 | - ) |
|
| 952 | - : ''; |
|
| 953 | - } |
|
| 954 | - |
|
| 955 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 956 | - 'ee_edit_payments', |
|
| 957 | - 'espresso_transactions_recalculate_line_items' |
|
| 958 | - ) |
|
| 959 | - ) { |
|
| 960 | - $actions['recalculate_line_items'] = EEH_Template::get_button_or_link( |
|
| 961 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 962 | - array( |
|
| 963 | - 'action' => 'espresso_recalculate_line_items', |
|
| 964 | - 'TXN_ID' => $this->_transaction->ID(), |
|
| 965 | - 'redirect_to' => 'view_transaction', |
|
| 966 | - ), |
|
| 967 | - TXN_ADMIN_URL |
|
| 968 | - ), |
|
| 969 | - esc_html__(' Recalculate Taxes and Total', 'event_espresso'), |
|
| 970 | - 'button secondary-button', |
|
| 971 | - 'dashicons dashicons-update' |
|
| 972 | - ); |
|
| 973 | - } |
|
| 974 | - |
|
| 975 | - if ($primary_registration instanceof EE_Registration |
|
| 976 | - && EEH_MSG_Template::is_mt_active('receipt') |
|
| 977 | - ) { |
|
| 978 | - $actions['receipt'] = EEH_Template::get_button_or_link( |
|
| 979 | - $primary_registration->receipt_url(), |
|
| 980 | - esc_html__('View Receipt', 'event_espresso'), |
|
| 981 | - 'button secondary-button', |
|
| 982 | - 'dashicons dashicons-media-default' |
|
| 983 | - ); |
|
| 984 | - } |
|
| 985 | - |
|
| 986 | - if ($primary_registration instanceof EE_Registration |
|
| 987 | - && EEH_MSG_Template::is_mt_active('invoice') |
|
| 988 | - ) { |
|
| 989 | - $actions['invoice'] = EEH_Template::get_button_or_link( |
|
| 990 | - $primary_registration->invoice_url(), |
|
| 991 | - esc_html__('View Invoice', 'event_espresso'), |
|
| 992 | - 'button secondary-button', |
|
| 993 | - 'dashicons dashicons-media-spreadsheet' |
|
| 994 | - ); |
|
| 995 | - } |
|
| 996 | - $actions = array_filter( |
|
| 997 | - apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction) |
|
| 998 | - ); |
|
| 999 | - if ($actions) { |
|
| 1000 | - $content = '<ul>'; |
|
| 1001 | - $content .= '<li>' . implode('</li><li>', $actions) . '</li>'; |
|
| 1002 | - $content .= '</uL>'; |
|
| 1003 | - } |
|
| 1004 | - return $content; |
|
| 1005 | - } |
|
| 1006 | - |
|
| 1007 | - |
|
| 1008 | - /** |
|
| 1009 | - * txn_details_meta_box |
|
| 1010 | - * generates HTML for the Transaction main meta box |
|
| 1011 | - * |
|
| 1012 | - * @return void |
|
| 1013 | - * @throws DomainException |
|
| 1014 | - * @throws EE_Error |
|
| 1015 | - * @throws InvalidArgumentException |
|
| 1016 | - * @throws InvalidDataTypeException |
|
| 1017 | - * @throws InvalidInterfaceException |
|
| 1018 | - * @throws RuntimeException |
|
| 1019 | - * @throws ReflectionException |
|
| 1020 | - */ |
|
| 1021 | - public function txn_details_meta_box() |
|
| 1022 | - { |
|
| 1023 | - $this->_set_transaction_object(); |
|
| 1024 | - $this->_template_args['TXN_ID'] = $this->_transaction->ID(); |
|
| 1025 | - $this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration |
|
| 1026 | - ? $this->_transaction->primary_registration()->attendee() |
|
| 1027 | - : null; |
|
| 1028 | - $this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
| 1029 | - 'ee_edit_payments', |
|
| 1030 | - 'apply_payment_or_refund_from_registration_details' |
|
| 1031 | - ); |
|
| 1032 | - $this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
| 1033 | - 'ee_delete_payments', |
|
| 1034 | - 'delete_payment_from_registration_details' |
|
| 1035 | - ); |
|
| 1036 | - |
|
| 1037 | - // get line table |
|
| 1038 | - EEH_Autoloader::register_line_item_display_autoloaders(); |
|
| 1039 | - $Line_Item_Display = new EE_Line_Item_Display( |
|
| 1040 | - 'admin_table', |
|
| 1041 | - 'EE_Admin_Table_Line_Item_Display_Strategy' |
|
| 1042 | - ); |
|
| 1043 | - $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item( |
|
| 1044 | - $this->_transaction->total_line_item() |
|
| 1045 | - ); |
|
| 1046 | - $this->_template_args['REG_code'] = $this->_transaction->primary_registration()->reg_code(); |
|
| 1047 | - |
|
| 1048 | - // process taxes |
|
| 1049 | - $taxes = $this->_transaction->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax))); |
|
| 1050 | - $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false; |
|
| 1051 | - |
|
| 1052 | - $this->_template_args['grand_total'] = EEH_Template::format_currency( |
|
| 1053 | - $this->_transaction->total(), |
|
| 1054 | - false, |
|
| 1055 | - false |
|
| 1056 | - ); |
|
| 1057 | - $this->_template_args['grand_raw_total'] = $this->_transaction->total(); |
|
| 1058 | - $this->_template_args['TXN_status'] = $this->_transaction->status_ID(); |
|
| 1059 | - |
|
| 1060 | - // process payment details |
|
| 1061 | - $payments = $this->_transaction->payments(); |
|
| 1062 | - if (! empty($payments)) { |
|
| 1063 | - $this->_template_args['payments'] = $payments; |
|
| 1064 | - $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments); |
|
| 1065 | - } else { |
|
| 1066 | - $this->_template_args['payments'] = false; |
|
| 1067 | - $this->_template_args['existing_reg_payments'] = array(); |
|
| 1068 | - } |
|
| 1069 | - |
|
| 1070 | - $this->_template_args['edit_payment_url'] = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL); |
|
| 1071 | - $this->_template_args['delete_payment_url'] = add_query_arg( |
|
| 1072 | - array('action' => 'espresso_delete_payment'), |
|
| 1073 | - TXN_ADMIN_URL |
|
| 1074 | - ); |
|
| 1075 | - |
|
| 1076 | - if (isset($txn_details['invoice_number'])) { |
|
| 1077 | - $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code']; |
|
| 1078 | - $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__( |
|
| 1079 | - 'Invoice Number', |
|
| 1080 | - 'event_espresso' |
|
| 1081 | - ); |
|
| 1082 | - } |
|
| 1083 | - |
|
| 1084 | - $this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction |
|
| 1085 | - ->primary_registration() |
|
| 1086 | - ->session_ID(); |
|
| 1087 | - $this->_template_args['txn_details']['registration_session']['label'] = esc_html__( |
|
| 1088 | - 'Registration Session', |
|
| 1089 | - 'event_espresso' |
|
| 1090 | - ); |
|
| 1091 | - |
|
| 1092 | - $this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address']) |
|
| 1093 | - ? $this->_session['ip_address'] |
|
| 1094 | - : ''; |
|
| 1095 | - $this->_template_args['txn_details']['ip_address']['label'] = esc_html__( |
|
| 1096 | - 'Transaction placed from IP', |
|
| 1097 | - 'event_espresso' |
|
| 1098 | - ); |
|
| 1099 | - |
|
| 1100 | - $this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent']) |
|
| 1101 | - ? $this->_session['user_agent'] |
|
| 1102 | - : ''; |
|
| 1103 | - $this->_template_args['txn_details']['user_agent']['label'] = esc_html__( |
|
| 1104 | - 'Registrant User Agent', |
|
| 1105 | - 'event_espresso' |
|
| 1106 | - ); |
|
| 1107 | - |
|
| 1108 | - $reg_steps = '<ul>'; |
|
| 1109 | - foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) { |
|
| 1110 | - if ($reg_step_status === true) { |
|
| 1111 | - $reg_steps .= '<li style="color:#70cc50">' |
|
| 1112 | - . sprintf( |
|
| 1113 | - esc_html__('%1$s : Completed', 'event_espresso'), |
|
| 1114 | - ucwords(str_replace('_', ' ', $reg_step)) |
|
| 1115 | - ) |
|
| 1116 | - . '</li>'; |
|
| 1117 | - } elseif (is_numeric($reg_step_status) && $reg_step_status !== false) { |
|
| 1118 | - $reg_steps .= '<li style="color:#2EA2CC">' |
|
| 1119 | - . sprintf( |
|
| 1120 | - esc_html__('%1$s : Initiated %2$s', 'event_espresso'), |
|
| 1121 | - ucwords(str_replace('_', ' ', $reg_step)), |
|
| 1122 | - date( |
|
| 1123 | - get_option('date_format') . ' ' . get_option('time_format'), |
|
| 1124 | - $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS) |
|
| 1125 | - ) |
|
| 1126 | - ) |
|
| 1127 | - . '</li>'; |
|
| 1128 | - } else { |
|
| 1129 | - $reg_steps .= '<li style="color:#E76700">' |
|
| 1130 | - . sprintf( |
|
| 1131 | - esc_html__('%1$s : Never Initiated', 'event_espresso'), |
|
| 1132 | - ucwords(str_replace('_', ' ', $reg_step)) |
|
| 1133 | - ) |
|
| 1134 | - . '</li>'; |
|
| 1135 | - } |
|
| 1136 | - } |
|
| 1137 | - $reg_steps .= '</ul>'; |
|
| 1138 | - $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps; |
|
| 1139 | - $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__( |
|
| 1140 | - 'Registration Step Progress', |
|
| 1141 | - 'event_espresso' |
|
| 1142 | - ); |
|
| 1143 | - |
|
| 1144 | - |
|
| 1145 | - $this->_get_registrations_to_apply_payment_to(); |
|
| 1146 | - $this->_get_payment_methods($payments); |
|
| 1147 | - $this->_get_payment_status_array(); |
|
| 1148 | - $this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction. |
|
| 1149 | - |
|
| 1150 | - $this->_template_args['transaction_form_url'] = add_query_arg( |
|
| 1151 | - array( |
|
| 1152 | - 'action' => 'edit_transaction', |
|
| 1153 | - 'process' => 'transaction', |
|
| 1154 | - ), |
|
| 1155 | - TXN_ADMIN_URL |
|
| 1156 | - ); |
|
| 1157 | - $this->_template_args['apply_payment_form_url'] = add_query_arg( |
|
| 1158 | - array( |
|
| 1159 | - 'page' => 'espresso_transactions', |
|
| 1160 | - 'action' => 'espresso_apply_payment', |
|
| 1161 | - ), |
|
| 1162 | - WP_AJAX_URL |
|
| 1163 | - ); |
|
| 1164 | - $this->_template_args['delete_payment_form_url'] = add_query_arg( |
|
| 1165 | - array( |
|
| 1166 | - 'page' => 'espresso_transactions', |
|
| 1167 | - 'action' => 'espresso_delete_payment', |
|
| 1168 | - ), |
|
| 1169 | - WP_AJAX_URL |
|
| 1170 | - ); |
|
| 1171 | - |
|
| 1172 | - $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction); |
|
| 1173 | - |
|
| 1174 | - // 'espresso_delete_payment_nonce' |
|
| 1175 | - |
|
| 1176 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
| 1177 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1178 | - } |
|
| 1179 | - |
|
| 1180 | - |
|
| 1181 | - /** |
|
| 1182 | - * _get_registration_payment_IDs |
|
| 1183 | - * generates an array of Payment IDs and their corresponding Registration IDs |
|
| 1184 | - * |
|
| 1185 | - * @access protected |
|
| 1186 | - * @param EE_Payment[] $payments |
|
| 1187 | - * @return array |
|
| 1188 | - * @throws EE_Error |
|
| 1189 | - * @throws InvalidArgumentException |
|
| 1190 | - * @throws InvalidDataTypeException |
|
| 1191 | - * @throws InvalidInterfaceException |
|
| 1192 | - * @throws ReflectionException |
|
| 1193 | - */ |
|
| 1194 | - protected function _get_registration_payment_IDs($payments = array()) |
|
| 1195 | - { |
|
| 1196 | - $existing_reg_payments = array(); |
|
| 1197 | - // get all reg payments for these payments |
|
| 1198 | - $reg_payments = EEM_Registration_Payment::instance()->get_all( |
|
| 1199 | - array( |
|
| 1200 | - array( |
|
| 1201 | - 'PAY_ID' => array( |
|
| 1202 | - 'IN', |
|
| 1203 | - array_keys($payments), |
|
| 1204 | - ), |
|
| 1205 | - ), |
|
| 1206 | - ) |
|
| 1207 | - ); |
|
| 1208 | - if (! empty($reg_payments)) { |
|
| 1209 | - foreach ($payments as $payment) { |
|
| 1210 | - if (! $payment instanceof EE_Payment) { |
|
| 1211 | - continue; |
|
| 1212 | - } elseif (! isset($existing_reg_payments[ $payment->ID() ])) { |
|
| 1213 | - $existing_reg_payments[ $payment->ID() ] = array(); |
|
| 1214 | - } |
|
| 1215 | - foreach ($reg_payments as $reg_payment) { |
|
| 1216 | - if ($reg_payment instanceof EE_Registration_Payment |
|
| 1217 | - && $reg_payment->payment_ID() === $payment->ID() |
|
| 1218 | - ) { |
|
| 1219 | - $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID(); |
|
| 1220 | - } |
|
| 1221 | - } |
|
| 1222 | - } |
|
| 1223 | - } |
|
| 1224 | - |
|
| 1225 | - return $existing_reg_payments; |
|
| 1226 | - } |
|
| 1227 | - |
|
| 1228 | - |
|
| 1229 | - /** |
|
| 1230 | - * _get_registrations_to_apply_payment_to |
|
| 1231 | - * generates HTML for displaying a series of checkboxes in the admin payment modal window |
|
| 1232 | - * which allows the admin to only apply the payment to the specific registrations |
|
| 1233 | - * |
|
| 1234 | - * @access protected |
|
| 1235 | - * @return void |
|
| 1236 | - * @throws EE_Error |
|
| 1237 | - * @throws InvalidArgumentException |
|
| 1238 | - * @throws InvalidDataTypeException |
|
| 1239 | - * @throws InvalidInterfaceException |
|
| 1240 | - * @throws ReflectionException |
|
| 1241 | - */ |
|
| 1242 | - protected function _get_registrations_to_apply_payment_to() |
|
| 1243 | - { |
|
| 1244 | - // we want any registration with an active status (ie: not deleted or cancelled) |
|
| 1245 | - $query_params = array( |
|
| 1246 | - array( |
|
| 1247 | - 'STS_ID' => array( |
|
| 1248 | - 'IN', |
|
| 1249 | - array( |
|
| 1250 | - EEM_Registration::status_id_approved, |
|
| 1251 | - EEM_Registration::status_id_pending_payment, |
|
| 1252 | - EEM_Registration::status_id_not_approved, |
|
| 1253 | - ), |
|
| 1254 | - ), |
|
| 1255 | - ), |
|
| 1256 | - ); |
|
| 1257 | - $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div( |
|
| 1258 | - '', |
|
| 1259 | - 'txn-admin-apply-payment-to-registrations-dv', |
|
| 1260 | - '', |
|
| 1261 | - 'clear: both; margin: 1.5em 0 0; display: none;' |
|
| 1262 | - ); |
|
| 1263 | - $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
| 1264 | - $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl'); |
|
| 1265 | - $registrations_to_apply_payment_to .= EEH_HTML::thead( |
|
| 1266 | - EEH_HTML::tr( |
|
| 1267 | - EEH_HTML::th(esc_html__('ID', 'event_espresso')) . |
|
| 1268 | - EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) . |
|
| 1269 | - EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) . |
|
| 1270 | - EEH_HTML::th(esc_html__('Event', 'event_espresso')) . |
|
| 1271 | - EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
| 1272 | - EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
| 1273 | - EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr') |
|
| 1274 | - ) |
|
| 1275 | - ); |
|
| 1276 | - $registrations_to_apply_payment_to .= EEH_HTML::tbody(); |
|
| 1277 | - // get registrations for TXN |
|
| 1278 | - $registrations = $this->_transaction->registrations($query_params); |
|
| 1279 | - $existing_reg_payments = $this->_template_args['existing_reg_payments']; |
|
| 1280 | - foreach ($registrations as $registration) { |
|
| 1281 | - if ($registration instanceof EE_Registration) { |
|
| 1282 | - $attendee_name = $registration->attendee() instanceof EE_Attendee |
|
| 1283 | - ? $registration->attendee()->full_name() |
|
| 1284 | - : esc_html__('Unknown Attendee', 'event_espresso'); |
|
| 1285 | - $owing = $registration->final_price() - $registration->paid(); |
|
| 1286 | - $taxable = $registration->ticket()->taxable() |
|
| 1287 | - ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>' |
|
| 1288 | - : ''; |
|
| 1289 | - $checked = empty($existing_reg_payments) |
|
| 1290 | - || in_array($registration->ID(), $existing_reg_payments, true) |
|
| 1291 | - ? ' checked="checked"' |
|
| 1292 | - : ''; |
|
| 1293 | - $disabled = $registration->final_price() > 0 ? '' : ' disabled'; |
|
| 1294 | - $registrations_to_apply_payment_to .= EEH_HTML::tr( |
|
| 1295 | - EEH_HTML::td($registration->ID()) . |
|
| 1296 | - EEH_HTML::td($attendee_name) . |
|
| 1297 | - EEH_HTML::td( |
|
| 1298 | - $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable |
|
| 1299 | - ) . |
|
| 1300 | - EEH_HTML::td($registration->event_name()) . |
|
| 1301 | - EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
| 1302 | - EEH_HTML::td( |
|
| 1303 | - EEH_Template::format_currency($owing), |
|
| 1304 | - '', |
|
| 1305 | - 'txn-admin-payment-owing-td jst-cntr' |
|
| 1306 | - ) . |
|
| 1307 | - EEH_HTML::td( |
|
| 1308 | - '<input type="checkbox" value="' . $registration->ID() |
|
| 1309 | - . '" name="txn_admin_payment[registrations]"' |
|
| 1310 | - . $checked . $disabled . '>', |
|
| 1311 | - '', |
|
| 1312 | - 'jst-cntr' |
|
| 1313 | - ), |
|
| 1314 | - 'apply-payment-registration-row-' . $registration->ID() |
|
| 1315 | - ); |
|
| 1316 | - } |
|
| 1317 | - } |
|
| 1318 | - $registrations_to_apply_payment_to .= EEH_HTML::tbodyx(); |
|
| 1319 | - $registrations_to_apply_payment_to .= EEH_HTML::tablex(); |
|
| 1320 | - $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
| 1321 | - $registrations_to_apply_payment_to .= EEH_HTML::p( |
|
| 1322 | - esc_html__( |
|
| 1323 | - 'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.', |
|
| 1324 | - 'event_espresso' |
|
| 1325 | - ), |
|
| 1326 | - '', |
|
| 1327 | - 'clear description' |
|
| 1328 | - ); |
|
| 1329 | - $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
| 1330 | - $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to; |
|
| 1331 | - } |
|
| 1332 | - |
|
| 1333 | - |
|
| 1334 | - /** |
|
| 1335 | - * _get_reg_status_selection |
|
| 1336 | - * |
|
| 1337 | - * @todo this will need to be adjusted either once MER comes along OR we move default reg status to tickets |
|
| 1338 | - * instead of events. |
|
| 1339 | - * @access protected |
|
| 1340 | - * @return void |
|
| 1341 | - * @throws EE_Error |
|
| 1342 | - */ |
|
| 1343 | - protected function _get_reg_status_selection() |
|
| 1344 | - { |
|
| 1345 | - // first get all possible statuses |
|
| 1346 | - $statuses = EEM_Registration::reg_status_array(array(), true); |
|
| 1347 | - // let's add a "don't change" option. |
|
| 1348 | - $status_array['NAN'] = esc_html__('Leave the Same', 'event_espresso'); |
|
| 1349 | - $status_array = array_merge($status_array, $statuses); |
|
| 1350 | - $this->_template_args['status_change_select'] = EEH_Form_Fields::select_input( |
|
| 1351 | - 'txn_reg_status_change[reg_status]', |
|
| 1352 | - $status_array, |
|
| 1353 | - 'NAN', |
|
| 1354 | - 'id="txn-admin-payment-reg-status-inp"', |
|
| 1355 | - 'txn-reg-status-change-reg-status' |
|
| 1356 | - ); |
|
| 1357 | - $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input( |
|
| 1358 | - 'delete_txn_reg_status_change[reg_status]', |
|
| 1359 | - $status_array, |
|
| 1360 | - 'NAN', |
|
| 1361 | - 'delete-txn-admin-payment-reg-status-inp', |
|
| 1362 | - 'delete-txn-reg-status-change-reg-status' |
|
| 1363 | - ); |
|
| 1364 | - } |
|
| 1365 | - |
|
| 1366 | - |
|
| 1367 | - /** |
|
| 1368 | - * _get_payment_methods |
|
| 1369 | - * Gets all the payment methods available generally, or the ones that are already |
|
| 1370 | - * selected on these payments (in case their payment methods are no longer active). |
|
| 1371 | - * Has the side-effect of updating the template args' payment_methods item |
|
| 1372 | - * |
|
| 1373 | - * @access private |
|
| 1374 | - * @param EE_Payment[] to show on this page |
|
| 1375 | - * @return void |
|
| 1376 | - * @throws EE_Error |
|
| 1377 | - * @throws InvalidArgumentException |
|
| 1378 | - * @throws InvalidDataTypeException |
|
| 1379 | - * @throws InvalidInterfaceException |
|
| 1380 | - * @throws ReflectionException |
|
| 1381 | - */ |
|
| 1382 | - private function _get_payment_methods($payments = array()) |
|
| 1383 | - { |
|
| 1384 | - $payment_methods_of_payments = array(); |
|
| 1385 | - foreach ($payments as $payment) { |
|
| 1386 | - if ($payment instanceof EE_Payment) { |
|
| 1387 | - $payment_methods_of_payments[] = $payment->ID(); |
|
| 1388 | - } |
|
| 1389 | - } |
|
| 1390 | - if ($payment_methods_of_payments) { |
|
| 1391 | - $query_args = array( |
|
| 1392 | - array( |
|
| 1393 | - 'OR*payment_method_for_payment' => array( |
|
| 1394 | - 'PMD_ID' => array('IN', $payment_methods_of_payments), |
|
| 1395 | - 'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'), |
|
| 1396 | - ), |
|
| 1397 | - ), |
|
| 1398 | - ); |
|
| 1399 | - } else { |
|
| 1400 | - $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'))); |
|
| 1401 | - } |
|
| 1402 | - $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args); |
|
| 1403 | - } |
|
| 1404 | - |
|
| 1405 | - |
|
| 1406 | - /** |
|
| 1407 | - * txn_attendees_meta_box |
|
| 1408 | - * generates HTML for the Attendees Transaction main meta box |
|
| 1409 | - * |
|
| 1410 | - * @access public |
|
| 1411 | - * @param WP_Post $post |
|
| 1412 | - * @param array $metabox |
|
| 1413 | - * @return void |
|
| 1414 | - * @throws DomainException |
|
| 1415 | - * @throws EE_Error |
|
| 1416 | - * @throws InvalidArgumentException |
|
| 1417 | - * @throws InvalidDataTypeException |
|
| 1418 | - * @throws InvalidInterfaceException |
|
| 1419 | - * @throws ReflectionException |
|
| 1420 | - */ |
|
| 1421 | - public function txn_attendees_meta_box($post, $metabox = array('args' => array())) |
|
| 1422 | - { |
|
| 1423 | - |
|
| 1424 | - /** @noinspection NonSecureExtractUsageInspection */ |
|
| 1425 | - extract($metabox['args']); |
|
| 1426 | - $this->_template_args['post'] = $post; |
|
| 1427 | - $this->_template_args['event_attendees'] = array(); |
|
| 1428 | - // process items in cart |
|
| 1429 | - $line_items = $this->_transaction->get_many_related( |
|
| 1430 | - 'Line_Item', |
|
| 1431 | - array(array('LIN_type' => 'line-item')) |
|
| 1432 | - ); |
|
| 1433 | - if (! empty($line_items)) { |
|
| 1434 | - foreach ($line_items as $item) { |
|
| 1435 | - if ($item instanceof EE_Line_Item) { |
|
| 1436 | - switch ($item->OBJ_type()) { |
|
| 1437 | - case 'Event': |
|
| 1438 | - break; |
|
| 1439 | - case 'Ticket': |
|
| 1440 | - $ticket = $item->ticket(); |
|
| 1441 | - // right now we're only handling tickets here. |
|
| 1442 | - // Cause its expected that only tickets will have attendees right? |
|
| 1443 | - if (! $ticket instanceof EE_Ticket) { |
|
| 1444 | - break; |
|
| 1445 | - } |
|
| 1446 | - try { |
|
| 1447 | - $event_name = $ticket->get_event_name(); |
|
| 1448 | - } catch (Exception $e) { |
|
| 1449 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1450 | - $event_name = esc_html__('Unknown Event', 'event_espresso'); |
|
| 1451 | - } |
|
| 1452 | - $event_name .= ' - ' . $item->name(); |
|
| 1453 | - $ticket_price = EEH_Template::format_currency($item->unit_price()); |
|
| 1454 | - // now get all of the registrations for this transaction that use this ticket |
|
| 1455 | - $registrations = $ticket->registrations( |
|
| 1456 | - array(array('TXN_ID' => $this->_transaction->ID())) |
|
| 1457 | - ); |
|
| 1458 | - foreach ($registrations as $registration) { |
|
| 1459 | - if (! $registration instanceof EE_Registration) { |
|
| 1460 | - break; |
|
| 1461 | - } |
|
| 1462 | - $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID'] |
|
| 1463 | - = $registration->status_ID(); |
|
| 1464 | - $this->_template_args['event_attendees'][ $registration->ID() ]['att_num'] |
|
| 1465 | - = $registration->count(); |
|
| 1466 | - $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name'] |
|
| 1467 | - = $event_name; |
|
| 1468 | - $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price'] |
|
| 1469 | - = $ticket_price; |
|
| 1470 | - // attendee info |
|
| 1471 | - $attendee = $registration->get_first_related('Attendee'); |
|
| 1472 | - if ($attendee instanceof EE_Attendee) { |
|
| 1473 | - $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] |
|
| 1474 | - = $attendee->ID(); |
|
| 1475 | - $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] |
|
| 1476 | - = $attendee->full_name(); |
|
| 1477 | - $this->_template_args['event_attendees'][ $registration->ID() ]['email'] |
|
| 1478 | - = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name |
|
| 1479 | - . esc_html__( |
|
| 1480 | - ' Event', |
|
| 1481 | - 'event_espresso' |
|
| 1482 | - ) |
|
| 1483 | - . '">' . $attendee->email() . '</a>'; |
|
| 1484 | - $this->_template_args['event_attendees'][ $registration->ID() ]['address'] |
|
| 1485 | - = EEH_Address::format($attendee, 'inline', false, false); |
|
| 1486 | - } else { |
|
| 1487 | - $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] = ''; |
|
| 1488 | - $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = ''; |
|
| 1489 | - $this->_template_args['event_attendees'][ $registration->ID() ]['email'] = ''; |
|
| 1490 | - $this->_template_args['event_attendees'][ $registration->ID() ]['address'] = ''; |
|
| 1491 | - } |
|
| 1492 | - } |
|
| 1493 | - break; |
|
| 1494 | - } |
|
| 1495 | - } |
|
| 1496 | - } |
|
| 1497 | - |
|
| 1498 | - $this->_template_args['transaction_form_url'] = add_query_arg( |
|
| 1499 | - array( |
|
| 1500 | - 'action' => 'edit_transaction', |
|
| 1501 | - 'process' => 'attendees', |
|
| 1502 | - ), |
|
| 1503 | - TXN_ADMIN_URL |
|
| 1504 | - ); |
|
| 1505 | - echo EEH_Template::display_template( |
|
| 1506 | - TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php', |
|
| 1507 | - $this->_template_args, |
|
| 1508 | - true |
|
| 1509 | - ); |
|
| 1510 | - } else { |
|
| 1511 | - echo sprintf( |
|
| 1512 | - esc_html__( |
|
| 1513 | - '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s', |
|
| 1514 | - 'event_espresso' |
|
| 1515 | - ), |
|
| 1516 | - '<p class="important-notice">', |
|
| 1517 | - '</p>' |
|
| 1518 | - ); |
|
| 1519 | - } |
|
| 1520 | - } |
|
| 1521 | - |
|
| 1522 | - |
|
| 1523 | - /** |
|
| 1524 | - * txn_registrant_side_meta_box |
|
| 1525 | - * generates HTML for the Edit Transaction side meta box |
|
| 1526 | - * |
|
| 1527 | - * @access public |
|
| 1528 | - * @return void |
|
| 1529 | - * @throws DomainException |
|
| 1530 | - * @throws EE_Error |
|
| 1531 | - * @throws InvalidArgumentException |
|
| 1532 | - * @throws InvalidDataTypeException |
|
| 1533 | - * @throws InvalidInterfaceException |
|
| 1534 | - * @throws ReflectionException |
|
| 1535 | - */ |
|
| 1536 | - public function txn_registrant_side_meta_box() |
|
| 1537 | - { |
|
| 1538 | - $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration |
|
| 1539 | - ? $this->_transaction->primary_registration()->get_first_related('Attendee') |
|
| 1540 | - : null; |
|
| 1541 | - if (! $primary_att instanceof EE_Attendee) { |
|
| 1542 | - $this->_template_args['no_attendee_message'] = esc_html__( |
|
| 1543 | - 'There is no attached contact for this transaction. The transaction either failed due to an error or was abandoned.', |
|
| 1544 | - 'event_espresso' |
|
| 1545 | - ); |
|
| 1546 | - $primary_att = EEM_Attendee::instance()->create_default_object(); |
|
| 1547 | - } |
|
| 1548 | - $this->_template_args['ATT_ID'] = $primary_att->ID(); |
|
| 1549 | - $this->_template_args['prime_reg_fname'] = $primary_att->fname(); |
|
| 1550 | - $this->_template_args['prime_reg_lname'] = $primary_att->lname(); |
|
| 1551 | - $this->_template_args['prime_reg_email'] = $primary_att->email(); |
|
| 1552 | - $this->_template_args['prime_reg_phone'] = $primary_att->phone(); |
|
| 1553 | - $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1554 | - array( |
|
| 1555 | - 'action' => 'edit_attendee', |
|
| 1556 | - 'post' => $primary_att->ID(), |
|
| 1557 | - ), |
|
| 1558 | - REG_ADMIN_URL |
|
| 1559 | - ); |
|
| 1560 | - // get formatted address for registrant |
|
| 1561 | - $this->_template_args['formatted_address'] = EEH_Address::format($primary_att); |
|
| 1562 | - echo EEH_Template::display_template( |
|
| 1563 | - TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php', |
|
| 1564 | - $this->_template_args, |
|
| 1565 | - true |
|
| 1566 | - ); |
|
| 1567 | - } |
|
| 1568 | - |
|
| 1569 | - |
|
| 1570 | - /** |
|
| 1571 | - * txn_billing_info_side_meta_box |
|
| 1572 | - * generates HTML for the Edit Transaction side meta box |
|
| 1573 | - * |
|
| 1574 | - * @access public |
|
| 1575 | - * @return void |
|
| 1576 | - * @throws DomainException |
|
| 1577 | - * @throws EE_Error |
|
| 1578 | - */ |
|
| 1579 | - public function txn_billing_info_side_meta_box() |
|
| 1580 | - { |
|
| 1581 | - |
|
| 1582 | - $this->_template_args['billing_form'] = $this->_transaction->billing_info(); |
|
| 1583 | - $this->_template_args['billing_form_url'] = add_query_arg( |
|
| 1584 | - array('action' => 'edit_transaction', 'process' => 'billing'), |
|
| 1585 | - TXN_ADMIN_URL |
|
| 1586 | - ); |
|
| 1587 | - |
|
| 1588 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
| 1589 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1590 | - } |
|
| 1591 | - |
|
| 1592 | - |
|
| 1593 | - /** |
|
| 1594 | - * apply_payments_or_refunds |
|
| 1595 | - * registers a payment or refund made towards a transaction |
|
| 1596 | - * |
|
| 1597 | - * @access public |
|
| 1598 | - * @return void |
|
| 1599 | - * @throws EE_Error |
|
| 1600 | - * @throws InvalidArgumentException |
|
| 1601 | - * @throws ReflectionException |
|
| 1602 | - * @throws RuntimeException |
|
| 1603 | - * @throws InvalidDataTypeException |
|
| 1604 | - * @throws InvalidInterfaceException |
|
| 1605 | - */ |
|
| 1606 | - public function apply_payments_or_refunds() |
|
| 1607 | - { |
|
| 1608 | - $json_response_data = array('return_data' => false); |
|
| 1609 | - $valid_data = $this->_validate_payment_request_data(); |
|
| 1610 | - $has_access = EE_Registry::instance()->CAP->current_user_can( |
|
| 1611 | - 'ee_edit_payments', |
|
| 1612 | - 'apply_payment_or_refund_from_registration_details' |
|
| 1613 | - ); |
|
| 1614 | - if (! empty($valid_data) && $has_access) { |
|
| 1615 | - $PAY_ID = $valid_data['PAY_ID']; |
|
| 1616 | - // save the new payment |
|
| 1617 | - $payment = $this->_create_payment_from_request_data($valid_data); |
|
| 1618 | - // get the TXN for this payment |
|
| 1619 | - $transaction = $payment->transaction(); |
|
| 1620 | - // verify transaction |
|
| 1621 | - if ($transaction instanceof EE_Transaction) { |
|
| 1622 | - // calculate_total_payments_and_update_status |
|
| 1623 | - $this->_process_transaction_payments($transaction); |
|
| 1624 | - $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment); |
|
| 1625 | - $this->_remove_existing_registration_payments($payment, $PAY_ID); |
|
| 1626 | - // apply payment to registrations (if applicable) |
|
| 1627 | - if (! empty($REG_IDs)) { |
|
| 1628 | - $this->_update_registration_payments($transaction, $payment, $REG_IDs); |
|
| 1629 | - $this->_maybe_send_notifications(); |
|
| 1630 | - // now process status changes for the same registrations |
|
| 1631 | - $this->_process_registration_status_change($transaction, $REG_IDs); |
|
| 1632 | - } |
|
| 1633 | - $this->_maybe_send_notifications($payment); |
|
| 1634 | - // prepare to render page |
|
| 1635 | - $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs); |
|
| 1636 | - do_action( |
|
| 1637 | - 'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording', |
|
| 1638 | - $transaction, |
|
| 1639 | - $payment |
|
| 1640 | - ); |
|
| 1641 | - } else { |
|
| 1642 | - EE_Error::add_error( |
|
| 1643 | - esc_html__( |
|
| 1644 | - 'A valid Transaction for this payment could not be retrieved.', |
|
| 1645 | - 'event_espresso' |
|
| 1646 | - ), |
|
| 1647 | - __FILE__, |
|
| 1648 | - __FUNCTION__, |
|
| 1649 | - __LINE__ |
|
| 1650 | - ); |
|
| 1651 | - } |
|
| 1652 | - } elseif ($has_access) { |
|
| 1653 | - EE_Error::add_error( |
|
| 1654 | - esc_html__( |
|
| 1655 | - 'The payment form data could not be processed. Please try again.', |
|
| 1656 | - 'event_espresso' |
|
| 1657 | - ), |
|
| 1658 | - __FILE__, |
|
| 1659 | - __FUNCTION__, |
|
| 1660 | - __LINE__ |
|
| 1661 | - ); |
|
| 1662 | - } else { |
|
| 1663 | - EE_Error::add_error( |
|
| 1664 | - esc_html__( |
|
| 1665 | - 'You do not have access to apply payments or refunds to a registration.', |
|
| 1666 | - 'event_espresso' |
|
| 1667 | - ), |
|
| 1668 | - __FILE__, |
|
| 1669 | - __FUNCTION__, |
|
| 1670 | - __LINE__ |
|
| 1671 | - ); |
|
| 1672 | - } |
|
| 1673 | - $notices = EE_Error::get_notices( |
|
| 1674 | - false, |
|
| 1675 | - false, |
|
| 1676 | - false |
|
| 1677 | - ); |
|
| 1678 | - $this->_template_args = array( |
|
| 1679 | - 'data' => $json_response_data, |
|
| 1680 | - 'error' => $notices['errors'], |
|
| 1681 | - 'success' => $notices['success'], |
|
| 1682 | - ); |
|
| 1683 | - $this->_return_json(); |
|
| 1684 | - } |
|
| 1685 | - |
|
| 1686 | - |
|
| 1687 | - /** |
|
| 1688 | - * _validate_payment_request_data |
|
| 1689 | - * |
|
| 1690 | - * @return array |
|
| 1691 | - * @throws EE_Error |
|
| 1692 | - * @throws InvalidArgumentException |
|
| 1693 | - * @throws InvalidDataTypeException |
|
| 1694 | - * @throws InvalidInterfaceException |
|
| 1695 | - */ |
|
| 1696 | - protected function _validate_payment_request_data() |
|
| 1697 | - { |
|
| 1698 | - if (! isset($this->_req_data['txn_admin_payment'])) { |
|
| 1699 | - return array(); |
|
| 1700 | - } |
|
| 1701 | - $payment_form = $this->_generate_payment_form_section(); |
|
| 1702 | - try { |
|
| 1703 | - if ($payment_form->was_submitted()) { |
|
| 1704 | - $payment_form->receive_form_submission(); |
|
| 1705 | - if (! $payment_form->is_valid()) { |
|
| 1706 | - $submission_error_messages = array(); |
|
| 1707 | - foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) { |
|
| 1708 | - if ($validation_error instanceof EE_Validation_Error) { |
|
| 1709 | - $submission_error_messages[] = sprintf( |
|
| 1710 | - _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'), |
|
| 1711 | - $validation_error->get_form_section()->html_label_text(), |
|
| 1712 | - $validation_error->getMessage() |
|
| 1713 | - ); |
|
| 1714 | - } |
|
| 1715 | - } |
|
| 1716 | - EE_Error::add_error( |
|
| 1717 | - implode('<br />', $submission_error_messages), |
|
| 1718 | - __FILE__, |
|
| 1719 | - __FUNCTION__, |
|
| 1720 | - __LINE__ |
|
| 1721 | - ); |
|
| 1722 | - return array(); |
|
| 1723 | - } |
|
| 1724 | - } |
|
| 1725 | - } catch (EE_Error $e) { |
|
| 1726 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1727 | - return array(); |
|
| 1728 | - } |
|
| 1729 | - |
|
| 1730 | - return $payment_form->valid_data(); |
|
| 1731 | - } |
|
| 1732 | - |
|
| 1733 | - |
|
| 1734 | - /** |
|
| 1735 | - * _generate_payment_form_section |
|
| 1736 | - * |
|
| 1737 | - * @return EE_Form_Section_Proper |
|
| 1738 | - * @throws EE_Error |
|
| 1739 | - */ |
|
| 1740 | - protected function _generate_payment_form_section() |
|
| 1741 | - { |
|
| 1742 | - return new EE_Form_Section_Proper( |
|
| 1743 | - array( |
|
| 1744 | - 'name' => 'txn_admin_payment', |
|
| 1745 | - 'subsections' => array( |
|
| 1746 | - 'PAY_ID' => new EE_Text_Input( |
|
| 1747 | - array( |
|
| 1748 | - 'default' => 0, |
|
| 1749 | - 'required' => false, |
|
| 1750 | - 'html_label_text' => esc_html__('Payment ID', 'event_espresso'), |
|
| 1751 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1752 | - ) |
|
| 1753 | - ), |
|
| 1754 | - 'TXN_ID' => new EE_Text_Input( |
|
| 1755 | - array( |
|
| 1756 | - 'default' => 0, |
|
| 1757 | - 'required' => true, |
|
| 1758 | - 'html_label_text' => esc_html__('Transaction ID', 'event_espresso'), |
|
| 1759 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1760 | - ) |
|
| 1761 | - ), |
|
| 1762 | - 'type' => new EE_Text_Input( |
|
| 1763 | - array( |
|
| 1764 | - 'default' => 1, |
|
| 1765 | - 'required' => true, |
|
| 1766 | - 'html_label_text' => esc_html__('Payment or Refund', 'event_espresso'), |
|
| 1767 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1768 | - ) |
|
| 1769 | - ), |
|
| 1770 | - 'amount' => new EE_Text_Input( |
|
| 1771 | - array( |
|
| 1772 | - 'default' => 0, |
|
| 1773 | - 'required' => true, |
|
| 1774 | - 'html_label_text' => esc_html__('Payment amount', 'event_espresso'), |
|
| 1775 | - 'validation_strategies' => array(new EE_Float_Normalization()), |
|
| 1776 | - ) |
|
| 1777 | - ), |
|
| 1778 | - 'status' => new EE_Text_Input( |
|
| 1779 | - array( |
|
| 1780 | - 'default' => EEM_Payment::status_id_approved, |
|
| 1781 | - 'required' => true, |
|
| 1782 | - 'html_label_text' => esc_html__('Payment status', 'event_espresso'), |
|
| 1783 | - ) |
|
| 1784 | - ), |
|
| 1785 | - 'PMD_ID' => new EE_Text_Input( |
|
| 1786 | - array( |
|
| 1787 | - 'default' => 2, |
|
| 1788 | - 'required' => true, |
|
| 1789 | - 'html_label_text' => esc_html__('Payment Method', 'event_espresso'), |
|
| 1790 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1791 | - ) |
|
| 1792 | - ), |
|
| 1793 | - 'date' => new EE_Text_Input( |
|
| 1794 | - array( |
|
| 1795 | - 'default' => time(), |
|
| 1796 | - 'required' => true, |
|
| 1797 | - 'html_label_text' => esc_html__('Payment date', 'event_espresso'), |
|
| 1798 | - ) |
|
| 1799 | - ), |
|
| 1800 | - 'txn_id_chq_nmbr' => new EE_Text_Input( |
|
| 1801 | - array( |
|
| 1802 | - 'default' => '', |
|
| 1803 | - 'required' => false, |
|
| 1804 | - 'html_label_text' => esc_html__('Transaction or Cheque Number', 'event_espresso'), |
|
| 1805 | - 'validation_strategies' => array( |
|
| 1806 | - new EE_Max_Length_Validation_Strategy( |
|
| 1807 | - esc_html__('Input too long', 'event_espresso'), |
|
| 1808 | - 100 |
|
| 1809 | - ), |
|
| 1810 | - ), |
|
| 1811 | - ) |
|
| 1812 | - ), |
|
| 1813 | - 'po_number' => new EE_Text_Input( |
|
| 1814 | - array( |
|
| 1815 | - 'default' => '', |
|
| 1816 | - 'required' => false, |
|
| 1817 | - 'html_label_text' => esc_html__('Purchase Order Number', 'event_espresso'), |
|
| 1818 | - 'validation_strategies' => array( |
|
| 1819 | - new EE_Max_Length_Validation_Strategy( |
|
| 1820 | - esc_html__('Input too long', 'event_espresso'), |
|
| 1821 | - 100 |
|
| 1822 | - ), |
|
| 1823 | - ), |
|
| 1824 | - ) |
|
| 1825 | - ), |
|
| 1826 | - 'accounting' => new EE_Text_Input( |
|
| 1827 | - array( |
|
| 1828 | - 'default' => '', |
|
| 1829 | - 'required' => false, |
|
| 1830 | - 'html_label_text' => esc_html__('Extra Field for Accounting', 'event_espresso'), |
|
| 1831 | - 'validation_strategies' => array( |
|
| 1832 | - new EE_Max_Length_Validation_Strategy( |
|
| 1833 | - esc_html__('Input too long', 'event_espresso'), |
|
| 1834 | - 100 |
|
| 1835 | - ), |
|
| 1836 | - ), |
|
| 1837 | - ) |
|
| 1838 | - ), |
|
| 1839 | - ), |
|
| 1840 | - ) |
|
| 1841 | - ); |
|
| 1842 | - } |
|
| 1843 | - |
|
| 1844 | - |
|
| 1845 | - /** |
|
| 1846 | - * _create_payment_from_request_data |
|
| 1847 | - * |
|
| 1848 | - * @param array $valid_data |
|
| 1849 | - * @return EE_Payment |
|
| 1850 | - * @throws EE_Error |
|
| 1851 | - * @throws InvalidArgumentException |
|
| 1852 | - * @throws InvalidDataTypeException |
|
| 1853 | - * @throws InvalidInterfaceException |
|
| 1854 | - * @throws ReflectionException |
|
| 1855 | - */ |
|
| 1856 | - protected function _create_payment_from_request_data($valid_data) |
|
| 1857 | - { |
|
| 1858 | - $PAY_ID = $valid_data['PAY_ID']; |
|
| 1859 | - // get payment amount |
|
| 1860 | - $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0; |
|
| 1861 | - // payments have a type value of 1 and refunds have a type value of -1 |
|
| 1862 | - // so multiplying amount by type will give a positive value for payments, and negative values for refunds |
|
| 1863 | - $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount; |
|
| 1864 | - // for some reason the date string coming in has extra spaces between the date and time. This fixes that. |
|
| 1865 | - $date = $valid_data['date'] |
|
| 1866 | - ? preg_replace('/\s+/', ' ', $valid_data['date']) |
|
| 1867 | - : date('Y-m-d g:i a', current_time('timestamp')); |
|
| 1868 | - $payment = EE_Payment::new_instance( |
|
| 1869 | - array( |
|
| 1870 | - 'TXN_ID' => $valid_data['TXN_ID'], |
|
| 1871 | - 'STS_ID' => $valid_data['status'], |
|
| 1872 | - 'PAY_timestamp' => $date, |
|
| 1873 | - 'PAY_source' => EEM_Payment_Method::scope_admin, |
|
| 1874 | - 'PMD_ID' => $valid_data['PMD_ID'], |
|
| 1875 | - 'PAY_amount' => $amount, |
|
| 1876 | - 'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'], |
|
| 1877 | - 'PAY_po_number' => $valid_data['po_number'], |
|
| 1878 | - 'PAY_extra_accntng' => $valid_data['accounting'], |
|
| 1879 | - 'PAY_details' => $valid_data, |
|
| 1880 | - 'PAY_ID' => $PAY_ID, |
|
| 1881 | - ), |
|
| 1882 | - '', |
|
| 1883 | - array('Y-m-d', 'g:i a') |
|
| 1884 | - ); |
|
| 1885 | - |
|
| 1886 | - if (! $payment->save()) { |
|
| 1887 | - EE_Error::add_error( |
|
| 1888 | - sprintf( |
|
| 1889 | - esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'), |
|
| 1890 | - $payment->ID() |
|
| 1891 | - ), |
|
| 1892 | - __FILE__, |
|
| 1893 | - __FUNCTION__, |
|
| 1894 | - __LINE__ |
|
| 1895 | - ); |
|
| 1896 | - } |
|
| 1897 | - |
|
| 1898 | - return $payment; |
|
| 1899 | - } |
|
| 1900 | - |
|
| 1901 | - |
|
| 1902 | - /** |
|
| 1903 | - * _process_transaction_payments |
|
| 1904 | - * |
|
| 1905 | - * @param \EE_Transaction $transaction |
|
| 1906 | - * @return void |
|
| 1907 | - * @throws EE_Error |
|
| 1908 | - * @throws InvalidArgumentException |
|
| 1909 | - * @throws ReflectionException |
|
| 1910 | - * @throws InvalidDataTypeException |
|
| 1911 | - * @throws InvalidInterfaceException |
|
| 1912 | - */ |
|
| 1913 | - protected function _process_transaction_payments(EE_Transaction $transaction) |
|
| 1914 | - { |
|
| 1915 | - /** @type EE_Transaction_Payments $transaction_payments */ |
|
| 1916 | - $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
| 1917 | - // update the transaction with this payment |
|
| 1918 | - if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) { |
|
| 1919 | - EE_Error::add_success( |
|
| 1920 | - esc_html__( |
|
| 1921 | - 'The payment has been processed successfully.', |
|
| 1922 | - 'event_espresso' |
|
| 1923 | - ), |
|
| 1924 | - __FILE__, |
|
| 1925 | - __FUNCTION__, |
|
| 1926 | - __LINE__ |
|
| 1927 | - ); |
|
| 1928 | - } else { |
|
| 1929 | - EE_Error::add_error( |
|
| 1930 | - esc_html__( |
|
| 1931 | - 'The payment was processed successfully but the amount paid for the transaction was not updated.', |
|
| 1932 | - 'event_espresso' |
|
| 1933 | - ), |
|
| 1934 | - __FILE__, |
|
| 1935 | - __FUNCTION__, |
|
| 1936 | - __LINE__ |
|
| 1937 | - ); |
|
| 1938 | - } |
|
| 1939 | - } |
|
| 1940 | - |
|
| 1941 | - |
|
| 1942 | - /** |
|
| 1943 | - * _get_REG_IDs_to_apply_payment_to |
|
| 1944 | - * returns a list of registration IDs that the payment will apply to |
|
| 1945 | - * |
|
| 1946 | - * @param \EE_Payment $payment |
|
| 1947 | - * @return array |
|
| 1948 | - * @throws EE_Error |
|
| 1949 | - * @throws InvalidArgumentException |
|
| 1950 | - * @throws InvalidDataTypeException |
|
| 1951 | - * @throws InvalidInterfaceException |
|
| 1952 | - * @throws ReflectionException |
|
| 1953 | - */ |
|
| 1954 | - protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment) |
|
| 1955 | - { |
|
| 1956 | - $REG_IDs = array(); |
|
| 1957 | - // grab array of IDs for specific registrations to apply changes to |
|
| 1958 | - if (isset($this->_req_data['txn_admin_payment']['registrations'])) { |
|
| 1959 | - $REG_IDs = (array) $this->_req_data['txn_admin_payment']['registrations']; |
|
| 1960 | - } |
|
| 1961 | - // nothing specified ? then get all reg IDs |
|
| 1962 | - if (empty($REG_IDs)) { |
|
| 1963 | - $registrations = $payment->transaction()->registrations(); |
|
| 1964 | - $REG_IDs = ! empty($registrations) |
|
| 1965 | - ? array_keys($registrations) |
|
| 1966 | - : $this->_get_existing_reg_payment_REG_IDs($payment); |
|
| 1967 | - } |
|
| 1968 | - |
|
| 1969 | - // ensure that REG_IDs are integers and NOT strings |
|
| 1970 | - return array_map('intval', $REG_IDs); |
|
| 1971 | - } |
|
| 1972 | - |
|
| 1973 | - |
|
| 1974 | - /** |
|
| 1975 | - * @return array |
|
| 1976 | - */ |
|
| 1977 | - public function existing_reg_payment_REG_IDs() |
|
| 1978 | - { |
|
| 1979 | - return $this->_existing_reg_payment_REG_IDs; |
|
| 1980 | - } |
|
| 1981 | - |
|
| 1982 | - |
|
| 1983 | - /** |
|
| 1984 | - * @param array $existing_reg_payment_REG_IDs |
|
| 1985 | - */ |
|
| 1986 | - public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null) |
|
| 1987 | - { |
|
| 1988 | - $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs; |
|
| 1989 | - } |
|
| 1990 | - |
|
| 1991 | - |
|
| 1992 | - /** |
|
| 1993 | - * _get_existing_reg_payment_REG_IDs |
|
| 1994 | - * returns a list of registration IDs that the payment is currently related to |
|
| 1995 | - * as recorded in the database |
|
| 1996 | - * |
|
| 1997 | - * @param \EE_Payment $payment |
|
| 1998 | - * @return array |
|
| 1999 | - * @throws EE_Error |
|
| 2000 | - * @throws InvalidArgumentException |
|
| 2001 | - * @throws InvalidDataTypeException |
|
| 2002 | - * @throws InvalidInterfaceException |
|
| 2003 | - * @throws ReflectionException |
|
| 2004 | - */ |
|
| 2005 | - protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment) |
|
| 2006 | - { |
|
| 2007 | - if ($this->existing_reg_payment_REG_IDs() === null) { |
|
| 2008 | - // let's get any existing reg payment records for this payment |
|
| 2009 | - $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration'); |
|
| 2010 | - // but we only want the REG IDs, so grab the array keys |
|
| 2011 | - $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs) |
|
| 2012 | - ? array_keys($existing_reg_payment_REG_IDs) |
|
| 2013 | - : array(); |
|
| 2014 | - $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs); |
|
| 2015 | - } |
|
| 2016 | - |
|
| 2017 | - return $this->existing_reg_payment_REG_IDs(); |
|
| 2018 | - } |
|
| 2019 | - |
|
| 2020 | - |
|
| 2021 | - /** |
|
| 2022 | - * _remove_existing_registration_payments |
|
| 2023 | - * this calculates the difference between existing relations |
|
| 2024 | - * to the supplied payment and the new list registration IDs, |
|
| 2025 | - * removes any related registrations that no longer apply, |
|
| 2026 | - * and then updates the registration paid fields |
|
| 2027 | - * |
|
| 2028 | - * @param \EE_Payment $payment |
|
| 2029 | - * @param int $PAY_ID |
|
| 2030 | - * @return bool; |
|
| 2031 | - * @throws EE_Error |
|
| 2032 | - * @throws InvalidArgumentException |
|
| 2033 | - * @throws ReflectionException |
|
| 2034 | - * @throws InvalidDataTypeException |
|
| 2035 | - * @throws InvalidInterfaceException |
|
| 2036 | - */ |
|
| 2037 | - protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0) |
|
| 2038 | - { |
|
| 2039 | - // newly created payments will have nothing recorded for $PAY_ID |
|
| 2040 | - if (absint($PAY_ID) === 0) { |
|
| 2041 | - return false; |
|
| 2042 | - } |
|
| 2043 | - $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
| 2044 | - if (empty($existing_reg_payment_REG_IDs)) { |
|
| 2045 | - return false; |
|
| 2046 | - } |
|
| 2047 | - /** @type EE_Transaction_Payments $transaction_payments */ |
|
| 2048 | - $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
| 2049 | - |
|
| 2050 | - return $transaction_payments->delete_registration_payments_and_update_registrations( |
|
| 2051 | - $payment, |
|
| 2052 | - array( |
|
| 2053 | - array( |
|
| 2054 | - 'PAY_ID' => $payment->ID(), |
|
| 2055 | - 'REG_ID' => array('IN', $existing_reg_payment_REG_IDs), |
|
| 2056 | - ), |
|
| 2057 | - ) |
|
| 2058 | - ); |
|
| 2059 | - } |
|
| 2060 | - |
|
| 2061 | - |
|
| 2062 | - /** |
|
| 2063 | - * _update_registration_payments |
|
| 2064 | - * this applies the payments to the selected registrations |
|
| 2065 | - * but only if they have not already been paid for |
|
| 2066 | - * |
|
| 2067 | - * @param EE_Transaction $transaction |
|
| 2068 | - * @param \EE_Payment $payment |
|
| 2069 | - * @param array $REG_IDs |
|
| 2070 | - * @return void |
|
| 2071 | - * @throws EE_Error |
|
| 2072 | - * @throws InvalidArgumentException |
|
| 2073 | - * @throws ReflectionException |
|
| 2074 | - * @throws RuntimeException |
|
| 2075 | - * @throws InvalidDataTypeException |
|
| 2076 | - * @throws InvalidInterfaceException |
|
| 2077 | - */ |
|
| 2078 | - protected function _update_registration_payments( |
|
| 2079 | - EE_Transaction $transaction, |
|
| 2080 | - EE_Payment $payment, |
|
| 2081 | - $REG_IDs = array() |
|
| 2082 | - ) { |
|
| 2083 | - // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments() |
|
| 2084 | - // so let's do that using our set of REG_IDs from the form |
|
| 2085 | - $registration_query_where_params = array( |
|
| 2086 | - 'REG_ID' => array('IN', $REG_IDs), |
|
| 2087 | - ); |
|
| 2088 | - // but add in some conditions regarding payment, |
|
| 2089 | - // so that we don't apply payments to registrations that are free or have already been paid for |
|
| 2090 | - // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative ) |
|
| 2091 | - if (! $payment->is_a_refund()) { |
|
| 2092 | - $registration_query_where_params['REG_final_price'] = array('!=', 0); |
|
| 2093 | - $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true); |
|
| 2094 | - } |
|
| 2095 | - $registrations = $transaction->registrations(array($registration_query_where_params)); |
|
| 2096 | - if (! empty($registrations)) { |
|
| 2097 | - /** @type EE_Payment_Processor $payment_processor */ |
|
| 2098 | - $payment_processor = EE_Registry::instance()->load_core('Payment_Processor'); |
|
| 2099 | - $payment_processor->process_registration_payments($transaction, $payment, $registrations); |
|
| 2100 | - } |
|
| 2101 | - } |
|
| 2102 | - |
|
| 2103 | - |
|
| 2104 | - /** |
|
| 2105 | - * _process_registration_status_change |
|
| 2106 | - * This processes requested registration status changes for all the registrations |
|
| 2107 | - * on a given transaction and (optionally) sends out notifications for the changes. |
|
| 2108 | - * |
|
| 2109 | - * @param EE_Transaction $transaction |
|
| 2110 | - * @param array $REG_IDs |
|
| 2111 | - * @return bool |
|
| 2112 | - * @throws EE_Error |
|
| 2113 | - * @throws InvalidArgumentException |
|
| 2114 | - * @throws ReflectionException |
|
| 2115 | - * @throws InvalidDataTypeException |
|
| 2116 | - * @throws InvalidInterfaceException |
|
| 2117 | - */ |
|
| 2118 | - protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array()) |
|
| 2119 | - { |
|
| 2120 | - // first if there is no change in status then we get out. |
|
| 2121 | - if (! isset($this->_req_data['txn_reg_status_change']['reg_status']) |
|
| 2122 | - || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN' |
|
| 2123 | - ) { |
|
| 2124 | - // no error message, no change requested, just nothing to do man. |
|
| 2125 | - return false; |
|
| 2126 | - } |
|
| 2127 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 2128 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 2129 | - |
|
| 2130 | - // made it here dude? Oh WOW. K, let's take care of changing the statuses |
|
| 2131 | - return $transaction_processor->manually_update_registration_statuses( |
|
| 2132 | - $transaction, |
|
| 2133 | - sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']), |
|
| 2134 | - array(array('REG_ID' => array('IN', $REG_IDs))) |
|
| 2135 | - ); |
|
| 2136 | - } |
|
| 2137 | - |
|
| 2138 | - |
|
| 2139 | - /** |
|
| 2140 | - * _build_payment_json_response |
|
| 2141 | - * |
|
| 2142 | - * @access public |
|
| 2143 | - * @param \EE_Payment $payment |
|
| 2144 | - * @param array $REG_IDs |
|
| 2145 | - * @param bool | null $delete_txn_reg_status_change |
|
| 2146 | - * @return array |
|
| 2147 | - * @throws EE_Error |
|
| 2148 | - * @throws InvalidArgumentException |
|
| 2149 | - * @throws InvalidDataTypeException |
|
| 2150 | - * @throws InvalidInterfaceException |
|
| 2151 | - * @throws ReflectionException |
|
| 2152 | - */ |
|
| 2153 | - protected function _build_payment_json_response( |
|
| 2154 | - EE_Payment $payment, |
|
| 2155 | - $REG_IDs = array(), |
|
| 2156 | - $delete_txn_reg_status_change = null |
|
| 2157 | - ) { |
|
| 2158 | - // was the payment deleted ? |
|
| 2159 | - if (is_bool($delete_txn_reg_status_change)) { |
|
| 2160 | - return array( |
|
| 2161 | - 'PAY_ID' => $payment->ID(), |
|
| 2162 | - 'amount' => $payment->amount(), |
|
| 2163 | - 'total_paid' => $payment->transaction()->paid(), |
|
| 2164 | - 'txn_status' => $payment->transaction()->status_ID(), |
|
| 2165 | - 'pay_status' => $payment->STS_ID(), |
|
| 2166 | - 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
| 2167 | - 'delete_txn_reg_status_change' => $delete_txn_reg_status_change, |
|
| 2168 | - ); |
|
| 2169 | - } else { |
|
| 2170 | - $this->_get_payment_status_array(); |
|
| 2171 | - |
|
| 2172 | - return array( |
|
| 2173 | - 'amount' => $payment->amount(), |
|
| 2174 | - 'total_paid' => $payment->transaction()->paid(), |
|
| 2175 | - 'txn_status' => $payment->transaction()->status_ID(), |
|
| 2176 | - 'pay_status' => $payment->STS_ID(), |
|
| 2177 | - 'PAY_ID' => $payment->ID(), |
|
| 2178 | - 'STS_ID' => $payment->STS_ID(), |
|
| 2179 | - 'status' => self::$_pay_status[ $payment->STS_ID() ], |
|
| 2180 | - 'date' => $payment->timestamp('Y-m-d', 'h:i a'), |
|
| 2181 | - 'method' => strtoupper($payment->source()), |
|
| 2182 | - 'PM_ID' => $payment->payment_method() ? $payment->payment_method()->ID() : 1, |
|
| 2183 | - 'gateway' => $payment->payment_method() |
|
| 2184 | - ? $payment->payment_method()->admin_name() |
|
| 2185 | - : esc_html__('Unknown', 'event_espresso'), |
|
| 2186 | - 'gateway_response' => $payment->gateway_response(), |
|
| 2187 | - 'txn_id_chq_nmbr' => $payment->txn_id_chq_nmbr(), |
|
| 2188 | - 'po_number' => $payment->po_number(), |
|
| 2189 | - 'extra_accntng' => $payment->extra_accntng(), |
|
| 2190 | - 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
| 2191 | - ); |
|
| 2192 | - } |
|
| 2193 | - } |
|
| 2194 | - |
|
| 2195 | - |
|
| 2196 | - /** |
|
| 2197 | - * delete_payment |
|
| 2198 | - * delete a payment or refund made towards a transaction |
|
| 2199 | - * |
|
| 2200 | - * @access public |
|
| 2201 | - * @return void |
|
| 2202 | - * @throws EE_Error |
|
| 2203 | - * @throws InvalidArgumentException |
|
| 2204 | - * @throws ReflectionException |
|
| 2205 | - * @throws InvalidDataTypeException |
|
| 2206 | - * @throws InvalidInterfaceException |
|
| 2207 | - */ |
|
| 2208 | - public function delete_payment() |
|
| 2209 | - { |
|
| 2210 | - $json_response_data = array('return_data' => false); |
|
| 2211 | - $PAY_ID = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
| 2212 | - ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
| 2213 | - : 0; |
|
| 2214 | - $can_delete = EE_Registry::instance()->CAP->current_user_can( |
|
| 2215 | - 'ee_delete_payments', |
|
| 2216 | - 'delete_payment_from_registration_details' |
|
| 2217 | - ); |
|
| 2218 | - if ($PAY_ID && $can_delete) { |
|
| 2219 | - $delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change']) |
|
| 2220 | - ? $this->_req_data['delete_txn_reg_status_change'] |
|
| 2221 | - : false; |
|
| 2222 | - $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID); |
|
| 2223 | - if ($payment instanceof EE_Payment) { |
|
| 2224 | - $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
| 2225 | - /** @type EE_Transaction_Payments $transaction_payments */ |
|
| 2226 | - $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
| 2227 | - if ($transaction_payments->delete_payment_and_update_transaction($payment)) { |
|
| 2228 | - $json_response_data['return_data'] = $this->_build_payment_json_response( |
|
| 2229 | - $payment, |
|
| 2230 | - $REG_IDs, |
|
| 2231 | - $delete_txn_reg_status_change |
|
| 2232 | - ); |
|
| 2233 | - if ($delete_txn_reg_status_change) { |
|
| 2234 | - $this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
| 2235 | - // MAKE sure we also add the delete_txn_req_status_change to the |
|
| 2236 | - // $_REQUEST global because that's how messages will be looking for it. |
|
| 2237 | - $_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
| 2238 | - $this->_maybe_send_notifications(); |
|
| 2239 | - $this->_process_registration_status_change($payment->transaction(), $REG_IDs); |
|
| 2240 | - } |
|
| 2241 | - } |
|
| 2242 | - } else { |
|
| 2243 | - EE_Error::add_error( |
|
| 2244 | - esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'), |
|
| 2245 | - __FILE__, |
|
| 2246 | - __FUNCTION__, |
|
| 2247 | - __LINE__ |
|
| 2248 | - ); |
|
| 2249 | - } |
|
| 2250 | - } elseif ($can_delete) { |
|
| 2251 | - EE_Error::add_error( |
|
| 2252 | - esc_html__( |
|
| 2253 | - 'A valid Payment ID was not received, therefore payment form data could not be loaded.', |
|
| 2254 | - 'event_espresso' |
|
| 2255 | - ), |
|
| 2256 | - __FILE__, |
|
| 2257 | - __FUNCTION__, |
|
| 2258 | - __LINE__ |
|
| 2259 | - ); |
|
| 2260 | - } else { |
|
| 2261 | - EE_Error::add_error( |
|
| 2262 | - esc_html__( |
|
| 2263 | - 'You do not have access to delete a payment.', |
|
| 2264 | - 'event_espresso' |
|
| 2265 | - ), |
|
| 2266 | - __FILE__, |
|
| 2267 | - __FUNCTION__, |
|
| 2268 | - __LINE__ |
|
| 2269 | - ); |
|
| 2270 | - } |
|
| 2271 | - $notices = EE_Error::get_notices(false, false, false); |
|
| 2272 | - $this->_template_args = array( |
|
| 2273 | - 'data' => $json_response_data, |
|
| 2274 | - 'success' => $notices['success'], |
|
| 2275 | - 'error' => $notices['errors'], |
|
| 2276 | - 'attention' => $notices['attention'], |
|
| 2277 | - ); |
|
| 2278 | - $this->_return_json(); |
|
| 2279 | - } |
|
| 2280 | - |
|
| 2281 | - |
|
| 2282 | - /** |
|
| 2283 | - * _registration_payment_data_array |
|
| 2284 | - * adds info for 'owing' and 'paid' for each registration to the json response |
|
| 2285 | - * |
|
| 2286 | - * @access protected |
|
| 2287 | - * @param array $REG_IDs |
|
| 2288 | - * @return array |
|
| 2289 | - * @throws EE_Error |
|
| 2290 | - * @throws InvalidArgumentException |
|
| 2291 | - * @throws InvalidDataTypeException |
|
| 2292 | - * @throws InvalidInterfaceException |
|
| 2293 | - * @throws ReflectionException |
|
| 2294 | - */ |
|
| 2295 | - protected function _registration_payment_data_array($REG_IDs) |
|
| 2296 | - { |
|
| 2297 | - $registration_payment_data = array(); |
|
| 2298 | - // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows. |
|
| 2299 | - if (! empty($REG_IDs)) { |
|
| 2300 | - $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs)))); |
|
| 2301 | - foreach ($registrations as $registration) { |
|
| 2302 | - if ($registration instanceof EE_Registration) { |
|
| 2303 | - $registration_payment_data[ $registration->ID() ] = array( |
|
| 2304 | - 'paid' => $registration->pretty_paid(), |
|
| 2305 | - 'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()), |
|
| 2306 | - ); |
|
| 2307 | - } |
|
| 2308 | - } |
|
| 2309 | - } |
|
| 2310 | - |
|
| 2311 | - return $registration_payment_data; |
|
| 2312 | - } |
|
| 2313 | - |
|
| 2314 | - |
|
| 2315 | - /** |
|
| 2316 | - * _maybe_send_notifications |
|
| 2317 | - * determines whether or not the admin has indicated that notifications should be sent. |
|
| 2318 | - * If so, will toggle a filter switch for delivering registration notices. |
|
| 2319 | - * If passed an EE_Payment object, then it will trigger payment notifications instead. |
|
| 2320 | - * |
|
| 2321 | - * @access protected |
|
| 2322 | - * @param \EE_Payment | null $payment |
|
| 2323 | - */ |
|
| 2324 | - protected function _maybe_send_notifications($payment = null) |
|
| 2325 | - { |
|
| 2326 | - switch ($payment instanceof EE_Payment) { |
|
| 2327 | - // payment notifications |
|
| 2328 | - case true: |
|
| 2329 | - if (isset($this->_req_data['txn_payments']['send_notifications']) |
|
| 2330 | - && filter_var( |
|
| 2331 | - $this->_req_data['txn_payments']['send_notifications'], |
|
| 2332 | - FILTER_VALIDATE_BOOLEAN |
|
| 2333 | - ) |
|
| 2334 | - ) { |
|
| 2335 | - $this->_process_payment_notification($payment); |
|
| 2336 | - } |
|
| 2337 | - break; |
|
| 2338 | - // registration notifications |
|
| 2339 | - case false: |
|
| 2340 | - if (isset($this->_req_data['txn_reg_status_change']['send_notifications']) |
|
| 2341 | - && filter_var( |
|
| 2342 | - $this->_req_data['txn_reg_status_change']['send_notifications'], |
|
| 2343 | - FILTER_VALIDATE_BOOLEAN |
|
| 2344 | - ) |
|
| 2345 | - ) { |
|
| 2346 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true'); |
|
| 2347 | - } |
|
| 2348 | - break; |
|
| 2349 | - } |
|
| 2350 | - } |
|
| 2351 | - |
|
| 2352 | - |
|
| 2353 | - /** |
|
| 2354 | - * _send_payment_reminder |
|
| 2355 | - * generates HTML for the View Transaction Details Admin page |
|
| 2356 | - * |
|
| 2357 | - * @access protected |
|
| 2358 | - * @return void |
|
| 2359 | - * @throws EE_Error |
|
| 2360 | - * @throws InvalidArgumentException |
|
| 2361 | - * @throws InvalidDataTypeException |
|
| 2362 | - * @throws InvalidInterfaceException |
|
| 2363 | - */ |
|
| 2364 | - protected function _send_payment_reminder() |
|
| 2365 | - { |
|
| 2366 | - $TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false; |
|
| 2367 | - $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
| 2368 | - $query_args = isset($this->_req_data['redirect_to']) ? array( |
|
| 2369 | - 'action' => $this->_req_data['redirect_to'], |
|
| 2370 | - 'TXN_ID' => $this->_req_data['TXN_ID'], |
|
| 2371 | - ) : array(); |
|
| 2372 | - do_action( |
|
| 2373 | - 'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder', |
|
| 2374 | - $transaction |
|
| 2375 | - ); |
|
| 2376 | - $this->_redirect_after_action( |
|
| 2377 | - false, |
|
| 2378 | - esc_html__('payment reminder', 'event_espresso'), |
|
| 2379 | - esc_html__('sent', 'event_espresso'), |
|
| 2380 | - $query_args, |
|
| 2381 | - true |
|
| 2382 | - ); |
|
| 2383 | - } |
|
| 2384 | - |
|
| 2385 | - |
|
| 2386 | - /** |
|
| 2387 | - * get_transactions |
|
| 2388 | - * get transactions for given parameters (used by list table) |
|
| 2389 | - * |
|
| 2390 | - * @param int $perpage how many transactions displayed per page |
|
| 2391 | - * @param boolean $count return the count or objects |
|
| 2392 | - * @param string $view |
|
| 2393 | - * @return mixed int = count || array of transaction objects |
|
| 2394 | - * @throws EE_Error |
|
| 2395 | - * @throws InvalidArgumentException |
|
| 2396 | - * @throws InvalidDataTypeException |
|
| 2397 | - * @throws InvalidInterfaceException |
|
| 2398 | - */ |
|
| 2399 | - public function get_transactions($perpage, $count = false, $view = '') |
|
| 2400 | - { |
|
| 2401 | - |
|
| 2402 | - $TXN = EEM_Transaction::instance(); |
|
| 2403 | - |
|
| 2404 | - $start_date = isset($this->_req_data['txn-filter-start-date']) |
|
| 2405 | - ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) |
|
| 2406 | - : date( |
|
| 2407 | - 'm/d/Y', |
|
| 2408 | - strtotime('-10 year') |
|
| 2409 | - ); |
|
| 2410 | - $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
| 2411 | - ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) |
|
| 2412 | - : date('m/d/Y'); |
|
| 2413 | - |
|
| 2414 | - // make sure our timestamps start and end right at the boundaries for each day |
|
| 2415 | - $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
| 2416 | - $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
| 2417 | - |
|
| 2418 | - |
|
| 2419 | - // convert to timestamps |
|
| 2420 | - $start_date = strtotime($start_date); |
|
| 2421 | - $end_date = strtotime($end_date); |
|
| 2422 | - |
|
| 2423 | - // makes sure start date is the lowest value and vice versa |
|
| 2424 | - $start_date = min($start_date, $end_date); |
|
| 2425 | - $end_date = max($start_date, $end_date); |
|
| 2426 | - |
|
| 2427 | - // convert to correct format for query |
|
| 2428 | - $start_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
| 2429 | - 'TXN_timestamp', |
|
| 2430 | - date('Y-m-d H:i:s', $start_date), |
|
| 2431 | - 'Y-m-d H:i:s' |
|
| 2432 | - ); |
|
| 2433 | - $end_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
| 2434 | - 'TXN_timestamp', |
|
| 2435 | - date('Y-m-d H:i:s', $end_date), |
|
| 2436 | - 'Y-m-d H:i:s' |
|
| 2437 | - ); |
|
| 2438 | - |
|
| 2439 | - |
|
| 2440 | - // set orderby |
|
| 2441 | - $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
| 2442 | - |
|
| 2443 | - switch ($this->_req_data['orderby']) { |
|
| 2444 | - case 'TXN_ID': |
|
| 2445 | - $orderby = 'TXN_ID'; |
|
| 2446 | - break; |
|
| 2447 | - case 'ATT_fname': |
|
| 2448 | - $orderby = 'Registration.Attendee.ATT_fname'; |
|
| 2449 | - break; |
|
| 2450 | - case 'event_name': |
|
| 2451 | - $orderby = 'Registration.Event.EVT_name'; |
|
| 2452 | - break; |
|
| 2453 | - default: // 'TXN_timestamp' |
|
| 2454 | - $orderby = 'TXN_timestamp'; |
|
| 2455 | - } |
|
| 2456 | - |
|
| 2457 | - $sort = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC'; |
|
| 2458 | - $current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1; |
|
| 2459 | - $per_page = ! empty($perpage) ? $perpage : 10; |
|
| 2460 | - $per_page = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page; |
|
| 2461 | - |
|
| 2462 | - $offset = ($current_page - 1) * $per_page; |
|
| 2463 | - $limit = array($offset, $per_page); |
|
| 2464 | - |
|
| 2465 | - $_where = array( |
|
| 2466 | - 'TXN_timestamp' => array('BETWEEN', array($start_date, $end_date)), |
|
| 2467 | - 'Registration.REG_count' => 1, |
|
| 2468 | - ); |
|
| 2469 | - |
|
| 2470 | - if (isset($this->_req_data['EVT_ID'])) { |
|
| 2471 | - $_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID']; |
|
| 2472 | - } |
|
| 2473 | - |
|
| 2474 | - if (isset($this->_req_data['s'])) { |
|
| 2475 | - $search_string = '%' . $this->_req_data['s'] . '%'; |
|
| 2476 | - $_where['OR'] = array( |
|
| 2477 | - 'Registration.Event.EVT_name' => array('LIKE', $search_string), |
|
| 2478 | - 'Registration.Event.EVT_desc' => array('LIKE', $search_string), |
|
| 2479 | - 'Registration.Event.EVT_short_desc' => array('LIKE', $search_string), |
|
| 2480 | - 'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
| 2481 | - 'Registration.Attendee.ATT_fname' => array('LIKE', $search_string), |
|
| 2482 | - 'Registration.Attendee.ATT_lname' => array('LIKE', $search_string), |
|
| 2483 | - 'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
| 2484 | - 'Registration.Attendee.ATT_email' => array('LIKE', $search_string), |
|
| 2485 | - 'Registration.Attendee.ATT_address' => array('LIKE', $search_string), |
|
| 2486 | - 'Registration.Attendee.ATT_address2' => array('LIKE', $search_string), |
|
| 2487 | - 'Registration.Attendee.ATT_city' => array('LIKE', $search_string), |
|
| 2488 | - 'Registration.REG_final_price' => array('LIKE', $search_string), |
|
| 2489 | - 'Registration.REG_code' => array('LIKE', $search_string), |
|
| 2490 | - 'Registration.REG_count' => array('LIKE', $search_string), |
|
| 2491 | - 'Registration.REG_group_size' => array('LIKE', $search_string), |
|
| 2492 | - 'Registration.Ticket.TKT_name' => array('LIKE', $search_string), |
|
| 2493 | - 'Registration.Ticket.TKT_description' => array('LIKE', $search_string), |
|
| 2494 | - 'Payment.PAY_source' => array('LIKE', $search_string), |
|
| 2495 | - 'Payment.Payment_Method.PMD_name' => array('LIKE', $search_string), |
|
| 2496 | - 'TXN_session_data' => array('LIKE', $search_string), |
|
| 2497 | - 'Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
| 2498 | - ); |
|
| 2499 | - } |
|
| 2500 | - |
|
| 2501 | - // failed transactions |
|
| 2502 | - $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
| 2503 | - || ($count && $view === 'failed'); |
|
| 2504 | - $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
| 2505 | - || ($count && $view === 'abandoned'); |
|
| 2506 | - $incomplete = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'incomplete' && ! $count) |
|
| 2507 | - || ($count && $view === 'incomplete'); |
|
| 2508 | - |
|
| 2509 | - if ($failed) { |
|
| 2510 | - $_where['STS_ID'] = EEM_Transaction::failed_status_code; |
|
| 2511 | - } elseif ($abandoned) { |
|
| 2512 | - $_where['STS_ID'] = EEM_Transaction::abandoned_status_code; |
|
| 2513 | - } elseif ($incomplete) { |
|
| 2514 | - $_where['STS_ID'] = EEM_Transaction::incomplete_status_code; |
|
| 2515 | - } else { |
|
| 2516 | - $_where['STS_ID'] = array('!=', EEM_Transaction::failed_status_code); |
|
| 2517 | - $_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code); |
|
| 2518 | - } |
|
| 2519 | - |
|
| 2520 | - $query_params = apply_filters( |
|
| 2521 | - 'FHEE__Transactions_Admin_Page___get_transactions_query_params', |
|
| 2522 | - array( |
|
| 2523 | - $_where, |
|
| 2524 | - 'order_by' => array($orderby => $sort), |
|
| 2525 | - 'limit' => $limit, |
|
| 2526 | - 'default_where_conditions' => EEM_Base::default_where_conditions_this_only, |
|
| 2527 | - ), |
|
| 2528 | - $this->_req_data, |
|
| 2529 | - $view, |
|
| 2530 | - $count |
|
| 2531 | - ); |
|
| 2532 | - |
|
| 2533 | - $transactions = $count |
|
| 2534 | - ? $TXN->count(array($query_params[0]), 'TXN_ID', true) |
|
| 2535 | - : $TXN->get_all($query_params); |
|
| 2536 | - |
|
| 2537 | - return $transactions; |
|
| 2538 | - } |
|
| 2539 | - |
|
| 2540 | - |
|
| 2541 | - /** |
|
| 2542 | - * @since $VID:$ |
|
| 2543 | - * @throws EE_Error |
|
| 2544 | - * @throws InvalidArgumentException |
|
| 2545 | - * @throws InvalidDataTypeException |
|
| 2546 | - * @throws InvalidInterfaceException |
|
| 2547 | - * @throws ReflectionException |
|
| 2548 | - * @throws RuntimeException |
|
| 2549 | - */ |
|
| 2550 | - public function recalculateLineItems() |
|
| 2551 | - { |
|
| 2552 | - $TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false; |
|
| 2553 | - /** @var EE_Transaction $transaction */ |
|
| 2554 | - $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
| 2555 | - $total_line_item = $transaction->total_line_item(false); |
|
| 2556 | - $success = false; |
|
| 2557 | - if ($total_line_item instanceof EE_Line_Item) { |
|
| 2558 | - EEH_Line_Item::resetIsTaxableForTickets($total_line_item); |
|
| 2559 | - $success = EEH_Line_Item::apply_taxes($total_line_item, true); |
|
| 2560 | - } |
|
| 2561 | - $this->_redirect_after_action( |
|
| 2562 | - (bool) $success, |
|
| 2563 | - esc_html__('Transaction taxes and totals', 'event_espresso'), |
|
| 2564 | - esc_html__('recalculated', 'event_espresso'), |
|
| 2565 | - isset($this->_req_data['redirect_to']) |
|
| 2566 | - ? array( |
|
| 2567 | - 'action' => $this->_req_data['redirect_to'], |
|
| 2568 | - 'TXN_ID' => $this->_req_data['TXN_ID'], |
|
| 2569 | - ) |
|
| 2570 | - : array(), |
|
| 2571 | - true |
|
| 2572 | - ); |
|
| 2573 | - } |
|
| 16 | + /** |
|
| 17 | + * @var EE_Transaction |
|
| 18 | + */ |
|
| 19 | + private $_transaction; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * @var EE_Session |
|
| 23 | + */ |
|
| 24 | + private $_session; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * @var array $_txn_status |
|
| 28 | + */ |
|
| 29 | + private static $_txn_status; |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * @var array $_pay_status |
|
| 33 | + */ |
|
| 34 | + private static $_pay_status; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var array $_existing_reg_payment_REG_IDs |
|
| 38 | + */ |
|
| 39 | + protected $_existing_reg_payment_REG_IDs; |
|
| 40 | + |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * _init_page_props |
|
| 44 | + * |
|
| 45 | + * @return void |
|
| 46 | + */ |
|
| 47 | + protected function _init_page_props() |
|
| 48 | + { |
|
| 49 | + $this->page_slug = TXN_PG_SLUG; |
|
| 50 | + $this->page_label = esc_html__('Transactions', 'event_espresso'); |
|
| 51 | + $this->_admin_base_url = TXN_ADMIN_URL; |
|
| 52 | + $this->_admin_base_path = TXN_ADMIN; |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * _ajax_hooks |
|
| 58 | + * |
|
| 59 | + * @return void |
|
| 60 | + */ |
|
| 61 | + protected function _ajax_hooks() |
|
| 62 | + { |
|
| 63 | + add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds')); |
|
| 64 | + add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds')); |
|
| 65 | + add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment')); |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * _define_page_props |
|
| 71 | + * |
|
| 72 | + * @return void |
|
| 73 | + */ |
|
| 74 | + protected function _define_page_props() |
|
| 75 | + { |
|
| 76 | + $this->_admin_page_title = $this->page_label; |
|
| 77 | + $this->_labels = array( |
|
| 78 | + 'buttons' => array( |
|
| 79 | + 'add' => esc_html__('Add New Transaction', 'event_espresso'), |
|
| 80 | + 'edit' => esc_html__('Edit Transaction', 'event_espresso'), |
|
| 81 | + 'delete' => esc_html__('Delete Transaction', 'event_espresso'), |
|
| 82 | + ), |
|
| 83 | + ); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * grab url requests and route them |
|
| 89 | + * |
|
| 90 | + * @access private |
|
| 91 | + * @return void |
|
| 92 | + * @throws EE_Error |
|
| 93 | + * @throws InvalidArgumentException |
|
| 94 | + * @throws InvalidDataTypeException |
|
| 95 | + * @throws InvalidInterfaceException |
|
| 96 | + */ |
|
| 97 | + public function _set_page_routes() |
|
| 98 | + { |
|
| 99 | + |
|
| 100 | + $this->_set_transaction_status_array(); |
|
| 101 | + |
|
| 102 | + $txn_id = ! empty($this->_req_data['TXN_ID']) |
|
| 103 | + && ! is_array($this->_req_data['TXN_ID']) |
|
| 104 | + ? $this->_req_data['TXN_ID'] |
|
| 105 | + : 0; |
|
| 106 | + |
|
| 107 | + $this->_page_routes = array( |
|
| 108 | + |
|
| 109 | + 'default' => array( |
|
| 110 | + 'func' => '_transactions_overview_list_table', |
|
| 111 | + 'capability' => 'ee_read_transactions', |
|
| 112 | + ), |
|
| 113 | + |
|
| 114 | + 'view_transaction' => array( |
|
| 115 | + 'func' => '_transaction_details', |
|
| 116 | + 'capability' => 'ee_read_transaction', |
|
| 117 | + 'obj_id' => $txn_id, |
|
| 118 | + ), |
|
| 119 | + |
|
| 120 | + 'send_payment_reminder' => array( |
|
| 121 | + 'func' => '_send_payment_reminder', |
|
| 122 | + 'noheader' => true, |
|
| 123 | + 'capability' => 'ee_send_message', |
|
| 124 | + ), |
|
| 125 | + |
|
| 126 | + 'espresso_apply_payment' => array( |
|
| 127 | + 'func' => 'apply_payments_or_refunds', |
|
| 128 | + 'noheader' => true, |
|
| 129 | + 'capability' => 'ee_edit_payments', |
|
| 130 | + ), |
|
| 131 | + |
|
| 132 | + 'espresso_apply_refund' => array( |
|
| 133 | + 'func' => 'apply_payments_or_refunds', |
|
| 134 | + 'noheader' => true, |
|
| 135 | + 'capability' => 'ee_edit_payments', |
|
| 136 | + ), |
|
| 137 | + |
|
| 138 | + 'espresso_delete_payment' => array( |
|
| 139 | + 'func' => 'delete_payment', |
|
| 140 | + 'noheader' => true, |
|
| 141 | + 'capability' => 'ee_delete_payments', |
|
| 142 | + ), |
|
| 143 | + |
|
| 144 | + 'espresso_recalculate_line_items' => array( |
|
| 145 | + 'func' => 'recalculateLineItems', |
|
| 146 | + 'noheader' => true, |
|
| 147 | + 'capability' => 'ee_edit_payments', |
|
| 148 | + ), |
|
| 149 | + |
|
| 150 | + ); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + |
|
| 154 | + protected function _set_page_config() |
|
| 155 | + { |
|
| 156 | + $this->_page_config = array( |
|
| 157 | + 'default' => array( |
|
| 158 | + 'nav' => array( |
|
| 159 | + 'label' => esc_html__('Overview', 'event_espresso'), |
|
| 160 | + 'order' => 10, |
|
| 161 | + ), |
|
| 162 | + 'list_table' => 'EE_Admin_Transactions_List_Table', |
|
| 163 | + 'help_tabs' => array( |
|
| 164 | + 'transactions_overview_help_tab' => array( |
|
| 165 | + 'title' => esc_html__('Transactions Overview', 'event_espresso'), |
|
| 166 | + 'filename' => 'transactions_overview', |
|
| 167 | + ), |
|
| 168 | + 'transactions_overview_table_column_headings_help_tab' => array( |
|
| 169 | + 'title' => esc_html__('Transactions Table Column Headings', 'event_espresso'), |
|
| 170 | + 'filename' => 'transactions_overview_table_column_headings', |
|
| 171 | + ), |
|
| 172 | + 'transactions_overview_views_filters_help_tab' => array( |
|
| 173 | + 'title' => esc_html__('Transaction Views & Filters & Search', 'event_espresso'), |
|
| 174 | + 'filename' => 'transactions_overview_views_filters_search', |
|
| 175 | + ), |
|
| 176 | + ), |
|
| 177 | + 'help_tour' => array('Transactions_Overview_Help_Tour'), |
|
| 178 | + /** |
|
| 179 | + * commented out because currently we are not displaying tips for transaction list table status but this |
|
| 180 | + * may change in a later iteration so want to keep the code for then. |
|
| 181 | + */ |
|
| 182 | + // 'qtips' => array( 'Transactions_List_Table_Tips' ), |
|
| 183 | + 'require_nonce' => false, |
|
| 184 | + ), |
|
| 185 | + 'view_transaction' => array( |
|
| 186 | + 'nav' => array( |
|
| 187 | + 'label' => esc_html__('View Transaction', 'event_espresso'), |
|
| 188 | + 'order' => 5, |
|
| 189 | + 'url' => isset($this->_req_data['TXN_ID']) |
|
| 190 | + ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url) |
|
| 191 | + : $this->_admin_base_url, |
|
| 192 | + 'persistent' => false, |
|
| 193 | + ), |
|
| 194 | + 'help_tabs' => array( |
|
| 195 | + 'transactions_view_transaction_help_tab' => array( |
|
| 196 | + 'title' => esc_html__('View Transaction', 'event_espresso'), |
|
| 197 | + 'filename' => 'transactions_view_transaction', |
|
| 198 | + ), |
|
| 199 | + 'transactions_view_transaction_transaction_details_table_help_tab' => array( |
|
| 200 | + 'title' => esc_html__('Transaction Details Table', 'event_espresso'), |
|
| 201 | + 'filename' => 'transactions_view_transaction_transaction_details_table', |
|
| 202 | + ), |
|
| 203 | + 'transactions_view_transaction_attendees_registered_help_tab' => array( |
|
| 204 | + 'title' => esc_html__('Attendees Registered', 'event_espresso'), |
|
| 205 | + 'filename' => 'transactions_view_transaction_attendees_registered', |
|
| 206 | + ), |
|
| 207 | + 'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array( |
|
| 208 | + 'title' => esc_html__('Primary Registrant & Billing Information', 'event_espresso'), |
|
| 209 | + 'filename' => 'transactions_view_transaction_primary_registrant_billing_information', |
|
| 210 | + ), |
|
| 211 | + ), |
|
| 212 | + 'qtips' => array('Transaction_Details_Tips'), |
|
| 213 | + 'help_tour' => array('Transaction_Details_Help_Tour'), |
|
| 214 | + 'metaboxes' => array('_transaction_details_metaboxes'), |
|
| 215 | + |
|
| 216 | + 'require_nonce' => false, |
|
| 217 | + ), |
|
| 218 | + ); |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * The below methods aren't used by this class currently |
|
| 224 | + */ |
|
| 225 | + protected function _add_screen_options() |
|
| 226 | + { |
|
| 227 | + // noop |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + |
|
| 231 | + protected function _add_feature_pointers() |
|
| 232 | + { |
|
| 233 | + // noop |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + |
|
| 237 | + public function admin_init() |
|
| 238 | + { |
|
| 239 | + // IF a registration was JUST added via the admin... |
|
| 240 | + if (isset( |
|
| 241 | + $this->_req_data['redirect_from'], |
|
| 242 | + $this->_req_data['EVT_ID'], |
|
| 243 | + $this->_req_data['event_name'] |
|
| 244 | + )) { |
|
| 245 | + // then set a cookie so that we can block any attempts to use |
|
| 246 | + // the back button as a way to enter another registration. |
|
| 247 | + setcookie( |
|
| 248 | + 'ee_registration_added', |
|
| 249 | + $this->_req_data['EVT_ID'], |
|
| 250 | + time() + WEEK_IN_SECONDS, |
|
| 251 | + '/' |
|
| 252 | + ); |
|
| 253 | + // and update the global |
|
| 254 | + $_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID']; |
|
| 255 | + } |
|
| 256 | + EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__( |
|
| 257 | + 'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.', |
|
| 258 | + 'event_espresso' |
|
| 259 | + ); |
|
| 260 | + EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__( |
|
| 261 | + 'An error occurred! Please refresh the page and try again.', |
|
| 262 | + 'event_espresso' |
|
| 263 | + ); |
|
| 264 | + EE_Registry::$i18n_js_strings['txn_status_array'] = self::$_txn_status; |
|
| 265 | + EE_Registry::$i18n_js_strings['pay_status_array'] = self::$_pay_status; |
|
| 266 | + EE_Registry::$i18n_js_strings['payments_total'] = esc_html__('Payments Total', 'event_espresso'); |
|
| 267 | + EE_Registry::$i18n_js_strings['transaction_overpaid'] = esc_html__( |
|
| 268 | + 'This transaction has been overpaid ! Payments Total', |
|
| 269 | + 'event_espresso' |
|
| 270 | + ); |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + |
|
| 274 | + public function admin_notices() |
|
| 275 | + { |
|
| 276 | + // noop |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + |
|
| 280 | + public function admin_footer_scripts() |
|
| 281 | + { |
|
| 282 | + // noop |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + |
|
| 286 | + /** |
|
| 287 | + * _set_transaction_status_array |
|
| 288 | + * sets list of transaction statuses |
|
| 289 | + * |
|
| 290 | + * @access private |
|
| 291 | + * @return void |
|
| 292 | + * @throws EE_Error |
|
| 293 | + * @throws InvalidArgumentException |
|
| 294 | + * @throws InvalidDataTypeException |
|
| 295 | + * @throws InvalidInterfaceException |
|
| 296 | + */ |
|
| 297 | + private function _set_transaction_status_array() |
|
| 298 | + { |
|
| 299 | + self::$_txn_status = EEM_Transaction::instance()->status_array(true); |
|
| 300 | + } |
|
| 301 | + |
|
| 302 | + |
|
| 303 | + /** |
|
| 304 | + * get_transaction_status_array |
|
| 305 | + * return the transaction status array for wp_list_table |
|
| 306 | + * |
|
| 307 | + * @access public |
|
| 308 | + * @return array |
|
| 309 | + */ |
|
| 310 | + public function get_transaction_status_array() |
|
| 311 | + { |
|
| 312 | + return self::$_txn_status; |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + |
|
| 316 | + /** |
|
| 317 | + * get list of payment statuses |
|
| 318 | + * |
|
| 319 | + * @access private |
|
| 320 | + * @return void |
|
| 321 | + * @throws EE_Error |
|
| 322 | + * @throws InvalidArgumentException |
|
| 323 | + * @throws InvalidDataTypeException |
|
| 324 | + * @throws InvalidInterfaceException |
|
| 325 | + */ |
|
| 326 | + private function _get_payment_status_array() |
|
| 327 | + { |
|
| 328 | + self::$_pay_status = EEM_Payment::instance()->status_array(true); |
|
| 329 | + $this->_template_args['payment_status'] = self::$_pay_status; |
|
| 330 | + } |
|
| 331 | + |
|
| 332 | + |
|
| 333 | + /** |
|
| 334 | + * _add_screen_options_default |
|
| 335 | + * |
|
| 336 | + * @access protected |
|
| 337 | + * @return void |
|
| 338 | + * @throws InvalidArgumentException |
|
| 339 | + * @throws InvalidDataTypeException |
|
| 340 | + * @throws InvalidInterfaceException |
|
| 341 | + */ |
|
| 342 | + protected function _add_screen_options_default() |
|
| 343 | + { |
|
| 344 | + $this->_per_page_screen_option(); |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + |
|
| 348 | + /** |
|
| 349 | + * load_scripts_styles |
|
| 350 | + * |
|
| 351 | + * @access public |
|
| 352 | + * @return void |
|
| 353 | + */ |
|
| 354 | + public function load_scripts_styles() |
|
| 355 | + { |
|
| 356 | + // enqueue style |
|
| 357 | + wp_register_style( |
|
| 358 | + 'espresso_txn', |
|
| 359 | + TXN_ASSETS_URL . 'espresso_transactions_admin.css', |
|
| 360 | + array(), |
|
| 361 | + EVENT_ESPRESSO_VERSION |
|
| 362 | + ); |
|
| 363 | + wp_enqueue_style('espresso_txn'); |
|
| 364 | + // scripts |
|
| 365 | + wp_register_script( |
|
| 366 | + 'espresso_txn', |
|
| 367 | + TXN_ASSETS_URL . 'espresso_transactions_admin.js', |
|
| 368 | + array( |
|
| 369 | + 'ee_admin_js', |
|
| 370 | + 'ee-datepicker', |
|
| 371 | + 'jquery-ui-datepicker', |
|
| 372 | + 'jquery-ui-draggable', |
|
| 373 | + 'ee-dialog', |
|
| 374 | + 'ee-accounting', |
|
| 375 | + 'ee-serialize-full-array', |
|
| 376 | + ), |
|
| 377 | + EVENT_ESPRESSO_VERSION, |
|
| 378 | + true |
|
| 379 | + ); |
|
| 380 | + wp_enqueue_script('espresso_txn'); |
|
| 381 | + } |
|
| 382 | + |
|
| 383 | + |
|
| 384 | + /** |
|
| 385 | + * load_scripts_styles_view_transaction |
|
| 386 | + * |
|
| 387 | + * @access public |
|
| 388 | + * @return void |
|
| 389 | + */ |
|
| 390 | + public function load_scripts_styles_view_transaction() |
|
| 391 | + { |
|
| 392 | + // styles |
|
| 393 | + wp_enqueue_style('espresso-ui-theme'); |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + |
|
| 397 | + /** |
|
| 398 | + * load_scripts_styles_default |
|
| 399 | + * |
|
| 400 | + * @access public |
|
| 401 | + * @return void |
|
| 402 | + */ |
|
| 403 | + public function load_scripts_styles_default() |
|
| 404 | + { |
|
| 405 | + // styles |
|
| 406 | + wp_enqueue_style('espresso-ui-theme'); |
|
| 407 | + } |
|
| 408 | + |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * _set_list_table_views_default |
|
| 412 | + * |
|
| 413 | + * @access protected |
|
| 414 | + * @return void |
|
| 415 | + */ |
|
| 416 | + protected function _set_list_table_views_default() |
|
| 417 | + { |
|
| 418 | + $this->_views = array( |
|
| 419 | + 'all' => array( |
|
| 420 | + 'slug' => 'all', |
|
| 421 | + 'label' => esc_html__('View All Transactions', 'event_espresso'), |
|
| 422 | + 'count' => 0, |
|
| 423 | + ), |
|
| 424 | + 'abandoned' => array( |
|
| 425 | + 'slug' => 'abandoned', |
|
| 426 | + 'label' => esc_html__('Abandoned Transactions', 'event_espresso'), |
|
| 427 | + 'count' => 0, |
|
| 428 | + ), |
|
| 429 | + 'incomplete' => array( |
|
| 430 | + 'slug' => 'incomplete', |
|
| 431 | + 'label' => esc_html__('Incomplete Transactions', 'event_espresso'), |
|
| 432 | + 'count' => 0, |
|
| 433 | + ), |
|
| 434 | + ); |
|
| 435 | + if (/** |
|
| 436 | + * Filters whether a link to the "Failed Transactions" list table |
|
| 437 | + * appears on the Transactions Admin Page list table. |
|
| 438 | + * List display can be turned back on via the following: |
|
| 439 | + * add_filter( |
|
| 440 | + * 'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list', |
|
| 441 | + * '__return_true' |
|
| 442 | + * ); |
|
| 443 | + * |
|
| 444 | + * @since 4.9.70.p |
|
| 445 | + * @param boolean $display_failed_txns_list |
|
| 446 | + * @param Transactions_Admin_Page $this |
|
| 447 | + */ |
|
| 448 | + apply_filters( |
|
| 449 | + 'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list', |
|
| 450 | + false, |
|
| 451 | + $this |
|
| 452 | + ) |
|
| 453 | + ) { |
|
| 454 | + $this->_views['failed'] = array( |
|
| 455 | + 'slug' => 'failed', |
|
| 456 | + 'label' => esc_html__('Failed Transactions', 'event_espresso'), |
|
| 457 | + 'count' => 0, |
|
| 458 | + ); |
|
| 459 | + } |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + |
|
| 463 | + /** |
|
| 464 | + * _set_transaction_object |
|
| 465 | + * This sets the _transaction property for the transaction details screen |
|
| 466 | + * |
|
| 467 | + * @access private |
|
| 468 | + * @return void |
|
| 469 | + * @throws EE_Error |
|
| 470 | + * @throws InvalidArgumentException |
|
| 471 | + * @throws RuntimeException |
|
| 472 | + * @throws InvalidDataTypeException |
|
| 473 | + * @throws InvalidInterfaceException |
|
| 474 | + * @throws ReflectionException |
|
| 475 | + */ |
|
| 476 | + private function _set_transaction_object() |
|
| 477 | + { |
|
| 478 | + if ($this->_transaction instanceof EE_Transaction) { |
|
| 479 | + return; |
|
| 480 | + } //get out we've already set the object |
|
| 481 | + |
|
| 482 | + $TXN_ID = ! empty($this->_req_data['TXN_ID']) |
|
| 483 | + ? absint($this->_req_data['TXN_ID']) |
|
| 484 | + : false; |
|
| 485 | + |
|
| 486 | + // get transaction object |
|
| 487 | + $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
| 488 | + $this->_session = $this->_transaction instanceof EE_Transaction |
|
| 489 | + ? $this->_transaction->session_data() |
|
| 490 | + : null; |
|
| 491 | + if ($this->_transaction instanceof EE_Transaction) { |
|
| 492 | + $this->_transaction->verify_abandoned_transaction_status(); |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + if (! $this->_transaction instanceof EE_Transaction) { |
|
| 496 | + $error_msg = sprintf( |
|
| 497 | + esc_html__( |
|
| 498 | + 'An error occurred and the details for the transaction with the ID # %d could not be retrieved.', |
|
| 499 | + 'event_espresso' |
|
| 500 | + ), |
|
| 501 | + $TXN_ID |
|
| 502 | + ); |
|
| 503 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 504 | + } |
|
| 505 | + } |
|
| 506 | + |
|
| 507 | + |
|
| 508 | + /** |
|
| 509 | + * _transaction_legend_items |
|
| 510 | + * |
|
| 511 | + * @access protected |
|
| 512 | + * @return array |
|
| 513 | + * @throws EE_Error |
|
| 514 | + * @throws InvalidArgumentException |
|
| 515 | + * @throws ReflectionException |
|
| 516 | + * @throws InvalidDataTypeException |
|
| 517 | + * @throws InvalidInterfaceException |
|
| 518 | + */ |
|
| 519 | + protected function _transaction_legend_items() |
|
| 520 | + { |
|
| 521 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 522 | + $items = array(); |
|
| 523 | + |
|
| 524 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 525 | + 'ee_read_global_messages', |
|
| 526 | + 'view_filtered_messages' |
|
| 527 | + )) { |
|
| 528 | + $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
| 529 | + if (is_array($related_for_icon) |
|
| 530 | + && isset($related_for_icon['css_class'], $related_for_icon['label']) |
|
| 531 | + ) { |
|
| 532 | + $items['view_related_messages'] = array( |
|
| 533 | + 'class' => $related_for_icon['css_class'], |
|
| 534 | + 'desc' => $related_for_icon['label'], |
|
| 535 | + ); |
|
| 536 | + } |
|
| 537 | + } |
|
| 538 | + |
|
| 539 | + $items = apply_filters( |
|
| 540 | + 'FHEE__Transactions_Admin_Page___transaction_legend_items__items', |
|
| 541 | + array_merge( |
|
| 542 | + $items, |
|
| 543 | + array( |
|
| 544 | + 'view_details' => array( |
|
| 545 | + 'class' => 'dashicons dashicons-cart', |
|
| 546 | + 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
| 547 | + ), |
|
| 548 | + 'view_invoice' => array( |
|
| 549 | + 'class' => 'dashicons dashicons-media-spreadsheet', |
|
| 550 | + 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
| 551 | + ), |
|
| 552 | + 'view_receipt' => array( |
|
| 553 | + 'class' => 'dashicons dashicons-media-default', |
|
| 554 | + 'desc' => esc_html__('View Transaction Receipt', 'event_espresso'), |
|
| 555 | + ), |
|
| 556 | + 'view_registration' => array( |
|
| 557 | + 'class' => 'dashicons dashicons-clipboard', |
|
| 558 | + 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
| 559 | + ), |
|
| 560 | + 'payment_overview_link' => array( |
|
| 561 | + 'class' => 'dashicons dashicons-money', |
|
| 562 | + 'desc' => esc_html__('Make Payment on Frontend', 'event_espresso'), |
|
| 563 | + ), |
|
| 564 | + ) |
|
| 565 | + ) |
|
| 566 | + ); |
|
| 567 | + |
|
| 568 | + if (EEH_MSG_Template::is_mt_active('payment_reminder') |
|
| 569 | + && EE_Registry::instance()->CAP->current_user_can( |
|
| 570 | + 'ee_send_message', |
|
| 571 | + 'espresso_transactions_send_payment_reminder' |
|
| 572 | + ) |
|
| 573 | + ) { |
|
| 574 | + $items['send_payment_reminder'] = array( |
|
| 575 | + 'class' => 'dashicons dashicons-email-alt', |
|
| 576 | + 'desc' => esc_html__('Send Payment Reminder', 'event_espresso'), |
|
| 577 | + ); |
|
| 578 | + } else { |
|
| 579 | + $items['blank*'] = array( |
|
| 580 | + 'class' => '', |
|
| 581 | + 'desc' => '', |
|
| 582 | + ); |
|
| 583 | + } |
|
| 584 | + $more_items = apply_filters( |
|
| 585 | + 'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items', |
|
| 586 | + array( |
|
| 587 | + 'overpaid' => array( |
|
| 588 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code, |
|
| 589 | + 'desc' => EEH_Template::pretty_status( |
|
| 590 | + EEM_Transaction::overpaid_status_code, |
|
| 591 | + false, |
|
| 592 | + 'sentence' |
|
| 593 | + ), |
|
| 594 | + ), |
|
| 595 | + 'complete' => array( |
|
| 596 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code, |
|
| 597 | + 'desc' => EEH_Template::pretty_status( |
|
| 598 | + EEM_Transaction::complete_status_code, |
|
| 599 | + false, |
|
| 600 | + 'sentence' |
|
| 601 | + ), |
|
| 602 | + ), |
|
| 603 | + 'incomplete' => array( |
|
| 604 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code, |
|
| 605 | + 'desc' => EEH_Template::pretty_status( |
|
| 606 | + EEM_Transaction::incomplete_status_code, |
|
| 607 | + false, |
|
| 608 | + 'sentence' |
|
| 609 | + ), |
|
| 610 | + ), |
|
| 611 | + 'abandoned' => array( |
|
| 612 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code, |
|
| 613 | + 'desc' => EEH_Template::pretty_status( |
|
| 614 | + EEM_Transaction::abandoned_status_code, |
|
| 615 | + false, |
|
| 616 | + 'sentence' |
|
| 617 | + ), |
|
| 618 | + ), |
|
| 619 | + 'failed' => array( |
|
| 620 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code, |
|
| 621 | + 'desc' => EEH_Template::pretty_status( |
|
| 622 | + EEM_Transaction::failed_status_code, |
|
| 623 | + false, |
|
| 624 | + 'sentence' |
|
| 625 | + ), |
|
| 626 | + ), |
|
| 627 | + ) |
|
| 628 | + ); |
|
| 629 | + |
|
| 630 | + return array_merge($items, $more_items); |
|
| 631 | + } |
|
| 632 | + |
|
| 633 | + |
|
| 634 | + /** |
|
| 635 | + * _transactions_overview_list_table |
|
| 636 | + * |
|
| 637 | + * @access protected |
|
| 638 | + * @return void |
|
| 639 | + * @throws DomainException |
|
| 640 | + * @throws EE_Error |
|
| 641 | + * @throws InvalidArgumentException |
|
| 642 | + * @throws InvalidDataTypeException |
|
| 643 | + * @throws InvalidInterfaceException |
|
| 644 | + * @throws ReflectionException |
|
| 645 | + */ |
|
| 646 | + protected function _transactions_overview_list_table() |
|
| 647 | + { |
|
| 648 | + $this->_admin_page_title = esc_html__('Transactions', 'event_espresso'); |
|
| 649 | + $event = isset($this->_req_data['EVT_ID']) |
|
| 650 | + ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']) |
|
| 651 | + : null; |
|
| 652 | + $this->_template_args['admin_page_header'] = $event instanceof EE_Event |
|
| 653 | + ? sprintf( |
|
| 654 | + esc_html__( |
|
| 655 | + '%sViewing Transactions for the Event: %s%s', |
|
| 656 | + 'event_espresso' |
|
| 657 | + ), |
|
| 658 | + '<h3>', |
|
| 659 | + '<a href="' |
|
| 660 | + . EE_Admin_Page::add_query_args_and_nonce( |
|
| 661 | + array('action' => 'edit', 'post' => $event->ID()), |
|
| 662 | + EVENTS_ADMIN_URL |
|
| 663 | + ) |
|
| 664 | + . '" title="' |
|
| 665 | + . esc_attr__( |
|
| 666 | + 'Click to Edit event', |
|
| 667 | + 'event_espresso' |
|
| 668 | + ) |
|
| 669 | + . '">' . $event->name() . '</a>', |
|
| 670 | + '</h3>' |
|
| 671 | + ) |
|
| 672 | + : ''; |
|
| 673 | + $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items()); |
|
| 674 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 675 | + } |
|
| 676 | + |
|
| 677 | + |
|
| 678 | + /** |
|
| 679 | + * _transaction_details |
|
| 680 | + * generates HTML for the View Transaction Details Admin page |
|
| 681 | + * |
|
| 682 | + * @access protected |
|
| 683 | + * @return void |
|
| 684 | + * @throws DomainException |
|
| 685 | + * @throws EE_Error |
|
| 686 | + * @throws InvalidArgumentException |
|
| 687 | + * @throws InvalidDataTypeException |
|
| 688 | + * @throws InvalidInterfaceException |
|
| 689 | + * @throws RuntimeException |
|
| 690 | + * @throws ReflectionException |
|
| 691 | + */ |
|
| 692 | + protected function _transaction_details() |
|
| 693 | + { |
|
| 694 | + do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction); |
|
| 695 | + |
|
| 696 | + $this->_set_transaction_status_array(); |
|
| 697 | + |
|
| 698 | + $this->_template_args = array(); |
|
| 699 | + $this->_template_args['transactions_page'] = $this->_wp_page_slug; |
|
| 700 | + |
|
| 701 | + $this->_set_transaction_object(); |
|
| 702 | + |
|
| 703 | + if (! $this->_transaction instanceof EE_Transaction) { |
|
| 704 | + return; |
|
| 705 | + } |
|
| 706 | + $primary_registration = $this->_transaction->primary_registration(); |
|
| 707 | + $attendee = $primary_registration instanceof EE_Registration |
|
| 708 | + ? $primary_registration->attendee() |
|
| 709 | + : null; |
|
| 710 | + |
|
| 711 | + $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID(); |
|
| 712 | + $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso'); |
|
| 713 | + |
|
| 714 | + $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp'); |
|
| 715 | + $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
| 716 | + |
|
| 717 | + $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ]; |
|
| 718 | + $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso'); |
|
| 719 | + $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->status_ID(); |
|
| 720 | + |
|
| 721 | + $this->_template_args['grand_total'] = $this->_transaction->total(); |
|
| 722 | + $this->_template_args['total_paid'] = $this->_transaction->paid(); |
|
| 723 | + |
|
| 724 | + $amount_due = $this->_transaction->total() - $this->_transaction->paid(); |
|
| 725 | + $this->_template_args['amount_due'] = EEH_Template::format_currency( |
|
| 726 | + $amount_due, |
|
| 727 | + true |
|
| 728 | + ); |
|
| 729 | + if (EE_Registry::instance()->CFG->currency->sign_b4) { |
|
| 730 | + $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign |
|
| 731 | + . $this->_template_args['amount_due']; |
|
| 732 | + } else { |
|
| 733 | + $this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign; |
|
| 734 | + } |
|
| 735 | + $this->_template_args['amount_due_class'] = ''; |
|
| 736 | + |
|
| 737 | + if ($this->_transaction->paid() === $this->_transaction->total()) { |
|
| 738 | + // paid in full |
|
| 739 | + $this->_template_args['amount_due'] = false; |
|
| 740 | + } elseif ($this->_transaction->paid() > $this->_transaction->total()) { |
|
| 741 | + // overpaid |
|
| 742 | + $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
| 743 | + } elseif ($this->_transaction->total() > (float) 0) { |
|
| 744 | + if ($this->_transaction->paid() > (float) 0) { |
|
| 745 | + // monies owing |
|
| 746 | + $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn'; |
|
| 747 | + } elseif ($this->_transaction->paid() === (float) 0) { |
|
| 748 | + // no payments made yet |
|
| 749 | + $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
| 750 | + } |
|
| 751 | + } elseif ($this->_transaction->total() === (float) 0) { |
|
| 752 | + // free event |
|
| 753 | + $this->_template_args['amount_due'] = false; |
|
| 754 | + } |
|
| 755 | + |
|
| 756 | + $payment_method = $this->_transaction->payment_method(); |
|
| 757 | + |
|
| 758 | + $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method |
|
| 759 | + ? $payment_method->admin_name() |
|
| 760 | + : esc_html__('Unknown', 'event_espresso'); |
|
| 761 | + |
|
| 762 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 763 | + // link back to overview |
|
| 764 | + $this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER']) |
|
| 765 | + ? $_SERVER['HTTP_REFERER'] |
|
| 766 | + : TXN_ADMIN_URL; |
|
| 767 | + |
|
| 768 | + |
|
| 769 | + // next link |
|
| 770 | + $next_txn = $this->_transaction->next( |
|
| 771 | + null, |
|
| 772 | + array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
| 773 | + 'TXN_ID' |
|
| 774 | + ); |
|
| 775 | + $this->_template_args['next_transaction'] = $next_txn |
|
| 776 | + ? $this->_next_link( |
|
| 777 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 778 | + array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']), |
|
| 779 | + TXN_ADMIN_URL |
|
| 780 | + ), |
|
| 781 | + 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
| 782 | + ) |
|
| 783 | + : ''; |
|
| 784 | + // previous link |
|
| 785 | + $previous_txn = $this->_transaction->previous( |
|
| 786 | + null, |
|
| 787 | + array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
| 788 | + 'TXN_ID' |
|
| 789 | + ); |
|
| 790 | + $this->_template_args['previous_transaction'] = $previous_txn |
|
| 791 | + ? $this->_previous_link( |
|
| 792 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 793 | + array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']), |
|
| 794 | + TXN_ADMIN_URL |
|
| 795 | + ), |
|
| 796 | + 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
| 797 | + ) |
|
| 798 | + : ''; |
|
| 799 | + |
|
| 800 | + // were we just redirected here after adding a new registration ??? |
|
| 801 | + if (isset( |
|
| 802 | + $this->_req_data['redirect_from'], |
|
| 803 | + $this->_req_data['EVT_ID'], |
|
| 804 | + $this->_req_data['event_name'] |
|
| 805 | + )) { |
|
| 806 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 807 | + 'ee_edit_registrations', |
|
| 808 | + 'espresso_registrations_new_registration', |
|
| 809 | + $this->_req_data['EVT_ID'] |
|
| 810 | + )) { |
|
| 811 | + $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="'; |
|
| 812 | + $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce( |
|
| 813 | + array( |
|
| 814 | + 'page' => 'espresso_registrations', |
|
| 815 | + 'action' => 'new_registration', |
|
| 816 | + 'return' => 'default', |
|
| 817 | + 'TXN_ID' => $this->_transaction->ID(), |
|
| 818 | + 'event_id' => $this->_req_data['EVT_ID'], |
|
| 819 | + ), |
|
| 820 | + REG_ADMIN_URL |
|
| 821 | + ); |
|
| 822 | + $this->_admin_page_title .= '">'; |
|
| 823 | + |
|
| 824 | + $this->_admin_page_title .= sprintf( |
|
| 825 | + esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'), |
|
| 826 | + htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8') |
|
| 827 | + ); |
|
| 828 | + $this->_admin_page_title .= '</a>'; |
|
| 829 | + } |
|
| 830 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 831 | + } |
|
| 832 | + // grab messages at the last second |
|
| 833 | + $this->_template_args['notices'] = EE_Error::get_notices(); |
|
| 834 | + // path to template |
|
| 835 | + $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php'; |
|
| 836 | + $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
| 837 | + $template_path, |
|
| 838 | + $this->_template_args, |
|
| 839 | + true |
|
| 840 | + ); |
|
| 841 | + |
|
| 842 | + // the details template wrapper |
|
| 843 | + $this->display_admin_page_with_sidebar(); |
|
| 844 | + } |
|
| 845 | + |
|
| 846 | + |
|
| 847 | + /** |
|
| 848 | + * _transaction_details_metaboxes |
|
| 849 | + * |
|
| 850 | + * @access protected |
|
| 851 | + * @return void |
|
| 852 | + * @throws EE_Error |
|
| 853 | + * @throws InvalidArgumentException |
|
| 854 | + * @throws InvalidDataTypeException |
|
| 855 | + * @throws InvalidInterfaceException |
|
| 856 | + * @throws RuntimeException |
|
| 857 | + * @throws ReflectionException |
|
| 858 | + */ |
|
| 859 | + protected function _transaction_details_metaboxes() |
|
| 860 | + { |
|
| 861 | + |
|
| 862 | + $this->_set_transaction_object(); |
|
| 863 | + |
|
| 864 | + if (! $this->_transaction instanceof EE_Transaction) { |
|
| 865 | + return; |
|
| 866 | + } |
|
| 867 | + add_meta_box( |
|
| 868 | + 'edit-txn-details-mbox', |
|
| 869 | + esc_html__('Transaction Details', 'event_espresso'), |
|
| 870 | + array($this, 'txn_details_meta_box'), |
|
| 871 | + $this->_wp_page_slug, |
|
| 872 | + 'normal', |
|
| 873 | + 'high' |
|
| 874 | + ); |
|
| 875 | + add_meta_box( |
|
| 876 | + 'edit-txn-attendees-mbox', |
|
| 877 | + esc_html__('Attendees Registered in this Transaction', 'event_espresso'), |
|
| 878 | + array($this, 'txn_attendees_meta_box'), |
|
| 879 | + $this->_wp_page_slug, |
|
| 880 | + 'normal', |
|
| 881 | + 'high', |
|
| 882 | + array('TXN_ID' => $this->_transaction->ID()) |
|
| 883 | + ); |
|
| 884 | + add_meta_box( |
|
| 885 | + 'edit-txn-registrant-mbox', |
|
| 886 | + esc_html__('Primary Contact', 'event_espresso'), |
|
| 887 | + array($this, 'txn_registrant_side_meta_box'), |
|
| 888 | + $this->_wp_page_slug, |
|
| 889 | + 'side', |
|
| 890 | + 'high' |
|
| 891 | + ); |
|
| 892 | + add_meta_box( |
|
| 893 | + 'edit-txn-billing-info-mbox', |
|
| 894 | + esc_html__('Billing Information', 'event_espresso'), |
|
| 895 | + array($this, 'txn_billing_info_side_meta_box'), |
|
| 896 | + $this->_wp_page_slug, |
|
| 897 | + 'side', |
|
| 898 | + 'high' |
|
| 899 | + ); |
|
| 900 | + } |
|
| 901 | + |
|
| 902 | + |
|
| 903 | + /** |
|
| 904 | + * Callback for transaction actions metabox. |
|
| 905 | + * |
|
| 906 | + * @param EE_Transaction|null $transaction |
|
| 907 | + * @return string |
|
| 908 | + * @throws DomainException |
|
| 909 | + * @throws EE_Error |
|
| 910 | + * @throws InvalidArgumentException |
|
| 911 | + * @throws InvalidDataTypeException |
|
| 912 | + * @throws InvalidInterfaceException |
|
| 913 | + * @throws ReflectionException |
|
| 914 | + * @throws RuntimeException |
|
| 915 | + */ |
|
| 916 | + public function getActionButtons(EE_Transaction $transaction = null) |
|
| 917 | + { |
|
| 918 | + $content = ''; |
|
| 919 | + $actions = array(); |
|
| 920 | + if (! $transaction instanceof EE_Transaction) { |
|
| 921 | + return $content; |
|
| 922 | + } |
|
| 923 | + /** @var EE_Registration $primary_registration */ |
|
| 924 | + $primary_registration = $transaction->primary_registration(); |
|
| 925 | + $attendee = $primary_registration instanceof EE_Registration |
|
| 926 | + ? $primary_registration->attendee() |
|
| 927 | + : null; |
|
| 928 | + |
|
| 929 | + if ($attendee instanceof EE_Attendee |
|
| 930 | + && EE_Registry::instance()->CAP->current_user_can( |
|
| 931 | + 'ee_send_message', |
|
| 932 | + 'espresso_transactions_send_payment_reminder' |
|
| 933 | + ) |
|
| 934 | + ) { |
|
| 935 | + $actions['payment_reminder'] = |
|
| 936 | + EEH_MSG_Template::is_mt_active('payment_reminder') |
|
| 937 | + && $this->_transaction->status_ID() !== EEM_Transaction::complete_status_code |
|
| 938 | + && $this->_transaction->status_ID() !== EEM_Transaction::overpaid_status_code |
|
| 939 | + ? EEH_Template::get_button_or_link( |
|
| 940 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 941 | + array( |
|
| 942 | + 'action' => 'send_payment_reminder', |
|
| 943 | + 'TXN_ID' => $this->_transaction->ID(), |
|
| 944 | + 'redirect_to' => 'view_transaction', |
|
| 945 | + ), |
|
| 946 | + TXN_ADMIN_URL |
|
| 947 | + ), |
|
| 948 | + esc_html__(' Send Payment Reminder', 'event_espresso'), |
|
| 949 | + 'button secondary-button', |
|
| 950 | + 'dashicons dashicons-email-alt' |
|
| 951 | + ) |
|
| 952 | + : ''; |
|
| 953 | + } |
|
| 954 | + |
|
| 955 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 956 | + 'ee_edit_payments', |
|
| 957 | + 'espresso_transactions_recalculate_line_items' |
|
| 958 | + ) |
|
| 959 | + ) { |
|
| 960 | + $actions['recalculate_line_items'] = EEH_Template::get_button_or_link( |
|
| 961 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 962 | + array( |
|
| 963 | + 'action' => 'espresso_recalculate_line_items', |
|
| 964 | + 'TXN_ID' => $this->_transaction->ID(), |
|
| 965 | + 'redirect_to' => 'view_transaction', |
|
| 966 | + ), |
|
| 967 | + TXN_ADMIN_URL |
|
| 968 | + ), |
|
| 969 | + esc_html__(' Recalculate Taxes and Total', 'event_espresso'), |
|
| 970 | + 'button secondary-button', |
|
| 971 | + 'dashicons dashicons-update' |
|
| 972 | + ); |
|
| 973 | + } |
|
| 974 | + |
|
| 975 | + if ($primary_registration instanceof EE_Registration |
|
| 976 | + && EEH_MSG_Template::is_mt_active('receipt') |
|
| 977 | + ) { |
|
| 978 | + $actions['receipt'] = EEH_Template::get_button_or_link( |
|
| 979 | + $primary_registration->receipt_url(), |
|
| 980 | + esc_html__('View Receipt', 'event_espresso'), |
|
| 981 | + 'button secondary-button', |
|
| 982 | + 'dashicons dashicons-media-default' |
|
| 983 | + ); |
|
| 984 | + } |
|
| 985 | + |
|
| 986 | + if ($primary_registration instanceof EE_Registration |
|
| 987 | + && EEH_MSG_Template::is_mt_active('invoice') |
|
| 988 | + ) { |
|
| 989 | + $actions['invoice'] = EEH_Template::get_button_or_link( |
|
| 990 | + $primary_registration->invoice_url(), |
|
| 991 | + esc_html__('View Invoice', 'event_espresso'), |
|
| 992 | + 'button secondary-button', |
|
| 993 | + 'dashicons dashicons-media-spreadsheet' |
|
| 994 | + ); |
|
| 995 | + } |
|
| 996 | + $actions = array_filter( |
|
| 997 | + apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction) |
|
| 998 | + ); |
|
| 999 | + if ($actions) { |
|
| 1000 | + $content = '<ul>'; |
|
| 1001 | + $content .= '<li>' . implode('</li><li>', $actions) . '</li>'; |
|
| 1002 | + $content .= '</uL>'; |
|
| 1003 | + } |
|
| 1004 | + return $content; |
|
| 1005 | + } |
|
| 1006 | + |
|
| 1007 | + |
|
| 1008 | + /** |
|
| 1009 | + * txn_details_meta_box |
|
| 1010 | + * generates HTML for the Transaction main meta box |
|
| 1011 | + * |
|
| 1012 | + * @return void |
|
| 1013 | + * @throws DomainException |
|
| 1014 | + * @throws EE_Error |
|
| 1015 | + * @throws InvalidArgumentException |
|
| 1016 | + * @throws InvalidDataTypeException |
|
| 1017 | + * @throws InvalidInterfaceException |
|
| 1018 | + * @throws RuntimeException |
|
| 1019 | + * @throws ReflectionException |
|
| 1020 | + */ |
|
| 1021 | + public function txn_details_meta_box() |
|
| 1022 | + { |
|
| 1023 | + $this->_set_transaction_object(); |
|
| 1024 | + $this->_template_args['TXN_ID'] = $this->_transaction->ID(); |
|
| 1025 | + $this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration |
|
| 1026 | + ? $this->_transaction->primary_registration()->attendee() |
|
| 1027 | + : null; |
|
| 1028 | + $this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
| 1029 | + 'ee_edit_payments', |
|
| 1030 | + 'apply_payment_or_refund_from_registration_details' |
|
| 1031 | + ); |
|
| 1032 | + $this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
| 1033 | + 'ee_delete_payments', |
|
| 1034 | + 'delete_payment_from_registration_details' |
|
| 1035 | + ); |
|
| 1036 | + |
|
| 1037 | + // get line table |
|
| 1038 | + EEH_Autoloader::register_line_item_display_autoloaders(); |
|
| 1039 | + $Line_Item_Display = new EE_Line_Item_Display( |
|
| 1040 | + 'admin_table', |
|
| 1041 | + 'EE_Admin_Table_Line_Item_Display_Strategy' |
|
| 1042 | + ); |
|
| 1043 | + $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item( |
|
| 1044 | + $this->_transaction->total_line_item() |
|
| 1045 | + ); |
|
| 1046 | + $this->_template_args['REG_code'] = $this->_transaction->primary_registration()->reg_code(); |
|
| 1047 | + |
|
| 1048 | + // process taxes |
|
| 1049 | + $taxes = $this->_transaction->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax))); |
|
| 1050 | + $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false; |
|
| 1051 | + |
|
| 1052 | + $this->_template_args['grand_total'] = EEH_Template::format_currency( |
|
| 1053 | + $this->_transaction->total(), |
|
| 1054 | + false, |
|
| 1055 | + false |
|
| 1056 | + ); |
|
| 1057 | + $this->_template_args['grand_raw_total'] = $this->_transaction->total(); |
|
| 1058 | + $this->_template_args['TXN_status'] = $this->_transaction->status_ID(); |
|
| 1059 | + |
|
| 1060 | + // process payment details |
|
| 1061 | + $payments = $this->_transaction->payments(); |
|
| 1062 | + if (! empty($payments)) { |
|
| 1063 | + $this->_template_args['payments'] = $payments; |
|
| 1064 | + $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments); |
|
| 1065 | + } else { |
|
| 1066 | + $this->_template_args['payments'] = false; |
|
| 1067 | + $this->_template_args['existing_reg_payments'] = array(); |
|
| 1068 | + } |
|
| 1069 | + |
|
| 1070 | + $this->_template_args['edit_payment_url'] = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL); |
|
| 1071 | + $this->_template_args['delete_payment_url'] = add_query_arg( |
|
| 1072 | + array('action' => 'espresso_delete_payment'), |
|
| 1073 | + TXN_ADMIN_URL |
|
| 1074 | + ); |
|
| 1075 | + |
|
| 1076 | + if (isset($txn_details['invoice_number'])) { |
|
| 1077 | + $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code']; |
|
| 1078 | + $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__( |
|
| 1079 | + 'Invoice Number', |
|
| 1080 | + 'event_espresso' |
|
| 1081 | + ); |
|
| 1082 | + } |
|
| 1083 | + |
|
| 1084 | + $this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction |
|
| 1085 | + ->primary_registration() |
|
| 1086 | + ->session_ID(); |
|
| 1087 | + $this->_template_args['txn_details']['registration_session']['label'] = esc_html__( |
|
| 1088 | + 'Registration Session', |
|
| 1089 | + 'event_espresso' |
|
| 1090 | + ); |
|
| 1091 | + |
|
| 1092 | + $this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address']) |
|
| 1093 | + ? $this->_session['ip_address'] |
|
| 1094 | + : ''; |
|
| 1095 | + $this->_template_args['txn_details']['ip_address']['label'] = esc_html__( |
|
| 1096 | + 'Transaction placed from IP', |
|
| 1097 | + 'event_espresso' |
|
| 1098 | + ); |
|
| 1099 | + |
|
| 1100 | + $this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent']) |
|
| 1101 | + ? $this->_session['user_agent'] |
|
| 1102 | + : ''; |
|
| 1103 | + $this->_template_args['txn_details']['user_agent']['label'] = esc_html__( |
|
| 1104 | + 'Registrant User Agent', |
|
| 1105 | + 'event_espresso' |
|
| 1106 | + ); |
|
| 1107 | + |
|
| 1108 | + $reg_steps = '<ul>'; |
|
| 1109 | + foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) { |
|
| 1110 | + if ($reg_step_status === true) { |
|
| 1111 | + $reg_steps .= '<li style="color:#70cc50">' |
|
| 1112 | + . sprintf( |
|
| 1113 | + esc_html__('%1$s : Completed', 'event_espresso'), |
|
| 1114 | + ucwords(str_replace('_', ' ', $reg_step)) |
|
| 1115 | + ) |
|
| 1116 | + . '</li>'; |
|
| 1117 | + } elseif (is_numeric($reg_step_status) && $reg_step_status !== false) { |
|
| 1118 | + $reg_steps .= '<li style="color:#2EA2CC">' |
|
| 1119 | + . sprintf( |
|
| 1120 | + esc_html__('%1$s : Initiated %2$s', 'event_espresso'), |
|
| 1121 | + ucwords(str_replace('_', ' ', $reg_step)), |
|
| 1122 | + date( |
|
| 1123 | + get_option('date_format') . ' ' . get_option('time_format'), |
|
| 1124 | + $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS) |
|
| 1125 | + ) |
|
| 1126 | + ) |
|
| 1127 | + . '</li>'; |
|
| 1128 | + } else { |
|
| 1129 | + $reg_steps .= '<li style="color:#E76700">' |
|
| 1130 | + . sprintf( |
|
| 1131 | + esc_html__('%1$s : Never Initiated', 'event_espresso'), |
|
| 1132 | + ucwords(str_replace('_', ' ', $reg_step)) |
|
| 1133 | + ) |
|
| 1134 | + . '</li>'; |
|
| 1135 | + } |
|
| 1136 | + } |
|
| 1137 | + $reg_steps .= '</ul>'; |
|
| 1138 | + $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps; |
|
| 1139 | + $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__( |
|
| 1140 | + 'Registration Step Progress', |
|
| 1141 | + 'event_espresso' |
|
| 1142 | + ); |
|
| 1143 | + |
|
| 1144 | + |
|
| 1145 | + $this->_get_registrations_to_apply_payment_to(); |
|
| 1146 | + $this->_get_payment_methods($payments); |
|
| 1147 | + $this->_get_payment_status_array(); |
|
| 1148 | + $this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction. |
|
| 1149 | + |
|
| 1150 | + $this->_template_args['transaction_form_url'] = add_query_arg( |
|
| 1151 | + array( |
|
| 1152 | + 'action' => 'edit_transaction', |
|
| 1153 | + 'process' => 'transaction', |
|
| 1154 | + ), |
|
| 1155 | + TXN_ADMIN_URL |
|
| 1156 | + ); |
|
| 1157 | + $this->_template_args['apply_payment_form_url'] = add_query_arg( |
|
| 1158 | + array( |
|
| 1159 | + 'page' => 'espresso_transactions', |
|
| 1160 | + 'action' => 'espresso_apply_payment', |
|
| 1161 | + ), |
|
| 1162 | + WP_AJAX_URL |
|
| 1163 | + ); |
|
| 1164 | + $this->_template_args['delete_payment_form_url'] = add_query_arg( |
|
| 1165 | + array( |
|
| 1166 | + 'page' => 'espresso_transactions', |
|
| 1167 | + 'action' => 'espresso_delete_payment', |
|
| 1168 | + ), |
|
| 1169 | + WP_AJAX_URL |
|
| 1170 | + ); |
|
| 1171 | + |
|
| 1172 | + $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction); |
|
| 1173 | + |
|
| 1174 | + // 'espresso_delete_payment_nonce' |
|
| 1175 | + |
|
| 1176 | + $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
| 1177 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1178 | + } |
|
| 1179 | + |
|
| 1180 | + |
|
| 1181 | + /** |
|
| 1182 | + * _get_registration_payment_IDs |
|
| 1183 | + * generates an array of Payment IDs and their corresponding Registration IDs |
|
| 1184 | + * |
|
| 1185 | + * @access protected |
|
| 1186 | + * @param EE_Payment[] $payments |
|
| 1187 | + * @return array |
|
| 1188 | + * @throws EE_Error |
|
| 1189 | + * @throws InvalidArgumentException |
|
| 1190 | + * @throws InvalidDataTypeException |
|
| 1191 | + * @throws InvalidInterfaceException |
|
| 1192 | + * @throws ReflectionException |
|
| 1193 | + */ |
|
| 1194 | + protected function _get_registration_payment_IDs($payments = array()) |
|
| 1195 | + { |
|
| 1196 | + $existing_reg_payments = array(); |
|
| 1197 | + // get all reg payments for these payments |
|
| 1198 | + $reg_payments = EEM_Registration_Payment::instance()->get_all( |
|
| 1199 | + array( |
|
| 1200 | + array( |
|
| 1201 | + 'PAY_ID' => array( |
|
| 1202 | + 'IN', |
|
| 1203 | + array_keys($payments), |
|
| 1204 | + ), |
|
| 1205 | + ), |
|
| 1206 | + ) |
|
| 1207 | + ); |
|
| 1208 | + if (! empty($reg_payments)) { |
|
| 1209 | + foreach ($payments as $payment) { |
|
| 1210 | + if (! $payment instanceof EE_Payment) { |
|
| 1211 | + continue; |
|
| 1212 | + } elseif (! isset($existing_reg_payments[ $payment->ID() ])) { |
|
| 1213 | + $existing_reg_payments[ $payment->ID() ] = array(); |
|
| 1214 | + } |
|
| 1215 | + foreach ($reg_payments as $reg_payment) { |
|
| 1216 | + if ($reg_payment instanceof EE_Registration_Payment |
|
| 1217 | + && $reg_payment->payment_ID() === $payment->ID() |
|
| 1218 | + ) { |
|
| 1219 | + $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID(); |
|
| 1220 | + } |
|
| 1221 | + } |
|
| 1222 | + } |
|
| 1223 | + } |
|
| 1224 | + |
|
| 1225 | + return $existing_reg_payments; |
|
| 1226 | + } |
|
| 1227 | + |
|
| 1228 | + |
|
| 1229 | + /** |
|
| 1230 | + * _get_registrations_to_apply_payment_to |
|
| 1231 | + * generates HTML for displaying a series of checkboxes in the admin payment modal window |
|
| 1232 | + * which allows the admin to only apply the payment to the specific registrations |
|
| 1233 | + * |
|
| 1234 | + * @access protected |
|
| 1235 | + * @return void |
|
| 1236 | + * @throws EE_Error |
|
| 1237 | + * @throws InvalidArgumentException |
|
| 1238 | + * @throws InvalidDataTypeException |
|
| 1239 | + * @throws InvalidInterfaceException |
|
| 1240 | + * @throws ReflectionException |
|
| 1241 | + */ |
|
| 1242 | + protected function _get_registrations_to_apply_payment_to() |
|
| 1243 | + { |
|
| 1244 | + // we want any registration with an active status (ie: not deleted or cancelled) |
|
| 1245 | + $query_params = array( |
|
| 1246 | + array( |
|
| 1247 | + 'STS_ID' => array( |
|
| 1248 | + 'IN', |
|
| 1249 | + array( |
|
| 1250 | + EEM_Registration::status_id_approved, |
|
| 1251 | + EEM_Registration::status_id_pending_payment, |
|
| 1252 | + EEM_Registration::status_id_not_approved, |
|
| 1253 | + ), |
|
| 1254 | + ), |
|
| 1255 | + ), |
|
| 1256 | + ); |
|
| 1257 | + $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div( |
|
| 1258 | + '', |
|
| 1259 | + 'txn-admin-apply-payment-to-registrations-dv', |
|
| 1260 | + '', |
|
| 1261 | + 'clear: both; margin: 1.5em 0 0; display: none;' |
|
| 1262 | + ); |
|
| 1263 | + $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
| 1264 | + $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl'); |
|
| 1265 | + $registrations_to_apply_payment_to .= EEH_HTML::thead( |
|
| 1266 | + EEH_HTML::tr( |
|
| 1267 | + EEH_HTML::th(esc_html__('ID', 'event_espresso')) . |
|
| 1268 | + EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) . |
|
| 1269 | + EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) . |
|
| 1270 | + EEH_HTML::th(esc_html__('Event', 'event_espresso')) . |
|
| 1271 | + EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
| 1272 | + EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
| 1273 | + EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr') |
|
| 1274 | + ) |
|
| 1275 | + ); |
|
| 1276 | + $registrations_to_apply_payment_to .= EEH_HTML::tbody(); |
|
| 1277 | + // get registrations for TXN |
|
| 1278 | + $registrations = $this->_transaction->registrations($query_params); |
|
| 1279 | + $existing_reg_payments = $this->_template_args['existing_reg_payments']; |
|
| 1280 | + foreach ($registrations as $registration) { |
|
| 1281 | + if ($registration instanceof EE_Registration) { |
|
| 1282 | + $attendee_name = $registration->attendee() instanceof EE_Attendee |
|
| 1283 | + ? $registration->attendee()->full_name() |
|
| 1284 | + : esc_html__('Unknown Attendee', 'event_espresso'); |
|
| 1285 | + $owing = $registration->final_price() - $registration->paid(); |
|
| 1286 | + $taxable = $registration->ticket()->taxable() |
|
| 1287 | + ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>' |
|
| 1288 | + : ''; |
|
| 1289 | + $checked = empty($existing_reg_payments) |
|
| 1290 | + || in_array($registration->ID(), $existing_reg_payments, true) |
|
| 1291 | + ? ' checked="checked"' |
|
| 1292 | + : ''; |
|
| 1293 | + $disabled = $registration->final_price() > 0 ? '' : ' disabled'; |
|
| 1294 | + $registrations_to_apply_payment_to .= EEH_HTML::tr( |
|
| 1295 | + EEH_HTML::td($registration->ID()) . |
|
| 1296 | + EEH_HTML::td($attendee_name) . |
|
| 1297 | + EEH_HTML::td( |
|
| 1298 | + $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable |
|
| 1299 | + ) . |
|
| 1300 | + EEH_HTML::td($registration->event_name()) . |
|
| 1301 | + EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
| 1302 | + EEH_HTML::td( |
|
| 1303 | + EEH_Template::format_currency($owing), |
|
| 1304 | + '', |
|
| 1305 | + 'txn-admin-payment-owing-td jst-cntr' |
|
| 1306 | + ) . |
|
| 1307 | + EEH_HTML::td( |
|
| 1308 | + '<input type="checkbox" value="' . $registration->ID() |
|
| 1309 | + . '" name="txn_admin_payment[registrations]"' |
|
| 1310 | + . $checked . $disabled . '>', |
|
| 1311 | + '', |
|
| 1312 | + 'jst-cntr' |
|
| 1313 | + ), |
|
| 1314 | + 'apply-payment-registration-row-' . $registration->ID() |
|
| 1315 | + ); |
|
| 1316 | + } |
|
| 1317 | + } |
|
| 1318 | + $registrations_to_apply_payment_to .= EEH_HTML::tbodyx(); |
|
| 1319 | + $registrations_to_apply_payment_to .= EEH_HTML::tablex(); |
|
| 1320 | + $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
| 1321 | + $registrations_to_apply_payment_to .= EEH_HTML::p( |
|
| 1322 | + esc_html__( |
|
| 1323 | + 'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.', |
|
| 1324 | + 'event_espresso' |
|
| 1325 | + ), |
|
| 1326 | + '', |
|
| 1327 | + 'clear description' |
|
| 1328 | + ); |
|
| 1329 | + $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
| 1330 | + $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to; |
|
| 1331 | + } |
|
| 1332 | + |
|
| 1333 | + |
|
| 1334 | + /** |
|
| 1335 | + * _get_reg_status_selection |
|
| 1336 | + * |
|
| 1337 | + * @todo this will need to be adjusted either once MER comes along OR we move default reg status to tickets |
|
| 1338 | + * instead of events. |
|
| 1339 | + * @access protected |
|
| 1340 | + * @return void |
|
| 1341 | + * @throws EE_Error |
|
| 1342 | + */ |
|
| 1343 | + protected function _get_reg_status_selection() |
|
| 1344 | + { |
|
| 1345 | + // first get all possible statuses |
|
| 1346 | + $statuses = EEM_Registration::reg_status_array(array(), true); |
|
| 1347 | + // let's add a "don't change" option. |
|
| 1348 | + $status_array['NAN'] = esc_html__('Leave the Same', 'event_espresso'); |
|
| 1349 | + $status_array = array_merge($status_array, $statuses); |
|
| 1350 | + $this->_template_args['status_change_select'] = EEH_Form_Fields::select_input( |
|
| 1351 | + 'txn_reg_status_change[reg_status]', |
|
| 1352 | + $status_array, |
|
| 1353 | + 'NAN', |
|
| 1354 | + 'id="txn-admin-payment-reg-status-inp"', |
|
| 1355 | + 'txn-reg-status-change-reg-status' |
|
| 1356 | + ); |
|
| 1357 | + $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input( |
|
| 1358 | + 'delete_txn_reg_status_change[reg_status]', |
|
| 1359 | + $status_array, |
|
| 1360 | + 'NAN', |
|
| 1361 | + 'delete-txn-admin-payment-reg-status-inp', |
|
| 1362 | + 'delete-txn-reg-status-change-reg-status' |
|
| 1363 | + ); |
|
| 1364 | + } |
|
| 1365 | + |
|
| 1366 | + |
|
| 1367 | + /** |
|
| 1368 | + * _get_payment_methods |
|
| 1369 | + * Gets all the payment methods available generally, or the ones that are already |
|
| 1370 | + * selected on these payments (in case their payment methods are no longer active). |
|
| 1371 | + * Has the side-effect of updating the template args' payment_methods item |
|
| 1372 | + * |
|
| 1373 | + * @access private |
|
| 1374 | + * @param EE_Payment[] to show on this page |
|
| 1375 | + * @return void |
|
| 1376 | + * @throws EE_Error |
|
| 1377 | + * @throws InvalidArgumentException |
|
| 1378 | + * @throws InvalidDataTypeException |
|
| 1379 | + * @throws InvalidInterfaceException |
|
| 1380 | + * @throws ReflectionException |
|
| 1381 | + */ |
|
| 1382 | + private function _get_payment_methods($payments = array()) |
|
| 1383 | + { |
|
| 1384 | + $payment_methods_of_payments = array(); |
|
| 1385 | + foreach ($payments as $payment) { |
|
| 1386 | + if ($payment instanceof EE_Payment) { |
|
| 1387 | + $payment_methods_of_payments[] = $payment->ID(); |
|
| 1388 | + } |
|
| 1389 | + } |
|
| 1390 | + if ($payment_methods_of_payments) { |
|
| 1391 | + $query_args = array( |
|
| 1392 | + array( |
|
| 1393 | + 'OR*payment_method_for_payment' => array( |
|
| 1394 | + 'PMD_ID' => array('IN', $payment_methods_of_payments), |
|
| 1395 | + 'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'), |
|
| 1396 | + ), |
|
| 1397 | + ), |
|
| 1398 | + ); |
|
| 1399 | + } else { |
|
| 1400 | + $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'))); |
|
| 1401 | + } |
|
| 1402 | + $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args); |
|
| 1403 | + } |
|
| 1404 | + |
|
| 1405 | + |
|
| 1406 | + /** |
|
| 1407 | + * txn_attendees_meta_box |
|
| 1408 | + * generates HTML for the Attendees Transaction main meta box |
|
| 1409 | + * |
|
| 1410 | + * @access public |
|
| 1411 | + * @param WP_Post $post |
|
| 1412 | + * @param array $metabox |
|
| 1413 | + * @return void |
|
| 1414 | + * @throws DomainException |
|
| 1415 | + * @throws EE_Error |
|
| 1416 | + * @throws InvalidArgumentException |
|
| 1417 | + * @throws InvalidDataTypeException |
|
| 1418 | + * @throws InvalidInterfaceException |
|
| 1419 | + * @throws ReflectionException |
|
| 1420 | + */ |
|
| 1421 | + public function txn_attendees_meta_box($post, $metabox = array('args' => array())) |
|
| 1422 | + { |
|
| 1423 | + |
|
| 1424 | + /** @noinspection NonSecureExtractUsageInspection */ |
|
| 1425 | + extract($metabox['args']); |
|
| 1426 | + $this->_template_args['post'] = $post; |
|
| 1427 | + $this->_template_args['event_attendees'] = array(); |
|
| 1428 | + // process items in cart |
|
| 1429 | + $line_items = $this->_transaction->get_many_related( |
|
| 1430 | + 'Line_Item', |
|
| 1431 | + array(array('LIN_type' => 'line-item')) |
|
| 1432 | + ); |
|
| 1433 | + if (! empty($line_items)) { |
|
| 1434 | + foreach ($line_items as $item) { |
|
| 1435 | + if ($item instanceof EE_Line_Item) { |
|
| 1436 | + switch ($item->OBJ_type()) { |
|
| 1437 | + case 'Event': |
|
| 1438 | + break; |
|
| 1439 | + case 'Ticket': |
|
| 1440 | + $ticket = $item->ticket(); |
|
| 1441 | + // right now we're only handling tickets here. |
|
| 1442 | + // Cause its expected that only tickets will have attendees right? |
|
| 1443 | + if (! $ticket instanceof EE_Ticket) { |
|
| 1444 | + break; |
|
| 1445 | + } |
|
| 1446 | + try { |
|
| 1447 | + $event_name = $ticket->get_event_name(); |
|
| 1448 | + } catch (Exception $e) { |
|
| 1449 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1450 | + $event_name = esc_html__('Unknown Event', 'event_espresso'); |
|
| 1451 | + } |
|
| 1452 | + $event_name .= ' - ' . $item->name(); |
|
| 1453 | + $ticket_price = EEH_Template::format_currency($item->unit_price()); |
|
| 1454 | + // now get all of the registrations for this transaction that use this ticket |
|
| 1455 | + $registrations = $ticket->registrations( |
|
| 1456 | + array(array('TXN_ID' => $this->_transaction->ID())) |
|
| 1457 | + ); |
|
| 1458 | + foreach ($registrations as $registration) { |
|
| 1459 | + if (! $registration instanceof EE_Registration) { |
|
| 1460 | + break; |
|
| 1461 | + } |
|
| 1462 | + $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID'] |
|
| 1463 | + = $registration->status_ID(); |
|
| 1464 | + $this->_template_args['event_attendees'][ $registration->ID() ]['att_num'] |
|
| 1465 | + = $registration->count(); |
|
| 1466 | + $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name'] |
|
| 1467 | + = $event_name; |
|
| 1468 | + $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price'] |
|
| 1469 | + = $ticket_price; |
|
| 1470 | + // attendee info |
|
| 1471 | + $attendee = $registration->get_first_related('Attendee'); |
|
| 1472 | + if ($attendee instanceof EE_Attendee) { |
|
| 1473 | + $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] |
|
| 1474 | + = $attendee->ID(); |
|
| 1475 | + $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] |
|
| 1476 | + = $attendee->full_name(); |
|
| 1477 | + $this->_template_args['event_attendees'][ $registration->ID() ]['email'] |
|
| 1478 | + = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name |
|
| 1479 | + . esc_html__( |
|
| 1480 | + ' Event', |
|
| 1481 | + 'event_espresso' |
|
| 1482 | + ) |
|
| 1483 | + . '">' . $attendee->email() . '</a>'; |
|
| 1484 | + $this->_template_args['event_attendees'][ $registration->ID() ]['address'] |
|
| 1485 | + = EEH_Address::format($attendee, 'inline', false, false); |
|
| 1486 | + } else { |
|
| 1487 | + $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] = ''; |
|
| 1488 | + $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = ''; |
|
| 1489 | + $this->_template_args['event_attendees'][ $registration->ID() ]['email'] = ''; |
|
| 1490 | + $this->_template_args['event_attendees'][ $registration->ID() ]['address'] = ''; |
|
| 1491 | + } |
|
| 1492 | + } |
|
| 1493 | + break; |
|
| 1494 | + } |
|
| 1495 | + } |
|
| 1496 | + } |
|
| 1497 | + |
|
| 1498 | + $this->_template_args['transaction_form_url'] = add_query_arg( |
|
| 1499 | + array( |
|
| 1500 | + 'action' => 'edit_transaction', |
|
| 1501 | + 'process' => 'attendees', |
|
| 1502 | + ), |
|
| 1503 | + TXN_ADMIN_URL |
|
| 1504 | + ); |
|
| 1505 | + echo EEH_Template::display_template( |
|
| 1506 | + TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php', |
|
| 1507 | + $this->_template_args, |
|
| 1508 | + true |
|
| 1509 | + ); |
|
| 1510 | + } else { |
|
| 1511 | + echo sprintf( |
|
| 1512 | + esc_html__( |
|
| 1513 | + '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s', |
|
| 1514 | + 'event_espresso' |
|
| 1515 | + ), |
|
| 1516 | + '<p class="important-notice">', |
|
| 1517 | + '</p>' |
|
| 1518 | + ); |
|
| 1519 | + } |
|
| 1520 | + } |
|
| 1521 | + |
|
| 1522 | + |
|
| 1523 | + /** |
|
| 1524 | + * txn_registrant_side_meta_box |
|
| 1525 | + * generates HTML for the Edit Transaction side meta box |
|
| 1526 | + * |
|
| 1527 | + * @access public |
|
| 1528 | + * @return void |
|
| 1529 | + * @throws DomainException |
|
| 1530 | + * @throws EE_Error |
|
| 1531 | + * @throws InvalidArgumentException |
|
| 1532 | + * @throws InvalidDataTypeException |
|
| 1533 | + * @throws InvalidInterfaceException |
|
| 1534 | + * @throws ReflectionException |
|
| 1535 | + */ |
|
| 1536 | + public function txn_registrant_side_meta_box() |
|
| 1537 | + { |
|
| 1538 | + $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration |
|
| 1539 | + ? $this->_transaction->primary_registration()->get_first_related('Attendee') |
|
| 1540 | + : null; |
|
| 1541 | + if (! $primary_att instanceof EE_Attendee) { |
|
| 1542 | + $this->_template_args['no_attendee_message'] = esc_html__( |
|
| 1543 | + 'There is no attached contact for this transaction. The transaction either failed due to an error or was abandoned.', |
|
| 1544 | + 'event_espresso' |
|
| 1545 | + ); |
|
| 1546 | + $primary_att = EEM_Attendee::instance()->create_default_object(); |
|
| 1547 | + } |
|
| 1548 | + $this->_template_args['ATT_ID'] = $primary_att->ID(); |
|
| 1549 | + $this->_template_args['prime_reg_fname'] = $primary_att->fname(); |
|
| 1550 | + $this->_template_args['prime_reg_lname'] = $primary_att->lname(); |
|
| 1551 | + $this->_template_args['prime_reg_email'] = $primary_att->email(); |
|
| 1552 | + $this->_template_args['prime_reg_phone'] = $primary_att->phone(); |
|
| 1553 | + $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1554 | + array( |
|
| 1555 | + 'action' => 'edit_attendee', |
|
| 1556 | + 'post' => $primary_att->ID(), |
|
| 1557 | + ), |
|
| 1558 | + REG_ADMIN_URL |
|
| 1559 | + ); |
|
| 1560 | + // get formatted address for registrant |
|
| 1561 | + $this->_template_args['formatted_address'] = EEH_Address::format($primary_att); |
|
| 1562 | + echo EEH_Template::display_template( |
|
| 1563 | + TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php', |
|
| 1564 | + $this->_template_args, |
|
| 1565 | + true |
|
| 1566 | + ); |
|
| 1567 | + } |
|
| 1568 | + |
|
| 1569 | + |
|
| 1570 | + /** |
|
| 1571 | + * txn_billing_info_side_meta_box |
|
| 1572 | + * generates HTML for the Edit Transaction side meta box |
|
| 1573 | + * |
|
| 1574 | + * @access public |
|
| 1575 | + * @return void |
|
| 1576 | + * @throws DomainException |
|
| 1577 | + * @throws EE_Error |
|
| 1578 | + */ |
|
| 1579 | + public function txn_billing_info_side_meta_box() |
|
| 1580 | + { |
|
| 1581 | + |
|
| 1582 | + $this->_template_args['billing_form'] = $this->_transaction->billing_info(); |
|
| 1583 | + $this->_template_args['billing_form_url'] = add_query_arg( |
|
| 1584 | + array('action' => 'edit_transaction', 'process' => 'billing'), |
|
| 1585 | + TXN_ADMIN_URL |
|
| 1586 | + ); |
|
| 1587 | + |
|
| 1588 | + $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
| 1589 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1590 | + } |
|
| 1591 | + |
|
| 1592 | + |
|
| 1593 | + /** |
|
| 1594 | + * apply_payments_or_refunds |
|
| 1595 | + * registers a payment or refund made towards a transaction |
|
| 1596 | + * |
|
| 1597 | + * @access public |
|
| 1598 | + * @return void |
|
| 1599 | + * @throws EE_Error |
|
| 1600 | + * @throws InvalidArgumentException |
|
| 1601 | + * @throws ReflectionException |
|
| 1602 | + * @throws RuntimeException |
|
| 1603 | + * @throws InvalidDataTypeException |
|
| 1604 | + * @throws InvalidInterfaceException |
|
| 1605 | + */ |
|
| 1606 | + public function apply_payments_or_refunds() |
|
| 1607 | + { |
|
| 1608 | + $json_response_data = array('return_data' => false); |
|
| 1609 | + $valid_data = $this->_validate_payment_request_data(); |
|
| 1610 | + $has_access = EE_Registry::instance()->CAP->current_user_can( |
|
| 1611 | + 'ee_edit_payments', |
|
| 1612 | + 'apply_payment_or_refund_from_registration_details' |
|
| 1613 | + ); |
|
| 1614 | + if (! empty($valid_data) && $has_access) { |
|
| 1615 | + $PAY_ID = $valid_data['PAY_ID']; |
|
| 1616 | + // save the new payment |
|
| 1617 | + $payment = $this->_create_payment_from_request_data($valid_data); |
|
| 1618 | + // get the TXN for this payment |
|
| 1619 | + $transaction = $payment->transaction(); |
|
| 1620 | + // verify transaction |
|
| 1621 | + if ($transaction instanceof EE_Transaction) { |
|
| 1622 | + // calculate_total_payments_and_update_status |
|
| 1623 | + $this->_process_transaction_payments($transaction); |
|
| 1624 | + $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment); |
|
| 1625 | + $this->_remove_existing_registration_payments($payment, $PAY_ID); |
|
| 1626 | + // apply payment to registrations (if applicable) |
|
| 1627 | + if (! empty($REG_IDs)) { |
|
| 1628 | + $this->_update_registration_payments($transaction, $payment, $REG_IDs); |
|
| 1629 | + $this->_maybe_send_notifications(); |
|
| 1630 | + // now process status changes for the same registrations |
|
| 1631 | + $this->_process_registration_status_change($transaction, $REG_IDs); |
|
| 1632 | + } |
|
| 1633 | + $this->_maybe_send_notifications($payment); |
|
| 1634 | + // prepare to render page |
|
| 1635 | + $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs); |
|
| 1636 | + do_action( |
|
| 1637 | + 'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording', |
|
| 1638 | + $transaction, |
|
| 1639 | + $payment |
|
| 1640 | + ); |
|
| 1641 | + } else { |
|
| 1642 | + EE_Error::add_error( |
|
| 1643 | + esc_html__( |
|
| 1644 | + 'A valid Transaction for this payment could not be retrieved.', |
|
| 1645 | + 'event_espresso' |
|
| 1646 | + ), |
|
| 1647 | + __FILE__, |
|
| 1648 | + __FUNCTION__, |
|
| 1649 | + __LINE__ |
|
| 1650 | + ); |
|
| 1651 | + } |
|
| 1652 | + } elseif ($has_access) { |
|
| 1653 | + EE_Error::add_error( |
|
| 1654 | + esc_html__( |
|
| 1655 | + 'The payment form data could not be processed. Please try again.', |
|
| 1656 | + 'event_espresso' |
|
| 1657 | + ), |
|
| 1658 | + __FILE__, |
|
| 1659 | + __FUNCTION__, |
|
| 1660 | + __LINE__ |
|
| 1661 | + ); |
|
| 1662 | + } else { |
|
| 1663 | + EE_Error::add_error( |
|
| 1664 | + esc_html__( |
|
| 1665 | + 'You do not have access to apply payments or refunds to a registration.', |
|
| 1666 | + 'event_espresso' |
|
| 1667 | + ), |
|
| 1668 | + __FILE__, |
|
| 1669 | + __FUNCTION__, |
|
| 1670 | + __LINE__ |
|
| 1671 | + ); |
|
| 1672 | + } |
|
| 1673 | + $notices = EE_Error::get_notices( |
|
| 1674 | + false, |
|
| 1675 | + false, |
|
| 1676 | + false |
|
| 1677 | + ); |
|
| 1678 | + $this->_template_args = array( |
|
| 1679 | + 'data' => $json_response_data, |
|
| 1680 | + 'error' => $notices['errors'], |
|
| 1681 | + 'success' => $notices['success'], |
|
| 1682 | + ); |
|
| 1683 | + $this->_return_json(); |
|
| 1684 | + } |
|
| 1685 | + |
|
| 1686 | + |
|
| 1687 | + /** |
|
| 1688 | + * _validate_payment_request_data |
|
| 1689 | + * |
|
| 1690 | + * @return array |
|
| 1691 | + * @throws EE_Error |
|
| 1692 | + * @throws InvalidArgumentException |
|
| 1693 | + * @throws InvalidDataTypeException |
|
| 1694 | + * @throws InvalidInterfaceException |
|
| 1695 | + */ |
|
| 1696 | + protected function _validate_payment_request_data() |
|
| 1697 | + { |
|
| 1698 | + if (! isset($this->_req_data['txn_admin_payment'])) { |
|
| 1699 | + return array(); |
|
| 1700 | + } |
|
| 1701 | + $payment_form = $this->_generate_payment_form_section(); |
|
| 1702 | + try { |
|
| 1703 | + if ($payment_form->was_submitted()) { |
|
| 1704 | + $payment_form->receive_form_submission(); |
|
| 1705 | + if (! $payment_form->is_valid()) { |
|
| 1706 | + $submission_error_messages = array(); |
|
| 1707 | + foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) { |
|
| 1708 | + if ($validation_error instanceof EE_Validation_Error) { |
|
| 1709 | + $submission_error_messages[] = sprintf( |
|
| 1710 | + _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'), |
|
| 1711 | + $validation_error->get_form_section()->html_label_text(), |
|
| 1712 | + $validation_error->getMessage() |
|
| 1713 | + ); |
|
| 1714 | + } |
|
| 1715 | + } |
|
| 1716 | + EE_Error::add_error( |
|
| 1717 | + implode('<br />', $submission_error_messages), |
|
| 1718 | + __FILE__, |
|
| 1719 | + __FUNCTION__, |
|
| 1720 | + __LINE__ |
|
| 1721 | + ); |
|
| 1722 | + return array(); |
|
| 1723 | + } |
|
| 1724 | + } |
|
| 1725 | + } catch (EE_Error $e) { |
|
| 1726 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1727 | + return array(); |
|
| 1728 | + } |
|
| 1729 | + |
|
| 1730 | + return $payment_form->valid_data(); |
|
| 1731 | + } |
|
| 1732 | + |
|
| 1733 | + |
|
| 1734 | + /** |
|
| 1735 | + * _generate_payment_form_section |
|
| 1736 | + * |
|
| 1737 | + * @return EE_Form_Section_Proper |
|
| 1738 | + * @throws EE_Error |
|
| 1739 | + */ |
|
| 1740 | + protected function _generate_payment_form_section() |
|
| 1741 | + { |
|
| 1742 | + return new EE_Form_Section_Proper( |
|
| 1743 | + array( |
|
| 1744 | + 'name' => 'txn_admin_payment', |
|
| 1745 | + 'subsections' => array( |
|
| 1746 | + 'PAY_ID' => new EE_Text_Input( |
|
| 1747 | + array( |
|
| 1748 | + 'default' => 0, |
|
| 1749 | + 'required' => false, |
|
| 1750 | + 'html_label_text' => esc_html__('Payment ID', 'event_espresso'), |
|
| 1751 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1752 | + ) |
|
| 1753 | + ), |
|
| 1754 | + 'TXN_ID' => new EE_Text_Input( |
|
| 1755 | + array( |
|
| 1756 | + 'default' => 0, |
|
| 1757 | + 'required' => true, |
|
| 1758 | + 'html_label_text' => esc_html__('Transaction ID', 'event_espresso'), |
|
| 1759 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1760 | + ) |
|
| 1761 | + ), |
|
| 1762 | + 'type' => new EE_Text_Input( |
|
| 1763 | + array( |
|
| 1764 | + 'default' => 1, |
|
| 1765 | + 'required' => true, |
|
| 1766 | + 'html_label_text' => esc_html__('Payment or Refund', 'event_espresso'), |
|
| 1767 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1768 | + ) |
|
| 1769 | + ), |
|
| 1770 | + 'amount' => new EE_Text_Input( |
|
| 1771 | + array( |
|
| 1772 | + 'default' => 0, |
|
| 1773 | + 'required' => true, |
|
| 1774 | + 'html_label_text' => esc_html__('Payment amount', 'event_espresso'), |
|
| 1775 | + 'validation_strategies' => array(new EE_Float_Normalization()), |
|
| 1776 | + ) |
|
| 1777 | + ), |
|
| 1778 | + 'status' => new EE_Text_Input( |
|
| 1779 | + array( |
|
| 1780 | + 'default' => EEM_Payment::status_id_approved, |
|
| 1781 | + 'required' => true, |
|
| 1782 | + 'html_label_text' => esc_html__('Payment status', 'event_espresso'), |
|
| 1783 | + ) |
|
| 1784 | + ), |
|
| 1785 | + 'PMD_ID' => new EE_Text_Input( |
|
| 1786 | + array( |
|
| 1787 | + 'default' => 2, |
|
| 1788 | + 'required' => true, |
|
| 1789 | + 'html_label_text' => esc_html__('Payment Method', 'event_espresso'), |
|
| 1790 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
| 1791 | + ) |
|
| 1792 | + ), |
|
| 1793 | + 'date' => new EE_Text_Input( |
|
| 1794 | + array( |
|
| 1795 | + 'default' => time(), |
|
| 1796 | + 'required' => true, |
|
| 1797 | + 'html_label_text' => esc_html__('Payment date', 'event_espresso'), |
|
| 1798 | + ) |
|
| 1799 | + ), |
|
| 1800 | + 'txn_id_chq_nmbr' => new EE_Text_Input( |
|
| 1801 | + array( |
|
| 1802 | + 'default' => '', |
|
| 1803 | + 'required' => false, |
|
| 1804 | + 'html_label_text' => esc_html__('Transaction or Cheque Number', 'event_espresso'), |
|
| 1805 | + 'validation_strategies' => array( |
|
| 1806 | + new EE_Max_Length_Validation_Strategy( |
|
| 1807 | + esc_html__('Input too long', 'event_espresso'), |
|
| 1808 | + 100 |
|
| 1809 | + ), |
|
| 1810 | + ), |
|
| 1811 | + ) |
|
| 1812 | + ), |
|
| 1813 | + 'po_number' => new EE_Text_Input( |
|
| 1814 | + array( |
|
| 1815 | + 'default' => '', |
|
| 1816 | + 'required' => false, |
|
| 1817 | + 'html_label_text' => esc_html__('Purchase Order Number', 'event_espresso'), |
|
| 1818 | + 'validation_strategies' => array( |
|
| 1819 | + new EE_Max_Length_Validation_Strategy( |
|
| 1820 | + esc_html__('Input too long', 'event_espresso'), |
|
| 1821 | + 100 |
|
| 1822 | + ), |
|
| 1823 | + ), |
|
| 1824 | + ) |
|
| 1825 | + ), |
|
| 1826 | + 'accounting' => new EE_Text_Input( |
|
| 1827 | + array( |
|
| 1828 | + 'default' => '', |
|
| 1829 | + 'required' => false, |
|
| 1830 | + 'html_label_text' => esc_html__('Extra Field for Accounting', 'event_espresso'), |
|
| 1831 | + 'validation_strategies' => array( |
|
| 1832 | + new EE_Max_Length_Validation_Strategy( |
|
| 1833 | + esc_html__('Input too long', 'event_espresso'), |
|
| 1834 | + 100 |
|
| 1835 | + ), |
|
| 1836 | + ), |
|
| 1837 | + ) |
|
| 1838 | + ), |
|
| 1839 | + ), |
|
| 1840 | + ) |
|
| 1841 | + ); |
|
| 1842 | + } |
|
| 1843 | + |
|
| 1844 | + |
|
| 1845 | + /** |
|
| 1846 | + * _create_payment_from_request_data |
|
| 1847 | + * |
|
| 1848 | + * @param array $valid_data |
|
| 1849 | + * @return EE_Payment |
|
| 1850 | + * @throws EE_Error |
|
| 1851 | + * @throws InvalidArgumentException |
|
| 1852 | + * @throws InvalidDataTypeException |
|
| 1853 | + * @throws InvalidInterfaceException |
|
| 1854 | + * @throws ReflectionException |
|
| 1855 | + */ |
|
| 1856 | + protected function _create_payment_from_request_data($valid_data) |
|
| 1857 | + { |
|
| 1858 | + $PAY_ID = $valid_data['PAY_ID']; |
|
| 1859 | + // get payment amount |
|
| 1860 | + $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0; |
|
| 1861 | + // payments have a type value of 1 and refunds have a type value of -1 |
|
| 1862 | + // so multiplying amount by type will give a positive value for payments, and negative values for refunds |
|
| 1863 | + $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount; |
|
| 1864 | + // for some reason the date string coming in has extra spaces between the date and time. This fixes that. |
|
| 1865 | + $date = $valid_data['date'] |
|
| 1866 | + ? preg_replace('/\s+/', ' ', $valid_data['date']) |
|
| 1867 | + : date('Y-m-d g:i a', current_time('timestamp')); |
|
| 1868 | + $payment = EE_Payment::new_instance( |
|
| 1869 | + array( |
|
| 1870 | + 'TXN_ID' => $valid_data['TXN_ID'], |
|
| 1871 | + 'STS_ID' => $valid_data['status'], |
|
| 1872 | + 'PAY_timestamp' => $date, |
|
| 1873 | + 'PAY_source' => EEM_Payment_Method::scope_admin, |
|
| 1874 | + 'PMD_ID' => $valid_data['PMD_ID'], |
|
| 1875 | + 'PAY_amount' => $amount, |
|
| 1876 | + 'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'], |
|
| 1877 | + 'PAY_po_number' => $valid_data['po_number'], |
|
| 1878 | + 'PAY_extra_accntng' => $valid_data['accounting'], |
|
| 1879 | + 'PAY_details' => $valid_data, |
|
| 1880 | + 'PAY_ID' => $PAY_ID, |
|
| 1881 | + ), |
|
| 1882 | + '', |
|
| 1883 | + array('Y-m-d', 'g:i a') |
|
| 1884 | + ); |
|
| 1885 | + |
|
| 1886 | + if (! $payment->save()) { |
|
| 1887 | + EE_Error::add_error( |
|
| 1888 | + sprintf( |
|
| 1889 | + esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'), |
|
| 1890 | + $payment->ID() |
|
| 1891 | + ), |
|
| 1892 | + __FILE__, |
|
| 1893 | + __FUNCTION__, |
|
| 1894 | + __LINE__ |
|
| 1895 | + ); |
|
| 1896 | + } |
|
| 1897 | + |
|
| 1898 | + return $payment; |
|
| 1899 | + } |
|
| 1900 | + |
|
| 1901 | + |
|
| 1902 | + /** |
|
| 1903 | + * _process_transaction_payments |
|
| 1904 | + * |
|
| 1905 | + * @param \EE_Transaction $transaction |
|
| 1906 | + * @return void |
|
| 1907 | + * @throws EE_Error |
|
| 1908 | + * @throws InvalidArgumentException |
|
| 1909 | + * @throws ReflectionException |
|
| 1910 | + * @throws InvalidDataTypeException |
|
| 1911 | + * @throws InvalidInterfaceException |
|
| 1912 | + */ |
|
| 1913 | + protected function _process_transaction_payments(EE_Transaction $transaction) |
|
| 1914 | + { |
|
| 1915 | + /** @type EE_Transaction_Payments $transaction_payments */ |
|
| 1916 | + $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
| 1917 | + // update the transaction with this payment |
|
| 1918 | + if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) { |
|
| 1919 | + EE_Error::add_success( |
|
| 1920 | + esc_html__( |
|
| 1921 | + 'The payment has been processed successfully.', |
|
| 1922 | + 'event_espresso' |
|
| 1923 | + ), |
|
| 1924 | + __FILE__, |
|
| 1925 | + __FUNCTION__, |
|
| 1926 | + __LINE__ |
|
| 1927 | + ); |
|
| 1928 | + } else { |
|
| 1929 | + EE_Error::add_error( |
|
| 1930 | + esc_html__( |
|
| 1931 | + 'The payment was processed successfully but the amount paid for the transaction was not updated.', |
|
| 1932 | + 'event_espresso' |
|
| 1933 | + ), |
|
| 1934 | + __FILE__, |
|
| 1935 | + __FUNCTION__, |
|
| 1936 | + __LINE__ |
|
| 1937 | + ); |
|
| 1938 | + } |
|
| 1939 | + } |
|
| 1940 | + |
|
| 1941 | + |
|
| 1942 | + /** |
|
| 1943 | + * _get_REG_IDs_to_apply_payment_to |
|
| 1944 | + * returns a list of registration IDs that the payment will apply to |
|
| 1945 | + * |
|
| 1946 | + * @param \EE_Payment $payment |
|
| 1947 | + * @return array |
|
| 1948 | + * @throws EE_Error |
|
| 1949 | + * @throws InvalidArgumentException |
|
| 1950 | + * @throws InvalidDataTypeException |
|
| 1951 | + * @throws InvalidInterfaceException |
|
| 1952 | + * @throws ReflectionException |
|
| 1953 | + */ |
|
| 1954 | + protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment) |
|
| 1955 | + { |
|
| 1956 | + $REG_IDs = array(); |
|
| 1957 | + // grab array of IDs for specific registrations to apply changes to |
|
| 1958 | + if (isset($this->_req_data['txn_admin_payment']['registrations'])) { |
|
| 1959 | + $REG_IDs = (array) $this->_req_data['txn_admin_payment']['registrations']; |
|
| 1960 | + } |
|
| 1961 | + // nothing specified ? then get all reg IDs |
|
| 1962 | + if (empty($REG_IDs)) { |
|
| 1963 | + $registrations = $payment->transaction()->registrations(); |
|
| 1964 | + $REG_IDs = ! empty($registrations) |
|
| 1965 | + ? array_keys($registrations) |
|
| 1966 | + : $this->_get_existing_reg_payment_REG_IDs($payment); |
|
| 1967 | + } |
|
| 1968 | + |
|
| 1969 | + // ensure that REG_IDs are integers and NOT strings |
|
| 1970 | + return array_map('intval', $REG_IDs); |
|
| 1971 | + } |
|
| 1972 | + |
|
| 1973 | + |
|
| 1974 | + /** |
|
| 1975 | + * @return array |
|
| 1976 | + */ |
|
| 1977 | + public function existing_reg_payment_REG_IDs() |
|
| 1978 | + { |
|
| 1979 | + return $this->_existing_reg_payment_REG_IDs; |
|
| 1980 | + } |
|
| 1981 | + |
|
| 1982 | + |
|
| 1983 | + /** |
|
| 1984 | + * @param array $existing_reg_payment_REG_IDs |
|
| 1985 | + */ |
|
| 1986 | + public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null) |
|
| 1987 | + { |
|
| 1988 | + $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs; |
|
| 1989 | + } |
|
| 1990 | + |
|
| 1991 | + |
|
| 1992 | + /** |
|
| 1993 | + * _get_existing_reg_payment_REG_IDs |
|
| 1994 | + * returns a list of registration IDs that the payment is currently related to |
|
| 1995 | + * as recorded in the database |
|
| 1996 | + * |
|
| 1997 | + * @param \EE_Payment $payment |
|
| 1998 | + * @return array |
|
| 1999 | + * @throws EE_Error |
|
| 2000 | + * @throws InvalidArgumentException |
|
| 2001 | + * @throws InvalidDataTypeException |
|
| 2002 | + * @throws InvalidInterfaceException |
|
| 2003 | + * @throws ReflectionException |
|
| 2004 | + */ |
|
| 2005 | + protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment) |
|
| 2006 | + { |
|
| 2007 | + if ($this->existing_reg_payment_REG_IDs() === null) { |
|
| 2008 | + // let's get any existing reg payment records for this payment |
|
| 2009 | + $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration'); |
|
| 2010 | + // but we only want the REG IDs, so grab the array keys |
|
| 2011 | + $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs) |
|
| 2012 | + ? array_keys($existing_reg_payment_REG_IDs) |
|
| 2013 | + : array(); |
|
| 2014 | + $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs); |
|
| 2015 | + } |
|
| 2016 | + |
|
| 2017 | + return $this->existing_reg_payment_REG_IDs(); |
|
| 2018 | + } |
|
| 2019 | + |
|
| 2020 | + |
|
| 2021 | + /** |
|
| 2022 | + * _remove_existing_registration_payments |
|
| 2023 | + * this calculates the difference between existing relations |
|
| 2024 | + * to the supplied payment and the new list registration IDs, |
|
| 2025 | + * removes any related registrations that no longer apply, |
|
| 2026 | + * and then updates the registration paid fields |
|
| 2027 | + * |
|
| 2028 | + * @param \EE_Payment $payment |
|
| 2029 | + * @param int $PAY_ID |
|
| 2030 | + * @return bool; |
|
| 2031 | + * @throws EE_Error |
|
| 2032 | + * @throws InvalidArgumentException |
|
| 2033 | + * @throws ReflectionException |
|
| 2034 | + * @throws InvalidDataTypeException |
|
| 2035 | + * @throws InvalidInterfaceException |
|
| 2036 | + */ |
|
| 2037 | + protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0) |
|
| 2038 | + { |
|
| 2039 | + // newly created payments will have nothing recorded for $PAY_ID |
|
| 2040 | + if (absint($PAY_ID) === 0) { |
|
| 2041 | + return false; |
|
| 2042 | + } |
|
| 2043 | + $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
| 2044 | + if (empty($existing_reg_payment_REG_IDs)) { |
|
| 2045 | + return false; |
|
| 2046 | + } |
|
| 2047 | + /** @type EE_Transaction_Payments $transaction_payments */ |
|
| 2048 | + $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
| 2049 | + |
|
| 2050 | + return $transaction_payments->delete_registration_payments_and_update_registrations( |
|
| 2051 | + $payment, |
|
| 2052 | + array( |
|
| 2053 | + array( |
|
| 2054 | + 'PAY_ID' => $payment->ID(), |
|
| 2055 | + 'REG_ID' => array('IN', $existing_reg_payment_REG_IDs), |
|
| 2056 | + ), |
|
| 2057 | + ) |
|
| 2058 | + ); |
|
| 2059 | + } |
|
| 2060 | + |
|
| 2061 | + |
|
| 2062 | + /** |
|
| 2063 | + * _update_registration_payments |
|
| 2064 | + * this applies the payments to the selected registrations |
|
| 2065 | + * but only if they have not already been paid for |
|
| 2066 | + * |
|
| 2067 | + * @param EE_Transaction $transaction |
|
| 2068 | + * @param \EE_Payment $payment |
|
| 2069 | + * @param array $REG_IDs |
|
| 2070 | + * @return void |
|
| 2071 | + * @throws EE_Error |
|
| 2072 | + * @throws InvalidArgumentException |
|
| 2073 | + * @throws ReflectionException |
|
| 2074 | + * @throws RuntimeException |
|
| 2075 | + * @throws InvalidDataTypeException |
|
| 2076 | + * @throws InvalidInterfaceException |
|
| 2077 | + */ |
|
| 2078 | + protected function _update_registration_payments( |
|
| 2079 | + EE_Transaction $transaction, |
|
| 2080 | + EE_Payment $payment, |
|
| 2081 | + $REG_IDs = array() |
|
| 2082 | + ) { |
|
| 2083 | + // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments() |
|
| 2084 | + // so let's do that using our set of REG_IDs from the form |
|
| 2085 | + $registration_query_where_params = array( |
|
| 2086 | + 'REG_ID' => array('IN', $REG_IDs), |
|
| 2087 | + ); |
|
| 2088 | + // but add in some conditions regarding payment, |
|
| 2089 | + // so that we don't apply payments to registrations that are free or have already been paid for |
|
| 2090 | + // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative ) |
|
| 2091 | + if (! $payment->is_a_refund()) { |
|
| 2092 | + $registration_query_where_params['REG_final_price'] = array('!=', 0); |
|
| 2093 | + $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true); |
|
| 2094 | + } |
|
| 2095 | + $registrations = $transaction->registrations(array($registration_query_where_params)); |
|
| 2096 | + if (! empty($registrations)) { |
|
| 2097 | + /** @type EE_Payment_Processor $payment_processor */ |
|
| 2098 | + $payment_processor = EE_Registry::instance()->load_core('Payment_Processor'); |
|
| 2099 | + $payment_processor->process_registration_payments($transaction, $payment, $registrations); |
|
| 2100 | + } |
|
| 2101 | + } |
|
| 2102 | + |
|
| 2103 | + |
|
| 2104 | + /** |
|
| 2105 | + * _process_registration_status_change |
|
| 2106 | + * This processes requested registration status changes for all the registrations |
|
| 2107 | + * on a given transaction and (optionally) sends out notifications for the changes. |
|
| 2108 | + * |
|
| 2109 | + * @param EE_Transaction $transaction |
|
| 2110 | + * @param array $REG_IDs |
|
| 2111 | + * @return bool |
|
| 2112 | + * @throws EE_Error |
|
| 2113 | + * @throws InvalidArgumentException |
|
| 2114 | + * @throws ReflectionException |
|
| 2115 | + * @throws InvalidDataTypeException |
|
| 2116 | + * @throws InvalidInterfaceException |
|
| 2117 | + */ |
|
| 2118 | + protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array()) |
|
| 2119 | + { |
|
| 2120 | + // first if there is no change in status then we get out. |
|
| 2121 | + if (! isset($this->_req_data['txn_reg_status_change']['reg_status']) |
|
| 2122 | + || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN' |
|
| 2123 | + ) { |
|
| 2124 | + // no error message, no change requested, just nothing to do man. |
|
| 2125 | + return false; |
|
| 2126 | + } |
|
| 2127 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 2128 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 2129 | + |
|
| 2130 | + // made it here dude? Oh WOW. K, let's take care of changing the statuses |
|
| 2131 | + return $transaction_processor->manually_update_registration_statuses( |
|
| 2132 | + $transaction, |
|
| 2133 | + sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']), |
|
| 2134 | + array(array('REG_ID' => array('IN', $REG_IDs))) |
|
| 2135 | + ); |
|
| 2136 | + } |
|
| 2137 | + |
|
| 2138 | + |
|
| 2139 | + /** |
|
| 2140 | + * _build_payment_json_response |
|
| 2141 | + * |
|
| 2142 | + * @access public |
|
| 2143 | + * @param \EE_Payment $payment |
|
| 2144 | + * @param array $REG_IDs |
|
| 2145 | + * @param bool | null $delete_txn_reg_status_change |
|
| 2146 | + * @return array |
|
| 2147 | + * @throws EE_Error |
|
| 2148 | + * @throws InvalidArgumentException |
|
| 2149 | + * @throws InvalidDataTypeException |
|
| 2150 | + * @throws InvalidInterfaceException |
|
| 2151 | + * @throws ReflectionException |
|
| 2152 | + */ |
|
| 2153 | + protected function _build_payment_json_response( |
|
| 2154 | + EE_Payment $payment, |
|
| 2155 | + $REG_IDs = array(), |
|
| 2156 | + $delete_txn_reg_status_change = null |
|
| 2157 | + ) { |
|
| 2158 | + // was the payment deleted ? |
|
| 2159 | + if (is_bool($delete_txn_reg_status_change)) { |
|
| 2160 | + return array( |
|
| 2161 | + 'PAY_ID' => $payment->ID(), |
|
| 2162 | + 'amount' => $payment->amount(), |
|
| 2163 | + 'total_paid' => $payment->transaction()->paid(), |
|
| 2164 | + 'txn_status' => $payment->transaction()->status_ID(), |
|
| 2165 | + 'pay_status' => $payment->STS_ID(), |
|
| 2166 | + 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
| 2167 | + 'delete_txn_reg_status_change' => $delete_txn_reg_status_change, |
|
| 2168 | + ); |
|
| 2169 | + } else { |
|
| 2170 | + $this->_get_payment_status_array(); |
|
| 2171 | + |
|
| 2172 | + return array( |
|
| 2173 | + 'amount' => $payment->amount(), |
|
| 2174 | + 'total_paid' => $payment->transaction()->paid(), |
|
| 2175 | + 'txn_status' => $payment->transaction()->status_ID(), |
|
| 2176 | + 'pay_status' => $payment->STS_ID(), |
|
| 2177 | + 'PAY_ID' => $payment->ID(), |
|
| 2178 | + 'STS_ID' => $payment->STS_ID(), |
|
| 2179 | + 'status' => self::$_pay_status[ $payment->STS_ID() ], |
|
| 2180 | + 'date' => $payment->timestamp('Y-m-d', 'h:i a'), |
|
| 2181 | + 'method' => strtoupper($payment->source()), |
|
| 2182 | + 'PM_ID' => $payment->payment_method() ? $payment->payment_method()->ID() : 1, |
|
| 2183 | + 'gateway' => $payment->payment_method() |
|
| 2184 | + ? $payment->payment_method()->admin_name() |
|
| 2185 | + : esc_html__('Unknown', 'event_espresso'), |
|
| 2186 | + 'gateway_response' => $payment->gateway_response(), |
|
| 2187 | + 'txn_id_chq_nmbr' => $payment->txn_id_chq_nmbr(), |
|
| 2188 | + 'po_number' => $payment->po_number(), |
|
| 2189 | + 'extra_accntng' => $payment->extra_accntng(), |
|
| 2190 | + 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
| 2191 | + ); |
|
| 2192 | + } |
|
| 2193 | + } |
|
| 2194 | + |
|
| 2195 | + |
|
| 2196 | + /** |
|
| 2197 | + * delete_payment |
|
| 2198 | + * delete a payment or refund made towards a transaction |
|
| 2199 | + * |
|
| 2200 | + * @access public |
|
| 2201 | + * @return void |
|
| 2202 | + * @throws EE_Error |
|
| 2203 | + * @throws InvalidArgumentException |
|
| 2204 | + * @throws ReflectionException |
|
| 2205 | + * @throws InvalidDataTypeException |
|
| 2206 | + * @throws InvalidInterfaceException |
|
| 2207 | + */ |
|
| 2208 | + public function delete_payment() |
|
| 2209 | + { |
|
| 2210 | + $json_response_data = array('return_data' => false); |
|
| 2211 | + $PAY_ID = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
| 2212 | + ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
| 2213 | + : 0; |
|
| 2214 | + $can_delete = EE_Registry::instance()->CAP->current_user_can( |
|
| 2215 | + 'ee_delete_payments', |
|
| 2216 | + 'delete_payment_from_registration_details' |
|
| 2217 | + ); |
|
| 2218 | + if ($PAY_ID && $can_delete) { |
|
| 2219 | + $delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change']) |
|
| 2220 | + ? $this->_req_data['delete_txn_reg_status_change'] |
|
| 2221 | + : false; |
|
| 2222 | + $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID); |
|
| 2223 | + if ($payment instanceof EE_Payment) { |
|
| 2224 | + $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
| 2225 | + /** @type EE_Transaction_Payments $transaction_payments */ |
|
| 2226 | + $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
| 2227 | + if ($transaction_payments->delete_payment_and_update_transaction($payment)) { |
|
| 2228 | + $json_response_data['return_data'] = $this->_build_payment_json_response( |
|
| 2229 | + $payment, |
|
| 2230 | + $REG_IDs, |
|
| 2231 | + $delete_txn_reg_status_change |
|
| 2232 | + ); |
|
| 2233 | + if ($delete_txn_reg_status_change) { |
|
| 2234 | + $this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
| 2235 | + // MAKE sure we also add the delete_txn_req_status_change to the |
|
| 2236 | + // $_REQUEST global because that's how messages will be looking for it. |
|
| 2237 | + $_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
| 2238 | + $this->_maybe_send_notifications(); |
|
| 2239 | + $this->_process_registration_status_change($payment->transaction(), $REG_IDs); |
|
| 2240 | + } |
|
| 2241 | + } |
|
| 2242 | + } else { |
|
| 2243 | + EE_Error::add_error( |
|
| 2244 | + esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'), |
|
| 2245 | + __FILE__, |
|
| 2246 | + __FUNCTION__, |
|
| 2247 | + __LINE__ |
|
| 2248 | + ); |
|
| 2249 | + } |
|
| 2250 | + } elseif ($can_delete) { |
|
| 2251 | + EE_Error::add_error( |
|
| 2252 | + esc_html__( |
|
| 2253 | + 'A valid Payment ID was not received, therefore payment form data could not be loaded.', |
|
| 2254 | + 'event_espresso' |
|
| 2255 | + ), |
|
| 2256 | + __FILE__, |
|
| 2257 | + __FUNCTION__, |
|
| 2258 | + __LINE__ |
|
| 2259 | + ); |
|
| 2260 | + } else { |
|
| 2261 | + EE_Error::add_error( |
|
| 2262 | + esc_html__( |
|
| 2263 | + 'You do not have access to delete a payment.', |
|
| 2264 | + 'event_espresso' |
|
| 2265 | + ), |
|
| 2266 | + __FILE__, |
|
| 2267 | + __FUNCTION__, |
|
| 2268 | + __LINE__ |
|
| 2269 | + ); |
|
| 2270 | + } |
|
| 2271 | + $notices = EE_Error::get_notices(false, false, false); |
|
| 2272 | + $this->_template_args = array( |
|
| 2273 | + 'data' => $json_response_data, |
|
| 2274 | + 'success' => $notices['success'], |
|
| 2275 | + 'error' => $notices['errors'], |
|
| 2276 | + 'attention' => $notices['attention'], |
|
| 2277 | + ); |
|
| 2278 | + $this->_return_json(); |
|
| 2279 | + } |
|
| 2280 | + |
|
| 2281 | + |
|
| 2282 | + /** |
|
| 2283 | + * _registration_payment_data_array |
|
| 2284 | + * adds info for 'owing' and 'paid' for each registration to the json response |
|
| 2285 | + * |
|
| 2286 | + * @access protected |
|
| 2287 | + * @param array $REG_IDs |
|
| 2288 | + * @return array |
|
| 2289 | + * @throws EE_Error |
|
| 2290 | + * @throws InvalidArgumentException |
|
| 2291 | + * @throws InvalidDataTypeException |
|
| 2292 | + * @throws InvalidInterfaceException |
|
| 2293 | + * @throws ReflectionException |
|
| 2294 | + */ |
|
| 2295 | + protected function _registration_payment_data_array($REG_IDs) |
|
| 2296 | + { |
|
| 2297 | + $registration_payment_data = array(); |
|
| 2298 | + // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows. |
|
| 2299 | + if (! empty($REG_IDs)) { |
|
| 2300 | + $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs)))); |
|
| 2301 | + foreach ($registrations as $registration) { |
|
| 2302 | + if ($registration instanceof EE_Registration) { |
|
| 2303 | + $registration_payment_data[ $registration->ID() ] = array( |
|
| 2304 | + 'paid' => $registration->pretty_paid(), |
|
| 2305 | + 'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()), |
|
| 2306 | + ); |
|
| 2307 | + } |
|
| 2308 | + } |
|
| 2309 | + } |
|
| 2310 | + |
|
| 2311 | + return $registration_payment_data; |
|
| 2312 | + } |
|
| 2313 | + |
|
| 2314 | + |
|
| 2315 | + /** |
|
| 2316 | + * _maybe_send_notifications |
|
| 2317 | + * determines whether or not the admin has indicated that notifications should be sent. |
|
| 2318 | + * If so, will toggle a filter switch for delivering registration notices. |
|
| 2319 | + * If passed an EE_Payment object, then it will trigger payment notifications instead. |
|
| 2320 | + * |
|
| 2321 | + * @access protected |
|
| 2322 | + * @param \EE_Payment | null $payment |
|
| 2323 | + */ |
|
| 2324 | + protected function _maybe_send_notifications($payment = null) |
|
| 2325 | + { |
|
| 2326 | + switch ($payment instanceof EE_Payment) { |
|
| 2327 | + // payment notifications |
|
| 2328 | + case true: |
|
| 2329 | + if (isset($this->_req_data['txn_payments']['send_notifications']) |
|
| 2330 | + && filter_var( |
|
| 2331 | + $this->_req_data['txn_payments']['send_notifications'], |
|
| 2332 | + FILTER_VALIDATE_BOOLEAN |
|
| 2333 | + ) |
|
| 2334 | + ) { |
|
| 2335 | + $this->_process_payment_notification($payment); |
|
| 2336 | + } |
|
| 2337 | + break; |
|
| 2338 | + // registration notifications |
|
| 2339 | + case false: |
|
| 2340 | + if (isset($this->_req_data['txn_reg_status_change']['send_notifications']) |
|
| 2341 | + && filter_var( |
|
| 2342 | + $this->_req_data['txn_reg_status_change']['send_notifications'], |
|
| 2343 | + FILTER_VALIDATE_BOOLEAN |
|
| 2344 | + ) |
|
| 2345 | + ) { |
|
| 2346 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true'); |
|
| 2347 | + } |
|
| 2348 | + break; |
|
| 2349 | + } |
|
| 2350 | + } |
|
| 2351 | + |
|
| 2352 | + |
|
| 2353 | + /** |
|
| 2354 | + * _send_payment_reminder |
|
| 2355 | + * generates HTML for the View Transaction Details Admin page |
|
| 2356 | + * |
|
| 2357 | + * @access protected |
|
| 2358 | + * @return void |
|
| 2359 | + * @throws EE_Error |
|
| 2360 | + * @throws InvalidArgumentException |
|
| 2361 | + * @throws InvalidDataTypeException |
|
| 2362 | + * @throws InvalidInterfaceException |
|
| 2363 | + */ |
|
| 2364 | + protected function _send_payment_reminder() |
|
| 2365 | + { |
|
| 2366 | + $TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false; |
|
| 2367 | + $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
| 2368 | + $query_args = isset($this->_req_data['redirect_to']) ? array( |
|
| 2369 | + 'action' => $this->_req_data['redirect_to'], |
|
| 2370 | + 'TXN_ID' => $this->_req_data['TXN_ID'], |
|
| 2371 | + ) : array(); |
|
| 2372 | + do_action( |
|
| 2373 | + 'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder', |
|
| 2374 | + $transaction |
|
| 2375 | + ); |
|
| 2376 | + $this->_redirect_after_action( |
|
| 2377 | + false, |
|
| 2378 | + esc_html__('payment reminder', 'event_espresso'), |
|
| 2379 | + esc_html__('sent', 'event_espresso'), |
|
| 2380 | + $query_args, |
|
| 2381 | + true |
|
| 2382 | + ); |
|
| 2383 | + } |
|
| 2384 | + |
|
| 2385 | + |
|
| 2386 | + /** |
|
| 2387 | + * get_transactions |
|
| 2388 | + * get transactions for given parameters (used by list table) |
|
| 2389 | + * |
|
| 2390 | + * @param int $perpage how many transactions displayed per page |
|
| 2391 | + * @param boolean $count return the count or objects |
|
| 2392 | + * @param string $view |
|
| 2393 | + * @return mixed int = count || array of transaction objects |
|
| 2394 | + * @throws EE_Error |
|
| 2395 | + * @throws InvalidArgumentException |
|
| 2396 | + * @throws InvalidDataTypeException |
|
| 2397 | + * @throws InvalidInterfaceException |
|
| 2398 | + */ |
|
| 2399 | + public function get_transactions($perpage, $count = false, $view = '') |
|
| 2400 | + { |
|
| 2401 | + |
|
| 2402 | + $TXN = EEM_Transaction::instance(); |
|
| 2403 | + |
|
| 2404 | + $start_date = isset($this->_req_data['txn-filter-start-date']) |
|
| 2405 | + ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) |
|
| 2406 | + : date( |
|
| 2407 | + 'm/d/Y', |
|
| 2408 | + strtotime('-10 year') |
|
| 2409 | + ); |
|
| 2410 | + $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
| 2411 | + ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) |
|
| 2412 | + : date('m/d/Y'); |
|
| 2413 | + |
|
| 2414 | + // make sure our timestamps start and end right at the boundaries for each day |
|
| 2415 | + $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
| 2416 | + $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
| 2417 | + |
|
| 2418 | + |
|
| 2419 | + // convert to timestamps |
|
| 2420 | + $start_date = strtotime($start_date); |
|
| 2421 | + $end_date = strtotime($end_date); |
|
| 2422 | + |
|
| 2423 | + // makes sure start date is the lowest value and vice versa |
|
| 2424 | + $start_date = min($start_date, $end_date); |
|
| 2425 | + $end_date = max($start_date, $end_date); |
|
| 2426 | + |
|
| 2427 | + // convert to correct format for query |
|
| 2428 | + $start_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
| 2429 | + 'TXN_timestamp', |
|
| 2430 | + date('Y-m-d H:i:s', $start_date), |
|
| 2431 | + 'Y-m-d H:i:s' |
|
| 2432 | + ); |
|
| 2433 | + $end_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
| 2434 | + 'TXN_timestamp', |
|
| 2435 | + date('Y-m-d H:i:s', $end_date), |
|
| 2436 | + 'Y-m-d H:i:s' |
|
| 2437 | + ); |
|
| 2438 | + |
|
| 2439 | + |
|
| 2440 | + // set orderby |
|
| 2441 | + $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
| 2442 | + |
|
| 2443 | + switch ($this->_req_data['orderby']) { |
|
| 2444 | + case 'TXN_ID': |
|
| 2445 | + $orderby = 'TXN_ID'; |
|
| 2446 | + break; |
|
| 2447 | + case 'ATT_fname': |
|
| 2448 | + $orderby = 'Registration.Attendee.ATT_fname'; |
|
| 2449 | + break; |
|
| 2450 | + case 'event_name': |
|
| 2451 | + $orderby = 'Registration.Event.EVT_name'; |
|
| 2452 | + break; |
|
| 2453 | + default: // 'TXN_timestamp' |
|
| 2454 | + $orderby = 'TXN_timestamp'; |
|
| 2455 | + } |
|
| 2456 | + |
|
| 2457 | + $sort = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC'; |
|
| 2458 | + $current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1; |
|
| 2459 | + $per_page = ! empty($perpage) ? $perpage : 10; |
|
| 2460 | + $per_page = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page; |
|
| 2461 | + |
|
| 2462 | + $offset = ($current_page - 1) * $per_page; |
|
| 2463 | + $limit = array($offset, $per_page); |
|
| 2464 | + |
|
| 2465 | + $_where = array( |
|
| 2466 | + 'TXN_timestamp' => array('BETWEEN', array($start_date, $end_date)), |
|
| 2467 | + 'Registration.REG_count' => 1, |
|
| 2468 | + ); |
|
| 2469 | + |
|
| 2470 | + if (isset($this->_req_data['EVT_ID'])) { |
|
| 2471 | + $_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID']; |
|
| 2472 | + } |
|
| 2473 | + |
|
| 2474 | + if (isset($this->_req_data['s'])) { |
|
| 2475 | + $search_string = '%' . $this->_req_data['s'] . '%'; |
|
| 2476 | + $_where['OR'] = array( |
|
| 2477 | + 'Registration.Event.EVT_name' => array('LIKE', $search_string), |
|
| 2478 | + 'Registration.Event.EVT_desc' => array('LIKE', $search_string), |
|
| 2479 | + 'Registration.Event.EVT_short_desc' => array('LIKE', $search_string), |
|
| 2480 | + 'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
| 2481 | + 'Registration.Attendee.ATT_fname' => array('LIKE', $search_string), |
|
| 2482 | + 'Registration.Attendee.ATT_lname' => array('LIKE', $search_string), |
|
| 2483 | + 'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
| 2484 | + 'Registration.Attendee.ATT_email' => array('LIKE', $search_string), |
|
| 2485 | + 'Registration.Attendee.ATT_address' => array('LIKE', $search_string), |
|
| 2486 | + 'Registration.Attendee.ATT_address2' => array('LIKE', $search_string), |
|
| 2487 | + 'Registration.Attendee.ATT_city' => array('LIKE', $search_string), |
|
| 2488 | + 'Registration.REG_final_price' => array('LIKE', $search_string), |
|
| 2489 | + 'Registration.REG_code' => array('LIKE', $search_string), |
|
| 2490 | + 'Registration.REG_count' => array('LIKE', $search_string), |
|
| 2491 | + 'Registration.REG_group_size' => array('LIKE', $search_string), |
|
| 2492 | + 'Registration.Ticket.TKT_name' => array('LIKE', $search_string), |
|
| 2493 | + 'Registration.Ticket.TKT_description' => array('LIKE', $search_string), |
|
| 2494 | + 'Payment.PAY_source' => array('LIKE', $search_string), |
|
| 2495 | + 'Payment.Payment_Method.PMD_name' => array('LIKE', $search_string), |
|
| 2496 | + 'TXN_session_data' => array('LIKE', $search_string), |
|
| 2497 | + 'Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
| 2498 | + ); |
|
| 2499 | + } |
|
| 2500 | + |
|
| 2501 | + // failed transactions |
|
| 2502 | + $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
| 2503 | + || ($count && $view === 'failed'); |
|
| 2504 | + $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
| 2505 | + || ($count && $view === 'abandoned'); |
|
| 2506 | + $incomplete = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'incomplete' && ! $count) |
|
| 2507 | + || ($count && $view === 'incomplete'); |
|
| 2508 | + |
|
| 2509 | + if ($failed) { |
|
| 2510 | + $_where['STS_ID'] = EEM_Transaction::failed_status_code; |
|
| 2511 | + } elseif ($abandoned) { |
|
| 2512 | + $_where['STS_ID'] = EEM_Transaction::abandoned_status_code; |
|
| 2513 | + } elseif ($incomplete) { |
|
| 2514 | + $_where['STS_ID'] = EEM_Transaction::incomplete_status_code; |
|
| 2515 | + } else { |
|
| 2516 | + $_where['STS_ID'] = array('!=', EEM_Transaction::failed_status_code); |
|
| 2517 | + $_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code); |
|
| 2518 | + } |
|
| 2519 | + |
|
| 2520 | + $query_params = apply_filters( |
|
| 2521 | + 'FHEE__Transactions_Admin_Page___get_transactions_query_params', |
|
| 2522 | + array( |
|
| 2523 | + $_where, |
|
| 2524 | + 'order_by' => array($orderby => $sort), |
|
| 2525 | + 'limit' => $limit, |
|
| 2526 | + 'default_where_conditions' => EEM_Base::default_where_conditions_this_only, |
|
| 2527 | + ), |
|
| 2528 | + $this->_req_data, |
|
| 2529 | + $view, |
|
| 2530 | + $count |
|
| 2531 | + ); |
|
| 2532 | + |
|
| 2533 | + $transactions = $count |
|
| 2534 | + ? $TXN->count(array($query_params[0]), 'TXN_ID', true) |
|
| 2535 | + : $TXN->get_all($query_params); |
|
| 2536 | + |
|
| 2537 | + return $transactions; |
|
| 2538 | + } |
|
| 2539 | + |
|
| 2540 | + |
|
| 2541 | + /** |
|
| 2542 | + * @since $VID:$ |
|
| 2543 | + * @throws EE_Error |
|
| 2544 | + * @throws InvalidArgumentException |
|
| 2545 | + * @throws InvalidDataTypeException |
|
| 2546 | + * @throws InvalidInterfaceException |
|
| 2547 | + * @throws ReflectionException |
|
| 2548 | + * @throws RuntimeException |
|
| 2549 | + */ |
|
| 2550 | + public function recalculateLineItems() |
|
| 2551 | + { |
|
| 2552 | + $TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false; |
|
| 2553 | + /** @var EE_Transaction $transaction */ |
|
| 2554 | + $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
| 2555 | + $total_line_item = $transaction->total_line_item(false); |
|
| 2556 | + $success = false; |
|
| 2557 | + if ($total_line_item instanceof EE_Line_Item) { |
|
| 2558 | + EEH_Line_Item::resetIsTaxableForTickets($total_line_item); |
|
| 2559 | + $success = EEH_Line_Item::apply_taxes($total_line_item, true); |
|
| 2560 | + } |
|
| 2561 | + $this->_redirect_after_action( |
|
| 2562 | + (bool) $success, |
|
| 2563 | + esc_html__('Transaction taxes and totals', 'event_espresso'), |
|
| 2564 | + esc_html__('recalculated', 'event_espresso'), |
|
| 2565 | + isset($this->_req_data['redirect_to']) |
|
| 2566 | + ? array( |
|
| 2567 | + 'action' => $this->_req_data['redirect_to'], |
|
| 2568 | + 'TXN_ID' => $this->_req_data['TXN_ID'], |
|
| 2569 | + ) |
|
| 2570 | + : array(), |
|
| 2571 | + true |
|
| 2572 | + ); |
|
| 2573 | + } |
|
| 2574 | 2574 | } |
@@ -366,7 +366,7 @@ discard block |
||
| 366 | 366 | |
| 367 | 367 | |
| 368 | 368 | /** |
| 369 | - * @return mixed|null |
|
| 369 | + * @return EE_Cart|null |
|
| 370 | 370 | * @throws EE_Error |
| 371 | 371 | * @throws InvalidArgumentException |
| 372 | 372 | * @throws InvalidDataTypeException |
@@ -508,7 +508,7 @@ discard block |
||
| 508 | 508 | * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event |
| 509 | 509 | * function for getting attendees and how many registrations they each have for an event) |
| 510 | 510 | * |
| 511 | - * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT' |
|
| 511 | + * @return EE_Base_Class[] EE_Attendee[] by default, int if $output is set to 'COUNT' |
|
| 512 | 512 | * @throws EE_Error |
| 513 | 513 | * @throws InvalidArgumentException |
| 514 | 514 | * @throws InvalidDataTypeException |
@@ -564,7 +564,7 @@ discard block |
||
| 564 | 564 | /** |
| 565 | 565 | * Gets all payments which have not been approved |
| 566 | 566 | * |
| 567 | - * @return EE_Base_Class[]|EEI_Payment[] |
|
| 567 | + * @return EE_Base_Class[] |
|
| 568 | 568 | * @throws EE_Error if a model is misconfigured somehow |
| 569 | 569 | * @throws InvalidArgumentException |
| 570 | 570 | * @throws InvalidDataTypeException |
@@ -13,1682 +13,1682 @@ |
||
| 13 | 13 | class EE_Transaction extends EE_Base_Class implements EEI_Transaction |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * The length of time in seconds that a lock is applied before being considered expired. |
|
| 18 | - * It is not long because a transaction should only be locked for the duration of the request that locked it |
|
| 19 | - */ |
|
| 20 | - const LOCK_EXPIRATION = 2; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * txn status upon initial construction. |
|
| 24 | - * |
|
| 25 | - * @var string |
|
| 26 | - */ |
|
| 27 | - protected $_old_txn_status; |
|
| 28 | - |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @param array $props_n_values incoming values |
|
| 32 | - * @param string $timezone incoming timezone |
|
| 33 | - * (if not set the timezone set for the website will be used.) |
|
| 34 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 35 | - * date_format and the second value is the time format |
|
| 36 | - * @return EE_Transaction |
|
| 37 | - * @throws EE_Error |
|
| 38 | - * @throws InvalidArgumentException |
|
| 39 | - * @throws InvalidDataTypeException |
|
| 40 | - * @throws InvalidInterfaceException |
|
| 41 | - * @throws ReflectionException |
|
| 42 | - */ |
|
| 43 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 44 | - { |
|
| 45 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
| 46 | - $txn = $has_object |
|
| 47 | - ? $has_object |
|
| 48 | - : new self($props_n_values, false, $timezone, $date_formats); |
|
| 49 | - if (! $has_object) { |
|
| 50 | - $txn->set_old_txn_status($txn->status_ID()); |
|
| 51 | - } |
|
| 52 | - return $txn; |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @param array $props_n_values incoming values from the database |
|
| 58 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 59 | - * the website will be used. |
|
| 60 | - * @return EE_Transaction |
|
| 61 | - * @throws EE_Error |
|
| 62 | - * @throws InvalidArgumentException |
|
| 63 | - * @throws InvalidDataTypeException |
|
| 64 | - * @throws InvalidInterfaceException |
|
| 65 | - * @throws ReflectionException |
|
| 66 | - */ |
|
| 67 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 68 | - { |
|
| 69 | - $txn = new self($props_n_values, true, $timezone); |
|
| 70 | - $txn->set_old_txn_status($txn->status_ID()); |
|
| 71 | - return $txn; |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * Sets a meta field indicating that this TXN is locked and should not be updated in the db. |
|
| 77 | - * If a lock has already been set, then we will attempt to remove it in case it has expired. |
|
| 78 | - * If that also fails, then an exception is thrown. |
|
| 79 | - * |
|
| 80 | - * @throws EE_Error |
|
| 81 | - * @throws InvalidArgumentException |
|
| 82 | - * @throws InvalidDataTypeException |
|
| 83 | - * @throws InvalidInterfaceException |
|
| 84 | - * @throws ReflectionException |
|
| 85 | - */ |
|
| 86 | - public function lock() |
|
| 87 | - { |
|
| 88 | - // attempt to set lock, but if that fails... |
|
| 89 | - if (! $this->add_extra_meta('lock', time(), true)) { |
|
| 90 | - // then attempt to remove the lock in case it is expired |
|
| 91 | - if ($this->_remove_expired_lock()) { |
|
| 92 | - // if removal was successful, then try setting lock again |
|
| 93 | - $this->lock(); |
|
| 94 | - } else { |
|
| 95 | - // but if the lock can not be removed, then throw an exception |
|
| 96 | - throw new EE_Error( |
|
| 97 | - sprintf( |
|
| 98 | - __( |
|
| 99 | - 'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.', |
|
| 100 | - 'event_espresso' |
|
| 101 | - ), |
|
| 102 | - $this->ID() |
|
| 103 | - ) |
|
| 104 | - ); |
|
| 105 | - } |
|
| 106 | - } |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * removes transaction lock applied in EE_Transaction::lock() |
|
| 112 | - * |
|
| 113 | - * @return int |
|
| 114 | - * @throws EE_Error |
|
| 115 | - * @throws InvalidArgumentException |
|
| 116 | - * @throws InvalidDataTypeException |
|
| 117 | - * @throws InvalidInterfaceException |
|
| 118 | - * @throws ReflectionException |
|
| 119 | - */ |
|
| 120 | - public function unlock() |
|
| 121 | - { |
|
| 122 | - return $this->delete_extra_meta('lock'); |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Decides whether or not now is the right time to update the transaction. |
|
| 128 | - * This is useful because we don't always know if it is safe to update the transaction |
|
| 129 | - * and its related data. why? |
|
| 130 | - * because it's possible that the transaction is being used in another |
|
| 131 | - * request and could overwrite anything we save. |
|
| 132 | - * So we want to only update the txn once we know that won't happen. |
|
| 133 | - * We also check that the lock isn't expired, and remove it if it is |
|
| 134 | - * |
|
| 135 | - * @return boolean |
|
| 136 | - * @throws EE_Error |
|
| 137 | - * @throws InvalidArgumentException |
|
| 138 | - * @throws InvalidDataTypeException |
|
| 139 | - * @throws InvalidInterfaceException |
|
| 140 | - * @throws ReflectionException |
|
| 141 | - */ |
|
| 142 | - public function is_locked() |
|
| 143 | - { |
|
| 144 | - // if TXN is not locked, then return false immediately |
|
| 145 | - if (! $this->_get_lock()) { |
|
| 146 | - return false; |
|
| 147 | - } |
|
| 148 | - // if not, then let's try and remove the lock in case it's expired... |
|
| 149 | - // _remove_expired_lock() returns 0 when lock is valid (ie: removed = false) |
|
| 150 | - // and a positive number if the lock was removed (ie: number of locks deleted), |
|
| 151 | - // so we need to return the opposite |
|
| 152 | - return ! $this->_remove_expired_lock() ? true : false; |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Gets the meta field indicating that this TXN is locked |
|
| 158 | - * |
|
| 159 | - * @return int |
|
| 160 | - * @throws EE_Error |
|
| 161 | - * @throws InvalidArgumentException |
|
| 162 | - * @throws InvalidDataTypeException |
|
| 163 | - * @throws InvalidInterfaceException |
|
| 164 | - * @throws ReflectionException |
|
| 165 | - */ |
|
| 166 | - protected function _get_lock() |
|
| 167 | - { |
|
| 168 | - return (int) $this->get_extra_meta('lock', true, 0); |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated |
|
| 174 | - * |
|
| 175 | - * @return int |
|
| 176 | - * @throws EE_Error |
|
| 177 | - * @throws InvalidArgumentException |
|
| 178 | - * @throws InvalidDataTypeException |
|
| 179 | - * @throws InvalidInterfaceException |
|
| 180 | - * @throws ReflectionException |
|
| 181 | - */ |
|
| 182 | - protected function _remove_expired_lock() |
|
| 183 | - { |
|
| 184 | - $locked = $this->_get_lock(); |
|
| 185 | - if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) { |
|
| 186 | - return $this->unlock(); |
|
| 187 | - } |
|
| 188 | - return 0; |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Set transaction total |
|
| 194 | - * |
|
| 195 | - * @param float $total total value of transaction |
|
| 196 | - * @throws EE_Error |
|
| 197 | - * @throws InvalidArgumentException |
|
| 198 | - * @throws InvalidDataTypeException |
|
| 199 | - * @throws InvalidInterfaceException |
|
| 200 | - * @throws ReflectionException |
|
| 201 | - */ |
|
| 202 | - public function set_total($total = 0.00) |
|
| 203 | - { |
|
| 204 | - $this->set('TXN_total', (float) $total); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * Set Total Amount Paid to Date |
|
| 210 | - * |
|
| 211 | - * @param float $total_paid total amount paid to date (sum of all payments) |
|
| 212 | - * @throws EE_Error |
|
| 213 | - * @throws InvalidArgumentException |
|
| 214 | - * @throws InvalidDataTypeException |
|
| 215 | - * @throws InvalidInterfaceException |
|
| 216 | - * @throws ReflectionException |
|
| 217 | - */ |
|
| 218 | - public function set_paid($total_paid = 0.00) |
|
| 219 | - { |
|
| 220 | - $this->set('TXN_paid', (float) $total_paid); |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - |
|
| 224 | - /** |
|
| 225 | - * Set transaction status |
|
| 226 | - * |
|
| 227 | - * @param string $status whether the transaction is open, declined, accepted, |
|
| 228 | - * or any number of custom values that can be set |
|
| 229 | - * @throws EE_Error |
|
| 230 | - * @throws InvalidArgumentException |
|
| 231 | - * @throws InvalidDataTypeException |
|
| 232 | - * @throws InvalidInterfaceException |
|
| 233 | - * @throws ReflectionException |
|
| 234 | - */ |
|
| 235 | - public function set_status($status = '') |
|
| 236 | - { |
|
| 237 | - $this->set('STS_ID', $status); |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * Set hash salt |
|
| 243 | - * |
|
| 244 | - * @param string $hash_salt required for some payment gateways |
|
| 245 | - * @throws EE_Error |
|
| 246 | - * @throws InvalidArgumentException |
|
| 247 | - * @throws InvalidDataTypeException |
|
| 248 | - * @throws InvalidInterfaceException |
|
| 249 | - * @throws ReflectionException |
|
| 250 | - */ |
|
| 251 | - public function set_hash_salt($hash_salt = '') |
|
| 252 | - { |
|
| 253 | - $this->set('TXN_hash_salt', $hash_salt); |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - |
|
| 257 | - /** |
|
| 258 | - * Sets TXN_reg_steps array |
|
| 259 | - * |
|
| 260 | - * @param array $txn_reg_steps |
|
| 261 | - * @throws EE_Error |
|
| 262 | - * @throws InvalidArgumentException |
|
| 263 | - * @throws InvalidDataTypeException |
|
| 264 | - * @throws InvalidInterfaceException |
|
| 265 | - * @throws ReflectionException |
|
| 266 | - */ |
|
| 267 | - public function set_reg_steps(array $txn_reg_steps) |
|
| 268 | - { |
|
| 269 | - $this->set('TXN_reg_steps', $txn_reg_steps); |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - |
|
| 273 | - /** |
|
| 274 | - * Gets TXN_reg_steps |
|
| 275 | - * |
|
| 276 | - * @return array |
|
| 277 | - * @throws EE_Error |
|
| 278 | - * @throws InvalidArgumentException |
|
| 279 | - * @throws InvalidDataTypeException |
|
| 280 | - * @throws InvalidInterfaceException |
|
| 281 | - * @throws ReflectionException |
|
| 282 | - */ |
|
| 283 | - public function reg_steps() |
|
| 284 | - { |
|
| 285 | - $TXN_reg_steps = $this->get('TXN_reg_steps'); |
|
| 286 | - return is_array($TXN_reg_steps) ? (array) $TXN_reg_steps : array(); |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - |
|
| 290 | - /** |
|
| 291 | - * @return string of transaction's total cost, with currency symbol and decimal |
|
| 292 | - * @throws EE_Error |
|
| 293 | - * @throws InvalidArgumentException |
|
| 294 | - * @throws InvalidDataTypeException |
|
| 295 | - * @throws InvalidInterfaceException |
|
| 296 | - * @throws ReflectionException |
|
| 297 | - */ |
|
| 298 | - public function pretty_total() |
|
| 299 | - { |
|
| 300 | - return $this->get_pretty('TXN_total'); |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - |
|
| 304 | - /** |
|
| 305 | - * Gets the amount paid in a pretty string (formatted and with currency symbol) |
|
| 306 | - * |
|
| 307 | - * @return string |
|
| 308 | - * @throws EE_Error |
|
| 309 | - * @throws InvalidArgumentException |
|
| 310 | - * @throws InvalidDataTypeException |
|
| 311 | - * @throws InvalidInterfaceException |
|
| 312 | - * @throws ReflectionException |
|
| 313 | - */ |
|
| 314 | - public function pretty_paid() |
|
| 315 | - { |
|
| 316 | - return $this->get_pretty('TXN_paid'); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * calculate the amount remaining for this transaction and return; |
|
| 322 | - * |
|
| 323 | - * @return float amount remaining |
|
| 324 | - * @throws EE_Error |
|
| 325 | - * @throws InvalidArgumentException |
|
| 326 | - * @throws InvalidDataTypeException |
|
| 327 | - * @throws InvalidInterfaceException |
|
| 328 | - * @throws ReflectionException |
|
| 329 | - */ |
|
| 330 | - public function remaining() |
|
| 331 | - { |
|
| 332 | - return $this->total() - $this->paid(); |
|
| 333 | - } |
|
| 334 | - |
|
| 335 | - |
|
| 336 | - /** |
|
| 337 | - * get Transaction Total |
|
| 338 | - * |
|
| 339 | - * @return float |
|
| 340 | - * @throws EE_Error |
|
| 341 | - * @throws InvalidArgumentException |
|
| 342 | - * @throws InvalidDataTypeException |
|
| 343 | - * @throws InvalidInterfaceException |
|
| 344 | - * @throws ReflectionException |
|
| 345 | - */ |
|
| 346 | - public function total() |
|
| 347 | - { |
|
| 348 | - return (float) $this->get('TXN_total'); |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - |
|
| 352 | - /** |
|
| 353 | - * get Total Amount Paid to Date |
|
| 354 | - * |
|
| 355 | - * @return float |
|
| 356 | - * @throws EE_Error |
|
| 357 | - * @throws InvalidArgumentException |
|
| 358 | - * @throws InvalidDataTypeException |
|
| 359 | - * @throws InvalidInterfaceException |
|
| 360 | - * @throws ReflectionException |
|
| 361 | - */ |
|
| 362 | - public function paid() |
|
| 363 | - { |
|
| 364 | - return (float) $this->get('TXN_paid'); |
|
| 365 | - } |
|
| 366 | - |
|
| 367 | - |
|
| 368 | - /** |
|
| 369 | - * @return mixed|null |
|
| 370 | - * @throws EE_Error |
|
| 371 | - * @throws InvalidArgumentException |
|
| 372 | - * @throws InvalidDataTypeException |
|
| 373 | - * @throws InvalidInterfaceException |
|
| 374 | - * @throws ReflectionException |
|
| 375 | - */ |
|
| 376 | - public function get_cart_session() |
|
| 377 | - { |
|
| 378 | - $session_data = (array) $this->get('TXN_session_data'); |
|
| 379 | - return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart |
|
| 380 | - ? $session_data['cart'] |
|
| 381 | - : null; |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * get Transaction session data |
|
| 387 | - * |
|
| 388 | - * @return array|mixed |
|
| 389 | - * @throws EE_Error |
|
| 390 | - * @throws InvalidArgumentException |
|
| 391 | - * @throws InvalidDataTypeException |
|
| 392 | - * @throws InvalidInterfaceException |
|
| 393 | - * @throws ReflectionException |
|
| 394 | - */ |
|
| 395 | - public function session_data() |
|
| 396 | - { |
|
| 397 | - $session_data = $this->get('TXN_session_data'); |
|
| 398 | - if (empty($session_data)) { |
|
| 399 | - $session_data = array( |
|
| 400 | - 'id' => null, |
|
| 401 | - 'user_id' => null, |
|
| 402 | - 'ip_address' => null, |
|
| 403 | - 'user_agent' => null, |
|
| 404 | - 'init_access' => null, |
|
| 405 | - 'last_access' => null, |
|
| 406 | - 'pages_visited' => array(), |
|
| 407 | - ); |
|
| 408 | - } |
|
| 409 | - return $session_data; |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - |
|
| 413 | - /** |
|
| 414 | - * Set session data within the TXN object |
|
| 415 | - * |
|
| 416 | - * @param EE_Session|array $session_data |
|
| 417 | - * @throws EE_Error |
|
| 418 | - * @throws InvalidArgumentException |
|
| 419 | - * @throws InvalidDataTypeException |
|
| 420 | - * @throws InvalidInterfaceException |
|
| 421 | - * @throws ReflectionException |
|
| 422 | - */ |
|
| 423 | - public function set_txn_session_data($session_data) |
|
| 424 | - { |
|
| 425 | - if ($session_data instanceof EE_Session) { |
|
| 426 | - $this->set('TXN_session_data', $session_data->get_session_data(null, true)); |
|
| 427 | - } else { |
|
| 428 | - $this->set('TXN_session_data', $session_data); |
|
| 429 | - } |
|
| 430 | - } |
|
| 431 | - |
|
| 432 | - |
|
| 433 | - /** |
|
| 434 | - * get Transaction hash salt |
|
| 435 | - * |
|
| 436 | - * @return mixed |
|
| 437 | - * @throws EE_Error |
|
| 438 | - * @throws InvalidArgumentException |
|
| 439 | - * @throws InvalidDataTypeException |
|
| 440 | - * @throws InvalidInterfaceException |
|
| 441 | - * @throws ReflectionException |
|
| 442 | - */ |
|
| 443 | - public function hash_salt_() |
|
| 444 | - { |
|
| 445 | - return $this->get('TXN_hash_salt'); |
|
| 446 | - } |
|
| 447 | - |
|
| 448 | - |
|
| 449 | - /** |
|
| 450 | - * Returns the transaction datetime as either: |
|
| 451 | - * - unix timestamp format ($format = false, $gmt = true) |
|
| 452 | - * - formatted date string including the UTC (timezone) offset ($format = true ($gmt |
|
| 453 | - * has no affect with this option)), this also may include a timezone abbreviation if the |
|
| 454 | - * set timezone in this class differs from what the timezone is on the blog. |
|
| 455 | - * - formatted date string including the UTC (timezone) offset (default). |
|
| 456 | - * |
|
| 457 | - * @param boolean $format - whether to return a unix timestamp (default) or formatted date string |
|
| 458 | - * @param boolean $gmt - whether to return a unix timestamp with UTC offset applied (default) |
|
| 459 | - * or no UTC offset applied |
|
| 460 | - * @return string | int |
|
| 461 | - * @throws EE_Error |
|
| 462 | - * @throws InvalidArgumentException |
|
| 463 | - * @throws InvalidDataTypeException |
|
| 464 | - * @throws InvalidInterfaceException |
|
| 465 | - * @throws ReflectionException |
|
| 466 | - */ |
|
| 467 | - public function datetime($format = false, $gmt = false) |
|
| 468 | - { |
|
| 469 | - if ($format) { |
|
| 470 | - return $this->get_pretty('TXN_timestamp'); |
|
| 471 | - } |
|
| 472 | - if ($gmt) { |
|
| 473 | - return $this->get_raw('TXN_timestamp'); |
|
| 474 | - } |
|
| 475 | - return $this->get('TXN_timestamp'); |
|
| 476 | - } |
|
| 477 | - |
|
| 478 | - |
|
| 479 | - /** |
|
| 480 | - * Gets registrations on this transaction |
|
| 481 | - * |
|
| 482 | - * @param array $query_params array of query parameters |
|
| 483 | - * @param boolean $get_cached TRUE to retrieve cached registrations or FALSE to pull from the db |
|
| 484 | - * @return EE_Base_Class[]|EE_Registration[] |
|
| 485 | - * @throws EE_Error |
|
| 486 | - * @throws InvalidArgumentException |
|
| 487 | - * @throws InvalidDataTypeException |
|
| 488 | - * @throws InvalidInterfaceException |
|
| 489 | - * @throws ReflectionException |
|
| 490 | - */ |
|
| 491 | - public function registrations($query_params = array(), $get_cached = false) |
|
| 492 | - { |
|
| 493 | - $query_params = (empty($query_params) || ! is_array($query_params)) |
|
| 494 | - ? array( |
|
| 495 | - 'order_by' => array( |
|
| 496 | - 'Event.EVT_name' => 'ASC', |
|
| 497 | - 'Attendee.ATT_lname' => 'ASC', |
|
| 498 | - 'Attendee.ATT_fname' => 'ASC', |
|
| 499 | - ), |
|
| 500 | - ) |
|
| 501 | - : $query_params; |
|
| 502 | - $query_params = $get_cached ? array() : $query_params; |
|
| 503 | - return $this->get_many_related('Registration', $query_params); |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - |
|
| 507 | - /** |
|
| 508 | - * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event |
|
| 509 | - * function for getting attendees and how many registrations they each have for an event) |
|
| 510 | - * |
|
| 511 | - * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT' |
|
| 512 | - * @throws EE_Error |
|
| 513 | - * @throws InvalidArgumentException |
|
| 514 | - * @throws InvalidDataTypeException |
|
| 515 | - * @throws InvalidInterfaceException |
|
| 516 | - * @throws ReflectionException |
|
| 517 | - */ |
|
| 518 | - public function attendees() |
|
| 519 | - { |
|
| 520 | - return $this->get_many_related('Attendee', array(array('Registration.Transaction.TXN_ID' => $this->ID()))); |
|
| 521 | - } |
|
| 522 | - |
|
| 523 | - |
|
| 524 | - /** |
|
| 525 | - * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default |
|
| 526 | - * |
|
| 527 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 528 | - * @return EE_Base_Class[]|EE_Payment[] |
|
| 529 | - * @throws EE_Error |
|
| 530 | - * @throws InvalidArgumentException |
|
| 531 | - * @throws InvalidDataTypeException |
|
| 532 | - * @throws InvalidInterfaceException |
|
| 533 | - * @throws ReflectionException |
|
| 534 | - */ |
|
| 535 | - public function payments($query_params = array()) |
|
| 536 | - { |
|
| 537 | - return $this->get_many_related('Payment', $query_params); |
|
| 538 | - } |
|
| 539 | - |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * gets only approved payments for this transaction |
|
| 543 | - * |
|
| 544 | - * @return EE_Base_Class[]|EE_Payment[] |
|
| 545 | - * @throws EE_Error |
|
| 546 | - * @throws InvalidArgumentException |
|
| 547 | - * @throws ReflectionException |
|
| 548 | - * @throws InvalidDataTypeException |
|
| 549 | - * @throws InvalidInterfaceException |
|
| 550 | - */ |
|
| 551 | - public function approved_payments() |
|
| 552 | - { |
|
| 553 | - EE_Registry::instance()->load_model('Payment'); |
|
| 554 | - return $this->get_many_related( |
|
| 555 | - 'Payment', |
|
| 556 | - array( |
|
| 557 | - array('STS_ID' => EEM_Payment::status_id_approved), |
|
| 558 | - 'order_by' => array('PAY_timestamp' => 'DESC'), |
|
| 559 | - ) |
|
| 560 | - ); |
|
| 561 | - } |
|
| 562 | - |
|
| 563 | - |
|
| 564 | - /** |
|
| 565 | - * Gets all payments which have not been approved |
|
| 566 | - * |
|
| 567 | - * @return EE_Base_Class[]|EEI_Payment[] |
|
| 568 | - * @throws EE_Error if a model is misconfigured somehow |
|
| 569 | - * @throws InvalidArgumentException |
|
| 570 | - * @throws InvalidDataTypeException |
|
| 571 | - * @throws InvalidInterfaceException |
|
| 572 | - * @throws ReflectionException |
|
| 573 | - */ |
|
| 574 | - public function pending_payments() |
|
| 575 | - { |
|
| 576 | - return $this->get_many_related( |
|
| 577 | - 'Payment', |
|
| 578 | - array( |
|
| 579 | - array( |
|
| 580 | - 'STS_ID' => EEM_Payment::status_id_pending, |
|
| 581 | - ), |
|
| 582 | - 'order_by' => array( |
|
| 583 | - 'PAY_timestamp' => 'DESC', |
|
| 584 | - ), |
|
| 585 | - ) |
|
| 586 | - ); |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - |
|
| 590 | - /** |
|
| 591 | - * echoes $this->pretty_status() |
|
| 592 | - * |
|
| 593 | - * @param bool $show_icons |
|
| 594 | - * @throws EE_Error |
|
| 595 | - * @throws InvalidArgumentException |
|
| 596 | - * @throws InvalidDataTypeException |
|
| 597 | - * @throws InvalidInterfaceException |
|
| 598 | - * @throws ReflectionException |
|
| 599 | - */ |
|
| 600 | - public function e_pretty_status($show_icons = false) |
|
| 601 | - { |
|
| 602 | - echo $this->pretty_status($show_icons); |
|
| 603 | - } |
|
| 604 | - |
|
| 605 | - |
|
| 606 | - /** |
|
| 607 | - * returns a pretty version of the status, good for displaying to users |
|
| 608 | - * |
|
| 609 | - * @param bool $show_icons |
|
| 610 | - * @return string |
|
| 611 | - * @throws EE_Error |
|
| 612 | - * @throws InvalidArgumentException |
|
| 613 | - * @throws InvalidDataTypeException |
|
| 614 | - * @throws InvalidInterfaceException |
|
| 615 | - * @throws ReflectionException |
|
| 616 | - */ |
|
| 617 | - public function pretty_status($show_icons = false) |
|
| 618 | - { |
|
| 619 | - $status = EEM_Status::instance()->localized_status( |
|
| 620 | - array($this->status_ID() => __('unknown', 'event_espresso')), |
|
| 621 | - false, |
|
| 622 | - 'sentence' |
|
| 623 | - ); |
|
| 624 | - $icon = ''; |
|
| 625 | - switch ($this->status_ID()) { |
|
| 626 | - case EEM_Transaction::complete_status_code: |
|
| 627 | - $icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : ''; |
|
| 628 | - break; |
|
| 629 | - case EEM_Transaction::incomplete_status_code: |
|
| 630 | - $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>' |
|
| 631 | - : ''; |
|
| 632 | - break; |
|
| 633 | - case EEM_Transaction::abandoned_status_code: |
|
| 634 | - $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : ''; |
|
| 635 | - break; |
|
| 636 | - case EEM_Transaction::failed_status_code: |
|
| 637 | - $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : ''; |
|
| 638 | - break; |
|
| 639 | - case EEM_Transaction::overpaid_status_code: |
|
| 640 | - $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : ''; |
|
| 641 | - break; |
|
| 642 | - } |
|
| 643 | - return $icon . $status[ $this->status_ID() ]; |
|
| 644 | - } |
|
| 645 | - |
|
| 646 | - |
|
| 647 | - /** |
|
| 648 | - * get Transaction Status |
|
| 649 | - * |
|
| 650 | - * @return mixed |
|
| 651 | - * @throws EE_Error |
|
| 652 | - * @throws InvalidArgumentException |
|
| 653 | - * @throws InvalidDataTypeException |
|
| 654 | - * @throws InvalidInterfaceException |
|
| 655 | - * @throws ReflectionException |
|
| 656 | - */ |
|
| 657 | - public function status_ID() |
|
| 658 | - { |
|
| 659 | - return $this->get('STS_ID'); |
|
| 660 | - } |
|
| 661 | - |
|
| 662 | - |
|
| 663 | - /** |
|
| 664 | - * Returns TRUE or FALSE for whether or not this transaction cost any money |
|
| 665 | - * |
|
| 666 | - * @return boolean |
|
| 667 | - * @throws EE_Error |
|
| 668 | - * @throws InvalidArgumentException |
|
| 669 | - * @throws InvalidDataTypeException |
|
| 670 | - * @throws InvalidInterfaceException |
|
| 671 | - * @throws ReflectionException |
|
| 672 | - */ |
|
| 673 | - public function is_free() |
|
| 674 | - { |
|
| 675 | - return EEH_Money::compare_floats($this->get('TXN_total'), 0, '=='); |
|
| 676 | - } |
|
| 677 | - |
|
| 678 | - |
|
| 679 | - /** |
|
| 680 | - * Returns whether this transaction is complete |
|
| 681 | - * Useful in templates and other logic for deciding if we should ask for another payment... |
|
| 682 | - * |
|
| 683 | - * @return boolean |
|
| 684 | - * @throws EE_Error |
|
| 685 | - * @throws InvalidArgumentException |
|
| 686 | - * @throws InvalidDataTypeException |
|
| 687 | - * @throws InvalidInterfaceException |
|
| 688 | - * @throws ReflectionException |
|
| 689 | - */ |
|
| 690 | - public function is_completed() |
|
| 691 | - { |
|
| 692 | - return $this->status_ID() === EEM_Transaction::complete_status_code; |
|
| 693 | - } |
|
| 694 | - |
|
| 695 | - |
|
| 696 | - /** |
|
| 697 | - * Returns whether this transaction is incomplete |
|
| 698 | - * Useful in templates and other logic for deciding if we should ask for another payment... |
|
| 699 | - * |
|
| 700 | - * @return boolean |
|
| 701 | - * @throws EE_Error |
|
| 702 | - * @throws InvalidArgumentException |
|
| 703 | - * @throws InvalidDataTypeException |
|
| 704 | - * @throws InvalidInterfaceException |
|
| 705 | - * @throws ReflectionException |
|
| 706 | - */ |
|
| 707 | - public function is_incomplete() |
|
| 708 | - { |
|
| 709 | - return $this->status_ID() === EEM_Transaction::incomplete_status_code; |
|
| 710 | - } |
|
| 711 | - |
|
| 712 | - |
|
| 713 | - /** |
|
| 714 | - * Returns whether this transaction is overpaid |
|
| 715 | - * Useful in templates and other logic for deciding if monies need to be refunded |
|
| 716 | - * |
|
| 717 | - * @return boolean |
|
| 718 | - * @throws EE_Error |
|
| 719 | - * @throws InvalidArgumentException |
|
| 720 | - * @throws InvalidDataTypeException |
|
| 721 | - * @throws InvalidInterfaceException |
|
| 722 | - * @throws ReflectionException |
|
| 723 | - */ |
|
| 724 | - public function is_overpaid() |
|
| 725 | - { |
|
| 726 | - return $this->status_ID() === EEM_Transaction::overpaid_status_code; |
|
| 727 | - } |
|
| 728 | - |
|
| 729 | - |
|
| 730 | - /** |
|
| 731 | - * Returns whether this transaction was abandoned |
|
| 732 | - * meaning that the transaction/registration process was somehow interrupted and never completed |
|
| 733 | - * but that contact information exists for at least one registrant |
|
| 734 | - * |
|
| 735 | - * @return boolean |
|
| 736 | - * @throws EE_Error |
|
| 737 | - * @throws InvalidArgumentException |
|
| 738 | - * @throws InvalidDataTypeException |
|
| 739 | - * @throws InvalidInterfaceException |
|
| 740 | - * @throws ReflectionException |
|
| 741 | - */ |
|
| 742 | - public function is_abandoned() |
|
| 743 | - { |
|
| 744 | - return $this->status_ID() === EEM_Transaction::abandoned_status_code; |
|
| 745 | - } |
|
| 746 | - |
|
| 747 | - |
|
| 748 | - /** |
|
| 749 | - * Returns whether this transaction failed |
|
| 750 | - * meaning that the transaction/registration process was somehow interrupted and never completed |
|
| 751 | - * and that NO contact information exists for any registrants |
|
| 752 | - * |
|
| 753 | - * @return boolean |
|
| 754 | - * @throws EE_Error |
|
| 755 | - * @throws InvalidArgumentException |
|
| 756 | - * @throws InvalidDataTypeException |
|
| 757 | - * @throws InvalidInterfaceException |
|
| 758 | - * @throws ReflectionException |
|
| 759 | - */ |
|
| 760 | - public function failed() |
|
| 761 | - { |
|
| 762 | - return $this->status_ID() === EEM_Transaction::failed_status_code; |
|
| 763 | - } |
|
| 764 | - |
|
| 765 | - |
|
| 766 | - /** |
|
| 767 | - * This returns the url for the invoice of this transaction |
|
| 768 | - * |
|
| 769 | - * @param string $type 'html' or 'pdf' (default is pdf) |
|
| 770 | - * @return string |
|
| 771 | - * @throws EE_Error |
|
| 772 | - * @throws InvalidArgumentException |
|
| 773 | - * @throws InvalidDataTypeException |
|
| 774 | - * @throws InvalidInterfaceException |
|
| 775 | - * @throws ReflectionException |
|
| 776 | - */ |
|
| 777 | - public function invoice_url($type = 'html') |
|
| 778 | - { |
|
| 779 | - $REG = $this->primary_registration(); |
|
| 780 | - if (! $REG instanceof EE_Registration) { |
|
| 781 | - return ''; |
|
| 782 | - } |
|
| 783 | - return $REG->invoice_url($type); |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - |
|
| 787 | - /** |
|
| 788 | - * Gets the primary registration only |
|
| 789 | - * |
|
| 790 | - * @return EE_Base_Class|EE_Registration |
|
| 791 | - * @throws EE_Error |
|
| 792 | - * @throws InvalidArgumentException |
|
| 793 | - * @throws InvalidDataTypeException |
|
| 794 | - * @throws InvalidInterfaceException |
|
| 795 | - * @throws ReflectionException |
|
| 796 | - */ |
|
| 797 | - public function primary_registration() |
|
| 798 | - { |
|
| 799 | - $registrations = (array) $this->get_many_related( |
|
| 800 | - 'Registration', |
|
| 801 | - array(array('REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT)) |
|
| 802 | - ); |
|
| 803 | - foreach ($registrations as $registration) { |
|
| 804 | - // valid registration that is NOT cancelled or declined ? |
|
| 805 | - if ($registration instanceof EE_Registration |
|
| 806 | - && ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true) |
|
| 807 | - ) { |
|
| 808 | - return $registration; |
|
| 809 | - } |
|
| 810 | - } |
|
| 811 | - // nothing valid found, so just return first thing from array of results |
|
| 812 | - return reset($registrations); |
|
| 813 | - } |
|
| 814 | - |
|
| 815 | - |
|
| 816 | - /** |
|
| 817 | - * Gets the URL for viewing the receipt |
|
| 818 | - * |
|
| 819 | - * @param string $type 'pdf' or 'html' (default is 'html') |
|
| 820 | - * @return string |
|
| 821 | - * @throws EE_Error |
|
| 822 | - * @throws InvalidArgumentException |
|
| 823 | - * @throws InvalidDataTypeException |
|
| 824 | - * @throws InvalidInterfaceException |
|
| 825 | - * @throws ReflectionException |
|
| 826 | - */ |
|
| 827 | - public function receipt_url($type = 'html') |
|
| 828 | - { |
|
| 829 | - $REG = $this->primary_registration(); |
|
| 830 | - if (! $REG instanceof EE_Registration) { |
|
| 831 | - return ''; |
|
| 832 | - } |
|
| 833 | - return $REG->receipt_url($type); |
|
| 834 | - } |
|
| 835 | - |
|
| 836 | - |
|
| 837 | - /** |
|
| 838 | - * Gets the URL of the thank you page with this registration REG_url_link added as |
|
| 839 | - * a query parameter |
|
| 840 | - * |
|
| 841 | - * @return string |
|
| 842 | - * @throws EE_Error |
|
| 843 | - * @throws InvalidArgumentException |
|
| 844 | - * @throws InvalidDataTypeException |
|
| 845 | - * @throws InvalidInterfaceException |
|
| 846 | - * @throws ReflectionException |
|
| 847 | - */ |
|
| 848 | - public function payment_overview_url() |
|
| 849 | - { |
|
| 850 | - $primary_registration = $this->primary_registration(); |
|
| 851 | - return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false; |
|
| 852 | - } |
|
| 853 | - |
|
| 854 | - |
|
| 855 | - /** |
|
| 856 | - * @return string |
|
| 857 | - * @throws EE_Error |
|
| 858 | - * @throws InvalidArgumentException |
|
| 859 | - * @throws InvalidDataTypeException |
|
| 860 | - * @throws InvalidInterfaceException |
|
| 861 | - * @throws ReflectionException |
|
| 862 | - */ |
|
| 863 | - public function gateway_response_on_transaction() |
|
| 864 | - { |
|
| 865 | - $payment = $this->get_first_related('Payment'); |
|
| 866 | - return $payment instanceof EE_Payment ? $payment->gateway_response() : ''; |
|
| 867 | - } |
|
| 868 | - |
|
| 869 | - |
|
| 870 | - /** |
|
| 871 | - * Get the status object of this object |
|
| 872 | - * |
|
| 873 | - * @return EE_Base_Class|EE_Status |
|
| 874 | - * @throws EE_Error |
|
| 875 | - * @throws InvalidArgumentException |
|
| 876 | - * @throws InvalidDataTypeException |
|
| 877 | - * @throws InvalidInterfaceException |
|
| 878 | - * @throws ReflectionException |
|
| 879 | - */ |
|
| 880 | - public function status_obj() |
|
| 881 | - { |
|
| 882 | - return $this->get_first_related('Status'); |
|
| 883 | - } |
|
| 884 | - |
|
| 885 | - |
|
| 886 | - /** |
|
| 887 | - * Gets all the extra meta info on this payment |
|
| 888 | - * |
|
| 889 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 890 | - * @return EE_Base_Class[]|EE_Extra_Meta |
|
| 891 | - * @throws EE_Error |
|
| 892 | - * @throws InvalidArgumentException |
|
| 893 | - * @throws InvalidDataTypeException |
|
| 894 | - * @throws InvalidInterfaceException |
|
| 895 | - * @throws ReflectionException |
|
| 896 | - */ |
|
| 897 | - public function extra_meta($query_params = array()) |
|
| 898 | - { |
|
| 899 | - return $this->get_many_related('Extra_Meta', $query_params); |
|
| 900 | - } |
|
| 901 | - |
|
| 902 | - |
|
| 903 | - /** |
|
| 904 | - * Wrapper for _add_relation_to |
|
| 905 | - * |
|
| 906 | - * @param EE_Registration $registration |
|
| 907 | - * @return EE_Base_Class the relation was added to |
|
| 908 | - * @throws EE_Error |
|
| 909 | - * @throws InvalidArgumentException |
|
| 910 | - * @throws InvalidDataTypeException |
|
| 911 | - * @throws InvalidInterfaceException |
|
| 912 | - * @throws ReflectionException |
|
| 913 | - */ |
|
| 914 | - public function add_registration(EE_Registration $registration) |
|
| 915 | - { |
|
| 916 | - return $this->_add_relation_to($registration, 'Registration'); |
|
| 917 | - } |
|
| 918 | - |
|
| 919 | - |
|
| 920 | - /** |
|
| 921 | - * Removes the given registration from being related (even before saving this transaction). |
|
| 922 | - * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations |
|
| 923 | - * |
|
| 924 | - * @param int $registration_or_id |
|
| 925 | - * @return EE_Base_Class that was removed from being related |
|
| 926 | - * @throws EE_Error |
|
| 927 | - * @throws InvalidArgumentException |
|
| 928 | - * @throws InvalidDataTypeException |
|
| 929 | - * @throws InvalidInterfaceException |
|
| 930 | - * @throws ReflectionException |
|
| 931 | - */ |
|
| 932 | - public function remove_registration_with_id($registration_or_id) |
|
| 933 | - { |
|
| 934 | - return $this->_remove_relation_to($registration_or_id, 'Registration'); |
|
| 935 | - } |
|
| 936 | - |
|
| 937 | - |
|
| 938 | - /** |
|
| 939 | - * Gets all the line items which are for ACTUAL items |
|
| 940 | - * |
|
| 941 | - * @return EE_Line_Item[] |
|
| 942 | - * @throws EE_Error |
|
| 943 | - * @throws InvalidArgumentException |
|
| 944 | - * @throws InvalidDataTypeException |
|
| 945 | - * @throws InvalidInterfaceException |
|
| 946 | - * @throws ReflectionException |
|
| 947 | - */ |
|
| 948 | - public function items_purchased() |
|
| 949 | - { |
|
| 950 | - return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_line_item))); |
|
| 951 | - } |
|
| 952 | - |
|
| 953 | - |
|
| 954 | - /** |
|
| 955 | - * Wrapper for _add_relation_to |
|
| 956 | - * |
|
| 957 | - * @param EE_Line_Item $line_item |
|
| 958 | - * @return EE_Base_Class the relation was added to |
|
| 959 | - * @throws EE_Error |
|
| 960 | - * @throws InvalidArgumentException |
|
| 961 | - * @throws InvalidDataTypeException |
|
| 962 | - * @throws InvalidInterfaceException |
|
| 963 | - * @throws ReflectionException |
|
| 964 | - */ |
|
| 965 | - public function add_line_item(EE_Line_Item $line_item) |
|
| 966 | - { |
|
| 967 | - return $this->_add_relation_to($line_item, 'Line_Item'); |
|
| 968 | - } |
|
| 969 | - |
|
| 970 | - |
|
| 971 | - /** |
|
| 972 | - * Gets ALL the line items related to this transaction (unstructured) |
|
| 973 | - * |
|
| 974 | - * @param array $query_params |
|
| 975 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 976 | - * @throws EE_Error |
|
| 977 | - * @throws InvalidArgumentException |
|
| 978 | - * @throws InvalidDataTypeException |
|
| 979 | - * @throws InvalidInterfaceException |
|
| 980 | - * @throws ReflectionException |
|
| 981 | - */ |
|
| 982 | - public function line_items($query_params = array()) |
|
| 983 | - { |
|
| 984 | - return $this->get_many_related('Line_Item', $query_params); |
|
| 985 | - } |
|
| 986 | - |
|
| 987 | - |
|
| 988 | - /** |
|
| 989 | - * Gets all the line items which are taxes on the total |
|
| 990 | - * |
|
| 991 | - * @return EE_Line_Item[] |
|
| 992 | - * @throws EE_Error |
|
| 993 | - * @throws InvalidArgumentException |
|
| 994 | - * @throws InvalidDataTypeException |
|
| 995 | - * @throws InvalidInterfaceException |
|
| 996 | - * @throws ReflectionException |
|
| 997 | - */ |
|
| 998 | - public function tax_items() |
|
| 999 | - { |
|
| 1000 | - return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax))); |
|
| 1001 | - } |
|
| 1002 | - |
|
| 1003 | - |
|
| 1004 | - /** |
|
| 1005 | - * Gets the total line item (which is a parent of all other related line items, |
|
| 1006 | - * meaning it takes them all into account on its total) |
|
| 1007 | - * |
|
| 1008 | - * @param bool $create_if_not_found |
|
| 1009 | - * @return \EE_Line_Item |
|
| 1010 | - * @throws EE_Error |
|
| 1011 | - * @throws InvalidArgumentException |
|
| 1012 | - * @throws InvalidDataTypeException |
|
| 1013 | - * @throws InvalidInterfaceException |
|
| 1014 | - * @throws ReflectionException |
|
| 1015 | - */ |
|
| 1016 | - public function total_line_item($create_if_not_found = true) |
|
| 1017 | - { |
|
| 1018 | - $item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total))); |
|
| 1019 | - if (! $item && $create_if_not_found) { |
|
| 1020 | - $item = EEH_Line_Item::create_total_line_item($this); |
|
| 1021 | - } |
|
| 1022 | - return $item; |
|
| 1023 | - } |
|
| 1024 | - |
|
| 1025 | - |
|
| 1026 | - /** |
|
| 1027 | - * Returns the total amount of tax on this transaction |
|
| 1028 | - * (assumes there's only one tax subtotal line item) |
|
| 1029 | - * |
|
| 1030 | - * @return float |
|
| 1031 | - * @throws EE_Error |
|
| 1032 | - * @throws InvalidArgumentException |
|
| 1033 | - * @throws InvalidDataTypeException |
|
| 1034 | - * @throws InvalidInterfaceException |
|
| 1035 | - * @throws ReflectionException |
|
| 1036 | - */ |
|
| 1037 | - public function tax_total() |
|
| 1038 | - { |
|
| 1039 | - $tax_line_item = $this->tax_total_line_item(); |
|
| 1040 | - if ($tax_line_item) { |
|
| 1041 | - return (float) $tax_line_item->total(); |
|
| 1042 | - } |
|
| 1043 | - return (float) 0; |
|
| 1044 | - } |
|
| 1045 | - |
|
| 1046 | - |
|
| 1047 | - /** |
|
| 1048 | - * Gets the tax subtotal line item (assumes there's only one) |
|
| 1049 | - * |
|
| 1050 | - * @return EE_Line_Item |
|
| 1051 | - * @throws EE_Error |
|
| 1052 | - * @throws InvalidArgumentException |
|
| 1053 | - * @throws InvalidDataTypeException |
|
| 1054 | - * @throws InvalidInterfaceException |
|
| 1055 | - * @throws ReflectionException |
|
| 1056 | - */ |
|
| 1057 | - public function tax_total_line_item() |
|
| 1058 | - { |
|
| 1059 | - return EEH_Line_Item::get_taxes_subtotal($this->total_line_item()); |
|
| 1060 | - } |
|
| 1061 | - |
|
| 1062 | - |
|
| 1063 | - /** |
|
| 1064 | - * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee. |
|
| 1065 | - * |
|
| 1066 | - * @return EE_Form_Section_Proper |
|
| 1067 | - * @throws EE_Error |
|
| 1068 | - * @throws InvalidArgumentException |
|
| 1069 | - * @throws InvalidDataTypeException |
|
| 1070 | - * @throws InvalidInterfaceException |
|
| 1071 | - * @throws ReflectionException |
|
| 1072 | - */ |
|
| 1073 | - public function billing_info() |
|
| 1074 | - { |
|
| 1075 | - $payment_method = $this->payment_method(); |
|
| 1076 | - if (! $payment_method) { |
|
| 1077 | - EE_Error::add_error( |
|
| 1078 | - __( |
|
| 1079 | - 'Could not find billing info for transaction because no gateway has been used for it yet', |
|
| 1080 | - 'event_espresso' |
|
| 1081 | - ), |
|
| 1082 | - __FILE__, |
|
| 1083 | - __FUNCTION__, |
|
| 1084 | - __LINE__ |
|
| 1085 | - ); |
|
| 1086 | - return null; |
|
| 1087 | - } |
|
| 1088 | - $primary_reg = $this->primary_registration(); |
|
| 1089 | - if (! $primary_reg) { |
|
| 1090 | - EE_Error::add_error( |
|
| 1091 | - __( |
|
| 1092 | - 'Cannot get billing info for gateway %s on transaction because no primary registration exists', |
|
| 1093 | - 'event_espresso' |
|
| 1094 | - ), |
|
| 1095 | - __FILE__, |
|
| 1096 | - __FUNCTION__, |
|
| 1097 | - __LINE__ |
|
| 1098 | - ); |
|
| 1099 | - return null; |
|
| 1100 | - } |
|
| 1101 | - $attendee = $primary_reg->attendee(); |
|
| 1102 | - if (! $attendee) { |
|
| 1103 | - EE_Error::add_error( |
|
| 1104 | - __( |
|
| 1105 | - 'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists', |
|
| 1106 | - 'event_espresso' |
|
| 1107 | - ), |
|
| 1108 | - __FILE__, |
|
| 1109 | - __FUNCTION__, |
|
| 1110 | - __LINE__ |
|
| 1111 | - ); |
|
| 1112 | - return null; |
|
| 1113 | - } |
|
| 1114 | - return $attendee->billing_info_for_payment_method($payment_method); |
|
| 1115 | - } |
|
| 1116 | - |
|
| 1117 | - |
|
| 1118 | - /** |
|
| 1119 | - * Gets PMD_ID |
|
| 1120 | - * |
|
| 1121 | - * @return int |
|
| 1122 | - * @throws EE_Error |
|
| 1123 | - * @throws InvalidArgumentException |
|
| 1124 | - * @throws InvalidDataTypeException |
|
| 1125 | - * @throws InvalidInterfaceException |
|
| 1126 | - * @throws ReflectionException |
|
| 1127 | - */ |
|
| 1128 | - public function payment_method_ID() |
|
| 1129 | - { |
|
| 1130 | - return $this->get('PMD_ID'); |
|
| 1131 | - } |
|
| 1132 | - |
|
| 1133 | - |
|
| 1134 | - /** |
|
| 1135 | - * Sets PMD_ID |
|
| 1136 | - * |
|
| 1137 | - * @param int $PMD_ID |
|
| 1138 | - * @throws EE_Error |
|
| 1139 | - * @throws InvalidArgumentException |
|
| 1140 | - * @throws InvalidDataTypeException |
|
| 1141 | - * @throws InvalidInterfaceException |
|
| 1142 | - * @throws ReflectionException |
|
| 1143 | - */ |
|
| 1144 | - public function set_payment_method_ID($PMD_ID) |
|
| 1145 | - { |
|
| 1146 | - $this->set('PMD_ID', $PMD_ID); |
|
| 1147 | - } |
|
| 1148 | - |
|
| 1149 | - |
|
| 1150 | - /** |
|
| 1151 | - * Gets the last-used payment method on this transaction |
|
| 1152 | - * (we COULD just use the last-made payment, but some payment methods, namely |
|
| 1153 | - * offline ones, dont' create payments) |
|
| 1154 | - * |
|
| 1155 | - * @return EE_Payment_Method |
|
| 1156 | - * @throws EE_Error |
|
| 1157 | - * @throws InvalidArgumentException |
|
| 1158 | - * @throws InvalidDataTypeException |
|
| 1159 | - * @throws InvalidInterfaceException |
|
| 1160 | - * @throws ReflectionException |
|
| 1161 | - */ |
|
| 1162 | - public function payment_method() |
|
| 1163 | - { |
|
| 1164 | - $pm = $this->get_first_related('Payment_Method'); |
|
| 1165 | - if ($pm instanceof EE_Payment_Method) { |
|
| 1166 | - return $pm; |
|
| 1167 | - } |
|
| 1168 | - $last_payment = $this->last_payment(); |
|
| 1169 | - if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) { |
|
| 1170 | - return $last_payment->payment_method(); |
|
| 1171 | - } |
|
| 1172 | - return null; |
|
| 1173 | - } |
|
| 1174 | - |
|
| 1175 | - |
|
| 1176 | - /** |
|
| 1177 | - * Gets the last payment made |
|
| 1178 | - * |
|
| 1179 | - * @return EE_Base_Class|EE_Payment |
|
| 1180 | - * @throws EE_Error |
|
| 1181 | - * @throws InvalidArgumentException |
|
| 1182 | - * @throws InvalidDataTypeException |
|
| 1183 | - * @throws InvalidInterfaceException |
|
| 1184 | - * @throws ReflectionException |
|
| 1185 | - */ |
|
| 1186 | - public function last_payment() |
|
| 1187 | - { |
|
| 1188 | - return $this->get_first_related('Payment', array('order_by' => array('PAY_ID' => 'desc'))); |
|
| 1189 | - } |
|
| 1190 | - |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * Gets all the line items which are unrelated to tickets on this transaction |
|
| 1194 | - * |
|
| 1195 | - * @return EE_Line_Item[] |
|
| 1196 | - * @throws EE_Error |
|
| 1197 | - * @throws InvalidArgumentException |
|
| 1198 | - * @throws InvalidDataTypeException |
|
| 1199 | - * @throws InvalidInterfaceException |
|
| 1200 | - * @throws ReflectionException |
|
| 1201 | - */ |
|
| 1202 | - public function non_ticket_line_items() |
|
| 1203 | - { |
|
| 1204 | - return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID()); |
|
| 1205 | - } |
|
| 1206 | - |
|
| 1207 | - |
|
| 1208 | - /** |
|
| 1209 | - * possibly toggles TXN status |
|
| 1210 | - * |
|
| 1211 | - * @param boolean $update whether to save the TXN |
|
| 1212 | - * @return bool whether the TXN was saved |
|
| 1213 | - * @throws EE_Error |
|
| 1214 | - * @throws InvalidArgumentException |
|
| 1215 | - * @throws InvalidDataTypeException |
|
| 1216 | - * @throws InvalidInterfaceException |
|
| 1217 | - * @throws ReflectionException |
|
| 1218 | - * @throws RuntimeException |
|
| 1219 | - */ |
|
| 1220 | - public function update_status_based_on_total_paid($update = true) |
|
| 1221 | - { |
|
| 1222 | - // set transaction status based on comparison of TXN_paid vs TXN_total |
|
| 1223 | - if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) { |
|
| 1224 | - $new_txn_status = EEM_Transaction::overpaid_status_code; |
|
| 1225 | - } elseif (EEH_Money::compare_floats($this->paid(), $this->total())) { |
|
| 1226 | - $new_txn_status = EEM_Transaction::complete_status_code; |
|
| 1227 | - } elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) { |
|
| 1228 | - $new_txn_status = EEM_Transaction::incomplete_status_code; |
|
| 1229 | - } else { |
|
| 1230 | - throw new RuntimeException( |
|
| 1231 | - __('The total paid calculation for this transaction is inaccurate.', 'event_espresso') |
|
| 1232 | - ); |
|
| 1233 | - } |
|
| 1234 | - if ($new_txn_status !== $this->status_ID()) { |
|
| 1235 | - $this->set_status($new_txn_status); |
|
| 1236 | - if ($update) { |
|
| 1237 | - return $this->save() ? true : false; |
|
| 1238 | - } |
|
| 1239 | - } |
|
| 1240 | - return false; |
|
| 1241 | - } |
|
| 1242 | - |
|
| 1243 | - |
|
| 1244 | - /** |
|
| 1245 | - * Updates the transaction's status and total_paid based on all the payments |
|
| 1246 | - * that apply to it |
|
| 1247 | - * |
|
| 1248 | - * @deprecated |
|
| 1249 | - * @return array|bool |
|
| 1250 | - * @throws EE_Error |
|
| 1251 | - * @throws InvalidArgumentException |
|
| 1252 | - * @throws ReflectionException |
|
| 1253 | - * @throws InvalidDataTypeException |
|
| 1254 | - * @throws InvalidInterfaceException |
|
| 1255 | - */ |
|
| 1256 | - public function update_based_on_payments() |
|
| 1257 | - { |
|
| 1258 | - EE_Error::doing_it_wrong( |
|
| 1259 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 1260 | - sprintf( |
|
| 1261 | - __('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
| 1262 | - 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()' |
|
| 1263 | - ), |
|
| 1264 | - '4.6.0' |
|
| 1265 | - ); |
|
| 1266 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 1267 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 1268 | - return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this); |
|
| 1269 | - } |
|
| 1270 | - |
|
| 1271 | - |
|
| 1272 | - /** |
|
| 1273 | - * @return string |
|
| 1274 | - */ |
|
| 1275 | - public function old_txn_status() |
|
| 1276 | - { |
|
| 1277 | - return $this->_old_txn_status; |
|
| 1278 | - } |
|
| 1279 | - |
|
| 1280 | - |
|
| 1281 | - /** |
|
| 1282 | - * @param string $old_txn_status |
|
| 1283 | - */ |
|
| 1284 | - public function set_old_txn_status($old_txn_status) |
|
| 1285 | - { |
|
| 1286 | - // only set the first time |
|
| 1287 | - if ($this->_old_txn_status === null) { |
|
| 1288 | - $this->_old_txn_status = $old_txn_status; |
|
| 1289 | - } |
|
| 1290 | - } |
|
| 1291 | - |
|
| 1292 | - |
|
| 1293 | - /** |
|
| 1294 | - * reg_status_updated |
|
| 1295 | - * |
|
| 1296 | - * @return bool |
|
| 1297 | - * @throws EE_Error |
|
| 1298 | - * @throws InvalidArgumentException |
|
| 1299 | - * @throws InvalidDataTypeException |
|
| 1300 | - * @throws InvalidInterfaceException |
|
| 1301 | - * @throws ReflectionException |
|
| 1302 | - */ |
|
| 1303 | - public function txn_status_updated() |
|
| 1304 | - { |
|
| 1305 | - return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null; |
|
| 1306 | - } |
|
| 1307 | - |
|
| 1308 | - |
|
| 1309 | - /** |
|
| 1310 | - * _reg_steps_completed |
|
| 1311 | - * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed, |
|
| 1312 | - * if a $reg_step_slug is provided, then this step will be skipped when testing for completion |
|
| 1313 | - * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion |
|
| 1314 | - * |
|
| 1315 | - * @param string $reg_step_slug |
|
| 1316 | - * @param bool $check_all |
|
| 1317 | - * @return bool|int |
|
| 1318 | - * @throws EE_Error |
|
| 1319 | - * @throws InvalidArgumentException |
|
| 1320 | - * @throws InvalidDataTypeException |
|
| 1321 | - * @throws InvalidInterfaceException |
|
| 1322 | - * @throws ReflectionException |
|
| 1323 | - */ |
|
| 1324 | - private function _reg_steps_completed($reg_step_slug = '', $check_all = true) |
|
| 1325 | - { |
|
| 1326 | - $reg_steps = $this->reg_steps(); |
|
| 1327 | - if (! is_array($reg_steps) || empty($reg_steps)) { |
|
| 1328 | - return false; |
|
| 1329 | - } |
|
| 1330 | - // loop thru reg steps array) |
|
| 1331 | - foreach ($reg_steps as $slug => $reg_step_completed) { |
|
| 1332 | - // if NOT checking ALL steps (only checking one step) |
|
| 1333 | - if (! $check_all) { |
|
| 1334 | - // and this is the one |
|
| 1335 | - if ($slug === $reg_step_slug) { |
|
| 1336 | - return $reg_step_completed; |
|
| 1337 | - } |
|
| 1338 | - // skip to next reg step in loop |
|
| 1339 | - continue; |
|
| 1340 | - } |
|
| 1341 | - // $check_all must be true, else we would never have gotten to this point |
|
| 1342 | - if ($slug === $reg_step_slug) { |
|
| 1343 | - // if we reach this point, then we are testing either: |
|
| 1344 | - // all_reg_steps_completed_except() or |
|
| 1345 | - // all_reg_steps_completed_except_final_step(), |
|
| 1346 | - // and since this is the reg step EXCEPTION being tested |
|
| 1347 | - // we want to return true (yes true) if this reg step is NOT completed |
|
| 1348 | - // ie: "is everything completed except the final step?" |
|
| 1349 | - // "that is correct... the final step is not completed, but all others are." |
|
| 1350 | - return $reg_step_completed !== true; |
|
| 1351 | - } |
|
| 1352 | - if ($reg_step_completed !== true) { |
|
| 1353 | - // if any reg step is NOT completed, then ALL steps are not completed |
|
| 1354 | - return false; |
|
| 1355 | - } |
|
| 1356 | - } |
|
| 1357 | - return true; |
|
| 1358 | - } |
|
| 1359 | - |
|
| 1360 | - |
|
| 1361 | - /** |
|
| 1362 | - * all_reg_steps_completed |
|
| 1363 | - * returns: |
|
| 1364 | - * true if ALL reg steps have been marked as completed |
|
| 1365 | - * or false if any step is not completed |
|
| 1366 | - * |
|
| 1367 | - * @return bool |
|
| 1368 | - * @throws EE_Error |
|
| 1369 | - * @throws InvalidArgumentException |
|
| 1370 | - * @throws InvalidDataTypeException |
|
| 1371 | - * @throws InvalidInterfaceException |
|
| 1372 | - * @throws ReflectionException |
|
| 1373 | - */ |
|
| 1374 | - public function all_reg_steps_completed() |
|
| 1375 | - { |
|
| 1376 | - return $this->_reg_steps_completed(); |
|
| 1377 | - } |
|
| 1378 | - |
|
| 1379 | - |
|
| 1380 | - /** |
|
| 1381 | - * all_reg_steps_completed_except |
|
| 1382 | - * returns: |
|
| 1383 | - * true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed |
|
| 1384 | - * or false if any other step is not completed |
|
| 1385 | - * or false if ALL steps are completed including the exception you are testing !!! |
|
| 1386 | - * |
|
| 1387 | - * @param string $exception |
|
| 1388 | - * @return bool |
|
| 1389 | - * @throws EE_Error |
|
| 1390 | - * @throws InvalidArgumentException |
|
| 1391 | - * @throws InvalidDataTypeException |
|
| 1392 | - * @throws InvalidInterfaceException |
|
| 1393 | - * @throws ReflectionException |
|
| 1394 | - */ |
|
| 1395 | - public function all_reg_steps_completed_except($exception = '') |
|
| 1396 | - { |
|
| 1397 | - return $this->_reg_steps_completed($exception); |
|
| 1398 | - } |
|
| 1399 | - |
|
| 1400 | - |
|
| 1401 | - /** |
|
| 1402 | - * all_reg_steps_completed_except |
|
| 1403 | - * returns: |
|
| 1404 | - * true if ALL reg steps, except the final step, have been marked as completed |
|
| 1405 | - * or false if any step is not completed |
|
| 1406 | - * or false if ALL steps are completed including the final step !!! |
|
| 1407 | - * |
|
| 1408 | - * @return bool |
|
| 1409 | - * @throws EE_Error |
|
| 1410 | - * @throws InvalidArgumentException |
|
| 1411 | - * @throws InvalidDataTypeException |
|
| 1412 | - * @throws InvalidInterfaceException |
|
| 1413 | - * @throws ReflectionException |
|
| 1414 | - */ |
|
| 1415 | - public function all_reg_steps_completed_except_final_step() |
|
| 1416 | - { |
|
| 1417 | - return $this->_reg_steps_completed('finalize_registration'); |
|
| 1418 | - } |
|
| 1419 | - |
|
| 1420 | - |
|
| 1421 | - /** |
|
| 1422 | - * reg_step_completed |
|
| 1423 | - * returns: |
|
| 1424 | - * true if a specific reg step has been marked as completed |
|
| 1425 | - * a Unix timestamp if it has been initialized but not yet completed, |
|
| 1426 | - * or false if it has not yet been initialized |
|
| 1427 | - * |
|
| 1428 | - * @param string $reg_step_slug |
|
| 1429 | - * @return bool|int |
|
| 1430 | - * @throws EE_Error |
|
| 1431 | - * @throws InvalidArgumentException |
|
| 1432 | - * @throws InvalidDataTypeException |
|
| 1433 | - * @throws InvalidInterfaceException |
|
| 1434 | - * @throws ReflectionException |
|
| 1435 | - */ |
|
| 1436 | - public function reg_step_completed($reg_step_slug) |
|
| 1437 | - { |
|
| 1438 | - return $this->_reg_steps_completed($reg_step_slug, false); |
|
| 1439 | - } |
|
| 1440 | - |
|
| 1441 | - |
|
| 1442 | - /** |
|
| 1443 | - * completed_final_reg_step |
|
| 1444 | - * returns: |
|
| 1445 | - * true if the finalize_registration reg step has been marked as completed |
|
| 1446 | - * a Unix timestamp if it has been initialized but not yet completed, |
|
| 1447 | - * or false if it has not yet been initialized |
|
| 1448 | - * |
|
| 1449 | - * @return bool|int |
|
| 1450 | - * @throws EE_Error |
|
| 1451 | - * @throws InvalidArgumentException |
|
| 1452 | - * @throws InvalidDataTypeException |
|
| 1453 | - * @throws InvalidInterfaceException |
|
| 1454 | - * @throws ReflectionException |
|
| 1455 | - */ |
|
| 1456 | - public function final_reg_step_completed() |
|
| 1457 | - { |
|
| 1458 | - return $this->_reg_steps_completed('finalize_registration', false); |
|
| 1459 | - } |
|
| 1460 | - |
|
| 1461 | - |
|
| 1462 | - /** |
|
| 1463 | - * set_reg_step_initiated |
|
| 1464 | - * given a valid TXN_reg_step, this sets it's value to a unix timestamp |
|
| 1465 | - * |
|
| 1466 | - * @param string $reg_step_slug |
|
| 1467 | - * @return boolean |
|
| 1468 | - * @throws EE_Error |
|
| 1469 | - * @throws InvalidArgumentException |
|
| 1470 | - * @throws InvalidDataTypeException |
|
| 1471 | - * @throws InvalidInterfaceException |
|
| 1472 | - * @throws ReflectionException |
|
| 1473 | - */ |
|
| 1474 | - public function set_reg_step_initiated($reg_step_slug) |
|
| 1475 | - { |
|
| 1476 | - return $this->_set_reg_step_completed_status($reg_step_slug, time()); |
|
| 1477 | - } |
|
| 1478 | - |
|
| 1479 | - |
|
| 1480 | - /** |
|
| 1481 | - * set_reg_step_completed |
|
| 1482 | - * given a valid TXN_reg_step, this sets the step as completed |
|
| 1483 | - * |
|
| 1484 | - * @param string $reg_step_slug |
|
| 1485 | - * @return boolean |
|
| 1486 | - * @throws EE_Error |
|
| 1487 | - * @throws InvalidArgumentException |
|
| 1488 | - * @throws InvalidDataTypeException |
|
| 1489 | - * @throws InvalidInterfaceException |
|
| 1490 | - * @throws ReflectionException |
|
| 1491 | - */ |
|
| 1492 | - public function set_reg_step_completed($reg_step_slug) |
|
| 1493 | - { |
|
| 1494 | - return $this->_set_reg_step_completed_status($reg_step_slug, true); |
|
| 1495 | - } |
|
| 1496 | - |
|
| 1497 | - |
|
| 1498 | - /** |
|
| 1499 | - * set_reg_step_completed |
|
| 1500 | - * given a valid TXN_reg_step slug, this sets the step as NOT completed |
|
| 1501 | - * |
|
| 1502 | - * @param string $reg_step_slug |
|
| 1503 | - * @return boolean |
|
| 1504 | - * @throws EE_Error |
|
| 1505 | - * @throws InvalidArgumentException |
|
| 1506 | - * @throws InvalidDataTypeException |
|
| 1507 | - * @throws InvalidInterfaceException |
|
| 1508 | - * @throws ReflectionException |
|
| 1509 | - */ |
|
| 1510 | - public function set_reg_step_not_completed($reg_step_slug) |
|
| 1511 | - { |
|
| 1512 | - return $this->_set_reg_step_completed_status($reg_step_slug, false); |
|
| 1513 | - } |
|
| 1514 | - |
|
| 1515 | - |
|
| 1516 | - /** |
|
| 1517 | - * set_reg_step_completed |
|
| 1518 | - * given a valid reg step slug, this sets the TXN_reg_step completed status which is either: |
|
| 1519 | - * |
|
| 1520 | - * @param string $reg_step_slug |
|
| 1521 | - * @param boolean|int $status |
|
| 1522 | - * @return boolean |
|
| 1523 | - * @throws EE_Error |
|
| 1524 | - * @throws InvalidArgumentException |
|
| 1525 | - * @throws InvalidDataTypeException |
|
| 1526 | - * @throws InvalidInterfaceException |
|
| 1527 | - * @throws ReflectionException |
|
| 1528 | - */ |
|
| 1529 | - private function _set_reg_step_completed_status($reg_step_slug, $status) |
|
| 1530 | - { |
|
| 1531 | - // validate status |
|
| 1532 | - $status = is_bool($status) || is_int($status) ? $status : false; |
|
| 1533 | - // get reg steps array |
|
| 1534 | - $txn_reg_steps = $this->reg_steps(); |
|
| 1535 | - // if reg step does NOT exist |
|
| 1536 | - if (! isset($txn_reg_steps[ $reg_step_slug ])) { |
|
| 1537 | - return false; |
|
| 1538 | - } |
|
| 1539 | - // if we're trying to complete a step that is already completed |
|
| 1540 | - if ($txn_reg_steps[ $reg_step_slug ] === true) { |
|
| 1541 | - return true; |
|
| 1542 | - } |
|
| 1543 | - // if we're trying to complete a step that hasn't even started |
|
| 1544 | - if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) { |
|
| 1545 | - return false; |
|
| 1546 | - } |
|
| 1547 | - // if current status value matches the incoming value (no change) |
|
| 1548 | - // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890 |
|
| 1549 | - if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) { |
|
| 1550 | - // this will happen in cases where multiple AJAX requests occur during the same step |
|
| 1551 | - return true; |
|
| 1552 | - } |
|
| 1553 | - // if we're trying to set a start time, but it has already been set... |
|
| 1554 | - if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) { |
|
| 1555 | - // skip the update below, but don't return FALSE so that errors won't be displayed |
|
| 1556 | - return true; |
|
| 1557 | - } |
|
| 1558 | - // update completed status |
|
| 1559 | - $txn_reg_steps[ $reg_step_slug ] = $status; |
|
| 1560 | - $this->set_reg_steps($txn_reg_steps); |
|
| 1561 | - $this->save(); |
|
| 1562 | - return true; |
|
| 1563 | - } |
|
| 1564 | - |
|
| 1565 | - |
|
| 1566 | - /** |
|
| 1567 | - * remove_reg_step |
|
| 1568 | - * given a valid TXN_reg_step slug, this will remove (unset) |
|
| 1569 | - * the reg step from the TXN reg step array |
|
| 1570 | - * |
|
| 1571 | - * @param string $reg_step_slug |
|
| 1572 | - * @return void |
|
| 1573 | - * @throws EE_Error |
|
| 1574 | - * @throws InvalidArgumentException |
|
| 1575 | - * @throws InvalidDataTypeException |
|
| 1576 | - * @throws InvalidInterfaceException |
|
| 1577 | - * @throws ReflectionException |
|
| 1578 | - */ |
|
| 1579 | - public function remove_reg_step($reg_step_slug) |
|
| 1580 | - { |
|
| 1581 | - // get reg steps array |
|
| 1582 | - $txn_reg_steps = $this->reg_steps(); |
|
| 1583 | - unset($txn_reg_steps[ $reg_step_slug ]); |
|
| 1584 | - $this->set_reg_steps($txn_reg_steps); |
|
| 1585 | - } |
|
| 1586 | - |
|
| 1587 | - |
|
| 1588 | - /** |
|
| 1589 | - * toggle_failed_transaction_status |
|
| 1590 | - * upgrades a TXNs status from failed to abandoned, |
|
| 1591 | - * meaning that contact information has been captured for at least one registrant |
|
| 1592 | - * |
|
| 1593 | - * @param bool $save |
|
| 1594 | - * @return bool |
|
| 1595 | - * @throws EE_Error |
|
| 1596 | - * @throws InvalidArgumentException |
|
| 1597 | - * @throws InvalidDataTypeException |
|
| 1598 | - * @throws InvalidInterfaceException |
|
| 1599 | - * @throws ReflectionException |
|
| 1600 | - */ |
|
| 1601 | - public function toggle_failed_transaction_status($save = true) |
|
| 1602 | - { |
|
| 1603 | - // if TXN status is still set as "failed"... |
|
| 1604 | - if ($this->status_ID() === EEM_Transaction::failed_status_code) { |
|
| 1605 | - $this->set_status(EEM_Transaction::abandoned_status_code); |
|
| 1606 | - if ($save) { |
|
| 1607 | - $this->save(); |
|
| 1608 | - } |
|
| 1609 | - return true; |
|
| 1610 | - } |
|
| 1611 | - return false; |
|
| 1612 | - } |
|
| 1613 | - |
|
| 1614 | - |
|
| 1615 | - /** |
|
| 1616 | - * toggle_abandoned_transaction_status |
|
| 1617 | - * upgrades a TXNs status from failed or abandoned to incomplete |
|
| 1618 | - * |
|
| 1619 | - * @return bool |
|
| 1620 | - * @throws EE_Error |
|
| 1621 | - * @throws InvalidArgumentException |
|
| 1622 | - * @throws InvalidDataTypeException |
|
| 1623 | - * @throws InvalidInterfaceException |
|
| 1624 | - * @throws ReflectionException |
|
| 1625 | - */ |
|
| 1626 | - public function toggle_abandoned_transaction_status() |
|
| 1627 | - { |
|
| 1628 | - // if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"... |
|
| 1629 | - $txn_status = $this->status_ID(); |
|
| 1630 | - if ($txn_status === EEM_Transaction::failed_status_code |
|
| 1631 | - || $txn_status === EEM_Transaction::abandoned_status_code |
|
| 1632 | - ) { |
|
| 1633 | - // if a contact record for the primary registrant has been created |
|
| 1634 | - if ($this->primary_registration() instanceof EE_Registration |
|
| 1635 | - && $this->primary_registration()->attendee() instanceof EE_Attendee |
|
| 1636 | - ) { |
|
| 1637 | - $this->set_status(EEM_Transaction::incomplete_status_code); |
|
| 1638 | - } else { |
|
| 1639 | - // no contact record? yer abandoned! |
|
| 1640 | - $this->set_status(EEM_Transaction::abandoned_status_code); |
|
| 1641 | - } |
|
| 1642 | - return true; |
|
| 1643 | - } |
|
| 1644 | - return false; |
|
| 1645 | - } |
|
| 1646 | - |
|
| 1647 | - |
|
| 1648 | - /** |
|
| 1649 | - * checks if an Abandoned TXN has any related payments, and if so, |
|
| 1650 | - * updates the TXN status based on the amount paid |
|
| 1651 | - * |
|
| 1652 | - * @throws EE_Error |
|
| 1653 | - * @throws InvalidDataTypeException |
|
| 1654 | - * @throws InvalidInterfaceException |
|
| 1655 | - * @throws InvalidArgumentException |
|
| 1656 | - * @throws RuntimeException |
|
| 1657 | - * @throws ReflectionException |
|
| 1658 | - */ |
|
| 1659 | - public function verify_abandoned_transaction_status() |
|
| 1660 | - { |
|
| 1661 | - if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) { |
|
| 1662 | - return; |
|
| 1663 | - } |
|
| 1664 | - $payments = $this->get_many_related('Payment'); |
|
| 1665 | - if (! empty($payments)) { |
|
| 1666 | - foreach ($payments as $payment) { |
|
| 1667 | - if ($payment instanceof EE_Payment) { |
|
| 1668 | - // kk this TXN should NOT be abandoned |
|
| 1669 | - $this->update_status_based_on_total_paid(); |
|
| 1670 | - if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
| 1671 | - EE_Error::add_attention( |
|
| 1672 | - sprintf( |
|
| 1673 | - esc_html__( |
|
| 1674 | - 'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.', |
|
| 1675 | - 'event_espresso' |
|
| 1676 | - ), |
|
| 1677 | - $this->ID(), |
|
| 1678 | - $this->pretty_status() |
|
| 1679 | - ) |
|
| 1680 | - ); |
|
| 1681 | - } |
|
| 1682 | - // get final reg step status |
|
| 1683 | - $finalized = $this->final_reg_step_completed(); |
|
| 1684 | - // if the 'finalize_registration' step has been initiated (has a timestamp) |
|
| 1685 | - // but has not yet been fully completed (TRUE) |
|
| 1686 | - if (is_int($finalized) && $finalized !== false && $finalized !== true) { |
|
| 1687 | - $this->set_reg_step_completed('finalize_registration'); |
|
| 1688 | - $this->save(); |
|
| 1689 | - } |
|
| 1690 | - } |
|
| 1691 | - } |
|
| 1692 | - } |
|
| 1693 | - } |
|
| 16 | + /** |
|
| 17 | + * The length of time in seconds that a lock is applied before being considered expired. |
|
| 18 | + * It is not long because a transaction should only be locked for the duration of the request that locked it |
|
| 19 | + */ |
|
| 20 | + const LOCK_EXPIRATION = 2; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * txn status upon initial construction. |
|
| 24 | + * |
|
| 25 | + * @var string |
|
| 26 | + */ |
|
| 27 | + protected $_old_txn_status; |
|
| 28 | + |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @param array $props_n_values incoming values |
|
| 32 | + * @param string $timezone incoming timezone |
|
| 33 | + * (if not set the timezone set for the website will be used.) |
|
| 34 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 35 | + * date_format and the second value is the time format |
|
| 36 | + * @return EE_Transaction |
|
| 37 | + * @throws EE_Error |
|
| 38 | + * @throws InvalidArgumentException |
|
| 39 | + * @throws InvalidDataTypeException |
|
| 40 | + * @throws InvalidInterfaceException |
|
| 41 | + * @throws ReflectionException |
|
| 42 | + */ |
|
| 43 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 44 | + { |
|
| 45 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
| 46 | + $txn = $has_object |
|
| 47 | + ? $has_object |
|
| 48 | + : new self($props_n_values, false, $timezone, $date_formats); |
|
| 49 | + if (! $has_object) { |
|
| 50 | + $txn->set_old_txn_status($txn->status_ID()); |
|
| 51 | + } |
|
| 52 | + return $txn; |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @param array $props_n_values incoming values from the database |
|
| 58 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 59 | + * the website will be used. |
|
| 60 | + * @return EE_Transaction |
|
| 61 | + * @throws EE_Error |
|
| 62 | + * @throws InvalidArgumentException |
|
| 63 | + * @throws InvalidDataTypeException |
|
| 64 | + * @throws InvalidInterfaceException |
|
| 65 | + * @throws ReflectionException |
|
| 66 | + */ |
|
| 67 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 68 | + { |
|
| 69 | + $txn = new self($props_n_values, true, $timezone); |
|
| 70 | + $txn->set_old_txn_status($txn->status_ID()); |
|
| 71 | + return $txn; |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * Sets a meta field indicating that this TXN is locked and should not be updated in the db. |
|
| 77 | + * If a lock has already been set, then we will attempt to remove it in case it has expired. |
|
| 78 | + * If that also fails, then an exception is thrown. |
|
| 79 | + * |
|
| 80 | + * @throws EE_Error |
|
| 81 | + * @throws InvalidArgumentException |
|
| 82 | + * @throws InvalidDataTypeException |
|
| 83 | + * @throws InvalidInterfaceException |
|
| 84 | + * @throws ReflectionException |
|
| 85 | + */ |
|
| 86 | + public function lock() |
|
| 87 | + { |
|
| 88 | + // attempt to set lock, but if that fails... |
|
| 89 | + if (! $this->add_extra_meta('lock', time(), true)) { |
|
| 90 | + // then attempt to remove the lock in case it is expired |
|
| 91 | + if ($this->_remove_expired_lock()) { |
|
| 92 | + // if removal was successful, then try setting lock again |
|
| 93 | + $this->lock(); |
|
| 94 | + } else { |
|
| 95 | + // but if the lock can not be removed, then throw an exception |
|
| 96 | + throw new EE_Error( |
|
| 97 | + sprintf( |
|
| 98 | + __( |
|
| 99 | + 'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.', |
|
| 100 | + 'event_espresso' |
|
| 101 | + ), |
|
| 102 | + $this->ID() |
|
| 103 | + ) |
|
| 104 | + ); |
|
| 105 | + } |
|
| 106 | + } |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * removes transaction lock applied in EE_Transaction::lock() |
|
| 112 | + * |
|
| 113 | + * @return int |
|
| 114 | + * @throws EE_Error |
|
| 115 | + * @throws InvalidArgumentException |
|
| 116 | + * @throws InvalidDataTypeException |
|
| 117 | + * @throws InvalidInterfaceException |
|
| 118 | + * @throws ReflectionException |
|
| 119 | + */ |
|
| 120 | + public function unlock() |
|
| 121 | + { |
|
| 122 | + return $this->delete_extra_meta('lock'); |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * Decides whether or not now is the right time to update the transaction. |
|
| 128 | + * This is useful because we don't always know if it is safe to update the transaction |
|
| 129 | + * and its related data. why? |
|
| 130 | + * because it's possible that the transaction is being used in another |
|
| 131 | + * request and could overwrite anything we save. |
|
| 132 | + * So we want to only update the txn once we know that won't happen. |
|
| 133 | + * We also check that the lock isn't expired, and remove it if it is |
|
| 134 | + * |
|
| 135 | + * @return boolean |
|
| 136 | + * @throws EE_Error |
|
| 137 | + * @throws InvalidArgumentException |
|
| 138 | + * @throws InvalidDataTypeException |
|
| 139 | + * @throws InvalidInterfaceException |
|
| 140 | + * @throws ReflectionException |
|
| 141 | + */ |
|
| 142 | + public function is_locked() |
|
| 143 | + { |
|
| 144 | + // if TXN is not locked, then return false immediately |
|
| 145 | + if (! $this->_get_lock()) { |
|
| 146 | + return false; |
|
| 147 | + } |
|
| 148 | + // if not, then let's try and remove the lock in case it's expired... |
|
| 149 | + // _remove_expired_lock() returns 0 when lock is valid (ie: removed = false) |
|
| 150 | + // and a positive number if the lock was removed (ie: number of locks deleted), |
|
| 151 | + // so we need to return the opposite |
|
| 152 | + return ! $this->_remove_expired_lock() ? true : false; |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Gets the meta field indicating that this TXN is locked |
|
| 158 | + * |
|
| 159 | + * @return int |
|
| 160 | + * @throws EE_Error |
|
| 161 | + * @throws InvalidArgumentException |
|
| 162 | + * @throws InvalidDataTypeException |
|
| 163 | + * @throws InvalidInterfaceException |
|
| 164 | + * @throws ReflectionException |
|
| 165 | + */ |
|
| 166 | + protected function _get_lock() |
|
| 167 | + { |
|
| 168 | + return (int) $this->get_extra_meta('lock', true, 0); |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated |
|
| 174 | + * |
|
| 175 | + * @return int |
|
| 176 | + * @throws EE_Error |
|
| 177 | + * @throws InvalidArgumentException |
|
| 178 | + * @throws InvalidDataTypeException |
|
| 179 | + * @throws InvalidInterfaceException |
|
| 180 | + * @throws ReflectionException |
|
| 181 | + */ |
|
| 182 | + protected function _remove_expired_lock() |
|
| 183 | + { |
|
| 184 | + $locked = $this->_get_lock(); |
|
| 185 | + if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) { |
|
| 186 | + return $this->unlock(); |
|
| 187 | + } |
|
| 188 | + return 0; |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Set transaction total |
|
| 194 | + * |
|
| 195 | + * @param float $total total value of transaction |
|
| 196 | + * @throws EE_Error |
|
| 197 | + * @throws InvalidArgumentException |
|
| 198 | + * @throws InvalidDataTypeException |
|
| 199 | + * @throws InvalidInterfaceException |
|
| 200 | + * @throws ReflectionException |
|
| 201 | + */ |
|
| 202 | + public function set_total($total = 0.00) |
|
| 203 | + { |
|
| 204 | + $this->set('TXN_total', (float) $total); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * Set Total Amount Paid to Date |
|
| 210 | + * |
|
| 211 | + * @param float $total_paid total amount paid to date (sum of all payments) |
|
| 212 | + * @throws EE_Error |
|
| 213 | + * @throws InvalidArgumentException |
|
| 214 | + * @throws InvalidDataTypeException |
|
| 215 | + * @throws InvalidInterfaceException |
|
| 216 | + * @throws ReflectionException |
|
| 217 | + */ |
|
| 218 | + public function set_paid($total_paid = 0.00) |
|
| 219 | + { |
|
| 220 | + $this->set('TXN_paid', (float) $total_paid); |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + |
|
| 224 | + /** |
|
| 225 | + * Set transaction status |
|
| 226 | + * |
|
| 227 | + * @param string $status whether the transaction is open, declined, accepted, |
|
| 228 | + * or any number of custom values that can be set |
|
| 229 | + * @throws EE_Error |
|
| 230 | + * @throws InvalidArgumentException |
|
| 231 | + * @throws InvalidDataTypeException |
|
| 232 | + * @throws InvalidInterfaceException |
|
| 233 | + * @throws ReflectionException |
|
| 234 | + */ |
|
| 235 | + public function set_status($status = '') |
|
| 236 | + { |
|
| 237 | + $this->set('STS_ID', $status); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * Set hash salt |
|
| 243 | + * |
|
| 244 | + * @param string $hash_salt required for some payment gateways |
|
| 245 | + * @throws EE_Error |
|
| 246 | + * @throws InvalidArgumentException |
|
| 247 | + * @throws InvalidDataTypeException |
|
| 248 | + * @throws InvalidInterfaceException |
|
| 249 | + * @throws ReflectionException |
|
| 250 | + */ |
|
| 251 | + public function set_hash_salt($hash_salt = '') |
|
| 252 | + { |
|
| 253 | + $this->set('TXN_hash_salt', $hash_salt); |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + |
|
| 257 | + /** |
|
| 258 | + * Sets TXN_reg_steps array |
|
| 259 | + * |
|
| 260 | + * @param array $txn_reg_steps |
|
| 261 | + * @throws EE_Error |
|
| 262 | + * @throws InvalidArgumentException |
|
| 263 | + * @throws InvalidDataTypeException |
|
| 264 | + * @throws InvalidInterfaceException |
|
| 265 | + * @throws ReflectionException |
|
| 266 | + */ |
|
| 267 | + public function set_reg_steps(array $txn_reg_steps) |
|
| 268 | + { |
|
| 269 | + $this->set('TXN_reg_steps', $txn_reg_steps); |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + |
|
| 273 | + /** |
|
| 274 | + * Gets TXN_reg_steps |
|
| 275 | + * |
|
| 276 | + * @return array |
|
| 277 | + * @throws EE_Error |
|
| 278 | + * @throws InvalidArgumentException |
|
| 279 | + * @throws InvalidDataTypeException |
|
| 280 | + * @throws InvalidInterfaceException |
|
| 281 | + * @throws ReflectionException |
|
| 282 | + */ |
|
| 283 | + public function reg_steps() |
|
| 284 | + { |
|
| 285 | + $TXN_reg_steps = $this->get('TXN_reg_steps'); |
|
| 286 | + return is_array($TXN_reg_steps) ? (array) $TXN_reg_steps : array(); |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + |
|
| 290 | + /** |
|
| 291 | + * @return string of transaction's total cost, with currency symbol and decimal |
|
| 292 | + * @throws EE_Error |
|
| 293 | + * @throws InvalidArgumentException |
|
| 294 | + * @throws InvalidDataTypeException |
|
| 295 | + * @throws InvalidInterfaceException |
|
| 296 | + * @throws ReflectionException |
|
| 297 | + */ |
|
| 298 | + public function pretty_total() |
|
| 299 | + { |
|
| 300 | + return $this->get_pretty('TXN_total'); |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + |
|
| 304 | + /** |
|
| 305 | + * Gets the amount paid in a pretty string (formatted and with currency symbol) |
|
| 306 | + * |
|
| 307 | + * @return string |
|
| 308 | + * @throws EE_Error |
|
| 309 | + * @throws InvalidArgumentException |
|
| 310 | + * @throws InvalidDataTypeException |
|
| 311 | + * @throws InvalidInterfaceException |
|
| 312 | + * @throws ReflectionException |
|
| 313 | + */ |
|
| 314 | + public function pretty_paid() |
|
| 315 | + { |
|
| 316 | + return $this->get_pretty('TXN_paid'); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * calculate the amount remaining for this transaction and return; |
|
| 322 | + * |
|
| 323 | + * @return float amount remaining |
|
| 324 | + * @throws EE_Error |
|
| 325 | + * @throws InvalidArgumentException |
|
| 326 | + * @throws InvalidDataTypeException |
|
| 327 | + * @throws InvalidInterfaceException |
|
| 328 | + * @throws ReflectionException |
|
| 329 | + */ |
|
| 330 | + public function remaining() |
|
| 331 | + { |
|
| 332 | + return $this->total() - $this->paid(); |
|
| 333 | + } |
|
| 334 | + |
|
| 335 | + |
|
| 336 | + /** |
|
| 337 | + * get Transaction Total |
|
| 338 | + * |
|
| 339 | + * @return float |
|
| 340 | + * @throws EE_Error |
|
| 341 | + * @throws InvalidArgumentException |
|
| 342 | + * @throws InvalidDataTypeException |
|
| 343 | + * @throws InvalidInterfaceException |
|
| 344 | + * @throws ReflectionException |
|
| 345 | + */ |
|
| 346 | + public function total() |
|
| 347 | + { |
|
| 348 | + return (float) $this->get('TXN_total'); |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + |
|
| 352 | + /** |
|
| 353 | + * get Total Amount Paid to Date |
|
| 354 | + * |
|
| 355 | + * @return float |
|
| 356 | + * @throws EE_Error |
|
| 357 | + * @throws InvalidArgumentException |
|
| 358 | + * @throws InvalidDataTypeException |
|
| 359 | + * @throws InvalidInterfaceException |
|
| 360 | + * @throws ReflectionException |
|
| 361 | + */ |
|
| 362 | + public function paid() |
|
| 363 | + { |
|
| 364 | + return (float) $this->get('TXN_paid'); |
|
| 365 | + } |
|
| 366 | + |
|
| 367 | + |
|
| 368 | + /** |
|
| 369 | + * @return mixed|null |
|
| 370 | + * @throws EE_Error |
|
| 371 | + * @throws InvalidArgumentException |
|
| 372 | + * @throws InvalidDataTypeException |
|
| 373 | + * @throws InvalidInterfaceException |
|
| 374 | + * @throws ReflectionException |
|
| 375 | + */ |
|
| 376 | + public function get_cart_session() |
|
| 377 | + { |
|
| 378 | + $session_data = (array) $this->get('TXN_session_data'); |
|
| 379 | + return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart |
|
| 380 | + ? $session_data['cart'] |
|
| 381 | + : null; |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * get Transaction session data |
|
| 387 | + * |
|
| 388 | + * @return array|mixed |
|
| 389 | + * @throws EE_Error |
|
| 390 | + * @throws InvalidArgumentException |
|
| 391 | + * @throws InvalidDataTypeException |
|
| 392 | + * @throws InvalidInterfaceException |
|
| 393 | + * @throws ReflectionException |
|
| 394 | + */ |
|
| 395 | + public function session_data() |
|
| 396 | + { |
|
| 397 | + $session_data = $this->get('TXN_session_data'); |
|
| 398 | + if (empty($session_data)) { |
|
| 399 | + $session_data = array( |
|
| 400 | + 'id' => null, |
|
| 401 | + 'user_id' => null, |
|
| 402 | + 'ip_address' => null, |
|
| 403 | + 'user_agent' => null, |
|
| 404 | + 'init_access' => null, |
|
| 405 | + 'last_access' => null, |
|
| 406 | + 'pages_visited' => array(), |
|
| 407 | + ); |
|
| 408 | + } |
|
| 409 | + return $session_data; |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + |
|
| 413 | + /** |
|
| 414 | + * Set session data within the TXN object |
|
| 415 | + * |
|
| 416 | + * @param EE_Session|array $session_data |
|
| 417 | + * @throws EE_Error |
|
| 418 | + * @throws InvalidArgumentException |
|
| 419 | + * @throws InvalidDataTypeException |
|
| 420 | + * @throws InvalidInterfaceException |
|
| 421 | + * @throws ReflectionException |
|
| 422 | + */ |
|
| 423 | + public function set_txn_session_data($session_data) |
|
| 424 | + { |
|
| 425 | + if ($session_data instanceof EE_Session) { |
|
| 426 | + $this->set('TXN_session_data', $session_data->get_session_data(null, true)); |
|
| 427 | + } else { |
|
| 428 | + $this->set('TXN_session_data', $session_data); |
|
| 429 | + } |
|
| 430 | + } |
|
| 431 | + |
|
| 432 | + |
|
| 433 | + /** |
|
| 434 | + * get Transaction hash salt |
|
| 435 | + * |
|
| 436 | + * @return mixed |
|
| 437 | + * @throws EE_Error |
|
| 438 | + * @throws InvalidArgumentException |
|
| 439 | + * @throws InvalidDataTypeException |
|
| 440 | + * @throws InvalidInterfaceException |
|
| 441 | + * @throws ReflectionException |
|
| 442 | + */ |
|
| 443 | + public function hash_salt_() |
|
| 444 | + { |
|
| 445 | + return $this->get('TXN_hash_salt'); |
|
| 446 | + } |
|
| 447 | + |
|
| 448 | + |
|
| 449 | + /** |
|
| 450 | + * Returns the transaction datetime as either: |
|
| 451 | + * - unix timestamp format ($format = false, $gmt = true) |
|
| 452 | + * - formatted date string including the UTC (timezone) offset ($format = true ($gmt |
|
| 453 | + * has no affect with this option)), this also may include a timezone abbreviation if the |
|
| 454 | + * set timezone in this class differs from what the timezone is on the blog. |
|
| 455 | + * - formatted date string including the UTC (timezone) offset (default). |
|
| 456 | + * |
|
| 457 | + * @param boolean $format - whether to return a unix timestamp (default) or formatted date string |
|
| 458 | + * @param boolean $gmt - whether to return a unix timestamp with UTC offset applied (default) |
|
| 459 | + * or no UTC offset applied |
|
| 460 | + * @return string | int |
|
| 461 | + * @throws EE_Error |
|
| 462 | + * @throws InvalidArgumentException |
|
| 463 | + * @throws InvalidDataTypeException |
|
| 464 | + * @throws InvalidInterfaceException |
|
| 465 | + * @throws ReflectionException |
|
| 466 | + */ |
|
| 467 | + public function datetime($format = false, $gmt = false) |
|
| 468 | + { |
|
| 469 | + if ($format) { |
|
| 470 | + return $this->get_pretty('TXN_timestamp'); |
|
| 471 | + } |
|
| 472 | + if ($gmt) { |
|
| 473 | + return $this->get_raw('TXN_timestamp'); |
|
| 474 | + } |
|
| 475 | + return $this->get('TXN_timestamp'); |
|
| 476 | + } |
|
| 477 | + |
|
| 478 | + |
|
| 479 | + /** |
|
| 480 | + * Gets registrations on this transaction |
|
| 481 | + * |
|
| 482 | + * @param array $query_params array of query parameters |
|
| 483 | + * @param boolean $get_cached TRUE to retrieve cached registrations or FALSE to pull from the db |
|
| 484 | + * @return EE_Base_Class[]|EE_Registration[] |
|
| 485 | + * @throws EE_Error |
|
| 486 | + * @throws InvalidArgumentException |
|
| 487 | + * @throws InvalidDataTypeException |
|
| 488 | + * @throws InvalidInterfaceException |
|
| 489 | + * @throws ReflectionException |
|
| 490 | + */ |
|
| 491 | + public function registrations($query_params = array(), $get_cached = false) |
|
| 492 | + { |
|
| 493 | + $query_params = (empty($query_params) || ! is_array($query_params)) |
|
| 494 | + ? array( |
|
| 495 | + 'order_by' => array( |
|
| 496 | + 'Event.EVT_name' => 'ASC', |
|
| 497 | + 'Attendee.ATT_lname' => 'ASC', |
|
| 498 | + 'Attendee.ATT_fname' => 'ASC', |
|
| 499 | + ), |
|
| 500 | + ) |
|
| 501 | + : $query_params; |
|
| 502 | + $query_params = $get_cached ? array() : $query_params; |
|
| 503 | + return $this->get_many_related('Registration', $query_params); |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + |
|
| 507 | + /** |
|
| 508 | + * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event |
|
| 509 | + * function for getting attendees and how many registrations they each have for an event) |
|
| 510 | + * |
|
| 511 | + * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT' |
|
| 512 | + * @throws EE_Error |
|
| 513 | + * @throws InvalidArgumentException |
|
| 514 | + * @throws InvalidDataTypeException |
|
| 515 | + * @throws InvalidInterfaceException |
|
| 516 | + * @throws ReflectionException |
|
| 517 | + */ |
|
| 518 | + public function attendees() |
|
| 519 | + { |
|
| 520 | + return $this->get_many_related('Attendee', array(array('Registration.Transaction.TXN_ID' => $this->ID()))); |
|
| 521 | + } |
|
| 522 | + |
|
| 523 | + |
|
| 524 | + /** |
|
| 525 | + * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default |
|
| 526 | + * |
|
| 527 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 528 | + * @return EE_Base_Class[]|EE_Payment[] |
|
| 529 | + * @throws EE_Error |
|
| 530 | + * @throws InvalidArgumentException |
|
| 531 | + * @throws InvalidDataTypeException |
|
| 532 | + * @throws InvalidInterfaceException |
|
| 533 | + * @throws ReflectionException |
|
| 534 | + */ |
|
| 535 | + public function payments($query_params = array()) |
|
| 536 | + { |
|
| 537 | + return $this->get_many_related('Payment', $query_params); |
|
| 538 | + } |
|
| 539 | + |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * gets only approved payments for this transaction |
|
| 543 | + * |
|
| 544 | + * @return EE_Base_Class[]|EE_Payment[] |
|
| 545 | + * @throws EE_Error |
|
| 546 | + * @throws InvalidArgumentException |
|
| 547 | + * @throws ReflectionException |
|
| 548 | + * @throws InvalidDataTypeException |
|
| 549 | + * @throws InvalidInterfaceException |
|
| 550 | + */ |
|
| 551 | + public function approved_payments() |
|
| 552 | + { |
|
| 553 | + EE_Registry::instance()->load_model('Payment'); |
|
| 554 | + return $this->get_many_related( |
|
| 555 | + 'Payment', |
|
| 556 | + array( |
|
| 557 | + array('STS_ID' => EEM_Payment::status_id_approved), |
|
| 558 | + 'order_by' => array('PAY_timestamp' => 'DESC'), |
|
| 559 | + ) |
|
| 560 | + ); |
|
| 561 | + } |
|
| 562 | + |
|
| 563 | + |
|
| 564 | + /** |
|
| 565 | + * Gets all payments which have not been approved |
|
| 566 | + * |
|
| 567 | + * @return EE_Base_Class[]|EEI_Payment[] |
|
| 568 | + * @throws EE_Error if a model is misconfigured somehow |
|
| 569 | + * @throws InvalidArgumentException |
|
| 570 | + * @throws InvalidDataTypeException |
|
| 571 | + * @throws InvalidInterfaceException |
|
| 572 | + * @throws ReflectionException |
|
| 573 | + */ |
|
| 574 | + public function pending_payments() |
|
| 575 | + { |
|
| 576 | + return $this->get_many_related( |
|
| 577 | + 'Payment', |
|
| 578 | + array( |
|
| 579 | + array( |
|
| 580 | + 'STS_ID' => EEM_Payment::status_id_pending, |
|
| 581 | + ), |
|
| 582 | + 'order_by' => array( |
|
| 583 | + 'PAY_timestamp' => 'DESC', |
|
| 584 | + ), |
|
| 585 | + ) |
|
| 586 | + ); |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + |
|
| 590 | + /** |
|
| 591 | + * echoes $this->pretty_status() |
|
| 592 | + * |
|
| 593 | + * @param bool $show_icons |
|
| 594 | + * @throws EE_Error |
|
| 595 | + * @throws InvalidArgumentException |
|
| 596 | + * @throws InvalidDataTypeException |
|
| 597 | + * @throws InvalidInterfaceException |
|
| 598 | + * @throws ReflectionException |
|
| 599 | + */ |
|
| 600 | + public function e_pretty_status($show_icons = false) |
|
| 601 | + { |
|
| 602 | + echo $this->pretty_status($show_icons); |
|
| 603 | + } |
|
| 604 | + |
|
| 605 | + |
|
| 606 | + /** |
|
| 607 | + * returns a pretty version of the status, good for displaying to users |
|
| 608 | + * |
|
| 609 | + * @param bool $show_icons |
|
| 610 | + * @return string |
|
| 611 | + * @throws EE_Error |
|
| 612 | + * @throws InvalidArgumentException |
|
| 613 | + * @throws InvalidDataTypeException |
|
| 614 | + * @throws InvalidInterfaceException |
|
| 615 | + * @throws ReflectionException |
|
| 616 | + */ |
|
| 617 | + public function pretty_status($show_icons = false) |
|
| 618 | + { |
|
| 619 | + $status = EEM_Status::instance()->localized_status( |
|
| 620 | + array($this->status_ID() => __('unknown', 'event_espresso')), |
|
| 621 | + false, |
|
| 622 | + 'sentence' |
|
| 623 | + ); |
|
| 624 | + $icon = ''; |
|
| 625 | + switch ($this->status_ID()) { |
|
| 626 | + case EEM_Transaction::complete_status_code: |
|
| 627 | + $icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : ''; |
|
| 628 | + break; |
|
| 629 | + case EEM_Transaction::incomplete_status_code: |
|
| 630 | + $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>' |
|
| 631 | + : ''; |
|
| 632 | + break; |
|
| 633 | + case EEM_Transaction::abandoned_status_code: |
|
| 634 | + $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : ''; |
|
| 635 | + break; |
|
| 636 | + case EEM_Transaction::failed_status_code: |
|
| 637 | + $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : ''; |
|
| 638 | + break; |
|
| 639 | + case EEM_Transaction::overpaid_status_code: |
|
| 640 | + $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : ''; |
|
| 641 | + break; |
|
| 642 | + } |
|
| 643 | + return $icon . $status[ $this->status_ID() ]; |
|
| 644 | + } |
|
| 645 | + |
|
| 646 | + |
|
| 647 | + /** |
|
| 648 | + * get Transaction Status |
|
| 649 | + * |
|
| 650 | + * @return mixed |
|
| 651 | + * @throws EE_Error |
|
| 652 | + * @throws InvalidArgumentException |
|
| 653 | + * @throws InvalidDataTypeException |
|
| 654 | + * @throws InvalidInterfaceException |
|
| 655 | + * @throws ReflectionException |
|
| 656 | + */ |
|
| 657 | + public function status_ID() |
|
| 658 | + { |
|
| 659 | + return $this->get('STS_ID'); |
|
| 660 | + } |
|
| 661 | + |
|
| 662 | + |
|
| 663 | + /** |
|
| 664 | + * Returns TRUE or FALSE for whether or not this transaction cost any money |
|
| 665 | + * |
|
| 666 | + * @return boolean |
|
| 667 | + * @throws EE_Error |
|
| 668 | + * @throws InvalidArgumentException |
|
| 669 | + * @throws InvalidDataTypeException |
|
| 670 | + * @throws InvalidInterfaceException |
|
| 671 | + * @throws ReflectionException |
|
| 672 | + */ |
|
| 673 | + public function is_free() |
|
| 674 | + { |
|
| 675 | + return EEH_Money::compare_floats($this->get('TXN_total'), 0, '=='); |
|
| 676 | + } |
|
| 677 | + |
|
| 678 | + |
|
| 679 | + /** |
|
| 680 | + * Returns whether this transaction is complete |
|
| 681 | + * Useful in templates and other logic for deciding if we should ask for another payment... |
|
| 682 | + * |
|
| 683 | + * @return boolean |
|
| 684 | + * @throws EE_Error |
|
| 685 | + * @throws InvalidArgumentException |
|
| 686 | + * @throws InvalidDataTypeException |
|
| 687 | + * @throws InvalidInterfaceException |
|
| 688 | + * @throws ReflectionException |
|
| 689 | + */ |
|
| 690 | + public function is_completed() |
|
| 691 | + { |
|
| 692 | + return $this->status_ID() === EEM_Transaction::complete_status_code; |
|
| 693 | + } |
|
| 694 | + |
|
| 695 | + |
|
| 696 | + /** |
|
| 697 | + * Returns whether this transaction is incomplete |
|
| 698 | + * Useful in templates and other logic for deciding if we should ask for another payment... |
|
| 699 | + * |
|
| 700 | + * @return boolean |
|
| 701 | + * @throws EE_Error |
|
| 702 | + * @throws InvalidArgumentException |
|
| 703 | + * @throws InvalidDataTypeException |
|
| 704 | + * @throws InvalidInterfaceException |
|
| 705 | + * @throws ReflectionException |
|
| 706 | + */ |
|
| 707 | + public function is_incomplete() |
|
| 708 | + { |
|
| 709 | + return $this->status_ID() === EEM_Transaction::incomplete_status_code; |
|
| 710 | + } |
|
| 711 | + |
|
| 712 | + |
|
| 713 | + /** |
|
| 714 | + * Returns whether this transaction is overpaid |
|
| 715 | + * Useful in templates and other logic for deciding if monies need to be refunded |
|
| 716 | + * |
|
| 717 | + * @return boolean |
|
| 718 | + * @throws EE_Error |
|
| 719 | + * @throws InvalidArgumentException |
|
| 720 | + * @throws InvalidDataTypeException |
|
| 721 | + * @throws InvalidInterfaceException |
|
| 722 | + * @throws ReflectionException |
|
| 723 | + */ |
|
| 724 | + public function is_overpaid() |
|
| 725 | + { |
|
| 726 | + return $this->status_ID() === EEM_Transaction::overpaid_status_code; |
|
| 727 | + } |
|
| 728 | + |
|
| 729 | + |
|
| 730 | + /** |
|
| 731 | + * Returns whether this transaction was abandoned |
|
| 732 | + * meaning that the transaction/registration process was somehow interrupted and never completed |
|
| 733 | + * but that contact information exists for at least one registrant |
|
| 734 | + * |
|
| 735 | + * @return boolean |
|
| 736 | + * @throws EE_Error |
|
| 737 | + * @throws InvalidArgumentException |
|
| 738 | + * @throws InvalidDataTypeException |
|
| 739 | + * @throws InvalidInterfaceException |
|
| 740 | + * @throws ReflectionException |
|
| 741 | + */ |
|
| 742 | + public function is_abandoned() |
|
| 743 | + { |
|
| 744 | + return $this->status_ID() === EEM_Transaction::abandoned_status_code; |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + |
|
| 748 | + /** |
|
| 749 | + * Returns whether this transaction failed |
|
| 750 | + * meaning that the transaction/registration process was somehow interrupted and never completed |
|
| 751 | + * and that NO contact information exists for any registrants |
|
| 752 | + * |
|
| 753 | + * @return boolean |
|
| 754 | + * @throws EE_Error |
|
| 755 | + * @throws InvalidArgumentException |
|
| 756 | + * @throws InvalidDataTypeException |
|
| 757 | + * @throws InvalidInterfaceException |
|
| 758 | + * @throws ReflectionException |
|
| 759 | + */ |
|
| 760 | + public function failed() |
|
| 761 | + { |
|
| 762 | + return $this->status_ID() === EEM_Transaction::failed_status_code; |
|
| 763 | + } |
|
| 764 | + |
|
| 765 | + |
|
| 766 | + /** |
|
| 767 | + * This returns the url for the invoice of this transaction |
|
| 768 | + * |
|
| 769 | + * @param string $type 'html' or 'pdf' (default is pdf) |
|
| 770 | + * @return string |
|
| 771 | + * @throws EE_Error |
|
| 772 | + * @throws InvalidArgumentException |
|
| 773 | + * @throws InvalidDataTypeException |
|
| 774 | + * @throws InvalidInterfaceException |
|
| 775 | + * @throws ReflectionException |
|
| 776 | + */ |
|
| 777 | + public function invoice_url($type = 'html') |
|
| 778 | + { |
|
| 779 | + $REG = $this->primary_registration(); |
|
| 780 | + if (! $REG instanceof EE_Registration) { |
|
| 781 | + return ''; |
|
| 782 | + } |
|
| 783 | + return $REG->invoice_url($type); |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + |
|
| 787 | + /** |
|
| 788 | + * Gets the primary registration only |
|
| 789 | + * |
|
| 790 | + * @return EE_Base_Class|EE_Registration |
|
| 791 | + * @throws EE_Error |
|
| 792 | + * @throws InvalidArgumentException |
|
| 793 | + * @throws InvalidDataTypeException |
|
| 794 | + * @throws InvalidInterfaceException |
|
| 795 | + * @throws ReflectionException |
|
| 796 | + */ |
|
| 797 | + public function primary_registration() |
|
| 798 | + { |
|
| 799 | + $registrations = (array) $this->get_many_related( |
|
| 800 | + 'Registration', |
|
| 801 | + array(array('REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT)) |
|
| 802 | + ); |
|
| 803 | + foreach ($registrations as $registration) { |
|
| 804 | + // valid registration that is NOT cancelled or declined ? |
|
| 805 | + if ($registration instanceof EE_Registration |
|
| 806 | + && ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true) |
|
| 807 | + ) { |
|
| 808 | + return $registration; |
|
| 809 | + } |
|
| 810 | + } |
|
| 811 | + // nothing valid found, so just return first thing from array of results |
|
| 812 | + return reset($registrations); |
|
| 813 | + } |
|
| 814 | + |
|
| 815 | + |
|
| 816 | + /** |
|
| 817 | + * Gets the URL for viewing the receipt |
|
| 818 | + * |
|
| 819 | + * @param string $type 'pdf' or 'html' (default is 'html') |
|
| 820 | + * @return string |
|
| 821 | + * @throws EE_Error |
|
| 822 | + * @throws InvalidArgumentException |
|
| 823 | + * @throws InvalidDataTypeException |
|
| 824 | + * @throws InvalidInterfaceException |
|
| 825 | + * @throws ReflectionException |
|
| 826 | + */ |
|
| 827 | + public function receipt_url($type = 'html') |
|
| 828 | + { |
|
| 829 | + $REG = $this->primary_registration(); |
|
| 830 | + if (! $REG instanceof EE_Registration) { |
|
| 831 | + return ''; |
|
| 832 | + } |
|
| 833 | + return $REG->receipt_url($type); |
|
| 834 | + } |
|
| 835 | + |
|
| 836 | + |
|
| 837 | + /** |
|
| 838 | + * Gets the URL of the thank you page with this registration REG_url_link added as |
|
| 839 | + * a query parameter |
|
| 840 | + * |
|
| 841 | + * @return string |
|
| 842 | + * @throws EE_Error |
|
| 843 | + * @throws InvalidArgumentException |
|
| 844 | + * @throws InvalidDataTypeException |
|
| 845 | + * @throws InvalidInterfaceException |
|
| 846 | + * @throws ReflectionException |
|
| 847 | + */ |
|
| 848 | + public function payment_overview_url() |
|
| 849 | + { |
|
| 850 | + $primary_registration = $this->primary_registration(); |
|
| 851 | + return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false; |
|
| 852 | + } |
|
| 853 | + |
|
| 854 | + |
|
| 855 | + /** |
|
| 856 | + * @return string |
|
| 857 | + * @throws EE_Error |
|
| 858 | + * @throws InvalidArgumentException |
|
| 859 | + * @throws InvalidDataTypeException |
|
| 860 | + * @throws InvalidInterfaceException |
|
| 861 | + * @throws ReflectionException |
|
| 862 | + */ |
|
| 863 | + public function gateway_response_on_transaction() |
|
| 864 | + { |
|
| 865 | + $payment = $this->get_first_related('Payment'); |
|
| 866 | + return $payment instanceof EE_Payment ? $payment->gateway_response() : ''; |
|
| 867 | + } |
|
| 868 | + |
|
| 869 | + |
|
| 870 | + /** |
|
| 871 | + * Get the status object of this object |
|
| 872 | + * |
|
| 873 | + * @return EE_Base_Class|EE_Status |
|
| 874 | + * @throws EE_Error |
|
| 875 | + * @throws InvalidArgumentException |
|
| 876 | + * @throws InvalidDataTypeException |
|
| 877 | + * @throws InvalidInterfaceException |
|
| 878 | + * @throws ReflectionException |
|
| 879 | + */ |
|
| 880 | + public function status_obj() |
|
| 881 | + { |
|
| 882 | + return $this->get_first_related('Status'); |
|
| 883 | + } |
|
| 884 | + |
|
| 885 | + |
|
| 886 | + /** |
|
| 887 | + * Gets all the extra meta info on this payment |
|
| 888 | + * |
|
| 889 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 890 | + * @return EE_Base_Class[]|EE_Extra_Meta |
|
| 891 | + * @throws EE_Error |
|
| 892 | + * @throws InvalidArgumentException |
|
| 893 | + * @throws InvalidDataTypeException |
|
| 894 | + * @throws InvalidInterfaceException |
|
| 895 | + * @throws ReflectionException |
|
| 896 | + */ |
|
| 897 | + public function extra_meta($query_params = array()) |
|
| 898 | + { |
|
| 899 | + return $this->get_many_related('Extra_Meta', $query_params); |
|
| 900 | + } |
|
| 901 | + |
|
| 902 | + |
|
| 903 | + /** |
|
| 904 | + * Wrapper for _add_relation_to |
|
| 905 | + * |
|
| 906 | + * @param EE_Registration $registration |
|
| 907 | + * @return EE_Base_Class the relation was added to |
|
| 908 | + * @throws EE_Error |
|
| 909 | + * @throws InvalidArgumentException |
|
| 910 | + * @throws InvalidDataTypeException |
|
| 911 | + * @throws InvalidInterfaceException |
|
| 912 | + * @throws ReflectionException |
|
| 913 | + */ |
|
| 914 | + public function add_registration(EE_Registration $registration) |
|
| 915 | + { |
|
| 916 | + return $this->_add_relation_to($registration, 'Registration'); |
|
| 917 | + } |
|
| 918 | + |
|
| 919 | + |
|
| 920 | + /** |
|
| 921 | + * Removes the given registration from being related (even before saving this transaction). |
|
| 922 | + * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations |
|
| 923 | + * |
|
| 924 | + * @param int $registration_or_id |
|
| 925 | + * @return EE_Base_Class that was removed from being related |
|
| 926 | + * @throws EE_Error |
|
| 927 | + * @throws InvalidArgumentException |
|
| 928 | + * @throws InvalidDataTypeException |
|
| 929 | + * @throws InvalidInterfaceException |
|
| 930 | + * @throws ReflectionException |
|
| 931 | + */ |
|
| 932 | + public function remove_registration_with_id($registration_or_id) |
|
| 933 | + { |
|
| 934 | + return $this->_remove_relation_to($registration_or_id, 'Registration'); |
|
| 935 | + } |
|
| 936 | + |
|
| 937 | + |
|
| 938 | + /** |
|
| 939 | + * Gets all the line items which are for ACTUAL items |
|
| 940 | + * |
|
| 941 | + * @return EE_Line_Item[] |
|
| 942 | + * @throws EE_Error |
|
| 943 | + * @throws InvalidArgumentException |
|
| 944 | + * @throws InvalidDataTypeException |
|
| 945 | + * @throws InvalidInterfaceException |
|
| 946 | + * @throws ReflectionException |
|
| 947 | + */ |
|
| 948 | + public function items_purchased() |
|
| 949 | + { |
|
| 950 | + return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_line_item))); |
|
| 951 | + } |
|
| 952 | + |
|
| 953 | + |
|
| 954 | + /** |
|
| 955 | + * Wrapper for _add_relation_to |
|
| 956 | + * |
|
| 957 | + * @param EE_Line_Item $line_item |
|
| 958 | + * @return EE_Base_Class the relation was added to |
|
| 959 | + * @throws EE_Error |
|
| 960 | + * @throws InvalidArgumentException |
|
| 961 | + * @throws InvalidDataTypeException |
|
| 962 | + * @throws InvalidInterfaceException |
|
| 963 | + * @throws ReflectionException |
|
| 964 | + */ |
|
| 965 | + public function add_line_item(EE_Line_Item $line_item) |
|
| 966 | + { |
|
| 967 | + return $this->_add_relation_to($line_item, 'Line_Item'); |
|
| 968 | + } |
|
| 969 | + |
|
| 970 | + |
|
| 971 | + /** |
|
| 972 | + * Gets ALL the line items related to this transaction (unstructured) |
|
| 973 | + * |
|
| 974 | + * @param array $query_params |
|
| 975 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 976 | + * @throws EE_Error |
|
| 977 | + * @throws InvalidArgumentException |
|
| 978 | + * @throws InvalidDataTypeException |
|
| 979 | + * @throws InvalidInterfaceException |
|
| 980 | + * @throws ReflectionException |
|
| 981 | + */ |
|
| 982 | + public function line_items($query_params = array()) |
|
| 983 | + { |
|
| 984 | + return $this->get_many_related('Line_Item', $query_params); |
|
| 985 | + } |
|
| 986 | + |
|
| 987 | + |
|
| 988 | + /** |
|
| 989 | + * Gets all the line items which are taxes on the total |
|
| 990 | + * |
|
| 991 | + * @return EE_Line_Item[] |
|
| 992 | + * @throws EE_Error |
|
| 993 | + * @throws InvalidArgumentException |
|
| 994 | + * @throws InvalidDataTypeException |
|
| 995 | + * @throws InvalidInterfaceException |
|
| 996 | + * @throws ReflectionException |
|
| 997 | + */ |
|
| 998 | + public function tax_items() |
|
| 999 | + { |
|
| 1000 | + return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax))); |
|
| 1001 | + } |
|
| 1002 | + |
|
| 1003 | + |
|
| 1004 | + /** |
|
| 1005 | + * Gets the total line item (which is a parent of all other related line items, |
|
| 1006 | + * meaning it takes them all into account on its total) |
|
| 1007 | + * |
|
| 1008 | + * @param bool $create_if_not_found |
|
| 1009 | + * @return \EE_Line_Item |
|
| 1010 | + * @throws EE_Error |
|
| 1011 | + * @throws InvalidArgumentException |
|
| 1012 | + * @throws InvalidDataTypeException |
|
| 1013 | + * @throws InvalidInterfaceException |
|
| 1014 | + * @throws ReflectionException |
|
| 1015 | + */ |
|
| 1016 | + public function total_line_item($create_if_not_found = true) |
|
| 1017 | + { |
|
| 1018 | + $item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total))); |
|
| 1019 | + if (! $item && $create_if_not_found) { |
|
| 1020 | + $item = EEH_Line_Item::create_total_line_item($this); |
|
| 1021 | + } |
|
| 1022 | + return $item; |
|
| 1023 | + } |
|
| 1024 | + |
|
| 1025 | + |
|
| 1026 | + /** |
|
| 1027 | + * Returns the total amount of tax on this transaction |
|
| 1028 | + * (assumes there's only one tax subtotal line item) |
|
| 1029 | + * |
|
| 1030 | + * @return float |
|
| 1031 | + * @throws EE_Error |
|
| 1032 | + * @throws InvalidArgumentException |
|
| 1033 | + * @throws InvalidDataTypeException |
|
| 1034 | + * @throws InvalidInterfaceException |
|
| 1035 | + * @throws ReflectionException |
|
| 1036 | + */ |
|
| 1037 | + public function tax_total() |
|
| 1038 | + { |
|
| 1039 | + $tax_line_item = $this->tax_total_line_item(); |
|
| 1040 | + if ($tax_line_item) { |
|
| 1041 | + return (float) $tax_line_item->total(); |
|
| 1042 | + } |
|
| 1043 | + return (float) 0; |
|
| 1044 | + } |
|
| 1045 | + |
|
| 1046 | + |
|
| 1047 | + /** |
|
| 1048 | + * Gets the tax subtotal line item (assumes there's only one) |
|
| 1049 | + * |
|
| 1050 | + * @return EE_Line_Item |
|
| 1051 | + * @throws EE_Error |
|
| 1052 | + * @throws InvalidArgumentException |
|
| 1053 | + * @throws InvalidDataTypeException |
|
| 1054 | + * @throws InvalidInterfaceException |
|
| 1055 | + * @throws ReflectionException |
|
| 1056 | + */ |
|
| 1057 | + public function tax_total_line_item() |
|
| 1058 | + { |
|
| 1059 | + return EEH_Line_Item::get_taxes_subtotal($this->total_line_item()); |
|
| 1060 | + } |
|
| 1061 | + |
|
| 1062 | + |
|
| 1063 | + /** |
|
| 1064 | + * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee. |
|
| 1065 | + * |
|
| 1066 | + * @return EE_Form_Section_Proper |
|
| 1067 | + * @throws EE_Error |
|
| 1068 | + * @throws InvalidArgumentException |
|
| 1069 | + * @throws InvalidDataTypeException |
|
| 1070 | + * @throws InvalidInterfaceException |
|
| 1071 | + * @throws ReflectionException |
|
| 1072 | + */ |
|
| 1073 | + public function billing_info() |
|
| 1074 | + { |
|
| 1075 | + $payment_method = $this->payment_method(); |
|
| 1076 | + if (! $payment_method) { |
|
| 1077 | + EE_Error::add_error( |
|
| 1078 | + __( |
|
| 1079 | + 'Could not find billing info for transaction because no gateway has been used for it yet', |
|
| 1080 | + 'event_espresso' |
|
| 1081 | + ), |
|
| 1082 | + __FILE__, |
|
| 1083 | + __FUNCTION__, |
|
| 1084 | + __LINE__ |
|
| 1085 | + ); |
|
| 1086 | + return null; |
|
| 1087 | + } |
|
| 1088 | + $primary_reg = $this->primary_registration(); |
|
| 1089 | + if (! $primary_reg) { |
|
| 1090 | + EE_Error::add_error( |
|
| 1091 | + __( |
|
| 1092 | + 'Cannot get billing info for gateway %s on transaction because no primary registration exists', |
|
| 1093 | + 'event_espresso' |
|
| 1094 | + ), |
|
| 1095 | + __FILE__, |
|
| 1096 | + __FUNCTION__, |
|
| 1097 | + __LINE__ |
|
| 1098 | + ); |
|
| 1099 | + return null; |
|
| 1100 | + } |
|
| 1101 | + $attendee = $primary_reg->attendee(); |
|
| 1102 | + if (! $attendee) { |
|
| 1103 | + EE_Error::add_error( |
|
| 1104 | + __( |
|
| 1105 | + 'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists', |
|
| 1106 | + 'event_espresso' |
|
| 1107 | + ), |
|
| 1108 | + __FILE__, |
|
| 1109 | + __FUNCTION__, |
|
| 1110 | + __LINE__ |
|
| 1111 | + ); |
|
| 1112 | + return null; |
|
| 1113 | + } |
|
| 1114 | + return $attendee->billing_info_for_payment_method($payment_method); |
|
| 1115 | + } |
|
| 1116 | + |
|
| 1117 | + |
|
| 1118 | + /** |
|
| 1119 | + * Gets PMD_ID |
|
| 1120 | + * |
|
| 1121 | + * @return int |
|
| 1122 | + * @throws EE_Error |
|
| 1123 | + * @throws InvalidArgumentException |
|
| 1124 | + * @throws InvalidDataTypeException |
|
| 1125 | + * @throws InvalidInterfaceException |
|
| 1126 | + * @throws ReflectionException |
|
| 1127 | + */ |
|
| 1128 | + public function payment_method_ID() |
|
| 1129 | + { |
|
| 1130 | + return $this->get('PMD_ID'); |
|
| 1131 | + } |
|
| 1132 | + |
|
| 1133 | + |
|
| 1134 | + /** |
|
| 1135 | + * Sets PMD_ID |
|
| 1136 | + * |
|
| 1137 | + * @param int $PMD_ID |
|
| 1138 | + * @throws EE_Error |
|
| 1139 | + * @throws InvalidArgumentException |
|
| 1140 | + * @throws InvalidDataTypeException |
|
| 1141 | + * @throws InvalidInterfaceException |
|
| 1142 | + * @throws ReflectionException |
|
| 1143 | + */ |
|
| 1144 | + public function set_payment_method_ID($PMD_ID) |
|
| 1145 | + { |
|
| 1146 | + $this->set('PMD_ID', $PMD_ID); |
|
| 1147 | + } |
|
| 1148 | + |
|
| 1149 | + |
|
| 1150 | + /** |
|
| 1151 | + * Gets the last-used payment method on this transaction |
|
| 1152 | + * (we COULD just use the last-made payment, but some payment methods, namely |
|
| 1153 | + * offline ones, dont' create payments) |
|
| 1154 | + * |
|
| 1155 | + * @return EE_Payment_Method |
|
| 1156 | + * @throws EE_Error |
|
| 1157 | + * @throws InvalidArgumentException |
|
| 1158 | + * @throws InvalidDataTypeException |
|
| 1159 | + * @throws InvalidInterfaceException |
|
| 1160 | + * @throws ReflectionException |
|
| 1161 | + */ |
|
| 1162 | + public function payment_method() |
|
| 1163 | + { |
|
| 1164 | + $pm = $this->get_first_related('Payment_Method'); |
|
| 1165 | + if ($pm instanceof EE_Payment_Method) { |
|
| 1166 | + return $pm; |
|
| 1167 | + } |
|
| 1168 | + $last_payment = $this->last_payment(); |
|
| 1169 | + if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) { |
|
| 1170 | + return $last_payment->payment_method(); |
|
| 1171 | + } |
|
| 1172 | + return null; |
|
| 1173 | + } |
|
| 1174 | + |
|
| 1175 | + |
|
| 1176 | + /** |
|
| 1177 | + * Gets the last payment made |
|
| 1178 | + * |
|
| 1179 | + * @return EE_Base_Class|EE_Payment |
|
| 1180 | + * @throws EE_Error |
|
| 1181 | + * @throws InvalidArgumentException |
|
| 1182 | + * @throws InvalidDataTypeException |
|
| 1183 | + * @throws InvalidInterfaceException |
|
| 1184 | + * @throws ReflectionException |
|
| 1185 | + */ |
|
| 1186 | + public function last_payment() |
|
| 1187 | + { |
|
| 1188 | + return $this->get_first_related('Payment', array('order_by' => array('PAY_ID' => 'desc'))); |
|
| 1189 | + } |
|
| 1190 | + |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * Gets all the line items which are unrelated to tickets on this transaction |
|
| 1194 | + * |
|
| 1195 | + * @return EE_Line_Item[] |
|
| 1196 | + * @throws EE_Error |
|
| 1197 | + * @throws InvalidArgumentException |
|
| 1198 | + * @throws InvalidDataTypeException |
|
| 1199 | + * @throws InvalidInterfaceException |
|
| 1200 | + * @throws ReflectionException |
|
| 1201 | + */ |
|
| 1202 | + public function non_ticket_line_items() |
|
| 1203 | + { |
|
| 1204 | + return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID()); |
|
| 1205 | + } |
|
| 1206 | + |
|
| 1207 | + |
|
| 1208 | + /** |
|
| 1209 | + * possibly toggles TXN status |
|
| 1210 | + * |
|
| 1211 | + * @param boolean $update whether to save the TXN |
|
| 1212 | + * @return bool whether the TXN was saved |
|
| 1213 | + * @throws EE_Error |
|
| 1214 | + * @throws InvalidArgumentException |
|
| 1215 | + * @throws InvalidDataTypeException |
|
| 1216 | + * @throws InvalidInterfaceException |
|
| 1217 | + * @throws ReflectionException |
|
| 1218 | + * @throws RuntimeException |
|
| 1219 | + */ |
|
| 1220 | + public function update_status_based_on_total_paid($update = true) |
|
| 1221 | + { |
|
| 1222 | + // set transaction status based on comparison of TXN_paid vs TXN_total |
|
| 1223 | + if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) { |
|
| 1224 | + $new_txn_status = EEM_Transaction::overpaid_status_code; |
|
| 1225 | + } elseif (EEH_Money::compare_floats($this->paid(), $this->total())) { |
|
| 1226 | + $new_txn_status = EEM_Transaction::complete_status_code; |
|
| 1227 | + } elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) { |
|
| 1228 | + $new_txn_status = EEM_Transaction::incomplete_status_code; |
|
| 1229 | + } else { |
|
| 1230 | + throw new RuntimeException( |
|
| 1231 | + __('The total paid calculation for this transaction is inaccurate.', 'event_espresso') |
|
| 1232 | + ); |
|
| 1233 | + } |
|
| 1234 | + if ($new_txn_status !== $this->status_ID()) { |
|
| 1235 | + $this->set_status($new_txn_status); |
|
| 1236 | + if ($update) { |
|
| 1237 | + return $this->save() ? true : false; |
|
| 1238 | + } |
|
| 1239 | + } |
|
| 1240 | + return false; |
|
| 1241 | + } |
|
| 1242 | + |
|
| 1243 | + |
|
| 1244 | + /** |
|
| 1245 | + * Updates the transaction's status and total_paid based on all the payments |
|
| 1246 | + * that apply to it |
|
| 1247 | + * |
|
| 1248 | + * @deprecated |
|
| 1249 | + * @return array|bool |
|
| 1250 | + * @throws EE_Error |
|
| 1251 | + * @throws InvalidArgumentException |
|
| 1252 | + * @throws ReflectionException |
|
| 1253 | + * @throws InvalidDataTypeException |
|
| 1254 | + * @throws InvalidInterfaceException |
|
| 1255 | + */ |
|
| 1256 | + public function update_based_on_payments() |
|
| 1257 | + { |
|
| 1258 | + EE_Error::doing_it_wrong( |
|
| 1259 | + __CLASS__ . '::' . __FUNCTION__, |
|
| 1260 | + sprintf( |
|
| 1261 | + __('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
| 1262 | + 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()' |
|
| 1263 | + ), |
|
| 1264 | + '4.6.0' |
|
| 1265 | + ); |
|
| 1266 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 1267 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 1268 | + return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this); |
|
| 1269 | + } |
|
| 1270 | + |
|
| 1271 | + |
|
| 1272 | + /** |
|
| 1273 | + * @return string |
|
| 1274 | + */ |
|
| 1275 | + public function old_txn_status() |
|
| 1276 | + { |
|
| 1277 | + return $this->_old_txn_status; |
|
| 1278 | + } |
|
| 1279 | + |
|
| 1280 | + |
|
| 1281 | + /** |
|
| 1282 | + * @param string $old_txn_status |
|
| 1283 | + */ |
|
| 1284 | + public function set_old_txn_status($old_txn_status) |
|
| 1285 | + { |
|
| 1286 | + // only set the first time |
|
| 1287 | + if ($this->_old_txn_status === null) { |
|
| 1288 | + $this->_old_txn_status = $old_txn_status; |
|
| 1289 | + } |
|
| 1290 | + } |
|
| 1291 | + |
|
| 1292 | + |
|
| 1293 | + /** |
|
| 1294 | + * reg_status_updated |
|
| 1295 | + * |
|
| 1296 | + * @return bool |
|
| 1297 | + * @throws EE_Error |
|
| 1298 | + * @throws InvalidArgumentException |
|
| 1299 | + * @throws InvalidDataTypeException |
|
| 1300 | + * @throws InvalidInterfaceException |
|
| 1301 | + * @throws ReflectionException |
|
| 1302 | + */ |
|
| 1303 | + public function txn_status_updated() |
|
| 1304 | + { |
|
| 1305 | + return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null; |
|
| 1306 | + } |
|
| 1307 | + |
|
| 1308 | + |
|
| 1309 | + /** |
|
| 1310 | + * _reg_steps_completed |
|
| 1311 | + * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed, |
|
| 1312 | + * if a $reg_step_slug is provided, then this step will be skipped when testing for completion |
|
| 1313 | + * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion |
|
| 1314 | + * |
|
| 1315 | + * @param string $reg_step_slug |
|
| 1316 | + * @param bool $check_all |
|
| 1317 | + * @return bool|int |
|
| 1318 | + * @throws EE_Error |
|
| 1319 | + * @throws InvalidArgumentException |
|
| 1320 | + * @throws InvalidDataTypeException |
|
| 1321 | + * @throws InvalidInterfaceException |
|
| 1322 | + * @throws ReflectionException |
|
| 1323 | + */ |
|
| 1324 | + private function _reg_steps_completed($reg_step_slug = '', $check_all = true) |
|
| 1325 | + { |
|
| 1326 | + $reg_steps = $this->reg_steps(); |
|
| 1327 | + if (! is_array($reg_steps) || empty($reg_steps)) { |
|
| 1328 | + return false; |
|
| 1329 | + } |
|
| 1330 | + // loop thru reg steps array) |
|
| 1331 | + foreach ($reg_steps as $slug => $reg_step_completed) { |
|
| 1332 | + // if NOT checking ALL steps (only checking one step) |
|
| 1333 | + if (! $check_all) { |
|
| 1334 | + // and this is the one |
|
| 1335 | + if ($slug === $reg_step_slug) { |
|
| 1336 | + return $reg_step_completed; |
|
| 1337 | + } |
|
| 1338 | + // skip to next reg step in loop |
|
| 1339 | + continue; |
|
| 1340 | + } |
|
| 1341 | + // $check_all must be true, else we would never have gotten to this point |
|
| 1342 | + if ($slug === $reg_step_slug) { |
|
| 1343 | + // if we reach this point, then we are testing either: |
|
| 1344 | + // all_reg_steps_completed_except() or |
|
| 1345 | + // all_reg_steps_completed_except_final_step(), |
|
| 1346 | + // and since this is the reg step EXCEPTION being tested |
|
| 1347 | + // we want to return true (yes true) if this reg step is NOT completed |
|
| 1348 | + // ie: "is everything completed except the final step?" |
|
| 1349 | + // "that is correct... the final step is not completed, but all others are." |
|
| 1350 | + return $reg_step_completed !== true; |
|
| 1351 | + } |
|
| 1352 | + if ($reg_step_completed !== true) { |
|
| 1353 | + // if any reg step is NOT completed, then ALL steps are not completed |
|
| 1354 | + return false; |
|
| 1355 | + } |
|
| 1356 | + } |
|
| 1357 | + return true; |
|
| 1358 | + } |
|
| 1359 | + |
|
| 1360 | + |
|
| 1361 | + /** |
|
| 1362 | + * all_reg_steps_completed |
|
| 1363 | + * returns: |
|
| 1364 | + * true if ALL reg steps have been marked as completed |
|
| 1365 | + * or false if any step is not completed |
|
| 1366 | + * |
|
| 1367 | + * @return bool |
|
| 1368 | + * @throws EE_Error |
|
| 1369 | + * @throws InvalidArgumentException |
|
| 1370 | + * @throws InvalidDataTypeException |
|
| 1371 | + * @throws InvalidInterfaceException |
|
| 1372 | + * @throws ReflectionException |
|
| 1373 | + */ |
|
| 1374 | + public function all_reg_steps_completed() |
|
| 1375 | + { |
|
| 1376 | + return $this->_reg_steps_completed(); |
|
| 1377 | + } |
|
| 1378 | + |
|
| 1379 | + |
|
| 1380 | + /** |
|
| 1381 | + * all_reg_steps_completed_except |
|
| 1382 | + * returns: |
|
| 1383 | + * true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed |
|
| 1384 | + * or false if any other step is not completed |
|
| 1385 | + * or false if ALL steps are completed including the exception you are testing !!! |
|
| 1386 | + * |
|
| 1387 | + * @param string $exception |
|
| 1388 | + * @return bool |
|
| 1389 | + * @throws EE_Error |
|
| 1390 | + * @throws InvalidArgumentException |
|
| 1391 | + * @throws InvalidDataTypeException |
|
| 1392 | + * @throws InvalidInterfaceException |
|
| 1393 | + * @throws ReflectionException |
|
| 1394 | + */ |
|
| 1395 | + public function all_reg_steps_completed_except($exception = '') |
|
| 1396 | + { |
|
| 1397 | + return $this->_reg_steps_completed($exception); |
|
| 1398 | + } |
|
| 1399 | + |
|
| 1400 | + |
|
| 1401 | + /** |
|
| 1402 | + * all_reg_steps_completed_except |
|
| 1403 | + * returns: |
|
| 1404 | + * true if ALL reg steps, except the final step, have been marked as completed |
|
| 1405 | + * or false if any step is not completed |
|
| 1406 | + * or false if ALL steps are completed including the final step !!! |
|
| 1407 | + * |
|
| 1408 | + * @return bool |
|
| 1409 | + * @throws EE_Error |
|
| 1410 | + * @throws InvalidArgumentException |
|
| 1411 | + * @throws InvalidDataTypeException |
|
| 1412 | + * @throws InvalidInterfaceException |
|
| 1413 | + * @throws ReflectionException |
|
| 1414 | + */ |
|
| 1415 | + public function all_reg_steps_completed_except_final_step() |
|
| 1416 | + { |
|
| 1417 | + return $this->_reg_steps_completed('finalize_registration'); |
|
| 1418 | + } |
|
| 1419 | + |
|
| 1420 | + |
|
| 1421 | + /** |
|
| 1422 | + * reg_step_completed |
|
| 1423 | + * returns: |
|
| 1424 | + * true if a specific reg step has been marked as completed |
|
| 1425 | + * a Unix timestamp if it has been initialized but not yet completed, |
|
| 1426 | + * or false if it has not yet been initialized |
|
| 1427 | + * |
|
| 1428 | + * @param string $reg_step_slug |
|
| 1429 | + * @return bool|int |
|
| 1430 | + * @throws EE_Error |
|
| 1431 | + * @throws InvalidArgumentException |
|
| 1432 | + * @throws InvalidDataTypeException |
|
| 1433 | + * @throws InvalidInterfaceException |
|
| 1434 | + * @throws ReflectionException |
|
| 1435 | + */ |
|
| 1436 | + public function reg_step_completed($reg_step_slug) |
|
| 1437 | + { |
|
| 1438 | + return $this->_reg_steps_completed($reg_step_slug, false); |
|
| 1439 | + } |
|
| 1440 | + |
|
| 1441 | + |
|
| 1442 | + /** |
|
| 1443 | + * completed_final_reg_step |
|
| 1444 | + * returns: |
|
| 1445 | + * true if the finalize_registration reg step has been marked as completed |
|
| 1446 | + * a Unix timestamp if it has been initialized but not yet completed, |
|
| 1447 | + * or false if it has not yet been initialized |
|
| 1448 | + * |
|
| 1449 | + * @return bool|int |
|
| 1450 | + * @throws EE_Error |
|
| 1451 | + * @throws InvalidArgumentException |
|
| 1452 | + * @throws InvalidDataTypeException |
|
| 1453 | + * @throws InvalidInterfaceException |
|
| 1454 | + * @throws ReflectionException |
|
| 1455 | + */ |
|
| 1456 | + public function final_reg_step_completed() |
|
| 1457 | + { |
|
| 1458 | + return $this->_reg_steps_completed('finalize_registration', false); |
|
| 1459 | + } |
|
| 1460 | + |
|
| 1461 | + |
|
| 1462 | + /** |
|
| 1463 | + * set_reg_step_initiated |
|
| 1464 | + * given a valid TXN_reg_step, this sets it's value to a unix timestamp |
|
| 1465 | + * |
|
| 1466 | + * @param string $reg_step_slug |
|
| 1467 | + * @return boolean |
|
| 1468 | + * @throws EE_Error |
|
| 1469 | + * @throws InvalidArgumentException |
|
| 1470 | + * @throws InvalidDataTypeException |
|
| 1471 | + * @throws InvalidInterfaceException |
|
| 1472 | + * @throws ReflectionException |
|
| 1473 | + */ |
|
| 1474 | + public function set_reg_step_initiated($reg_step_slug) |
|
| 1475 | + { |
|
| 1476 | + return $this->_set_reg_step_completed_status($reg_step_slug, time()); |
|
| 1477 | + } |
|
| 1478 | + |
|
| 1479 | + |
|
| 1480 | + /** |
|
| 1481 | + * set_reg_step_completed |
|
| 1482 | + * given a valid TXN_reg_step, this sets the step as completed |
|
| 1483 | + * |
|
| 1484 | + * @param string $reg_step_slug |
|
| 1485 | + * @return boolean |
|
| 1486 | + * @throws EE_Error |
|
| 1487 | + * @throws InvalidArgumentException |
|
| 1488 | + * @throws InvalidDataTypeException |
|
| 1489 | + * @throws InvalidInterfaceException |
|
| 1490 | + * @throws ReflectionException |
|
| 1491 | + */ |
|
| 1492 | + public function set_reg_step_completed($reg_step_slug) |
|
| 1493 | + { |
|
| 1494 | + return $this->_set_reg_step_completed_status($reg_step_slug, true); |
|
| 1495 | + } |
|
| 1496 | + |
|
| 1497 | + |
|
| 1498 | + /** |
|
| 1499 | + * set_reg_step_completed |
|
| 1500 | + * given a valid TXN_reg_step slug, this sets the step as NOT completed |
|
| 1501 | + * |
|
| 1502 | + * @param string $reg_step_slug |
|
| 1503 | + * @return boolean |
|
| 1504 | + * @throws EE_Error |
|
| 1505 | + * @throws InvalidArgumentException |
|
| 1506 | + * @throws InvalidDataTypeException |
|
| 1507 | + * @throws InvalidInterfaceException |
|
| 1508 | + * @throws ReflectionException |
|
| 1509 | + */ |
|
| 1510 | + public function set_reg_step_not_completed($reg_step_slug) |
|
| 1511 | + { |
|
| 1512 | + return $this->_set_reg_step_completed_status($reg_step_slug, false); |
|
| 1513 | + } |
|
| 1514 | + |
|
| 1515 | + |
|
| 1516 | + /** |
|
| 1517 | + * set_reg_step_completed |
|
| 1518 | + * given a valid reg step slug, this sets the TXN_reg_step completed status which is either: |
|
| 1519 | + * |
|
| 1520 | + * @param string $reg_step_slug |
|
| 1521 | + * @param boolean|int $status |
|
| 1522 | + * @return boolean |
|
| 1523 | + * @throws EE_Error |
|
| 1524 | + * @throws InvalidArgumentException |
|
| 1525 | + * @throws InvalidDataTypeException |
|
| 1526 | + * @throws InvalidInterfaceException |
|
| 1527 | + * @throws ReflectionException |
|
| 1528 | + */ |
|
| 1529 | + private function _set_reg_step_completed_status($reg_step_slug, $status) |
|
| 1530 | + { |
|
| 1531 | + // validate status |
|
| 1532 | + $status = is_bool($status) || is_int($status) ? $status : false; |
|
| 1533 | + // get reg steps array |
|
| 1534 | + $txn_reg_steps = $this->reg_steps(); |
|
| 1535 | + // if reg step does NOT exist |
|
| 1536 | + if (! isset($txn_reg_steps[ $reg_step_slug ])) { |
|
| 1537 | + return false; |
|
| 1538 | + } |
|
| 1539 | + // if we're trying to complete a step that is already completed |
|
| 1540 | + if ($txn_reg_steps[ $reg_step_slug ] === true) { |
|
| 1541 | + return true; |
|
| 1542 | + } |
|
| 1543 | + // if we're trying to complete a step that hasn't even started |
|
| 1544 | + if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) { |
|
| 1545 | + return false; |
|
| 1546 | + } |
|
| 1547 | + // if current status value matches the incoming value (no change) |
|
| 1548 | + // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890 |
|
| 1549 | + if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) { |
|
| 1550 | + // this will happen in cases where multiple AJAX requests occur during the same step |
|
| 1551 | + return true; |
|
| 1552 | + } |
|
| 1553 | + // if we're trying to set a start time, but it has already been set... |
|
| 1554 | + if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) { |
|
| 1555 | + // skip the update below, but don't return FALSE so that errors won't be displayed |
|
| 1556 | + return true; |
|
| 1557 | + } |
|
| 1558 | + // update completed status |
|
| 1559 | + $txn_reg_steps[ $reg_step_slug ] = $status; |
|
| 1560 | + $this->set_reg_steps($txn_reg_steps); |
|
| 1561 | + $this->save(); |
|
| 1562 | + return true; |
|
| 1563 | + } |
|
| 1564 | + |
|
| 1565 | + |
|
| 1566 | + /** |
|
| 1567 | + * remove_reg_step |
|
| 1568 | + * given a valid TXN_reg_step slug, this will remove (unset) |
|
| 1569 | + * the reg step from the TXN reg step array |
|
| 1570 | + * |
|
| 1571 | + * @param string $reg_step_slug |
|
| 1572 | + * @return void |
|
| 1573 | + * @throws EE_Error |
|
| 1574 | + * @throws InvalidArgumentException |
|
| 1575 | + * @throws InvalidDataTypeException |
|
| 1576 | + * @throws InvalidInterfaceException |
|
| 1577 | + * @throws ReflectionException |
|
| 1578 | + */ |
|
| 1579 | + public function remove_reg_step($reg_step_slug) |
|
| 1580 | + { |
|
| 1581 | + // get reg steps array |
|
| 1582 | + $txn_reg_steps = $this->reg_steps(); |
|
| 1583 | + unset($txn_reg_steps[ $reg_step_slug ]); |
|
| 1584 | + $this->set_reg_steps($txn_reg_steps); |
|
| 1585 | + } |
|
| 1586 | + |
|
| 1587 | + |
|
| 1588 | + /** |
|
| 1589 | + * toggle_failed_transaction_status |
|
| 1590 | + * upgrades a TXNs status from failed to abandoned, |
|
| 1591 | + * meaning that contact information has been captured for at least one registrant |
|
| 1592 | + * |
|
| 1593 | + * @param bool $save |
|
| 1594 | + * @return bool |
|
| 1595 | + * @throws EE_Error |
|
| 1596 | + * @throws InvalidArgumentException |
|
| 1597 | + * @throws InvalidDataTypeException |
|
| 1598 | + * @throws InvalidInterfaceException |
|
| 1599 | + * @throws ReflectionException |
|
| 1600 | + */ |
|
| 1601 | + public function toggle_failed_transaction_status($save = true) |
|
| 1602 | + { |
|
| 1603 | + // if TXN status is still set as "failed"... |
|
| 1604 | + if ($this->status_ID() === EEM_Transaction::failed_status_code) { |
|
| 1605 | + $this->set_status(EEM_Transaction::abandoned_status_code); |
|
| 1606 | + if ($save) { |
|
| 1607 | + $this->save(); |
|
| 1608 | + } |
|
| 1609 | + return true; |
|
| 1610 | + } |
|
| 1611 | + return false; |
|
| 1612 | + } |
|
| 1613 | + |
|
| 1614 | + |
|
| 1615 | + /** |
|
| 1616 | + * toggle_abandoned_transaction_status |
|
| 1617 | + * upgrades a TXNs status from failed or abandoned to incomplete |
|
| 1618 | + * |
|
| 1619 | + * @return bool |
|
| 1620 | + * @throws EE_Error |
|
| 1621 | + * @throws InvalidArgumentException |
|
| 1622 | + * @throws InvalidDataTypeException |
|
| 1623 | + * @throws InvalidInterfaceException |
|
| 1624 | + * @throws ReflectionException |
|
| 1625 | + */ |
|
| 1626 | + public function toggle_abandoned_transaction_status() |
|
| 1627 | + { |
|
| 1628 | + // if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"... |
|
| 1629 | + $txn_status = $this->status_ID(); |
|
| 1630 | + if ($txn_status === EEM_Transaction::failed_status_code |
|
| 1631 | + || $txn_status === EEM_Transaction::abandoned_status_code |
|
| 1632 | + ) { |
|
| 1633 | + // if a contact record for the primary registrant has been created |
|
| 1634 | + if ($this->primary_registration() instanceof EE_Registration |
|
| 1635 | + && $this->primary_registration()->attendee() instanceof EE_Attendee |
|
| 1636 | + ) { |
|
| 1637 | + $this->set_status(EEM_Transaction::incomplete_status_code); |
|
| 1638 | + } else { |
|
| 1639 | + // no contact record? yer abandoned! |
|
| 1640 | + $this->set_status(EEM_Transaction::abandoned_status_code); |
|
| 1641 | + } |
|
| 1642 | + return true; |
|
| 1643 | + } |
|
| 1644 | + return false; |
|
| 1645 | + } |
|
| 1646 | + |
|
| 1647 | + |
|
| 1648 | + /** |
|
| 1649 | + * checks if an Abandoned TXN has any related payments, and if so, |
|
| 1650 | + * updates the TXN status based on the amount paid |
|
| 1651 | + * |
|
| 1652 | + * @throws EE_Error |
|
| 1653 | + * @throws InvalidDataTypeException |
|
| 1654 | + * @throws InvalidInterfaceException |
|
| 1655 | + * @throws InvalidArgumentException |
|
| 1656 | + * @throws RuntimeException |
|
| 1657 | + * @throws ReflectionException |
|
| 1658 | + */ |
|
| 1659 | + public function verify_abandoned_transaction_status() |
|
| 1660 | + { |
|
| 1661 | + if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) { |
|
| 1662 | + return; |
|
| 1663 | + } |
|
| 1664 | + $payments = $this->get_many_related('Payment'); |
|
| 1665 | + if (! empty($payments)) { |
|
| 1666 | + foreach ($payments as $payment) { |
|
| 1667 | + if ($payment instanceof EE_Payment) { |
|
| 1668 | + // kk this TXN should NOT be abandoned |
|
| 1669 | + $this->update_status_based_on_total_paid(); |
|
| 1670 | + if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
| 1671 | + EE_Error::add_attention( |
|
| 1672 | + sprintf( |
|
| 1673 | + esc_html__( |
|
| 1674 | + 'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.', |
|
| 1675 | + 'event_espresso' |
|
| 1676 | + ), |
|
| 1677 | + $this->ID(), |
|
| 1678 | + $this->pretty_status() |
|
| 1679 | + ) |
|
| 1680 | + ); |
|
| 1681 | + } |
|
| 1682 | + // get final reg step status |
|
| 1683 | + $finalized = $this->final_reg_step_completed(); |
|
| 1684 | + // if the 'finalize_registration' step has been initiated (has a timestamp) |
|
| 1685 | + // but has not yet been fully completed (TRUE) |
|
| 1686 | + if (is_int($finalized) && $finalized !== false && $finalized !== true) { |
|
| 1687 | + $this->set_reg_step_completed('finalize_registration'); |
|
| 1688 | + $this->save(); |
|
| 1689 | + } |
|
| 1690 | + } |
|
| 1691 | + } |
|
| 1692 | + } |
|
| 1693 | + } |
|
| 1694 | 1694 | } |
@@ -16,1259 +16,1259 @@ |
||
| 16 | 16 | { |
| 17 | 17 | |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * This is used to hold the reports template data which is setup early in the request. |
|
| 21 | - * |
|
| 22 | - * @type array |
|
| 23 | - */ |
|
| 24 | - protected $_reports_template_data = array(); |
|
| 19 | + /** |
|
| 20 | + * This is used to hold the reports template data which is setup early in the request. |
|
| 21 | + * |
|
| 22 | + * @type array |
|
| 23 | + */ |
|
| 24 | + protected $_reports_template_data = array(); |
|
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Extend_Registrations_Admin_Page constructor. |
|
| 29 | - * |
|
| 30 | - * @param bool $routing |
|
| 31 | - */ |
|
| 32 | - public function __construct($routing = true) |
|
| 33 | - { |
|
| 34 | - parent::__construct($routing); |
|
| 35 | - if (! defined('REG_CAF_TEMPLATE_PATH')) { |
|
| 36 | - define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/'); |
|
| 37 | - define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/'); |
|
| 38 | - define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/'); |
|
| 39 | - } |
|
| 40 | - } |
|
| 27 | + /** |
|
| 28 | + * Extend_Registrations_Admin_Page constructor. |
|
| 29 | + * |
|
| 30 | + * @param bool $routing |
|
| 31 | + */ |
|
| 32 | + public function __construct($routing = true) |
|
| 33 | + { |
|
| 34 | + parent::__construct($routing); |
|
| 35 | + if (! defined('REG_CAF_TEMPLATE_PATH')) { |
|
| 36 | + define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/'); |
|
| 37 | + define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/'); |
|
| 38 | + define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/'); |
|
| 39 | + } |
|
| 40 | + } |
|
| 41 | 41 | |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Extending page configuration. |
|
| 45 | - */ |
|
| 46 | - protected function _extend_page_config() |
|
| 47 | - { |
|
| 48 | - $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations'; |
|
| 49 | - $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
| 50 | - ? $this->_req_data['_REG_ID'] |
|
| 51 | - : 0; |
|
| 52 | - $new_page_routes = array( |
|
| 53 | - 'reports' => array( |
|
| 54 | - 'func' => '_registration_reports', |
|
| 55 | - 'capability' => 'ee_read_registrations', |
|
| 56 | - ), |
|
| 57 | - 'registration_checkins' => array( |
|
| 58 | - 'func' => '_registration_checkin_list_table', |
|
| 59 | - 'capability' => 'ee_read_checkins', |
|
| 60 | - ), |
|
| 61 | - 'newsletter_selected_send' => array( |
|
| 62 | - 'func' => '_newsletter_selected_send', |
|
| 63 | - 'noheader' => true, |
|
| 64 | - 'capability' => 'ee_send_message', |
|
| 65 | - ), |
|
| 66 | - 'delete_checkin_rows' => array( |
|
| 67 | - 'func' => '_delete_checkin_rows', |
|
| 68 | - 'noheader' => true, |
|
| 69 | - 'capability' => 'ee_delete_checkins', |
|
| 70 | - ), |
|
| 71 | - 'delete_checkin_row' => array( |
|
| 72 | - 'func' => '_delete_checkin_row', |
|
| 73 | - 'noheader' => true, |
|
| 74 | - 'capability' => 'ee_delete_checkin', |
|
| 75 | - 'obj_id' => $reg_id, |
|
| 76 | - ), |
|
| 77 | - 'toggle_checkin_status' => array( |
|
| 78 | - 'func' => '_toggle_checkin_status', |
|
| 79 | - 'noheader' => true, |
|
| 80 | - 'capability' => 'ee_edit_checkin', |
|
| 81 | - 'obj_id' => $reg_id, |
|
| 82 | - ), |
|
| 83 | - 'toggle_checkin_status_bulk' => array( |
|
| 84 | - 'func' => '_toggle_checkin_status', |
|
| 85 | - 'noheader' => true, |
|
| 86 | - 'capability' => 'ee_edit_checkins', |
|
| 87 | - ), |
|
| 88 | - 'event_registrations' => array( |
|
| 89 | - 'func' => '_event_registrations_list_table', |
|
| 90 | - 'capability' => 'ee_read_checkins', |
|
| 91 | - ), |
|
| 92 | - 'registrations_checkin_report' => array( |
|
| 93 | - 'func' => '_registrations_checkin_report', |
|
| 94 | - 'noheader' => true, |
|
| 95 | - 'capability' => 'ee_read_registrations', |
|
| 96 | - ), |
|
| 97 | - ); |
|
| 98 | - $this->_page_routes = array_merge($this->_page_routes, $new_page_routes); |
|
| 99 | - $new_page_config = array( |
|
| 100 | - 'reports' => array( |
|
| 101 | - 'nav' => array( |
|
| 102 | - 'label' => esc_html__('Reports', 'event_espresso'), |
|
| 103 | - 'order' => 30, |
|
| 104 | - ), |
|
| 105 | - 'help_tabs' => array( |
|
| 106 | - 'registrations_reports_help_tab' => array( |
|
| 107 | - 'title' => esc_html__('Registration Reports', 'event_espresso'), |
|
| 108 | - 'filename' => 'registrations_reports', |
|
| 109 | - ), |
|
| 110 | - ), |
|
| 111 | - /*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/ |
|
| 112 | - 'require_nonce' => false, |
|
| 113 | - ), |
|
| 114 | - 'event_registrations' => array( |
|
| 115 | - 'nav' => array( |
|
| 116 | - 'label' => esc_html__('Event Check-In', 'event_espresso'), |
|
| 117 | - 'order' => 10, |
|
| 118 | - 'persistent' => true, |
|
| 119 | - ), |
|
| 120 | - 'help_tabs' => array( |
|
| 121 | - 'registrations_event_checkin_help_tab' => array( |
|
| 122 | - 'title' => esc_html__('Registrations Event Check-In', 'event_espresso'), |
|
| 123 | - 'filename' => 'registrations_event_checkin', |
|
| 124 | - ), |
|
| 125 | - 'registrations_event_checkin_table_column_headings_help_tab' => array( |
|
| 126 | - 'title' => esc_html__('Event Check-In Table Column Headings', 'event_espresso'), |
|
| 127 | - 'filename' => 'registrations_event_checkin_table_column_headings', |
|
| 128 | - ), |
|
| 129 | - 'registrations_event_checkin_filters_help_tab' => array( |
|
| 130 | - 'title' => esc_html__('Event Check-In Filters', 'event_espresso'), |
|
| 131 | - 'filename' => 'registrations_event_checkin_filters', |
|
| 132 | - ), |
|
| 133 | - 'registrations_event_checkin_views_help_tab' => array( |
|
| 134 | - 'title' => esc_html__('Event Check-In Views', 'event_espresso'), |
|
| 135 | - 'filename' => 'registrations_event_checkin_views', |
|
| 136 | - ), |
|
| 137 | - 'registrations_event_checkin_other_help_tab' => array( |
|
| 138 | - 'title' => esc_html__('Event Check-In Other', 'event_espresso'), |
|
| 139 | - 'filename' => 'registrations_event_checkin_other', |
|
| 140 | - ), |
|
| 141 | - ), |
|
| 142 | - 'help_tour' => array('Event_Checkin_Help_Tour'), |
|
| 143 | - 'qtips' => array('Registration_List_Table_Tips'), |
|
| 144 | - 'list_table' => 'EE_Event_Registrations_List_Table', |
|
| 145 | - 'metaboxes' => array(), |
|
| 146 | - 'require_nonce' => false, |
|
| 147 | - ), |
|
| 148 | - 'registration_checkins' => array( |
|
| 149 | - 'nav' => array( |
|
| 150 | - 'label' => esc_html__('Check-In Records', 'event_espresso'), |
|
| 151 | - 'order' => 15, |
|
| 152 | - 'persistent' => false, |
|
| 153 | - 'url' => '', |
|
| 154 | - ), |
|
| 155 | - 'list_table' => 'EE_Registration_CheckIn_List_Table', |
|
| 156 | - // 'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ), |
|
| 157 | - 'metaboxes' => array(), |
|
| 158 | - 'require_nonce' => false, |
|
| 159 | - ), |
|
| 160 | - ); |
|
| 161 | - $this->_page_config = array_merge($this->_page_config, $new_page_config); |
|
| 162 | - $this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table'; |
|
| 163 | - $this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table'; |
|
| 164 | - } |
|
| 43 | + /** |
|
| 44 | + * Extending page configuration. |
|
| 45 | + */ |
|
| 46 | + protected function _extend_page_config() |
|
| 47 | + { |
|
| 48 | + $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations'; |
|
| 49 | + $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
| 50 | + ? $this->_req_data['_REG_ID'] |
|
| 51 | + : 0; |
|
| 52 | + $new_page_routes = array( |
|
| 53 | + 'reports' => array( |
|
| 54 | + 'func' => '_registration_reports', |
|
| 55 | + 'capability' => 'ee_read_registrations', |
|
| 56 | + ), |
|
| 57 | + 'registration_checkins' => array( |
|
| 58 | + 'func' => '_registration_checkin_list_table', |
|
| 59 | + 'capability' => 'ee_read_checkins', |
|
| 60 | + ), |
|
| 61 | + 'newsletter_selected_send' => array( |
|
| 62 | + 'func' => '_newsletter_selected_send', |
|
| 63 | + 'noheader' => true, |
|
| 64 | + 'capability' => 'ee_send_message', |
|
| 65 | + ), |
|
| 66 | + 'delete_checkin_rows' => array( |
|
| 67 | + 'func' => '_delete_checkin_rows', |
|
| 68 | + 'noheader' => true, |
|
| 69 | + 'capability' => 'ee_delete_checkins', |
|
| 70 | + ), |
|
| 71 | + 'delete_checkin_row' => array( |
|
| 72 | + 'func' => '_delete_checkin_row', |
|
| 73 | + 'noheader' => true, |
|
| 74 | + 'capability' => 'ee_delete_checkin', |
|
| 75 | + 'obj_id' => $reg_id, |
|
| 76 | + ), |
|
| 77 | + 'toggle_checkin_status' => array( |
|
| 78 | + 'func' => '_toggle_checkin_status', |
|
| 79 | + 'noheader' => true, |
|
| 80 | + 'capability' => 'ee_edit_checkin', |
|
| 81 | + 'obj_id' => $reg_id, |
|
| 82 | + ), |
|
| 83 | + 'toggle_checkin_status_bulk' => array( |
|
| 84 | + 'func' => '_toggle_checkin_status', |
|
| 85 | + 'noheader' => true, |
|
| 86 | + 'capability' => 'ee_edit_checkins', |
|
| 87 | + ), |
|
| 88 | + 'event_registrations' => array( |
|
| 89 | + 'func' => '_event_registrations_list_table', |
|
| 90 | + 'capability' => 'ee_read_checkins', |
|
| 91 | + ), |
|
| 92 | + 'registrations_checkin_report' => array( |
|
| 93 | + 'func' => '_registrations_checkin_report', |
|
| 94 | + 'noheader' => true, |
|
| 95 | + 'capability' => 'ee_read_registrations', |
|
| 96 | + ), |
|
| 97 | + ); |
|
| 98 | + $this->_page_routes = array_merge($this->_page_routes, $new_page_routes); |
|
| 99 | + $new_page_config = array( |
|
| 100 | + 'reports' => array( |
|
| 101 | + 'nav' => array( |
|
| 102 | + 'label' => esc_html__('Reports', 'event_espresso'), |
|
| 103 | + 'order' => 30, |
|
| 104 | + ), |
|
| 105 | + 'help_tabs' => array( |
|
| 106 | + 'registrations_reports_help_tab' => array( |
|
| 107 | + 'title' => esc_html__('Registration Reports', 'event_espresso'), |
|
| 108 | + 'filename' => 'registrations_reports', |
|
| 109 | + ), |
|
| 110 | + ), |
|
| 111 | + /*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/ |
|
| 112 | + 'require_nonce' => false, |
|
| 113 | + ), |
|
| 114 | + 'event_registrations' => array( |
|
| 115 | + 'nav' => array( |
|
| 116 | + 'label' => esc_html__('Event Check-In', 'event_espresso'), |
|
| 117 | + 'order' => 10, |
|
| 118 | + 'persistent' => true, |
|
| 119 | + ), |
|
| 120 | + 'help_tabs' => array( |
|
| 121 | + 'registrations_event_checkin_help_tab' => array( |
|
| 122 | + 'title' => esc_html__('Registrations Event Check-In', 'event_espresso'), |
|
| 123 | + 'filename' => 'registrations_event_checkin', |
|
| 124 | + ), |
|
| 125 | + 'registrations_event_checkin_table_column_headings_help_tab' => array( |
|
| 126 | + 'title' => esc_html__('Event Check-In Table Column Headings', 'event_espresso'), |
|
| 127 | + 'filename' => 'registrations_event_checkin_table_column_headings', |
|
| 128 | + ), |
|
| 129 | + 'registrations_event_checkin_filters_help_tab' => array( |
|
| 130 | + 'title' => esc_html__('Event Check-In Filters', 'event_espresso'), |
|
| 131 | + 'filename' => 'registrations_event_checkin_filters', |
|
| 132 | + ), |
|
| 133 | + 'registrations_event_checkin_views_help_tab' => array( |
|
| 134 | + 'title' => esc_html__('Event Check-In Views', 'event_espresso'), |
|
| 135 | + 'filename' => 'registrations_event_checkin_views', |
|
| 136 | + ), |
|
| 137 | + 'registrations_event_checkin_other_help_tab' => array( |
|
| 138 | + 'title' => esc_html__('Event Check-In Other', 'event_espresso'), |
|
| 139 | + 'filename' => 'registrations_event_checkin_other', |
|
| 140 | + ), |
|
| 141 | + ), |
|
| 142 | + 'help_tour' => array('Event_Checkin_Help_Tour'), |
|
| 143 | + 'qtips' => array('Registration_List_Table_Tips'), |
|
| 144 | + 'list_table' => 'EE_Event_Registrations_List_Table', |
|
| 145 | + 'metaboxes' => array(), |
|
| 146 | + 'require_nonce' => false, |
|
| 147 | + ), |
|
| 148 | + 'registration_checkins' => array( |
|
| 149 | + 'nav' => array( |
|
| 150 | + 'label' => esc_html__('Check-In Records', 'event_espresso'), |
|
| 151 | + 'order' => 15, |
|
| 152 | + 'persistent' => false, |
|
| 153 | + 'url' => '', |
|
| 154 | + ), |
|
| 155 | + 'list_table' => 'EE_Registration_CheckIn_List_Table', |
|
| 156 | + // 'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ), |
|
| 157 | + 'metaboxes' => array(), |
|
| 158 | + 'require_nonce' => false, |
|
| 159 | + ), |
|
| 160 | + ); |
|
| 161 | + $this->_page_config = array_merge($this->_page_config, $new_page_config); |
|
| 162 | + $this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table'; |
|
| 163 | + $this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table'; |
|
| 164 | + } |
|
| 165 | 165 | |
| 166 | 166 | |
| 167 | - /** |
|
| 168 | - * Ajax hooks for all routes in this page. |
|
| 169 | - */ |
|
| 170 | - protected function _ajax_hooks() |
|
| 171 | - { |
|
| 172 | - parent::_ajax_hooks(); |
|
| 173 | - add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content')); |
|
| 174 | - } |
|
| 167 | + /** |
|
| 168 | + * Ajax hooks for all routes in this page. |
|
| 169 | + */ |
|
| 170 | + protected function _ajax_hooks() |
|
| 171 | + { |
|
| 172 | + parent::_ajax_hooks(); |
|
| 173 | + add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content')); |
|
| 174 | + } |
|
| 175 | 175 | |
| 176 | 176 | |
| 177 | - /** |
|
| 178 | - * Global scripts for all routes in this page. |
|
| 179 | - */ |
|
| 180 | - public function load_scripts_styles() |
|
| 181 | - { |
|
| 182 | - parent::load_scripts_styles(); |
|
| 183 | - // if newsletter message type is active then let's add filter and load js for it. |
|
| 184 | - if (EEH_MSG_Template::is_mt_active('newsletter')) { |
|
| 185 | - // enqueue newsletter js |
|
| 186 | - wp_enqueue_script( |
|
| 187 | - 'ee-newsletter-trigger', |
|
| 188 | - REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js', |
|
| 189 | - array('ee-dialog'), |
|
| 190 | - EVENT_ESPRESSO_VERSION, |
|
| 191 | - true |
|
| 192 | - ); |
|
| 193 | - wp_enqueue_style( |
|
| 194 | - 'ee-newsletter-trigger-css', |
|
| 195 | - REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css', |
|
| 196 | - array(), |
|
| 197 | - EVENT_ESPRESSO_VERSION |
|
| 198 | - ); |
|
| 199 | - // hook in buttons for newsletter message type trigger. |
|
| 200 | - add_action( |
|
| 201 | - 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
| 202 | - array($this, 'add_newsletter_action_buttons'), |
|
| 203 | - 10 |
|
| 204 | - ); |
|
| 205 | - } |
|
| 206 | - } |
|
| 177 | + /** |
|
| 178 | + * Global scripts for all routes in this page. |
|
| 179 | + */ |
|
| 180 | + public function load_scripts_styles() |
|
| 181 | + { |
|
| 182 | + parent::load_scripts_styles(); |
|
| 183 | + // if newsletter message type is active then let's add filter and load js for it. |
|
| 184 | + if (EEH_MSG_Template::is_mt_active('newsletter')) { |
|
| 185 | + // enqueue newsletter js |
|
| 186 | + wp_enqueue_script( |
|
| 187 | + 'ee-newsletter-trigger', |
|
| 188 | + REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js', |
|
| 189 | + array('ee-dialog'), |
|
| 190 | + EVENT_ESPRESSO_VERSION, |
|
| 191 | + true |
|
| 192 | + ); |
|
| 193 | + wp_enqueue_style( |
|
| 194 | + 'ee-newsletter-trigger-css', |
|
| 195 | + REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css', |
|
| 196 | + array(), |
|
| 197 | + EVENT_ESPRESSO_VERSION |
|
| 198 | + ); |
|
| 199 | + // hook in buttons for newsletter message type trigger. |
|
| 200 | + add_action( |
|
| 201 | + 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
| 202 | + array($this, 'add_newsletter_action_buttons'), |
|
| 203 | + 10 |
|
| 204 | + ); |
|
| 205 | + } |
|
| 206 | + } |
|
| 207 | 207 | |
| 208 | 208 | |
| 209 | - /** |
|
| 210 | - * Scripts and styles for just the reports route. |
|
| 211 | - */ |
|
| 212 | - public function load_scripts_styles_reports() |
|
| 213 | - { |
|
| 214 | - wp_register_script( |
|
| 215 | - 'ee-reg-reports-js', |
|
| 216 | - REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js', |
|
| 217 | - array('google-charts'), |
|
| 218 | - EVENT_ESPRESSO_VERSION, |
|
| 219 | - true |
|
| 220 | - ); |
|
| 221 | - wp_enqueue_script('ee-reg-reports-js'); |
|
| 222 | - $this->_registration_reports_js_setup(); |
|
| 223 | - } |
|
| 209 | + /** |
|
| 210 | + * Scripts and styles for just the reports route. |
|
| 211 | + */ |
|
| 212 | + public function load_scripts_styles_reports() |
|
| 213 | + { |
|
| 214 | + wp_register_script( |
|
| 215 | + 'ee-reg-reports-js', |
|
| 216 | + REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js', |
|
| 217 | + array('google-charts'), |
|
| 218 | + EVENT_ESPRESSO_VERSION, |
|
| 219 | + true |
|
| 220 | + ); |
|
| 221 | + wp_enqueue_script('ee-reg-reports-js'); |
|
| 222 | + $this->_registration_reports_js_setup(); |
|
| 223 | + } |
|
| 224 | 224 | |
| 225 | 225 | |
| 226 | - /** |
|
| 227 | - * Register screen options for event_registrations route. |
|
| 228 | - */ |
|
| 229 | - protected function _add_screen_options_event_registrations() |
|
| 230 | - { |
|
| 231 | - $this->_per_page_screen_option(); |
|
| 232 | - } |
|
| 226 | + /** |
|
| 227 | + * Register screen options for event_registrations route. |
|
| 228 | + */ |
|
| 229 | + protected function _add_screen_options_event_registrations() |
|
| 230 | + { |
|
| 231 | + $this->_per_page_screen_option(); |
|
| 232 | + } |
|
| 233 | 233 | |
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * Register screen options for registration_checkins route |
|
| 237 | - */ |
|
| 238 | - protected function _add_screen_options_registration_checkins() |
|
| 239 | - { |
|
| 240 | - $page_title = $this->_admin_page_title; |
|
| 241 | - $this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso'); |
|
| 242 | - $this->_per_page_screen_option(); |
|
| 243 | - $this->_admin_page_title = $page_title; |
|
| 244 | - } |
|
| 235 | + /** |
|
| 236 | + * Register screen options for registration_checkins route |
|
| 237 | + */ |
|
| 238 | + protected function _add_screen_options_registration_checkins() |
|
| 239 | + { |
|
| 240 | + $page_title = $this->_admin_page_title; |
|
| 241 | + $this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso'); |
|
| 242 | + $this->_per_page_screen_option(); |
|
| 243 | + $this->_admin_page_title = $page_title; |
|
| 244 | + } |
|
| 245 | 245 | |
| 246 | 246 | |
| 247 | - /** |
|
| 248 | - * Set views property for event_registrations route. |
|
| 249 | - */ |
|
| 250 | - protected function _set_list_table_views_event_registrations() |
|
| 251 | - { |
|
| 252 | - $this->_views = array( |
|
| 253 | - 'all' => array( |
|
| 254 | - 'slug' => 'all', |
|
| 255 | - 'label' => esc_html__('All', 'event_espresso'), |
|
| 256 | - 'count' => 0, |
|
| 257 | - 'bulk_action' => ! isset($this->_req_data['event_id']) |
|
| 258 | - ? array() |
|
| 259 | - : array( |
|
| 260 | - 'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'), |
|
| 261 | - ), |
|
| 262 | - ), |
|
| 263 | - ); |
|
| 264 | - } |
|
| 247 | + /** |
|
| 248 | + * Set views property for event_registrations route. |
|
| 249 | + */ |
|
| 250 | + protected function _set_list_table_views_event_registrations() |
|
| 251 | + { |
|
| 252 | + $this->_views = array( |
|
| 253 | + 'all' => array( |
|
| 254 | + 'slug' => 'all', |
|
| 255 | + 'label' => esc_html__('All', 'event_espresso'), |
|
| 256 | + 'count' => 0, |
|
| 257 | + 'bulk_action' => ! isset($this->_req_data['event_id']) |
|
| 258 | + ? array() |
|
| 259 | + : array( |
|
| 260 | + 'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'), |
|
| 261 | + ), |
|
| 262 | + ), |
|
| 263 | + ); |
|
| 264 | + } |
|
| 265 | 265 | |
| 266 | 266 | |
| 267 | - /** |
|
| 268 | - * Set views property for registration_checkins route. |
|
| 269 | - */ |
|
| 270 | - protected function _set_list_table_views_registration_checkins() |
|
| 271 | - { |
|
| 272 | - $this->_views = array( |
|
| 273 | - 'all' => array( |
|
| 274 | - 'slug' => 'all', |
|
| 275 | - 'label' => esc_html__('All', 'event_espresso'), |
|
| 276 | - 'count' => 0, |
|
| 277 | - 'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')), |
|
| 278 | - ), |
|
| 279 | - ); |
|
| 280 | - } |
|
| 267 | + /** |
|
| 268 | + * Set views property for registration_checkins route. |
|
| 269 | + */ |
|
| 270 | + protected function _set_list_table_views_registration_checkins() |
|
| 271 | + { |
|
| 272 | + $this->_views = array( |
|
| 273 | + 'all' => array( |
|
| 274 | + 'slug' => 'all', |
|
| 275 | + 'label' => esc_html__('All', 'event_espresso'), |
|
| 276 | + 'count' => 0, |
|
| 277 | + 'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')), |
|
| 278 | + ), |
|
| 279 | + ); |
|
| 280 | + } |
|
| 281 | 281 | |
| 282 | 282 | |
| 283 | - /** |
|
| 284 | - * callback for ajax action. |
|
| 285 | - * |
|
| 286 | - * @since 4.3.0 |
|
| 287 | - * @return void (JSON) |
|
| 288 | - * @throws EE_Error |
|
| 289 | - * @throws InvalidArgumentException |
|
| 290 | - * @throws InvalidDataTypeException |
|
| 291 | - * @throws InvalidInterfaceException |
|
| 292 | - */ |
|
| 293 | - public function get_newsletter_form_content() |
|
| 294 | - { |
|
| 295 | - // do a nonce check cause we're not coming in from an normal route here. |
|
| 296 | - $nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field( |
|
| 297 | - $this->_req_data['get_newsletter_form_content_nonce'] |
|
| 298 | - ) : ''; |
|
| 299 | - $nonce_ref = 'get_newsletter_form_content_nonce'; |
|
| 300 | - $this->_verify_nonce($nonce, $nonce_ref); |
|
| 301 | - // let's get the mtp for the incoming MTP_ ID |
|
| 302 | - if (! isset($this->_req_data['GRP_ID'])) { |
|
| 303 | - EE_Error::add_error( |
|
| 304 | - esc_html__( |
|
| 305 | - 'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).', |
|
| 306 | - 'event_espresso' |
|
| 307 | - ), |
|
| 308 | - __FILE__, |
|
| 309 | - __FUNCTION__, |
|
| 310 | - __LINE__ |
|
| 311 | - ); |
|
| 312 | - $this->_template_args['success'] = false; |
|
| 313 | - $this->_template_args['error'] = true; |
|
| 314 | - $this->_return_json(); |
|
| 315 | - } |
|
| 316 | - $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']); |
|
| 317 | - if (! $MTPG instanceof EE_Message_Template_Group) { |
|
| 318 | - EE_Error::add_error( |
|
| 319 | - sprintf( |
|
| 320 | - esc_html__( |
|
| 321 | - 'The GRP_ID given (%d) does not appear to have a corresponding row in the database.', |
|
| 322 | - 'event_espresso' |
|
| 323 | - ), |
|
| 324 | - $this->_req_data['GRP_ID'] |
|
| 325 | - ), |
|
| 326 | - __FILE__, |
|
| 327 | - __FUNCTION__, |
|
| 328 | - __LINE__ |
|
| 329 | - ); |
|
| 330 | - $this->_template_args['success'] = false; |
|
| 331 | - $this->_template_args['error'] = true; |
|
| 332 | - $this->_return_json(); |
|
| 333 | - } |
|
| 334 | - $MTPs = $MTPG->context_templates(); |
|
| 335 | - $MTPs = $MTPs['attendee']; |
|
| 336 | - $template_fields = array(); |
|
| 337 | - /** @var EE_Message_Template $MTP */ |
|
| 338 | - foreach ($MTPs as $MTP) { |
|
| 339 | - $field = $MTP->get('MTP_template_field'); |
|
| 340 | - if ($field === 'content') { |
|
| 341 | - $content = $MTP->get('MTP_content'); |
|
| 342 | - if (! empty($content['newsletter_content'])) { |
|
| 343 | - $template_fields['newsletter_content'] = $content['newsletter_content']; |
|
| 344 | - } |
|
| 345 | - continue; |
|
| 346 | - } |
|
| 347 | - $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content'); |
|
| 348 | - } |
|
| 349 | - $this->_template_args['success'] = true; |
|
| 350 | - $this->_template_args['error'] = false; |
|
| 351 | - $this->_template_args['data'] = array( |
|
| 352 | - 'batch_message_from' => isset($template_fields['from']) |
|
| 353 | - ? $template_fields['from'] |
|
| 354 | - : '', |
|
| 355 | - 'batch_message_subject' => isset($template_fields['subject']) |
|
| 356 | - ? $template_fields['subject'] |
|
| 357 | - : '', |
|
| 358 | - 'batch_message_content' => isset($template_fields['newsletter_content']) |
|
| 359 | - ? $template_fields['newsletter_content'] |
|
| 360 | - : '', |
|
| 361 | - ); |
|
| 362 | - $this->_return_json(); |
|
| 363 | - } |
|
| 283 | + /** |
|
| 284 | + * callback for ajax action. |
|
| 285 | + * |
|
| 286 | + * @since 4.3.0 |
|
| 287 | + * @return void (JSON) |
|
| 288 | + * @throws EE_Error |
|
| 289 | + * @throws InvalidArgumentException |
|
| 290 | + * @throws InvalidDataTypeException |
|
| 291 | + * @throws InvalidInterfaceException |
|
| 292 | + */ |
|
| 293 | + public function get_newsletter_form_content() |
|
| 294 | + { |
|
| 295 | + // do a nonce check cause we're not coming in from an normal route here. |
|
| 296 | + $nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field( |
|
| 297 | + $this->_req_data['get_newsletter_form_content_nonce'] |
|
| 298 | + ) : ''; |
|
| 299 | + $nonce_ref = 'get_newsletter_form_content_nonce'; |
|
| 300 | + $this->_verify_nonce($nonce, $nonce_ref); |
|
| 301 | + // let's get the mtp for the incoming MTP_ ID |
|
| 302 | + if (! isset($this->_req_data['GRP_ID'])) { |
|
| 303 | + EE_Error::add_error( |
|
| 304 | + esc_html__( |
|
| 305 | + 'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).', |
|
| 306 | + 'event_espresso' |
|
| 307 | + ), |
|
| 308 | + __FILE__, |
|
| 309 | + __FUNCTION__, |
|
| 310 | + __LINE__ |
|
| 311 | + ); |
|
| 312 | + $this->_template_args['success'] = false; |
|
| 313 | + $this->_template_args['error'] = true; |
|
| 314 | + $this->_return_json(); |
|
| 315 | + } |
|
| 316 | + $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']); |
|
| 317 | + if (! $MTPG instanceof EE_Message_Template_Group) { |
|
| 318 | + EE_Error::add_error( |
|
| 319 | + sprintf( |
|
| 320 | + esc_html__( |
|
| 321 | + 'The GRP_ID given (%d) does not appear to have a corresponding row in the database.', |
|
| 322 | + 'event_espresso' |
|
| 323 | + ), |
|
| 324 | + $this->_req_data['GRP_ID'] |
|
| 325 | + ), |
|
| 326 | + __FILE__, |
|
| 327 | + __FUNCTION__, |
|
| 328 | + __LINE__ |
|
| 329 | + ); |
|
| 330 | + $this->_template_args['success'] = false; |
|
| 331 | + $this->_template_args['error'] = true; |
|
| 332 | + $this->_return_json(); |
|
| 333 | + } |
|
| 334 | + $MTPs = $MTPG->context_templates(); |
|
| 335 | + $MTPs = $MTPs['attendee']; |
|
| 336 | + $template_fields = array(); |
|
| 337 | + /** @var EE_Message_Template $MTP */ |
|
| 338 | + foreach ($MTPs as $MTP) { |
|
| 339 | + $field = $MTP->get('MTP_template_field'); |
|
| 340 | + if ($field === 'content') { |
|
| 341 | + $content = $MTP->get('MTP_content'); |
|
| 342 | + if (! empty($content['newsletter_content'])) { |
|
| 343 | + $template_fields['newsletter_content'] = $content['newsletter_content']; |
|
| 344 | + } |
|
| 345 | + continue; |
|
| 346 | + } |
|
| 347 | + $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content'); |
|
| 348 | + } |
|
| 349 | + $this->_template_args['success'] = true; |
|
| 350 | + $this->_template_args['error'] = false; |
|
| 351 | + $this->_template_args['data'] = array( |
|
| 352 | + 'batch_message_from' => isset($template_fields['from']) |
|
| 353 | + ? $template_fields['from'] |
|
| 354 | + : '', |
|
| 355 | + 'batch_message_subject' => isset($template_fields['subject']) |
|
| 356 | + ? $template_fields['subject'] |
|
| 357 | + : '', |
|
| 358 | + 'batch_message_content' => isset($template_fields['newsletter_content']) |
|
| 359 | + ? $template_fields['newsletter_content'] |
|
| 360 | + : '', |
|
| 361 | + ); |
|
| 362 | + $this->_return_json(); |
|
| 363 | + } |
|
| 364 | 364 | |
| 365 | 365 | |
| 366 | - /** |
|
| 367 | - * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action |
|
| 368 | - * |
|
| 369 | - * @since 4.3.0 |
|
| 370 | - * @param EE_Admin_List_Table $list_table |
|
| 371 | - * @return void |
|
| 372 | - * @throws InvalidArgumentException |
|
| 373 | - * @throws InvalidDataTypeException |
|
| 374 | - * @throws InvalidInterfaceException |
|
| 375 | - */ |
|
| 376 | - public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table) |
|
| 377 | - { |
|
| 378 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 379 | - 'ee_send_message', |
|
| 380 | - 'espresso_registrations_newsletter_selected_send' |
|
| 381 | - ) |
|
| 382 | - ) { |
|
| 383 | - return; |
|
| 384 | - } |
|
| 385 | - $routes_to_add_to = array( |
|
| 386 | - 'contact_list', |
|
| 387 | - 'event_registrations', |
|
| 388 | - 'default', |
|
| 389 | - ); |
|
| 390 | - if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) { |
|
| 391 | - if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id'])) |
|
| 392 | - || (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash') |
|
| 393 | - ) { |
|
| 394 | - echo ''; |
|
| 395 | - } else { |
|
| 396 | - $button_text = sprintf( |
|
| 397 | - esc_html__('Send Batch Message (%s selected)', 'event_espresso'), |
|
| 398 | - '<span class="send-selected-newsletter-count">0</span>' |
|
| 399 | - ); |
|
| 400 | - echo '<button id="selected-batch-send-trigger" class="button secondary-button">' |
|
| 401 | - . '<span class="dashicons dashicons-email "></span>' |
|
| 402 | - . $button_text |
|
| 403 | - . '</button>'; |
|
| 404 | - add_action('admin_footer', array($this, 'newsletter_send_form_skeleton')); |
|
| 405 | - } |
|
| 406 | - } |
|
| 407 | - } |
|
| 366 | + /** |
|
| 367 | + * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action |
|
| 368 | + * |
|
| 369 | + * @since 4.3.0 |
|
| 370 | + * @param EE_Admin_List_Table $list_table |
|
| 371 | + * @return void |
|
| 372 | + * @throws InvalidArgumentException |
|
| 373 | + * @throws InvalidDataTypeException |
|
| 374 | + * @throws InvalidInterfaceException |
|
| 375 | + */ |
|
| 376 | + public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table) |
|
| 377 | + { |
|
| 378 | + if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 379 | + 'ee_send_message', |
|
| 380 | + 'espresso_registrations_newsletter_selected_send' |
|
| 381 | + ) |
|
| 382 | + ) { |
|
| 383 | + return; |
|
| 384 | + } |
|
| 385 | + $routes_to_add_to = array( |
|
| 386 | + 'contact_list', |
|
| 387 | + 'event_registrations', |
|
| 388 | + 'default', |
|
| 389 | + ); |
|
| 390 | + if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) { |
|
| 391 | + if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id'])) |
|
| 392 | + || (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash') |
|
| 393 | + ) { |
|
| 394 | + echo ''; |
|
| 395 | + } else { |
|
| 396 | + $button_text = sprintf( |
|
| 397 | + esc_html__('Send Batch Message (%s selected)', 'event_espresso'), |
|
| 398 | + '<span class="send-selected-newsletter-count">0</span>' |
|
| 399 | + ); |
|
| 400 | + echo '<button id="selected-batch-send-trigger" class="button secondary-button">' |
|
| 401 | + . '<span class="dashicons dashicons-email "></span>' |
|
| 402 | + . $button_text |
|
| 403 | + . '</button>'; |
|
| 404 | + add_action('admin_footer', array($this, 'newsletter_send_form_skeleton')); |
|
| 405 | + } |
|
| 406 | + } |
|
| 407 | + } |
|
| 408 | 408 | |
| 409 | 409 | |
| 410 | - /** |
|
| 411 | - * @throws DomainException |
|
| 412 | - * @throws EE_Error |
|
| 413 | - * @throws InvalidArgumentException |
|
| 414 | - * @throws InvalidDataTypeException |
|
| 415 | - * @throws InvalidInterfaceException |
|
| 416 | - */ |
|
| 417 | - public function newsletter_send_form_skeleton() |
|
| 418 | - { |
|
| 419 | - $list_table = $this->_list_table_object; |
|
| 420 | - $codes = array(); |
|
| 421 | - // need to templates for the newsletter message type for the template selector. |
|
| 422 | - $values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0); |
|
| 423 | - $mtps = EEM_Message_Template_Group::instance()->get_all( |
|
| 424 | - array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email')) |
|
| 425 | - ); |
|
| 426 | - foreach ($mtps as $mtp) { |
|
| 427 | - $name = $mtp->name(); |
|
| 428 | - $values[] = array( |
|
| 429 | - 'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name, |
|
| 430 | - 'id' => $mtp->ID(), |
|
| 431 | - ); |
|
| 432 | - } |
|
| 433 | - // need to get a list of shortcodes that are available for the newsletter message type. |
|
| 434 | - $shortcodes = EEH_MSG_Template::get_shortcodes( |
|
| 435 | - 'newsletter', |
|
| 436 | - 'email', |
|
| 437 | - array(), |
|
| 438 | - 'attendee', |
|
| 439 | - false |
|
| 440 | - ); |
|
| 441 | - foreach ($shortcodes as $field => $shortcode_array) { |
|
| 442 | - $available_shortcodes = array(); |
|
| 443 | - foreach ($shortcode_array as $shortcode => $shortcode_details) { |
|
| 444 | - $field_id = $field === '[NEWSLETTER_CONTENT]' |
|
| 445 | - ? 'content' |
|
| 446 | - : $field; |
|
| 447 | - $field_id = 'batch-message-' . strtolower($field_id); |
|
| 448 | - $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="' |
|
| 449 | - . $shortcode |
|
| 450 | - . '" data-linked-input-id="' . $field_id . '">' |
|
| 451 | - . $shortcode |
|
| 452 | - . '</span>'; |
|
| 453 | - } |
|
| 454 | - $codes[ $field ] = implode(', ', $available_shortcodes); |
|
| 455 | - } |
|
| 456 | - $shortcodes = $codes; |
|
| 457 | - $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php'; |
|
| 458 | - $form_template_args = array( |
|
| 459 | - 'form_action' => admin_url('admin.php?page=espresso_registrations'), |
|
| 460 | - 'form_route' => 'newsletter_selected_send', |
|
| 461 | - 'form_nonce_name' => 'newsletter_selected_send_nonce', |
|
| 462 | - 'form_nonce' => wp_create_nonce('newsletter_selected_send_nonce'), |
|
| 463 | - 'redirect_back_to' => $this->_req_action, |
|
| 464 | - 'ajax_nonce' => wp_create_nonce('get_newsletter_form_content_nonce'), |
|
| 465 | - 'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values), |
|
| 466 | - 'shortcodes' => $shortcodes, |
|
| 467 | - 'id_type' => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration', |
|
| 468 | - ); |
|
| 469 | - EEH_Template::display_template($form_template, $form_template_args); |
|
| 470 | - } |
|
| 410 | + /** |
|
| 411 | + * @throws DomainException |
|
| 412 | + * @throws EE_Error |
|
| 413 | + * @throws InvalidArgumentException |
|
| 414 | + * @throws InvalidDataTypeException |
|
| 415 | + * @throws InvalidInterfaceException |
|
| 416 | + */ |
|
| 417 | + public function newsletter_send_form_skeleton() |
|
| 418 | + { |
|
| 419 | + $list_table = $this->_list_table_object; |
|
| 420 | + $codes = array(); |
|
| 421 | + // need to templates for the newsletter message type for the template selector. |
|
| 422 | + $values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0); |
|
| 423 | + $mtps = EEM_Message_Template_Group::instance()->get_all( |
|
| 424 | + array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email')) |
|
| 425 | + ); |
|
| 426 | + foreach ($mtps as $mtp) { |
|
| 427 | + $name = $mtp->name(); |
|
| 428 | + $values[] = array( |
|
| 429 | + 'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name, |
|
| 430 | + 'id' => $mtp->ID(), |
|
| 431 | + ); |
|
| 432 | + } |
|
| 433 | + // need to get a list of shortcodes that are available for the newsletter message type. |
|
| 434 | + $shortcodes = EEH_MSG_Template::get_shortcodes( |
|
| 435 | + 'newsletter', |
|
| 436 | + 'email', |
|
| 437 | + array(), |
|
| 438 | + 'attendee', |
|
| 439 | + false |
|
| 440 | + ); |
|
| 441 | + foreach ($shortcodes as $field => $shortcode_array) { |
|
| 442 | + $available_shortcodes = array(); |
|
| 443 | + foreach ($shortcode_array as $shortcode => $shortcode_details) { |
|
| 444 | + $field_id = $field === '[NEWSLETTER_CONTENT]' |
|
| 445 | + ? 'content' |
|
| 446 | + : $field; |
|
| 447 | + $field_id = 'batch-message-' . strtolower($field_id); |
|
| 448 | + $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="' |
|
| 449 | + . $shortcode |
|
| 450 | + . '" data-linked-input-id="' . $field_id . '">' |
|
| 451 | + . $shortcode |
|
| 452 | + . '</span>'; |
|
| 453 | + } |
|
| 454 | + $codes[ $field ] = implode(', ', $available_shortcodes); |
|
| 455 | + } |
|
| 456 | + $shortcodes = $codes; |
|
| 457 | + $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php'; |
|
| 458 | + $form_template_args = array( |
|
| 459 | + 'form_action' => admin_url('admin.php?page=espresso_registrations'), |
|
| 460 | + 'form_route' => 'newsletter_selected_send', |
|
| 461 | + 'form_nonce_name' => 'newsletter_selected_send_nonce', |
|
| 462 | + 'form_nonce' => wp_create_nonce('newsletter_selected_send_nonce'), |
|
| 463 | + 'redirect_back_to' => $this->_req_action, |
|
| 464 | + 'ajax_nonce' => wp_create_nonce('get_newsletter_form_content_nonce'), |
|
| 465 | + 'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values), |
|
| 466 | + 'shortcodes' => $shortcodes, |
|
| 467 | + 'id_type' => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration', |
|
| 468 | + ); |
|
| 469 | + EEH_Template::display_template($form_template, $form_template_args); |
|
| 470 | + } |
|
| 471 | 471 | |
| 472 | 472 | |
| 473 | - /** |
|
| 474 | - * Handles sending selected registrations/contacts a newsletter. |
|
| 475 | - * |
|
| 476 | - * @since 4.3.0 |
|
| 477 | - * @return void |
|
| 478 | - * @throws EE_Error |
|
| 479 | - * @throws InvalidArgumentException |
|
| 480 | - * @throws InvalidDataTypeException |
|
| 481 | - * @throws InvalidInterfaceException |
|
| 482 | - */ |
|
| 483 | - protected function _newsletter_selected_send() |
|
| 484 | - { |
|
| 485 | - $success = true; |
|
| 486 | - // first we need to make sure we have a GRP_ID so we know what template we're sending and updating! |
|
| 487 | - if (empty($this->_req_data['newsletter_mtp_selected'])) { |
|
| 488 | - EE_Error::add_error( |
|
| 489 | - esc_html__( |
|
| 490 | - 'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.', |
|
| 491 | - 'event_espresso' |
|
| 492 | - ), |
|
| 493 | - __FILE__, |
|
| 494 | - __FUNCTION__, |
|
| 495 | - __LINE__ |
|
| 496 | - ); |
|
| 497 | - $success = false; |
|
| 498 | - } |
|
| 499 | - if ($success) { |
|
| 500 | - // update Message template in case there are any changes |
|
| 501 | - $Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID( |
|
| 502 | - $this->_req_data['newsletter_mtp_selected'] |
|
| 503 | - ); |
|
| 504 | - $Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group |
|
| 505 | - ? $Message_Template_Group->context_templates() |
|
| 506 | - : array(); |
|
| 507 | - if (empty($Message_Templates)) { |
|
| 508 | - EE_Error::add_error( |
|
| 509 | - esc_html__( |
|
| 510 | - 'Unable to retrieve message template fields from the db. Messages not sent.', |
|
| 511 | - 'event_espresso' |
|
| 512 | - ), |
|
| 513 | - __FILE__, |
|
| 514 | - __FUNCTION__, |
|
| 515 | - __LINE__ |
|
| 516 | - ); |
|
| 517 | - } |
|
| 518 | - // let's just update the specific fields |
|
| 519 | - foreach ($Message_Templates['attendee'] as $Message_Template) { |
|
| 520 | - if ($Message_Template instanceof EE_Message_Template) { |
|
| 521 | - $field = $Message_Template->get('MTP_template_field'); |
|
| 522 | - $content = $Message_Template->get('MTP_content'); |
|
| 523 | - $new_content = $content; |
|
| 524 | - switch ($field) { |
|
| 525 | - case 'from': |
|
| 526 | - $new_content = ! empty($this->_req_data['batch_message']['from']) |
|
| 527 | - ? $this->_req_data['batch_message']['from'] |
|
| 528 | - : $content; |
|
| 529 | - break; |
|
| 530 | - case 'subject': |
|
| 531 | - $new_content = ! empty($this->_req_data['batch_message']['subject']) |
|
| 532 | - ? $this->_req_data['batch_message']['subject'] |
|
| 533 | - : $content; |
|
| 534 | - break; |
|
| 535 | - case 'content': |
|
| 536 | - $new_content = $content; |
|
| 537 | - $new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content']) |
|
| 538 | - ? $this->_req_data['batch_message']['content'] |
|
| 539 | - : $content['newsletter_content']; |
|
| 540 | - break; |
|
| 541 | - default: |
|
| 542 | - // continue the foreach loop, we don't want to set $new_content nor save. |
|
| 543 | - continue 2; |
|
| 544 | - } |
|
| 545 | - $Message_Template->set('MTP_content', $new_content); |
|
| 546 | - $Message_Template->save(); |
|
| 547 | - } |
|
| 548 | - } |
|
| 549 | - // great fields are updated! now let's make sure we just have contact objects (EE_Attendee). |
|
| 550 | - $id_type = ! empty($this->_req_data['batch_message']['id_type']) |
|
| 551 | - ? $this->_req_data['batch_message']['id_type'] |
|
| 552 | - : 'registration'; |
|
| 553 | - // id_type will affect how we assemble the ids. |
|
| 554 | - $ids = ! empty($this->_req_data['batch_message']['ids']) |
|
| 555 | - ? json_decode(stripslashes($this->_req_data['batch_message']['ids'])) |
|
| 556 | - : array(); |
|
| 557 | - $registrations_used_for_contact_data = array(); |
|
| 558 | - // using switch because eventually we'll have other contexts that will be used for generating messages. |
|
| 559 | - switch ($id_type) { |
|
| 560 | - case 'registration': |
|
| 561 | - $registrations_used_for_contact_data = EEM_Registration::instance()->get_all( |
|
| 562 | - array( |
|
| 563 | - array( |
|
| 564 | - 'REG_ID' => array('IN', $ids), |
|
| 565 | - ), |
|
| 566 | - ) |
|
| 567 | - ); |
|
| 568 | - break; |
|
| 569 | - case 'contact': |
|
| 570 | - $registrations_used_for_contact_data = EEM_Registration::instance() |
|
| 571 | - ->get_latest_registration_for_each_of_given_contacts( |
|
| 572 | - $ids |
|
| 573 | - ); |
|
| 574 | - break; |
|
| 575 | - } |
|
| 576 | - do_action_ref_array( |
|
| 577 | - 'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations', |
|
| 578 | - array( |
|
| 579 | - $registrations_used_for_contact_data, |
|
| 580 | - $Message_Template_Group->ID(), |
|
| 581 | - ) |
|
| 582 | - ); |
|
| 583 | - // kept for backward compat, internally we no longer use this action. |
|
| 584 | - // @deprecated 4.8.36.rc.002 |
|
| 585 | - $contacts = $id_type === 'registration' |
|
| 586 | - ? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids) |
|
| 587 | - : EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids)))); |
|
| 588 | - do_action_ref_array( |
|
| 589 | - 'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send', |
|
| 590 | - array( |
|
| 591 | - $contacts, |
|
| 592 | - $Message_Template_Group->ID(), |
|
| 593 | - ) |
|
| 594 | - ); |
|
| 595 | - } |
|
| 596 | - $query_args = array( |
|
| 597 | - 'action' => ! empty($this->_req_data['redirect_back_to']) |
|
| 598 | - ? $this->_req_data['redirect_back_to'] |
|
| 599 | - : 'default', |
|
| 600 | - ); |
|
| 601 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 602 | - } |
|
| 473 | + /** |
|
| 474 | + * Handles sending selected registrations/contacts a newsletter. |
|
| 475 | + * |
|
| 476 | + * @since 4.3.0 |
|
| 477 | + * @return void |
|
| 478 | + * @throws EE_Error |
|
| 479 | + * @throws InvalidArgumentException |
|
| 480 | + * @throws InvalidDataTypeException |
|
| 481 | + * @throws InvalidInterfaceException |
|
| 482 | + */ |
|
| 483 | + protected function _newsletter_selected_send() |
|
| 484 | + { |
|
| 485 | + $success = true; |
|
| 486 | + // first we need to make sure we have a GRP_ID so we know what template we're sending and updating! |
|
| 487 | + if (empty($this->_req_data['newsletter_mtp_selected'])) { |
|
| 488 | + EE_Error::add_error( |
|
| 489 | + esc_html__( |
|
| 490 | + 'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.', |
|
| 491 | + 'event_espresso' |
|
| 492 | + ), |
|
| 493 | + __FILE__, |
|
| 494 | + __FUNCTION__, |
|
| 495 | + __LINE__ |
|
| 496 | + ); |
|
| 497 | + $success = false; |
|
| 498 | + } |
|
| 499 | + if ($success) { |
|
| 500 | + // update Message template in case there are any changes |
|
| 501 | + $Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID( |
|
| 502 | + $this->_req_data['newsletter_mtp_selected'] |
|
| 503 | + ); |
|
| 504 | + $Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group |
|
| 505 | + ? $Message_Template_Group->context_templates() |
|
| 506 | + : array(); |
|
| 507 | + if (empty($Message_Templates)) { |
|
| 508 | + EE_Error::add_error( |
|
| 509 | + esc_html__( |
|
| 510 | + 'Unable to retrieve message template fields from the db. Messages not sent.', |
|
| 511 | + 'event_espresso' |
|
| 512 | + ), |
|
| 513 | + __FILE__, |
|
| 514 | + __FUNCTION__, |
|
| 515 | + __LINE__ |
|
| 516 | + ); |
|
| 517 | + } |
|
| 518 | + // let's just update the specific fields |
|
| 519 | + foreach ($Message_Templates['attendee'] as $Message_Template) { |
|
| 520 | + if ($Message_Template instanceof EE_Message_Template) { |
|
| 521 | + $field = $Message_Template->get('MTP_template_field'); |
|
| 522 | + $content = $Message_Template->get('MTP_content'); |
|
| 523 | + $new_content = $content; |
|
| 524 | + switch ($field) { |
|
| 525 | + case 'from': |
|
| 526 | + $new_content = ! empty($this->_req_data['batch_message']['from']) |
|
| 527 | + ? $this->_req_data['batch_message']['from'] |
|
| 528 | + : $content; |
|
| 529 | + break; |
|
| 530 | + case 'subject': |
|
| 531 | + $new_content = ! empty($this->_req_data['batch_message']['subject']) |
|
| 532 | + ? $this->_req_data['batch_message']['subject'] |
|
| 533 | + : $content; |
|
| 534 | + break; |
|
| 535 | + case 'content': |
|
| 536 | + $new_content = $content; |
|
| 537 | + $new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content']) |
|
| 538 | + ? $this->_req_data['batch_message']['content'] |
|
| 539 | + : $content['newsletter_content']; |
|
| 540 | + break; |
|
| 541 | + default: |
|
| 542 | + // continue the foreach loop, we don't want to set $new_content nor save. |
|
| 543 | + continue 2; |
|
| 544 | + } |
|
| 545 | + $Message_Template->set('MTP_content', $new_content); |
|
| 546 | + $Message_Template->save(); |
|
| 547 | + } |
|
| 548 | + } |
|
| 549 | + // great fields are updated! now let's make sure we just have contact objects (EE_Attendee). |
|
| 550 | + $id_type = ! empty($this->_req_data['batch_message']['id_type']) |
|
| 551 | + ? $this->_req_data['batch_message']['id_type'] |
|
| 552 | + : 'registration'; |
|
| 553 | + // id_type will affect how we assemble the ids. |
|
| 554 | + $ids = ! empty($this->_req_data['batch_message']['ids']) |
|
| 555 | + ? json_decode(stripslashes($this->_req_data['batch_message']['ids'])) |
|
| 556 | + : array(); |
|
| 557 | + $registrations_used_for_contact_data = array(); |
|
| 558 | + // using switch because eventually we'll have other contexts that will be used for generating messages. |
|
| 559 | + switch ($id_type) { |
|
| 560 | + case 'registration': |
|
| 561 | + $registrations_used_for_contact_data = EEM_Registration::instance()->get_all( |
|
| 562 | + array( |
|
| 563 | + array( |
|
| 564 | + 'REG_ID' => array('IN', $ids), |
|
| 565 | + ), |
|
| 566 | + ) |
|
| 567 | + ); |
|
| 568 | + break; |
|
| 569 | + case 'contact': |
|
| 570 | + $registrations_used_for_contact_data = EEM_Registration::instance() |
|
| 571 | + ->get_latest_registration_for_each_of_given_contacts( |
|
| 572 | + $ids |
|
| 573 | + ); |
|
| 574 | + break; |
|
| 575 | + } |
|
| 576 | + do_action_ref_array( |
|
| 577 | + 'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations', |
|
| 578 | + array( |
|
| 579 | + $registrations_used_for_contact_data, |
|
| 580 | + $Message_Template_Group->ID(), |
|
| 581 | + ) |
|
| 582 | + ); |
|
| 583 | + // kept for backward compat, internally we no longer use this action. |
|
| 584 | + // @deprecated 4.8.36.rc.002 |
|
| 585 | + $contacts = $id_type === 'registration' |
|
| 586 | + ? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids) |
|
| 587 | + : EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids)))); |
|
| 588 | + do_action_ref_array( |
|
| 589 | + 'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send', |
|
| 590 | + array( |
|
| 591 | + $contacts, |
|
| 592 | + $Message_Template_Group->ID(), |
|
| 593 | + ) |
|
| 594 | + ); |
|
| 595 | + } |
|
| 596 | + $query_args = array( |
|
| 597 | + 'action' => ! empty($this->_req_data['redirect_back_to']) |
|
| 598 | + ? $this->_req_data['redirect_back_to'] |
|
| 599 | + : 'default', |
|
| 600 | + ); |
|
| 601 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 602 | + } |
|
| 603 | 603 | |
| 604 | 604 | |
| 605 | - /** |
|
| 606 | - * This is called when javascript is being enqueued to setup the various data needed for the reports js. |
|
| 607 | - * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method. |
|
| 608 | - */ |
|
| 609 | - protected function _registration_reports_js_setup() |
|
| 610 | - { |
|
| 611 | - $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report(); |
|
| 612 | - $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report(); |
|
| 613 | - } |
|
| 605 | + /** |
|
| 606 | + * This is called when javascript is being enqueued to setup the various data needed for the reports js. |
|
| 607 | + * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method. |
|
| 608 | + */ |
|
| 609 | + protected function _registration_reports_js_setup() |
|
| 610 | + { |
|
| 611 | + $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report(); |
|
| 612 | + $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report(); |
|
| 613 | + } |
|
| 614 | 614 | |
| 615 | 615 | |
| 616 | - /** |
|
| 617 | - * generates Business Reports regarding Registrations |
|
| 618 | - * |
|
| 619 | - * @access protected |
|
| 620 | - * @return void |
|
| 621 | - * @throws DomainException |
|
| 622 | - */ |
|
| 623 | - protected function _registration_reports() |
|
| 624 | - { |
|
| 625 | - $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php'; |
|
| 626 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
| 627 | - $template_path, |
|
| 628 | - $this->_reports_template_data, |
|
| 629 | - true |
|
| 630 | - ); |
|
| 631 | - // the final template wrapper |
|
| 632 | - $this->display_admin_page_with_no_sidebar(); |
|
| 633 | - } |
|
| 616 | + /** |
|
| 617 | + * generates Business Reports regarding Registrations |
|
| 618 | + * |
|
| 619 | + * @access protected |
|
| 620 | + * @return void |
|
| 621 | + * @throws DomainException |
|
| 622 | + */ |
|
| 623 | + protected function _registration_reports() |
|
| 624 | + { |
|
| 625 | + $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php'; |
|
| 626 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
| 627 | + $template_path, |
|
| 628 | + $this->_reports_template_data, |
|
| 629 | + true |
|
| 630 | + ); |
|
| 631 | + // the final template wrapper |
|
| 632 | + $this->display_admin_page_with_no_sidebar(); |
|
| 633 | + } |
|
| 634 | 634 | |
| 635 | 635 | |
| 636 | - /** |
|
| 637 | - * Generates Business Report showing total registrations per day. |
|
| 638 | - * |
|
| 639 | - * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 640 | - * @return string |
|
| 641 | - * @throws EE_Error |
|
| 642 | - * @throws InvalidArgumentException |
|
| 643 | - * @throws InvalidDataTypeException |
|
| 644 | - * @throws InvalidInterfaceException |
|
| 645 | - */ |
|
| 646 | - private function _registrations_per_day_report($period = '-1 month') |
|
| 647 | - { |
|
| 648 | - $report_ID = 'reg-admin-registrations-per-day-report-dv'; |
|
| 649 | - $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period); |
|
| 650 | - $results = (array) $results; |
|
| 651 | - $regs = array(); |
|
| 652 | - $subtitle = ''; |
|
| 653 | - if ($results) { |
|
| 654 | - $column_titles = array(); |
|
| 655 | - $tracker = 0; |
|
| 656 | - foreach ($results as $result) { |
|
| 657 | - $report_column_values = array(); |
|
| 658 | - foreach ($result as $property_name => $property_value) { |
|
| 659 | - $property_value = $property_name === 'Registration_REG_date' ? $property_value |
|
| 660 | - : (int) $property_value; |
|
| 661 | - $report_column_values[] = $property_value; |
|
| 662 | - if ($tracker === 0) { |
|
| 663 | - if ($property_name === 'Registration_REG_date') { |
|
| 664 | - $column_titles[] = esc_html__( |
|
| 665 | - 'Date (only days with registrations are shown)', |
|
| 666 | - 'event_espresso' |
|
| 667 | - ); |
|
| 668 | - } else { |
|
| 669 | - $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence'); |
|
| 670 | - } |
|
| 671 | - } |
|
| 672 | - } |
|
| 673 | - $tracker++; |
|
| 674 | - $regs[] = $report_column_values; |
|
| 675 | - } |
|
| 676 | - // make sure the column_titles is pushed to the beginning of the array |
|
| 677 | - array_unshift($regs, $column_titles); |
|
| 678 | - // setup the date range. |
|
| 679 | - $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone()); |
|
| 680 | - $beginning_date = new DateTime("now " . $period, $DateTimeZone); |
|
| 681 | - $ending_date = new DateTime("now", $DateTimeZone); |
|
| 682 | - $subtitle = sprintf( |
|
| 683 | - _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'), |
|
| 684 | - $beginning_date->format('Y-m-d'), |
|
| 685 | - $ending_date->format('Y-m-d') |
|
| 686 | - ); |
|
| 687 | - } |
|
| 688 | - $report_title = esc_html__('Total Registrations per Day', 'event_espresso'); |
|
| 689 | - $report_params = array( |
|
| 690 | - 'title' => $report_title, |
|
| 691 | - 'subtitle' => $subtitle, |
|
| 692 | - 'id' => $report_ID, |
|
| 693 | - 'regs' => $regs, |
|
| 694 | - 'noResults' => empty($regs), |
|
| 695 | - 'noRegsMsg' => sprintf( |
|
| 696 | - esc_html__( |
|
| 697 | - '%sThere are currently no registration records in the last month for this report.%s', |
|
| 698 | - 'event_espresso' |
|
| 699 | - ), |
|
| 700 | - '<h2>' . $report_title . '</h2><p>', |
|
| 701 | - '</p>' |
|
| 702 | - ), |
|
| 703 | - ); |
|
| 704 | - wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params); |
|
| 705 | - return $report_ID; |
|
| 706 | - } |
|
| 636 | + /** |
|
| 637 | + * Generates Business Report showing total registrations per day. |
|
| 638 | + * |
|
| 639 | + * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 640 | + * @return string |
|
| 641 | + * @throws EE_Error |
|
| 642 | + * @throws InvalidArgumentException |
|
| 643 | + * @throws InvalidDataTypeException |
|
| 644 | + * @throws InvalidInterfaceException |
|
| 645 | + */ |
|
| 646 | + private function _registrations_per_day_report($period = '-1 month') |
|
| 647 | + { |
|
| 648 | + $report_ID = 'reg-admin-registrations-per-day-report-dv'; |
|
| 649 | + $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period); |
|
| 650 | + $results = (array) $results; |
|
| 651 | + $regs = array(); |
|
| 652 | + $subtitle = ''; |
|
| 653 | + if ($results) { |
|
| 654 | + $column_titles = array(); |
|
| 655 | + $tracker = 0; |
|
| 656 | + foreach ($results as $result) { |
|
| 657 | + $report_column_values = array(); |
|
| 658 | + foreach ($result as $property_name => $property_value) { |
|
| 659 | + $property_value = $property_name === 'Registration_REG_date' ? $property_value |
|
| 660 | + : (int) $property_value; |
|
| 661 | + $report_column_values[] = $property_value; |
|
| 662 | + if ($tracker === 0) { |
|
| 663 | + if ($property_name === 'Registration_REG_date') { |
|
| 664 | + $column_titles[] = esc_html__( |
|
| 665 | + 'Date (only days with registrations are shown)', |
|
| 666 | + 'event_espresso' |
|
| 667 | + ); |
|
| 668 | + } else { |
|
| 669 | + $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence'); |
|
| 670 | + } |
|
| 671 | + } |
|
| 672 | + } |
|
| 673 | + $tracker++; |
|
| 674 | + $regs[] = $report_column_values; |
|
| 675 | + } |
|
| 676 | + // make sure the column_titles is pushed to the beginning of the array |
|
| 677 | + array_unshift($regs, $column_titles); |
|
| 678 | + // setup the date range. |
|
| 679 | + $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone()); |
|
| 680 | + $beginning_date = new DateTime("now " . $period, $DateTimeZone); |
|
| 681 | + $ending_date = new DateTime("now", $DateTimeZone); |
|
| 682 | + $subtitle = sprintf( |
|
| 683 | + _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'), |
|
| 684 | + $beginning_date->format('Y-m-d'), |
|
| 685 | + $ending_date->format('Y-m-d') |
|
| 686 | + ); |
|
| 687 | + } |
|
| 688 | + $report_title = esc_html__('Total Registrations per Day', 'event_espresso'); |
|
| 689 | + $report_params = array( |
|
| 690 | + 'title' => $report_title, |
|
| 691 | + 'subtitle' => $subtitle, |
|
| 692 | + 'id' => $report_ID, |
|
| 693 | + 'regs' => $regs, |
|
| 694 | + 'noResults' => empty($regs), |
|
| 695 | + 'noRegsMsg' => sprintf( |
|
| 696 | + esc_html__( |
|
| 697 | + '%sThere are currently no registration records in the last month for this report.%s', |
|
| 698 | + 'event_espresso' |
|
| 699 | + ), |
|
| 700 | + '<h2>' . $report_title . '</h2><p>', |
|
| 701 | + '</p>' |
|
| 702 | + ), |
|
| 703 | + ); |
|
| 704 | + wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params); |
|
| 705 | + return $report_ID; |
|
| 706 | + } |
|
| 707 | 707 | |
| 708 | 708 | |
| 709 | - /** |
|
| 710 | - * Generates Business Report showing total registrations per event. |
|
| 711 | - * |
|
| 712 | - * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 713 | - * @return string |
|
| 714 | - * @throws EE_Error |
|
| 715 | - * @throws InvalidArgumentException |
|
| 716 | - * @throws InvalidDataTypeException |
|
| 717 | - * @throws InvalidInterfaceException |
|
| 718 | - */ |
|
| 719 | - private function _registrations_per_event_report($period = '-1 month') |
|
| 720 | - { |
|
| 721 | - $report_ID = 'reg-admin-registrations-per-event-report-dv'; |
|
| 722 | - $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period); |
|
| 723 | - $results = (array) $results; |
|
| 724 | - $regs = array(); |
|
| 725 | - $subtitle = ''; |
|
| 726 | - if ($results) { |
|
| 727 | - $column_titles = array(); |
|
| 728 | - $tracker = 0; |
|
| 729 | - foreach ($results as $result) { |
|
| 730 | - $report_column_values = array(); |
|
| 731 | - foreach ($result as $property_name => $property_value) { |
|
| 732 | - $property_value = $property_name === 'Registration_Event' ? wp_trim_words( |
|
| 733 | - $property_value, |
|
| 734 | - 4, |
|
| 735 | - '...' |
|
| 736 | - ) : (int) $property_value; |
|
| 737 | - $report_column_values[] = $property_value; |
|
| 738 | - if ($tracker === 0) { |
|
| 739 | - if ($property_name === 'Registration_Event') { |
|
| 740 | - $column_titles[] = esc_html__('Event', 'event_espresso'); |
|
| 741 | - } else { |
|
| 742 | - $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence'); |
|
| 743 | - } |
|
| 744 | - } |
|
| 745 | - } |
|
| 746 | - $tracker++; |
|
| 747 | - $regs[] = $report_column_values; |
|
| 748 | - } |
|
| 749 | - // make sure the column_titles is pushed to the beginning of the array |
|
| 750 | - array_unshift($regs, $column_titles); |
|
| 751 | - // setup the date range. |
|
| 752 | - $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone()); |
|
| 753 | - $beginning_date = new DateTime("now " . $period, $DateTimeZone); |
|
| 754 | - $ending_date = new DateTime("now", $DateTimeZone); |
|
| 755 | - $subtitle = sprintf( |
|
| 756 | - _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'), |
|
| 757 | - $beginning_date->format('Y-m-d'), |
|
| 758 | - $ending_date->format('Y-m-d') |
|
| 759 | - ); |
|
| 760 | - } |
|
| 761 | - $report_title = esc_html__('Total Registrations per Event', 'event_espresso'); |
|
| 762 | - $report_params = array( |
|
| 763 | - 'title' => $report_title, |
|
| 764 | - 'subtitle' => $subtitle, |
|
| 765 | - 'id' => $report_ID, |
|
| 766 | - 'regs' => $regs, |
|
| 767 | - 'noResults' => empty($regs), |
|
| 768 | - 'noRegsMsg' => sprintf( |
|
| 769 | - esc_html__( |
|
| 770 | - '%sThere are currently no registration records in the last month for this report.%s', |
|
| 771 | - 'event_espresso' |
|
| 772 | - ), |
|
| 773 | - '<h2>' . $report_title . '</h2><p>', |
|
| 774 | - '</p>' |
|
| 775 | - ), |
|
| 776 | - ); |
|
| 777 | - wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params); |
|
| 778 | - return $report_ID; |
|
| 779 | - } |
|
| 709 | + /** |
|
| 710 | + * Generates Business Report showing total registrations per event. |
|
| 711 | + * |
|
| 712 | + * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 713 | + * @return string |
|
| 714 | + * @throws EE_Error |
|
| 715 | + * @throws InvalidArgumentException |
|
| 716 | + * @throws InvalidDataTypeException |
|
| 717 | + * @throws InvalidInterfaceException |
|
| 718 | + */ |
|
| 719 | + private function _registrations_per_event_report($period = '-1 month') |
|
| 720 | + { |
|
| 721 | + $report_ID = 'reg-admin-registrations-per-event-report-dv'; |
|
| 722 | + $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period); |
|
| 723 | + $results = (array) $results; |
|
| 724 | + $regs = array(); |
|
| 725 | + $subtitle = ''; |
|
| 726 | + if ($results) { |
|
| 727 | + $column_titles = array(); |
|
| 728 | + $tracker = 0; |
|
| 729 | + foreach ($results as $result) { |
|
| 730 | + $report_column_values = array(); |
|
| 731 | + foreach ($result as $property_name => $property_value) { |
|
| 732 | + $property_value = $property_name === 'Registration_Event' ? wp_trim_words( |
|
| 733 | + $property_value, |
|
| 734 | + 4, |
|
| 735 | + '...' |
|
| 736 | + ) : (int) $property_value; |
|
| 737 | + $report_column_values[] = $property_value; |
|
| 738 | + if ($tracker === 0) { |
|
| 739 | + if ($property_name === 'Registration_Event') { |
|
| 740 | + $column_titles[] = esc_html__('Event', 'event_espresso'); |
|
| 741 | + } else { |
|
| 742 | + $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence'); |
|
| 743 | + } |
|
| 744 | + } |
|
| 745 | + } |
|
| 746 | + $tracker++; |
|
| 747 | + $regs[] = $report_column_values; |
|
| 748 | + } |
|
| 749 | + // make sure the column_titles is pushed to the beginning of the array |
|
| 750 | + array_unshift($regs, $column_titles); |
|
| 751 | + // setup the date range. |
|
| 752 | + $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone()); |
|
| 753 | + $beginning_date = new DateTime("now " . $period, $DateTimeZone); |
|
| 754 | + $ending_date = new DateTime("now", $DateTimeZone); |
|
| 755 | + $subtitle = sprintf( |
|
| 756 | + _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'), |
|
| 757 | + $beginning_date->format('Y-m-d'), |
|
| 758 | + $ending_date->format('Y-m-d') |
|
| 759 | + ); |
|
| 760 | + } |
|
| 761 | + $report_title = esc_html__('Total Registrations per Event', 'event_espresso'); |
|
| 762 | + $report_params = array( |
|
| 763 | + 'title' => $report_title, |
|
| 764 | + 'subtitle' => $subtitle, |
|
| 765 | + 'id' => $report_ID, |
|
| 766 | + 'regs' => $regs, |
|
| 767 | + 'noResults' => empty($regs), |
|
| 768 | + 'noRegsMsg' => sprintf( |
|
| 769 | + esc_html__( |
|
| 770 | + '%sThere are currently no registration records in the last month for this report.%s', |
|
| 771 | + 'event_espresso' |
|
| 772 | + ), |
|
| 773 | + '<h2>' . $report_title . '</h2><p>', |
|
| 774 | + '</p>' |
|
| 775 | + ), |
|
| 776 | + ); |
|
| 777 | + wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params); |
|
| 778 | + return $report_ID; |
|
| 779 | + } |
|
| 780 | 780 | |
| 781 | 781 | |
| 782 | - /** |
|
| 783 | - * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration) |
|
| 784 | - * |
|
| 785 | - * @access protected |
|
| 786 | - * @return void |
|
| 787 | - * @throws EE_Error |
|
| 788 | - * @throws InvalidArgumentException |
|
| 789 | - * @throws InvalidDataTypeException |
|
| 790 | - * @throws InvalidInterfaceException |
|
| 791 | - * @throws \EventEspresso\core\exceptions\EntityNotFoundException |
|
| 792 | - */ |
|
| 793 | - protected function _registration_checkin_list_table() |
|
| 794 | - { |
|
| 795 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 796 | - $reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null; |
|
| 797 | - /** @var EE_Registration $registration */ |
|
| 798 | - $registration = EEM_Registration::instance()->get_one_by_ID($reg_id); |
|
| 799 | - $attendee = $registration->attendee(); |
|
| 800 | - $this->_admin_page_title .= $this->get_action_link_or_button( |
|
| 801 | - 'new_registration', |
|
| 802 | - 'add-registrant', |
|
| 803 | - array('event_id' => $registration->event_ID()), |
|
| 804 | - 'add-new-h2' |
|
| 805 | - ); |
|
| 806 | - $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in); |
|
| 807 | - $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out); |
|
| 808 | - $legend_items = array( |
|
| 809 | - 'checkin' => array( |
|
| 810 | - 'class' => $checked_in->cssClasses(), |
|
| 811 | - 'desc' => $checked_in->legendLabel(), |
|
| 812 | - ), |
|
| 813 | - 'checkout' => array( |
|
| 814 | - 'class' => $checked_out->cssClasses(), |
|
| 815 | - 'desc' => $checked_out->legendLabel(), |
|
| 816 | - ), |
|
| 817 | - ); |
|
| 818 | - $this->_template_args['after_list_table'] = $this->_display_legend($legend_items); |
|
| 819 | - $dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null; |
|
| 820 | - /** @var EE_Datetime $datetime */ |
|
| 821 | - $datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id); |
|
| 822 | - $datetime_label = ''; |
|
| 823 | - if ($datetime instanceof EE_Datetime) { |
|
| 824 | - $datetime_label = $datetime->get_dtt_display_name(true); |
|
| 825 | - $datetime_label .= ! empty($datetime_label) |
|
| 826 | - ? ' (' . $datetime->get_dtt_display_name() . ')' |
|
| 827 | - : $datetime->get_dtt_display_name(); |
|
| 828 | - } |
|
| 829 | - $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration |
|
| 830 | - ? EE_Admin_Page::add_query_args_and_nonce( |
|
| 831 | - array( |
|
| 832 | - 'action' => 'event_registrations', |
|
| 833 | - 'event_id' => $registration->event_ID(), |
|
| 834 | - 'DTT_ID' => $dtt_id, |
|
| 835 | - ), |
|
| 836 | - $this->_admin_base_url |
|
| 837 | - ) |
|
| 838 | - : ''; |
|
| 839 | - $datetime_link = ! empty($datetime_link) |
|
| 840 | - ? '<a href="' . $datetime_link . '">' |
|
| 841 | - . '<span id="checkin-dtt">' |
|
| 842 | - . $datetime_label |
|
| 843 | - . '</span></a>' |
|
| 844 | - : $datetime_label; |
|
| 845 | - $attendee_name = $attendee instanceof EE_Attendee |
|
| 846 | - ? $attendee->full_name() |
|
| 847 | - : ''; |
|
| 848 | - $attendee_link = $attendee instanceof EE_Attendee |
|
| 849 | - ? $attendee->get_admin_details_link() |
|
| 850 | - : ''; |
|
| 851 | - $attendee_link = ! empty($attendee_link) |
|
| 852 | - ? '<a href="' . $attendee->get_admin_details_link() . '"' |
|
| 853 | - . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">' |
|
| 854 | - . '<span id="checkin-attendee-name">' |
|
| 855 | - . $attendee_name |
|
| 856 | - . '</span></a>' |
|
| 857 | - : ''; |
|
| 858 | - $event_link = $registration->event() instanceof EE_Event |
|
| 859 | - ? $registration->event()->get_admin_details_link() |
|
| 860 | - : ''; |
|
| 861 | - $event_link = ! empty($event_link) |
|
| 862 | - ? '<a href="' . $event_link . '"' |
|
| 863 | - . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">' |
|
| 864 | - . '<span id="checkin-event-name">' |
|
| 865 | - . $registration->event_name() |
|
| 866 | - . '</span>' |
|
| 867 | - . '</a>' |
|
| 868 | - : ''; |
|
| 869 | - $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id) |
|
| 870 | - ? '<h2>' . sprintf( |
|
| 871 | - esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'), |
|
| 872 | - $attendee_link, |
|
| 873 | - $datetime_link, |
|
| 874 | - $event_link |
|
| 875 | - ) . '</h2>' |
|
| 876 | - : ''; |
|
| 877 | - $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id) |
|
| 878 | - ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : ''; |
|
| 879 | - $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id) |
|
| 880 | - ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : ''; |
|
| 881 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 882 | - } |
|
| 782 | + /** |
|
| 783 | + * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration) |
|
| 784 | + * |
|
| 785 | + * @access protected |
|
| 786 | + * @return void |
|
| 787 | + * @throws EE_Error |
|
| 788 | + * @throws InvalidArgumentException |
|
| 789 | + * @throws InvalidDataTypeException |
|
| 790 | + * @throws InvalidInterfaceException |
|
| 791 | + * @throws \EventEspresso\core\exceptions\EntityNotFoundException |
|
| 792 | + */ |
|
| 793 | + protected function _registration_checkin_list_table() |
|
| 794 | + { |
|
| 795 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 796 | + $reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null; |
|
| 797 | + /** @var EE_Registration $registration */ |
|
| 798 | + $registration = EEM_Registration::instance()->get_one_by_ID($reg_id); |
|
| 799 | + $attendee = $registration->attendee(); |
|
| 800 | + $this->_admin_page_title .= $this->get_action_link_or_button( |
|
| 801 | + 'new_registration', |
|
| 802 | + 'add-registrant', |
|
| 803 | + array('event_id' => $registration->event_ID()), |
|
| 804 | + 'add-new-h2' |
|
| 805 | + ); |
|
| 806 | + $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in); |
|
| 807 | + $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out); |
|
| 808 | + $legend_items = array( |
|
| 809 | + 'checkin' => array( |
|
| 810 | + 'class' => $checked_in->cssClasses(), |
|
| 811 | + 'desc' => $checked_in->legendLabel(), |
|
| 812 | + ), |
|
| 813 | + 'checkout' => array( |
|
| 814 | + 'class' => $checked_out->cssClasses(), |
|
| 815 | + 'desc' => $checked_out->legendLabel(), |
|
| 816 | + ), |
|
| 817 | + ); |
|
| 818 | + $this->_template_args['after_list_table'] = $this->_display_legend($legend_items); |
|
| 819 | + $dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null; |
|
| 820 | + /** @var EE_Datetime $datetime */ |
|
| 821 | + $datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id); |
|
| 822 | + $datetime_label = ''; |
|
| 823 | + if ($datetime instanceof EE_Datetime) { |
|
| 824 | + $datetime_label = $datetime->get_dtt_display_name(true); |
|
| 825 | + $datetime_label .= ! empty($datetime_label) |
|
| 826 | + ? ' (' . $datetime->get_dtt_display_name() . ')' |
|
| 827 | + : $datetime->get_dtt_display_name(); |
|
| 828 | + } |
|
| 829 | + $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration |
|
| 830 | + ? EE_Admin_Page::add_query_args_and_nonce( |
|
| 831 | + array( |
|
| 832 | + 'action' => 'event_registrations', |
|
| 833 | + 'event_id' => $registration->event_ID(), |
|
| 834 | + 'DTT_ID' => $dtt_id, |
|
| 835 | + ), |
|
| 836 | + $this->_admin_base_url |
|
| 837 | + ) |
|
| 838 | + : ''; |
|
| 839 | + $datetime_link = ! empty($datetime_link) |
|
| 840 | + ? '<a href="' . $datetime_link . '">' |
|
| 841 | + . '<span id="checkin-dtt">' |
|
| 842 | + . $datetime_label |
|
| 843 | + . '</span></a>' |
|
| 844 | + : $datetime_label; |
|
| 845 | + $attendee_name = $attendee instanceof EE_Attendee |
|
| 846 | + ? $attendee->full_name() |
|
| 847 | + : ''; |
|
| 848 | + $attendee_link = $attendee instanceof EE_Attendee |
|
| 849 | + ? $attendee->get_admin_details_link() |
|
| 850 | + : ''; |
|
| 851 | + $attendee_link = ! empty($attendee_link) |
|
| 852 | + ? '<a href="' . $attendee->get_admin_details_link() . '"' |
|
| 853 | + . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">' |
|
| 854 | + . '<span id="checkin-attendee-name">' |
|
| 855 | + . $attendee_name |
|
| 856 | + . '</span></a>' |
|
| 857 | + : ''; |
|
| 858 | + $event_link = $registration->event() instanceof EE_Event |
|
| 859 | + ? $registration->event()->get_admin_details_link() |
|
| 860 | + : ''; |
|
| 861 | + $event_link = ! empty($event_link) |
|
| 862 | + ? '<a href="' . $event_link . '"' |
|
| 863 | + . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">' |
|
| 864 | + . '<span id="checkin-event-name">' |
|
| 865 | + . $registration->event_name() |
|
| 866 | + . '</span>' |
|
| 867 | + . '</a>' |
|
| 868 | + : ''; |
|
| 869 | + $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id) |
|
| 870 | + ? '<h2>' . sprintf( |
|
| 871 | + esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'), |
|
| 872 | + $attendee_link, |
|
| 873 | + $datetime_link, |
|
| 874 | + $event_link |
|
| 875 | + ) . '</h2>' |
|
| 876 | + : ''; |
|
| 877 | + $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id) |
|
| 878 | + ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : ''; |
|
| 879 | + $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id) |
|
| 880 | + ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : ''; |
|
| 881 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 882 | + } |
|
| 883 | 883 | |
| 884 | 884 | |
| 885 | - /** |
|
| 886 | - * toggle the Check-in status for the given registration (coming from ajax) |
|
| 887 | - * |
|
| 888 | - * @return void (JSON) |
|
| 889 | - * @throws EE_Error |
|
| 890 | - * @throws InvalidArgumentException |
|
| 891 | - * @throws InvalidDataTypeException |
|
| 892 | - * @throws InvalidInterfaceException |
|
| 893 | - */ |
|
| 894 | - public function toggle_checkin_status() |
|
| 895 | - { |
|
| 896 | - // first make sure we have the necessary data |
|
| 897 | - if (! isset($this->_req_data['_regid'])) { |
|
| 898 | - EE_Error::add_error( |
|
| 899 | - esc_html__( |
|
| 900 | - 'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax', |
|
| 901 | - 'event_espresso' |
|
| 902 | - ), |
|
| 903 | - __FILE__, |
|
| 904 | - __FUNCTION__, |
|
| 905 | - __LINE__ |
|
| 906 | - ); |
|
| 907 | - $this->_template_args['success'] = false; |
|
| 908 | - $this->_template_args['error'] = true; |
|
| 909 | - $this->_return_json(); |
|
| 910 | - }; |
|
| 911 | - // do a nonce check cause we're not coming in from an normal route here. |
|
| 912 | - $nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce']) |
|
| 913 | - : ''; |
|
| 914 | - $nonce_ref = 'checkin_nonce'; |
|
| 915 | - $this->_verify_nonce($nonce, $nonce_ref); |
|
| 916 | - // beautiful! Made it this far so let's get the status. |
|
| 917 | - $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status()); |
|
| 918 | - // setup new class to return via ajax |
|
| 919 | - $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses(); |
|
| 920 | - $this->_template_args['success'] = true; |
|
| 921 | - $this->_return_json(); |
|
| 922 | - } |
|
| 885 | + /** |
|
| 886 | + * toggle the Check-in status for the given registration (coming from ajax) |
|
| 887 | + * |
|
| 888 | + * @return void (JSON) |
|
| 889 | + * @throws EE_Error |
|
| 890 | + * @throws InvalidArgumentException |
|
| 891 | + * @throws InvalidDataTypeException |
|
| 892 | + * @throws InvalidInterfaceException |
|
| 893 | + */ |
|
| 894 | + public function toggle_checkin_status() |
|
| 895 | + { |
|
| 896 | + // first make sure we have the necessary data |
|
| 897 | + if (! isset($this->_req_data['_regid'])) { |
|
| 898 | + EE_Error::add_error( |
|
| 899 | + esc_html__( |
|
| 900 | + 'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax', |
|
| 901 | + 'event_espresso' |
|
| 902 | + ), |
|
| 903 | + __FILE__, |
|
| 904 | + __FUNCTION__, |
|
| 905 | + __LINE__ |
|
| 906 | + ); |
|
| 907 | + $this->_template_args['success'] = false; |
|
| 908 | + $this->_template_args['error'] = true; |
|
| 909 | + $this->_return_json(); |
|
| 910 | + }; |
|
| 911 | + // do a nonce check cause we're not coming in from an normal route here. |
|
| 912 | + $nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce']) |
|
| 913 | + : ''; |
|
| 914 | + $nonce_ref = 'checkin_nonce'; |
|
| 915 | + $this->_verify_nonce($nonce, $nonce_ref); |
|
| 916 | + // beautiful! Made it this far so let's get the status. |
|
| 917 | + $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status()); |
|
| 918 | + // setup new class to return via ajax |
|
| 919 | + $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses(); |
|
| 920 | + $this->_template_args['success'] = true; |
|
| 921 | + $this->_return_json(); |
|
| 922 | + } |
|
| 923 | 923 | |
| 924 | 924 | |
| 925 | - /** |
|
| 926 | - * handles toggling the checkin status for the registration, |
|
| 927 | - * |
|
| 928 | - * @access protected |
|
| 929 | - * @return int|void |
|
| 930 | - * @throws EE_Error |
|
| 931 | - * @throws InvalidArgumentException |
|
| 932 | - * @throws InvalidDataTypeException |
|
| 933 | - * @throws InvalidInterfaceException |
|
| 934 | - */ |
|
| 935 | - protected function _toggle_checkin_status() |
|
| 936 | - { |
|
| 937 | - // first let's get the query args out of the way for the redirect |
|
| 938 | - $query_args = array( |
|
| 939 | - 'action' => 'event_registrations', |
|
| 940 | - 'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null, |
|
| 941 | - 'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null, |
|
| 942 | - ); |
|
| 943 | - $new_status = false; |
|
| 944 | - // bulk action check in toggle |
|
| 945 | - if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 946 | - // cycle thru checkboxes |
|
| 947 | - while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 948 | - $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null; |
|
| 949 | - $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID); |
|
| 950 | - } |
|
| 951 | - } elseif (isset($this->_req_data['_regid'])) { |
|
| 952 | - // coming from ajax request |
|
| 953 | - $DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null; |
|
| 954 | - $query_args['DTT_ID'] = $DTT_ID; |
|
| 955 | - $new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID); |
|
| 956 | - } else { |
|
| 957 | - EE_Error::add_error( |
|
| 958 | - esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'), |
|
| 959 | - __FILE__, |
|
| 960 | - __FUNCTION__, |
|
| 961 | - __LINE__ |
|
| 962 | - ); |
|
| 963 | - } |
|
| 964 | - if (defined('DOING_AJAX')) { |
|
| 965 | - return $new_status; |
|
| 966 | - } |
|
| 967 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 968 | - } |
|
| 925 | + /** |
|
| 926 | + * handles toggling the checkin status for the registration, |
|
| 927 | + * |
|
| 928 | + * @access protected |
|
| 929 | + * @return int|void |
|
| 930 | + * @throws EE_Error |
|
| 931 | + * @throws InvalidArgumentException |
|
| 932 | + * @throws InvalidDataTypeException |
|
| 933 | + * @throws InvalidInterfaceException |
|
| 934 | + */ |
|
| 935 | + protected function _toggle_checkin_status() |
|
| 936 | + { |
|
| 937 | + // first let's get the query args out of the way for the redirect |
|
| 938 | + $query_args = array( |
|
| 939 | + 'action' => 'event_registrations', |
|
| 940 | + 'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null, |
|
| 941 | + 'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null, |
|
| 942 | + ); |
|
| 943 | + $new_status = false; |
|
| 944 | + // bulk action check in toggle |
|
| 945 | + if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 946 | + // cycle thru checkboxes |
|
| 947 | + while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 948 | + $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null; |
|
| 949 | + $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID); |
|
| 950 | + } |
|
| 951 | + } elseif (isset($this->_req_data['_regid'])) { |
|
| 952 | + // coming from ajax request |
|
| 953 | + $DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null; |
|
| 954 | + $query_args['DTT_ID'] = $DTT_ID; |
|
| 955 | + $new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID); |
|
| 956 | + } else { |
|
| 957 | + EE_Error::add_error( |
|
| 958 | + esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'), |
|
| 959 | + __FILE__, |
|
| 960 | + __FUNCTION__, |
|
| 961 | + __LINE__ |
|
| 962 | + ); |
|
| 963 | + } |
|
| 964 | + if (defined('DOING_AJAX')) { |
|
| 965 | + return $new_status; |
|
| 966 | + } |
|
| 967 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 968 | + } |
|
| 969 | 969 | |
| 970 | 970 | |
| 971 | - /** |
|
| 972 | - * This is toggles a single Check-in for the given registration and datetime. |
|
| 973 | - * |
|
| 974 | - * @param int $REG_ID The registration we're toggling |
|
| 975 | - * @param int $DTT_ID The datetime we're toggling |
|
| 976 | - * @return int The new status toggled to. |
|
| 977 | - * @throws EE_Error |
|
| 978 | - * @throws InvalidArgumentException |
|
| 979 | - * @throws InvalidDataTypeException |
|
| 980 | - * @throws InvalidInterfaceException |
|
| 981 | - */ |
|
| 982 | - private function _toggle_checkin($REG_ID, $DTT_ID) |
|
| 983 | - { |
|
| 984 | - /** @var EE_Registration $REG */ |
|
| 985 | - $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 986 | - $new_status = $REG->toggle_checkin_status($DTT_ID); |
|
| 987 | - if ($new_status !== false) { |
|
| 988 | - EE_Error::add_success($REG->get_checkin_msg($DTT_ID)); |
|
| 989 | - } else { |
|
| 990 | - EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__); |
|
| 991 | - $new_status = false; |
|
| 992 | - } |
|
| 993 | - return $new_status; |
|
| 994 | - } |
|
| 971 | + /** |
|
| 972 | + * This is toggles a single Check-in for the given registration and datetime. |
|
| 973 | + * |
|
| 974 | + * @param int $REG_ID The registration we're toggling |
|
| 975 | + * @param int $DTT_ID The datetime we're toggling |
|
| 976 | + * @return int The new status toggled to. |
|
| 977 | + * @throws EE_Error |
|
| 978 | + * @throws InvalidArgumentException |
|
| 979 | + * @throws InvalidDataTypeException |
|
| 980 | + * @throws InvalidInterfaceException |
|
| 981 | + */ |
|
| 982 | + private function _toggle_checkin($REG_ID, $DTT_ID) |
|
| 983 | + { |
|
| 984 | + /** @var EE_Registration $REG */ |
|
| 985 | + $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 986 | + $new_status = $REG->toggle_checkin_status($DTT_ID); |
|
| 987 | + if ($new_status !== false) { |
|
| 988 | + EE_Error::add_success($REG->get_checkin_msg($DTT_ID)); |
|
| 989 | + } else { |
|
| 990 | + EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__); |
|
| 991 | + $new_status = false; |
|
| 992 | + } |
|
| 993 | + return $new_status; |
|
| 994 | + } |
|
| 995 | 995 | |
| 996 | 996 | |
| 997 | - /** |
|
| 998 | - * Takes care of deleting multiple EE_Checkin table rows |
|
| 999 | - * |
|
| 1000 | - * @access protected |
|
| 1001 | - * @return void |
|
| 1002 | - * @throws EE_Error |
|
| 1003 | - * @throws InvalidArgumentException |
|
| 1004 | - * @throws InvalidDataTypeException |
|
| 1005 | - * @throws InvalidInterfaceException |
|
| 1006 | - */ |
|
| 1007 | - protected function _delete_checkin_rows() |
|
| 1008 | - { |
|
| 1009 | - $query_args = array( |
|
| 1010 | - 'action' => 'registration_checkins', |
|
| 1011 | - 'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0, |
|
| 1012 | - '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0, |
|
| 1013 | - ); |
|
| 1014 | - $errors = 0; |
|
| 1015 | - if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 1016 | - while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 1017 | - if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) { |
|
| 1018 | - $errors++; |
|
| 1019 | - } |
|
| 1020 | - } |
|
| 1021 | - } else { |
|
| 1022 | - EE_Error::add_error( |
|
| 1023 | - esc_html__( |
|
| 1024 | - 'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!', |
|
| 1025 | - 'event_espresso' |
|
| 1026 | - ), |
|
| 1027 | - __FILE__, |
|
| 1028 | - __FUNCTION__, |
|
| 1029 | - __LINE__ |
|
| 1030 | - ); |
|
| 1031 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 1032 | - } |
|
| 1033 | - if ($errors > 0) { |
|
| 1034 | - EE_Error::add_error( |
|
| 1035 | - sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors), |
|
| 1036 | - __FILE__, |
|
| 1037 | - __FUNCTION__, |
|
| 1038 | - __LINE__ |
|
| 1039 | - ); |
|
| 1040 | - } else { |
|
| 1041 | - EE_Error::add_success(__('Records were successfully deleted', 'event_espresso')); |
|
| 1042 | - } |
|
| 1043 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 1044 | - } |
|
| 997 | + /** |
|
| 998 | + * Takes care of deleting multiple EE_Checkin table rows |
|
| 999 | + * |
|
| 1000 | + * @access protected |
|
| 1001 | + * @return void |
|
| 1002 | + * @throws EE_Error |
|
| 1003 | + * @throws InvalidArgumentException |
|
| 1004 | + * @throws InvalidDataTypeException |
|
| 1005 | + * @throws InvalidInterfaceException |
|
| 1006 | + */ |
|
| 1007 | + protected function _delete_checkin_rows() |
|
| 1008 | + { |
|
| 1009 | + $query_args = array( |
|
| 1010 | + 'action' => 'registration_checkins', |
|
| 1011 | + 'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0, |
|
| 1012 | + '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0, |
|
| 1013 | + ); |
|
| 1014 | + $errors = 0; |
|
| 1015 | + if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 1016 | + while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 1017 | + if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) { |
|
| 1018 | + $errors++; |
|
| 1019 | + } |
|
| 1020 | + } |
|
| 1021 | + } else { |
|
| 1022 | + EE_Error::add_error( |
|
| 1023 | + esc_html__( |
|
| 1024 | + 'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!', |
|
| 1025 | + 'event_espresso' |
|
| 1026 | + ), |
|
| 1027 | + __FILE__, |
|
| 1028 | + __FUNCTION__, |
|
| 1029 | + __LINE__ |
|
| 1030 | + ); |
|
| 1031 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 1032 | + } |
|
| 1033 | + if ($errors > 0) { |
|
| 1034 | + EE_Error::add_error( |
|
| 1035 | + sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors), |
|
| 1036 | + __FILE__, |
|
| 1037 | + __FUNCTION__, |
|
| 1038 | + __LINE__ |
|
| 1039 | + ); |
|
| 1040 | + } else { |
|
| 1041 | + EE_Error::add_success(__('Records were successfully deleted', 'event_espresso')); |
|
| 1042 | + } |
|
| 1043 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 1044 | + } |
|
| 1045 | 1045 | |
| 1046 | 1046 | |
| 1047 | - /** |
|
| 1048 | - * Deletes a single EE_Checkin row |
|
| 1049 | - * |
|
| 1050 | - * @return void |
|
| 1051 | - * @throws EE_Error |
|
| 1052 | - * @throws InvalidArgumentException |
|
| 1053 | - * @throws InvalidDataTypeException |
|
| 1054 | - * @throws InvalidInterfaceException |
|
| 1055 | - */ |
|
| 1056 | - protected function _delete_checkin_row() |
|
| 1057 | - { |
|
| 1058 | - $query_args = array( |
|
| 1059 | - 'action' => 'registration_checkins', |
|
| 1060 | - 'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0, |
|
| 1061 | - '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0, |
|
| 1062 | - ); |
|
| 1063 | - if (! empty($this->_req_data['CHK_ID'])) { |
|
| 1064 | - if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) { |
|
| 1065 | - EE_Error::add_error( |
|
| 1066 | - esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'), |
|
| 1067 | - __FILE__, |
|
| 1068 | - __FUNCTION__, |
|
| 1069 | - __LINE__ |
|
| 1070 | - ); |
|
| 1071 | - } else { |
|
| 1072 | - EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso')); |
|
| 1073 | - } |
|
| 1074 | - } else { |
|
| 1075 | - EE_Error::add_error( |
|
| 1076 | - esc_html__( |
|
| 1077 | - 'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code', |
|
| 1078 | - 'event_espresso' |
|
| 1079 | - ), |
|
| 1080 | - __FILE__, |
|
| 1081 | - __FUNCTION__, |
|
| 1082 | - __LINE__ |
|
| 1083 | - ); |
|
| 1084 | - } |
|
| 1085 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 1086 | - } |
|
| 1047 | + /** |
|
| 1048 | + * Deletes a single EE_Checkin row |
|
| 1049 | + * |
|
| 1050 | + * @return void |
|
| 1051 | + * @throws EE_Error |
|
| 1052 | + * @throws InvalidArgumentException |
|
| 1053 | + * @throws InvalidDataTypeException |
|
| 1054 | + * @throws InvalidInterfaceException |
|
| 1055 | + */ |
|
| 1056 | + protected function _delete_checkin_row() |
|
| 1057 | + { |
|
| 1058 | + $query_args = array( |
|
| 1059 | + 'action' => 'registration_checkins', |
|
| 1060 | + 'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0, |
|
| 1061 | + '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0, |
|
| 1062 | + ); |
|
| 1063 | + if (! empty($this->_req_data['CHK_ID'])) { |
|
| 1064 | + if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) { |
|
| 1065 | + EE_Error::add_error( |
|
| 1066 | + esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'), |
|
| 1067 | + __FILE__, |
|
| 1068 | + __FUNCTION__, |
|
| 1069 | + __LINE__ |
|
| 1070 | + ); |
|
| 1071 | + } else { |
|
| 1072 | + EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso')); |
|
| 1073 | + } |
|
| 1074 | + } else { |
|
| 1075 | + EE_Error::add_error( |
|
| 1076 | + esc_html__( |
|
| 1077 | + 'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code', |
|
| 1078 | + 'event_espresso' |
|
| 1079 | + ), |
|
| 1080 | + __FILE__, |
|
| 1081 | + __FUNCTION__, |
|
| 1082 | + __LINE__ |
|
| 1083 | + ); |
|
| 1084 | + } |
|
| 1085 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 1086 | + } |
|
| 1087 | 1087 | |
| 1088 | 1088 | |
| 1089 | - /** |
|
| 1090 | - * generates HTML for the Event Registrations List Table |
|
| 1091 | - * |
|
| 1092 | - * @access protected |
|
| 1093 | - * @return void |
|
| 1094 | - * @throws EE_Error |
|
| 1095 | - * @throws InvalidArgumentException |
|
| 1096 | - * @throws InvalidDataTypeException |
|
| 1097 | - * @throws InvalidInterfaceException |
|
| 1098 | - */ |
|
| 1099 | - protected function _event_registrations_list_table() |
|
| 1100 | - { |
|
| 1101 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 1102 | - $this->_admin_page_title .= isset($this->_req_data['event_id']) |
|
| 1103 | - ? $this->get_action_link_or_button( |
|
| 1104 | - 'new_registration', |
|
| 1105 | - 'add-registrant', |
|
| 1106 | - array('event_id' => $this->_req_data['event_id']), |
|
| 1107 | - 'add-new-h2', |
|
| 1108 | - '', |
|
| 1109 | - false |
|
| 1110 | - ) |
|
| 1111 | - : ''; |
|
| 1112 | - $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in); |
|
| 1113 | - $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out); |
|
| 1114 | - $checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never); |
|
| 1115 | - $legend_items = array( |
|
| 1116 | - 'star-icon' => array( |
|
| 1117 | - 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
| 1118 | - 'desc' => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'), |
|
| 1119 | - ), |
|
| 1120 | - 'checkin' => array( |
|
| 1121 | - 'class' => $checked_in->cssClasses(), |
|
| 1122 | - 'desc' => $checked_in->legendLabel(), |
|
| 1123 | - ), |
|
| 1124 | - 'checkout' => array( |
|
| 1125 | - 'class' => $checked_out->cssClasses(), |
|
| 1126 | - 'desc' => $checked_out->legendLabel(), |
|
| 1127 | - ), |
|
| 1128 | - 'nocheckinrecord' => array( |
|
| 1129 | - 'class' => $checked_never->cssClasses(), |
|
| 1130 | - 'desc' => $checked_never->legendLabel(), |
|
| 1131 | - ), |
|
| 1132 | - 'approved_status' => array( |
|
| 1133 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 1134 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'), |
|
| 1135 | - ), |
|
| 1136 | - 'cancelled_status' => array( |
|
| 1137 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 1138 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'), |
|
| 1139 | - ), |
|
| 1140 | - 'declined_status' => array( |
|
| 1141 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 1142 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'), |
|
| 1143 | - ), |
|
| 1144 | - 'not_approved' => array( |
|
| 1145 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 1146 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'), |
|
| 1147 | - ), |
|
| 1148 | - 'pending_status' => array( |
|
| 1149 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 1150 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'), |
|
| 1151 | - ), |
|
| 1152 | - 'wait_list' => array( |
|
| 1153 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 1154 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'), |
|
| 1155 | - ), |
|
| 1156 | - ); |
|
| 1157 | - $this->_template_args['after_list_table'] = $this->_display_legend($legend_items); |
|
| 1158 | - $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null; |
|
| 1159 | - /** @var EE_Event $event */ |
|
| 1160 | - $event = EEM_Event::instance()->get_one_by_ID($event_id); |
|
| 1161 | - $this->_template_args['before_list_table'] = $event instanceof EE_Event |
|
| 1162 | - ? '<h2>' . sprintf( |
|
| 1163 | - esc_html__('Viewing Registrations for Event: %s', 'event_espresso'), |
|
| 1164 | - EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name') |
|
| 1165 | - ) . '</h2>' |
|
| 1166 | - : ''; |
|
| 1167 | - // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on |
|
| 1168 | - // the event. |
|
| 1169 | - $DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0; |
|
| 1170 | - $datetime = null; |
|
| 1171 | - if ($event instanceof EE_Event) { |
|
| 1172 | - $datetimes_on_event = $event->datetimes(); |
|
| 1173 | - if (count($datetimes_on_event) === 1) { |
|
| 1174 | - $datetime = reset($datetimes_on_event); |
|
| 1175 | - } |
|
| 1176 | - } |
|
| 1177 | - $datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
| 1178 | - if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') { |
|
| 1179 | - $this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5); |
|
| 1180 | - $this->_template_args['before_list_table'] .= ' <span class="drk-grey-text">'; |
|
| 1181 | - $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
| 1182 | - $this->_template_args['before_list_table'] .= $datetime->name(); |
|
| 1183 | - $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )'; |
|
| 1184 | - $this->_template_args['before_list_table'] .= '</span></h2>'; |
|
| 1185 | - } |
|
| 1186 | - // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status |
|
| 1187 | - // column represents |
|
| 1188 | - if (! $datetime instanceof EE_Datetime) { |
|
| 1189 | - $this->_template_args['before_list_table'] .= '<br><p class="description">' |
|
| 1190 | - . esc_html__( |
|
| 1191 | - 'In this view, the check-in status represents the latest check-in record for the registration in that row.', |
|
| 1192 | - 'event_espresso' |
|
| 1193 | - ) |
|
| 1194 | - . '</p>'; |
|
| 1195 | - } |
|
| 1196 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 1197 | - } |
|
| 1089 | + /** |
|
| 1090 | + * generates HTML for the Event Registrations List Table |
|
| 1091 | + * |
|
| 1092 | + * @access protected |
|
| 1093 | + * @return void |
|
| 1094 | + * @throws EE_Error |
|
| 1095 | + * @throws InvalidArgumentException |
|
| 1096 | + * @throws InvalidDataTypeException |
|
| 1097 | + * @throws InvalidInterfaceException |
|
| 1098 | + */ |
|
| 1099 | + protected function _event_registrations_list_table() |
|
| 1100 | + { |
|
| 1101 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 1102 | + $this->_admin_page_title .= isset($this->_req_data['event_id']) |
|
| 1103 | + ? $this->get_action_link_or_button( |
|
| 1104 | + 'new_registration', |
|
| 1105 | + 'add-registrant', |
|
| 1106 | + array('event_id' => $this->_req_data['event_id']), |
|
| 1107 | + 'add-new-h2', |
|
| 1108 | + '', |
|
| 1109 | + false |
|
| 1110 | + ) |
|
| 1111 | + : ''; |
|
| 1112 | + $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in); |
|
| 1113 | + $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out); |
|
| 1114 | + $checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never); |
|
| 1115 | + $legend_items = array( |
|
| 1116 | + 'star-icon' => array( |
|
| 1117 | + 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
| 1118 | + 'desc' => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'), |
|
| 1119 | + ), |
|
| 1120 | + 'checkin' => array( |
|
| 1121 | + 'class' => $checked_in->cssClasses(), |
|
| 1122 | + 'desc' => $checked_in->legendLabel(), |
|
| 1123 | + ), |
|
| 1124 | + 'checkout' => array( |
|
| 1125 | + 'class' => $checked_out->cssClasses(), |
|
| 1126 | + 'desc' => $checked_out->legendLabel(), |
|
| 1127 | + ), |
|
| 1128 | + 'nocheckinrecord' => array( |
|
| 1129 | + 'class' => $checked_never->cssClasses(), |
|
| 1130 | + 'desc' => $checked_never->legendLabel(), |
|
| 1131 | + ), |
|
| 1132 | + 'approved_status' => array( |
|
| 1133 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 1134 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'), |
|
| 1135 | + ), |
|
| 1136 | + 'cancelled_status' => array( |
|
| 1137 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 1138 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'), |
|
| 1139 | + ), |
|
| 1140 | + 'declined_status' => array( |
|
| 1141 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 1142 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'), |
|
| 1143 | + ), |
|
| 1144 | + 'not_approved' => array( |
|
| 1145 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 1146 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'), |
|
| 1147 | + ), |
|
| 1148 | + 'pending_status' => array( |
|
| 1149 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 1150 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'), |
|
| 1151 | + ), |
|
| 1152 | + 'wait_list' => array( |
|
| 1153 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 1154 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'), |
|
| 1155 | + ), |
|
| 1156 | + ); |
|
| 1157 | + $this->_template_args['after_list_table'] = $this->_display_legend($legend_items); |
|
| 1158 | + $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null; |
|
| 1159 | + /** @var EE_Event $event */ |
|
| 1160 | + $event = EEM_Event::instance()->get_one_by_ID($event_id); |
|
| 1161 | + $this->_template_args['before_list_table'] = $event instanceof EE_Event |
|
| 1162 | + ? '<h2>' . sprintf( |
|
| 1163 | + esc_html__('Viewing Registrations for Event: %s', 'event_espresso'), |
|
| 1164 | + EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name') |
|
| 1165 | + ) . '</h2>' |
|
| 1166 | + : ''; |
|
| 1167 | + // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on |
|
| 1168 | + // the event. |
|
| 1169 | + $DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0; |
|
| 1170 | + $datetime = null; |
|
| 1171 | + if ($event instanceof EE_Event) { |
|
| 1172 | + $datetimes_on_event = $event->datetimes(); |
|
| 1173 | + if (count($datetimes_on_event) === 1) { |
|
| 1174 | + $datetime = reset($datetimes_on_event); |
|
| 1175 | + } |
|
| 1176 | + } |
|
| 1177 | + $datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
| 1178 | + if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') { |
|
| 1179 | + $this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5); |
|
| 1180 | + $this->_template_args['before_list_table'] .= ' <span class="drk-grey-text">'; |
|
| 1181 | + $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
| 1182 | + $this->_template_args['before_list_table'] .= $datetime->name(); |
|
| 1183 | + $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )'; |
|
| 1184 | + $this->_template_args['before_list_table'] .= '</span></h2>'; |
|
| 1185 | + } |
|
| 1186 | + // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status |
|
| 1187 | + // column represents |
|
| 1188 | + if (! $datetime instanceof EE_Datetime) { |
|
| 1189 | + $this->_template_args['before_list_table'] .= '<br><p class="description">' |
|
| 1190 | + . esc_html__( |
|
| 1191 | + 'In this view, the check-in status represents the latest check-in record for the registration in that row.', |
|
| 1192 | + 'event_espresso' |
|
| 1193 | + ) |
|
| 1194 | + . '</p>'; |
|
| 1195 | + } |
|
| 1196 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 1197 | + } |
|
| 1198 | 1198 | |
| 1199 | - /** |
|
| 1200 | - * Download the registrations check-in report (same as the normal registration report, but with different where |
|
| 1201 | - * conditions) |
|
| 1202 | - * |
|
| 1203 | - * @return void ends the request by a redirect or download |
|
| 1204 | - */ |
|
| 1205 | - public function _registrations_checkin_report() |
|
| 1206 | - { |
|
| 1207 | - $this->_registrations_report_base('_get_checkin_query_params_from_request'); |
|
| 1208 | - } |
|
| 1199 | + /** |
|
| 1200 | + * Download the registrations check-in report (same as the normal registration report, but with different where |
|
| 1201 | + * conditions) |
|
| 1202 | + * |
|
| 1203 | + * @return void ends the request by a redirect or download |
|
| 1204 | + */ |
|
| 1205 | + public function _registrations_checkin_report() |
|
| 1206 | + { |
|
| 1207 | + $this->_registrations_report_base('_get_checkin_query_params_from_request'); |
|
| 1208 | + } |
|
| 1209 | 1209 | |
| 1210 | - /** |
|
| 1211 | - * Gets the query params from the request, plus adds a where condition for the registration status, |
|
| 1212 | - * because on the checkin page we only ever want to see approved and pending-approval registrations |
|
| 1213 | - * |
|
| 1214 | - * @param array $request |
|
| 1215 | - * @param int $per_page |
|
| 1216 | - * @param bool $count |
|
| 1217 | - * @return array |
|
| 1218 | - * @throws EE_Error |
|
| 1219 | - */ |
|
| 1220 | - protected function _get_checkin_query_params_from_request( |
|
| 1221 | - $request, |
|
| 1222 | - $per_page = 10, |
|
| 1223 | - $count = false |
|
| 1224 | - ) { |
|
| 1225 | - $query_params = $this->_get_registration_query_parameters($request, $per_page, $count); |
|
| 1226 | - // unlike the regular registrations list table, |
|
| 1227 | - $status_ids_array = apply_filters( |
|
| 1228 | - 'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array', |
|
| 1229 | - array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved) |
|
| 1230 | - ); |
|
| 1231 | - $query_params[0]['STS_ID'] = array('IN', $status_ids_array); |
|
| 1232 | - return $query_params; |
|
| 1233 | - } |
|
| 1210 | + /** |
|
| 1211 | + * Gets the query params from the request, plus adds a where condition for the registration status, |
|
| 1212 | + * because on the checkin page we only ever want to see approved and pending-approval registrations |
|
| 1213 | + * |
|
| 1214 | + * @param array $request |
|
| 1215 | + * @param int $per_page |
|
| 1216 | + * @param bool $count |
|
| 1217 | + * @return array |
|
| 1218 | + * @throws EE_Error |
|
| 1219 | + */ |
|
| 1220 | + protected function _get_checkin_query_params_from_request( |
|
| 1221 | + $request, |
|
| 1222 | + $per_page = 10, |
|
| 1223 | + $count = false |
|
| 1224 | + ) { |
|
| 1225 | + $query_params = $this->_get_registration_query_parameters($request, $per_page, $count); |
|
| 1226 | + // unlike the regular registrations list table, |
|
| 1227 | + $status_ids_array = apply_filters( |
|
| 1228 | + 'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array', |
|
| 1229 | + array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved) |
|
| 1230 | + ); |
|
| 1231 | + $query_params[0]['STS_ID'] = array('IN', $status_ids_array); |
|
| 1232 | + return $query_params; |
|
| 1233 | + } |
|
| 1234 | 1234 | |
| 1235 | 1235 | |
| 1236 | - /** |
|
| 1237 | - * Gets registrations for an event |
|
| 1238 | - * |
|
| 1239 | - * @param int $per_page |
|
| 1240 | - * @param bool $count whether to return count or data. |
|
| 1241 | - * @param bool $trash |
|
| 1242 | - * @param string $orderby |
|
| 1243 | - * @return EE_Registration[]|int |
|
| 1244 | - * @throws EE_Error |
|
| 1245 | - * @throws InvalidArgumentException |
|
| 1246 | - * @throws InvalidDataTypeException |
|
| 1247 | - * @throws InvalidInterfaceException |
|
| 1248 | - */ |
|
| 1249 | - public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname') |
|
| 1250 | - { |
|
| 1251 | - // normalize some request params that get setup by the parent `get_registrations` method. |
|
| 1252 | - $request = $this->_req_data; |
|
| 1253 | - $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby; |
|
| 1254 | - $request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC'; |
|
| 1255 | - if ($trash) { |
|
| 1256 | - $request['status'] = 'trash'; |
|
| 1257 | - } |
|
| 1258 | - $query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count); |
|
| 1259 | - /** |
|
| 1260 | - * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
| 1261 | - * |
|
| 1262 | - * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
| 1263 | - * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1264 | - * or if you have the development copy of EE you can view this at the path: |
|
| 1265 | - * /docs/G--Model-System/model-query-params.md |
|
| 1266 | - */ |
|
| 1267 | - $query_params['group_by'] = ''; |
|
| 1236 | + /** |
|
| 1237 | + * Gets registrations for an event |
|
| 1238 | + * |
|
| 1239 | + * @param int $per_page |
|
| 1240 | + * @param bool $count whether to return count or data. |
|
| 1241 | + * @param bool $trash |
|
| 1242 | + * @param string $orderby |
|
| 1243 | + * @return EE_Registration[]|int |
|
| 1244 | + * @throws EE_Error |
|
| 1245 | + * @throws InvalidArgumentException |
|
| 1246 | + * @throws InvalidDataTypeException |
|
| 1247 | + * @throws InvalidInterfaceException |
|
| 1248 | + */ |
|
| 1249 | + public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname') |
|
| 1250 | + { |
|
| 1251 | + // normalize some request params that get setup by the parent `get_registrations` method. |
|
| 1252 | + $request = $this->_req_data; |
|
| 1253 | + $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby; |
|
| 1254 | + $request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC'; |
|
| 1255 | + if ($trash) { |
|
| 1256 | + $request['status'] = 'trash'; |
|
| 1257 | + } |
|
| 1258 | + $query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count); |
|
| 1259 | + /** |
|
| 1260 | + * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
| 1261 | + * |
|
| 1262 | + * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
| 1263 | + * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1264 | + * or if you have the development copy of EE you can view this at the path: |
|
| 1265 | + * /docs/G--Model-System/model-query-params.md |
|
| 1266 | + */ |
|
| 1267 | + $query_params['group_by'] = ''; |
|
| 1268 | 1268 | |
| 1269 | - return $count |
|
| 1270 | - ? EEM_Registration::instance()->count($query_params) |
|
| 1271 | - /** @type EE_Registration[] */ |
|
| 1272 | - : EEM_Registration::instance()->get_all($query_params); |
|
| 1273 | - } |
|
| 1269 | + return $count |
|
| 1270 | + ? EEM_Registration::instance()->count($query_params) |
|
| 1271 | + /** @type EE_Registration[] */ |
|
| 1272 | + : EEM_Registration::instance()->get_all($query_params); |
|
| 1273 | + } |
|
| 1274 | 1274 | } |
@@ -32,10 +32,10 @@ discard block |
||
| 32 | 32 | public function __construct($routing = true) |
| 33 | 33 | { |
| 34 | 34 | parent::__construct($routing); |
| 35 | - if (! defined('REG_CAF_TEMPLATE_PATH')) { |
|
| 36 | - define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/'); |
|
| 37 | - define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/'); |
|
| 38 | - define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/'); |
|
| 35 | + if ( ! defined('REG_CAF_TEMPLATE_PATH')) { |
|
| 36 | + define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'registrations/templates/'); |
|
| 37 | + define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'registrations/assets/'); |
|
| 38 | + define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registrations/assets/'); |
|
| 39 | 39 | } |
| 40 | 40 | } |
| 41 | 41 | |
@@ -45,7 +45,7 @@ discard block |
||
| 45 | 45 | */ |
| 46 | 46 | protected function _extend_page_config() |
| 47 | 47 | { |
| 48 | - $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations'; |
|
| 48 | + $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'registrations'; |
|
| 49 | 49 | $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
| 50 | 50 | ? $this->_req_data['_REG_ID'] |
| 51 | 51 | : 0; |
@@ -185,14 +185,14 @@ discard block |
||
| 185 | 185 | // enqueue newsletter js |
| 186 | 186 | wp_enqueue_script( |
| 187 | 187 | 'ee-newsletter-trigger', |
| 188 | - REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js', |
|
| 188 | + REG_CAF_ASSETS_URL.'ee-newsletter-trigger.js', |
|
| 189 | 189 | array('ee-dialog'), |
| 190 | 190 | EVENT_ESPRESSO_VERSION, |
| 191 | 191 | true |
| 192 | 192 | ); |
| 193 | 193 | wp_enqueue_style( |
| 194 | 194 | 'ee-newsletter-trigger-css', |
| 195 | - REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css', |
|
| 195 | + REG_CAF_ASSETS_URL.'ee-newsletter-trigger.css', |
|
| 196 | 196 | array(), |
| 197 | 197 | EVENT_ESPRESSO_VERSION |
| 198 | 198 | ); |
@@ -213,7 +213,7 @@ discard block |
||
| 213 | 213 | { |
| 214 | 214 | wp_register_script( |
| 215 | 215 | 'ee-reg-reports-js', |
| 216 | - REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js', |
|
| 216 | + REG_CAF_ASSETS_URL.'ee-registration-admin-reports.js', |
|
| 217 | 217 | array('google-charts'), |
| 218 | 218 | EVENT_ESPRESSO_VERSION, |
| 219 | 219 | true |
@@ -299,7 +299,7 @@ discard block |
||
| 299 | 299 | $nonce_ref = 'get_newsletter_form_content_nonce'; |
| 300 | 300 | $this->_verify_nonce($nonce, $nonce_ref); |
| 301 | 301 | // let's get the mtp for the incoming MTP_ ID |
| 302 | - if (! isset($this->_req_data['GRP_ID'])) { |
|
| 302 | + if ( ! isset($this->_req_data['GRP_ID'])) { |
|
| 303 | 303 | EE_Error::add_error( |
| 304 | 304 | esc_html__( |
| 305 | 305 | 'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).', |
@@ -314,7 +314,7 @@ discard block |
||
| 314 | 314 | $this->_return_json(); |
| 315 | 315 | } |
| 316 | 316 | $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']); |
| 317 | - if (! $MTPG instanceof EE_Message_Template_Group) { |
|
| 317 | + if ( ! $MTPG instanceof EE_Message_Template_Group) { |
|
| 318 | 318 | EE_Error::add_error( |
| 319 | 319 | sprintf( |
| 320 | 320 | esc_html__( |
@@ -339,12 +339,12 @@ discard block |
||
| 339 | 339 | $field = $MTP->get('MTP_template_field'); |
| 340 | 340 | if ($field === 'content') { |
| 341 | 341 | $content = $MTP->get('MTP_content'); |
| 342 | - if (! empty($content['newsletter_content'])) { |
|
| 342 | + if ( ! empty($content['newsletter_content'])) { |
|
| 343 | 343 | $template_fields['newsletter_content'] = $content['newsletter_content']; |
| 344 | 344 | } |
| 345 | 345 | continue; |
| 346 | 346 | } |
| 347 | - $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content'); |
|
| 347 | + $template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content'); |
|
| 348 | 348 | } |
| 349 | 349 | $this->_template_args['success'] = true; |
| 350 | 350 | $this->_template_args['error'] = false; |
@@ -375,7 +375,7 @@ discard block |
||
| 375 | 375 | */ |
| 376 | 376 | public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table) |
| 377 | 377 | { |
| 378 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 378 | + if ( ! EE_Registry::instance()->CAP->current_user_can( |
|
| 379 | 379 | 'ee_send_message', |
| 380 | 380 | 'espresso_registrations_newsletter_selected_send' |
| 381 | 381 | ) |
@@ -444,17 +444,17 @@ discard block |
||
| 444 | 444 | $field_id = $field === '[NEWSLETTER_CONTENT]' |
| 445 | 445 | ? 'content' |
| 446 | 446 | : $field; |
| 447 | - $field_id = 'batch-message-' . strtolower($field_id); |
|
| 447 | + $field_id = 'batch-message-'.strtolower($field_id); |
|
| 448 | 448 | $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="' |
| 449 | 449 | . $shortcode |
| 450 | - . '" data-linked-input-id="' . $field_id . '">' |
|
| 450 | + . '" data-linked-input-id="'.$field_id.'">' |
|
| 451 | 451 | . $shortcode |
| 452 | 452 | . '</span>'; |
| 453 | 453 | } |
| 454 | - $codes[ $field ] = implode(', ', $available_shortcodes); |
|
| 454 | + $codes[$field] = implode(', ', $available_shortcodes); |
|
| 455 | 455 | } |
| 456 | 456 | $shortcodes = $codes; |
| 457 | - $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php'; |
|
| 457 | + $form_template = REG_CAF_TEMPLATE_PATH.'newsletter-send-form.template.php'; |
|
| 458 | 458 | $form_template_args = array( |
| 459 | 459 | 'form_action' => admin_url('admin.php?page=espresso_registrations'), |
| 460 | 460 | 'form_route' => 'newsletter_selected_send', |
@@ -622,7 +622,7 @@ discard block |
||
| 622 | 622 | */ |
| 623 | 623 | protected function _registration_reports() |
| 624 | 624 | { |
| 625 | - $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php'; |
|
| 625 | + $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php'; |
|
| 626 | 626 | $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
| 627 | 627 | $template_path, |
| 628 | 628 | $this->_reports_template_data, |
@@ -677,7 +677,7 @@ discard block |
||
| 677 | 677 | array_unshift($regs, $column_titles); |
| 678 | 678 | // setup the date range. |
| 679 | 679 | $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone()); |
| 680 | - $beginning_date = new DateTime("now " . $period, $DateTimeZone); |
|
| 680 | + $beginning_date = new DateTime("now ".$period, $DateTimeZone); |
|
| 681 | 681 | $ending_date = new DateTime("now", $DateTimeZone); |
| 682 | 682 | $subtitle = sprintf( |
| 683 | 683 | _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'), |
@@ -697,7 +697,7 @@ discard block |
||
| 697 | 697 | '%sThere are currently no registration records in the last month for this report.%s', |
| 698 | 698 | 'event_espresso' |
| 699 | 699 | ), |
| 700 | - '<h2>' . $report_title . '</h2><p>', |
|
| 700 | + '<h2>'.$report_title.'</h2><p>', |
|
| 701 | 701 | '</p>' |
| 702 | 702 | ), |
| 703 | 703 | ); |
@@ -750,7 +750,7 @@ discard block |
||
| 750 | 750 | array_unshift($regs, $column_titles); |
| 751 | 751 | // setup the date range. |
| 752 | 752 | $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone()); |
| 753 | - $beginning_date = new DateTime("now " . $period, $DateTimeZone); |
|
| 753 | + $beginning_date = new DateTime("now ".$period, $DateTimeZone); |
|
| 754 | 754 | $ending_date = new DateTime("now", $DateTimeZone); |
| 755 | 755 | $subtitle = sprintf( |
| 756 | 756 | _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'), |
@@ -770,7 +770,7 @@ discard block |
||
| 770 | 770 | '%sThere are currently no registration records in the last month for this report.%s', |
| 771 | 771 | 'event_espresso' |
| 772 | 772 | ), |
| 773 | - '<h2>' . $report_title . '</h2><p>', |
|
| 773 | + '<h2>'.$report_title.'</h2><p>', |
|
| 774 | 774 | '</p>' |
| 775 | 775 | ), |
| 776 | 776 | ); |
@@ -823,7 +823,7 @@ discard block |
||
| 823 | 823 | if ($datetime instanceof EE_Datetime) { |
| 824 | 824 | $datetime_label = $datetime->get_dtt_display_name(true); |
| 825 | 825 | $datetime_label .= ! empty($datetime_label) |
| 826 | - ? ' (' . $datetime->get_dtt_display_name() . ')' |
|
| 826 | + ? ' ('.$datetime->get_dtt_display_name().')' |
|
| 827 | 827 | : $datetime->get_dtt_display_name(); |
| 828 | 828 | } |
| 829 | 829 | $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration |
@@ -837,7 +837,7 @@ discard block |
||
| 837 | 837 | ) |
| 838 | 838 | : ''; |
| 839 | 839 | $datetime_link = ! empty($datetime_link) |
| 840 | - ? '<a href="' . $datetime_link . '">' |
|
| 840 | + ? '<a href="'.$datetime_link.'">' |
|
| 841 | 841 | . '<span id="checkin-dtt">' |
| 842 | 842 | . $datetime_label |
| 843 | 843 | . '</span></a>' |
@@ -849,8 +849,8 @@ discard block |
||
| 849 | 849 | ? $attendee->get_admin_details_link() |
| 850 | 850 | : ''; |
| 851 | 851 | $attendee_link = ! empty($attendee_link) |
| 852 | - ? '<a href="' . $attendee->get_admin_details_link() . '"' |
|
| 853 | - . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">' |
|
| 852 | + ? '<a href="'.$attendee->get_admin_details_link().'"' |
|
| 853 | + . ' title="'.esc_html__('Click for attendee details', 'event_espresso').'">' |
|
| 854 | 854 | . '<span id="checkin-attendee-name">' |
| 855 | 855 | . $attendee_name |
| 856 | 856 | . '</span></a>' |
@@ -859,25 +859,25 @@ discard block |
||
| 859 | 859 | ? $registration->event()->get_admin_details_link() |
| 860 | 860 | : ''; |
| 861 | 861 | $event_link = ! empty($event_link) |
| 862 | - ? '<a href="' . $event_link . '"' |
|
| 863 | - . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">' |
|
| 862 | + ? '<a href="'.$event_link.'"' |
|
| 863 | + . ' title="'.esc_html__('Click here to edit event.', 'event_espresso').'">' |
|
| 864 | 864 | . '<span id="checkin-event-name">' |
| 865 | 865 | . $registration->event_name() |
| 866 | 866 | . '</span>' |
| 867 | 867 | . '</a>' |
| 868 | 868 | : ''; |
| 869 | 869 | $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id) |
| 870 | - ? '<h2>' . sprintf( |
|
| 870 | + ? '<h2>'.sprintf( |
|
| 871 | 871 | esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'), |
| 872 | 872 | $attendee_link, |
| 873 | 873 | $datetime_link, |
| 874 | 874 | $event_link |
| 875 | - ) . '</h2>' |
|
| 875 | + ).'</h2>' |
|
| 876 | 876 | : ''; |
| 877 | 877 | $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id) |
| 878 | - ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : ''; |
|
| 878 | + ? '<input type="hidden" name="_REG_ID" value="'.$reg_id.'">' : ''; |
|
| 879 | 879 | $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id) |
| 880 | - ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : ''; |
|
| 880 | + ? '<input type="hidden" name="DTT_ID" value="'.$dtt_id.'">' : ''; |
|
| 881 | 881 | $this->display_admin_list_table_page_with_no_sidebar(); |
| 882 | 882 | } |
| 883 | 883 | |
@@ -894,7 +894,7 @@ discard block |
||
| 894 | 894 | public function toggle_checkin_status() |
| 895 | 895 | { |
| 896 | 896 | // first make sure we have the necessary data |
| 897 | - if (! isset($this->_req_data['_regid'])) { |
|
| 897 | + if ( ! isset($this->_req_data['_regid'])) { |
|
| 898 | 898 | EE_Error::add_error( |
| 899 | 899 | esc_html__( |
| 900 | 900 | 'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax', |
@@ -916,7 +916,7 @@ discard block |
||
| 916 | 916 | // beautiful! Made it this far so let's get the status. |
| 917 | 917 | $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status()); |
| 918 | 918 | // setup new class to return via ajax |
| 919 | - $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses(); |
|
| 919 | + $this->_template_args['admin_page_content'] = 'clickable trigger-checkin '.$new_status->cssClasses(); |
|
| 920 | 920 | $this->_template_args['success'] = true; |
| 921 | 921 | $this->_return_json(); |
| 922 | 922 | } |
@@ -942,7 +942,7 @@ discard block |
||
| 942 | 942 | ); |
| 943 | 943 | $new_status = false; |
| 944 | 944 | // bulk action check in toggle |
| 945 | - if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 945 | + if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 946 | 946 | // cycle thru checkboxes |
| 947 | 947 | while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) { |
| 948 | 948 | $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null; |
@@ -1012,9 +1012,9 @@ discard block |
||
| 1012 | 1012 | '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0, |
| 1013 | 1013 | ); |
| 1014 | 1014 | $errors = 0; |
| 1015 | - if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 1015 | + if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 1016 | 1016 | while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) { |
| 1017 | - if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) { |
|
| 1017 | + if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) { |
|
| 1018 | 1018 | $errors++; |
| 1019 | 1019 | } |
| 1020 | 1020 | } |
@@ -1060,8 +1060,8 @@ discard block |
||
| 1060 | 1060 | 'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0, |
| 1061 | 1061 | '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0, |
| 1062 | 1062 | ); |
| 1063 | - if (! empty($this->_req_data['CHK_ID'])) { |
|
| 1064 | - if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) { |
|
| 1063 | + if ( ! empty($this->_req_data['CHK_ID'])) { |
|
| 1064 | + if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) { |
|
| 1065 | 1065 | EE_Error::add_error( |
| 1066 | 1066 | esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'), |
| 1067 | 1067 | __FILE__, |
@@ -1130,27 +1130,27 @@ discard block |
||
| 1130 | 1130 | 'desc' => $checked_never->legendLabel(), |
| 1131 | 1131 | ), |
| 1132 | 1132 | 'approved_status' => array( |
| 1133 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 1133 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved, |
|
| 1134 | 1134 | 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'), |
| 1135 | 1135 | ), |
| 1136 | 1136 | 'cancelled_status' => array( |
| 1137 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 1137 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled, |
|
| 1138 | 1138 | 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'), |
| 1139 | 1139 | ), |
| 1140 | 1140 | 'declined_status' => array( |
| 1141 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 1141 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined, |
|
| 1142 | 1142 | 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'), |
| 1143 | 1143 | ), |
| 1144 | 1144 | 'not_approved' => array( |
| 1145 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 1145 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved, |
|
| 1146 | 1146 | 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'), |
| 1147 | 1147 | ), |
| 1148 | 1148 | 'pending_status' => array( |
| 1149 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 1149 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment, |
|
| 1150 | 1150 | 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'), |
| 1151 | 1151 | ), |
| 1152 | 1152 | 'wait_list' => array( |
| 1153 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 1153 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list, |
|
| 1154 | 1154 | 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'), |
| 1155 | 1155 | ), |
| 1156 | 1156 | ); |
@@ -1159,10 +1159,10 @@ discard block |
||
| 1159 | 1159 | /** @var EE_Event $event */ |
| 1160 | 1160 | $event = EEM_Event::instance()->get_one_by_ID($event_id); |
| 1161 | 1161 | $this->_template_args['before_list_table'] = $event instanceof EE_Event |
| 1162 | - ? '<h2>' . sprintf( |
|
| 1162 | + ? '<h2>'.sprintf( |
|
| 1163 | 1163 | esc_html__('Viewing Registrations for Event: %s', 'event_espresso'), |
| 1164 | 1164 | EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name') |
| 1165 | - ) . '</h2>' |
|
| 1165 | + ).'</h2>' |
|
| 1166 | 1166 | : ''; |
| 1167 | 1167 | // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on |
| 1168 | 1168 | // the event. |
@@ -1180,12 +1180,12 @@ discard block |
||
| 1180 | 1180 | $this->_template_args['before_list_table'] .= ' <span class="drk-grey-text">'; |
| 1181 | 1181 | $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>'; |
| 1182 | 1182 | $this->_template_args['before_list_table'] .= $datetime->name(); |
| 1183 | - $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )'; |
|
| 1183 | + $this->_template_args['before_list_table'] .= ' ( '.$datetime->date_and_time_range().' )'; |
|
| 1184 | 1184 | $this->_template_args['before_list_table'] .= '</span></h2>'; |
| 1185 | 1185 | } |
| 1186 | 1186 | // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status |
| 1187 | 1187 | // column represents |
| 1188 | - if (! $datetime instanceof EE_Datetime) { |
|
| 1188 | + if ( ! $datetime instanceof EE_Datetime) { |
|
| 1189 | 1189 | $this->_template_args['before_list_table'] .= '<br><p class="description">' |
| 1190 | 1190 | . esc_html__( |
| 1191 | 1191 | 'In this view, the check-in status represents the latest check-in record for the registration in that row.', |
@@ -16,142 +16,142 @@ |
||
| 16 | 16 | class Event_Categories_Admin_List_Table extends EE_Admin_List_Table |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | - public function __construct($admin_page) |
|
| 20 | - { |
|
| 21 | - parent::__construct($admin_page); |
|
| 22 | - } |
|
| 23 | - |
|
| 24 | - |
|
| 25 | - protected function _setup_data() |
|
| 26 | - { |
|
| 27 | - $this->_data = $this->_admin_page->get_categories($this->_per_page, $this->_current_page); |
|
| 28 | - $this->_all_data_count = EEM_Term_Taxonomy::instance()->count( |
|
| 29 | - array(array('taxonomy' => 'espresso_event_categories')) |
|
| 30 | - ); |
|
| 31 | - } |
|
| 32 | - |
|
| 33 | - |
|
| 34 | - protected function _set_properties() |
|
| 35 | - { |
|
| 36 | - $this->_wp_list_args = array( |
|
| 37 | - 'singular' => esc_html__('event category', 'event_espresso'), |
|
| 38 | - 'plural' => esc_html__('event categories', 'event_espresso'), |
|
| 39 | - 'ajax' => true, // for now, |
|
| 40 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 41 | - ); |
|
| 42 | - |
|
| 43 | - $this->_columns = array( |
|
| 44 | - 'cb' => '<input type="checkbox" />', |
|
| 45 | - 'id' => esc_html__('ID', 'event_espresso'), |
|
| 46 | - 'name' => esc_html__('Name', 'event_espresso'), |
|
| 47 | - 'shortcode' => esc_html__('Shortcode', 'event_espresso'), |
|
| 48 | - 'count' => esc_html__('Events', 'event_espresso'), |
|
| 49 | - ); |
|
| 50 | - |
|
| 51 | - $this->_sortable_columns = array( |
|
| 52 | - 'id' => array('Term.term_id' => true), |
|
| 53 | - 'name' => array('Term.slug' => false), |
|
| 54 | - 'count' => array('term_count' => false), |
|
| 55 | - ); |
|
| 56 | - |
|
| 57 | - $this->_primary_column = 'id'; |
|
| 58 | - |
|
| 59 | - $this->_hidden_columns = array(); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - // not needed |
|
| 64 | - protected function _get_table_filters() |
|
| 65 | - { |
|
| 66 | - return array(); |
|
| 67 | - } |
|
| 68 | - |
|
| 69 | - |
|
| 70 | - protected function _add_view_counts() |
|
| 71 | - { |
|
| 72 | - $this->_views['all']['count'] = $this->_all_data_count; |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - |
|
| 76 | - public function column_cb($item) |
|
| 77 | - { |
|
| 78 | - return sprintf('<input type="checkbox" name="EVT_CAT_ID[]" value="%s" />', $item->get('term_id')); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - |
|
| 82 | - public function column_id($item) |
|
| 83 | - { |
|
| 84 | - $content = $item->get('term_id'); |
|
| 85 | - $content .= ' <span class="show-on-mobile-view-only">' . $item->get_first_related('Term')->get( |
|
| 86 | - 'name' |
|
| 87 | - ) . '</span>'; |
|
| 88 | - return $content; |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - |
|
| 92 | - public function column_name($item) |
|
| 93 | - { |
|
| 94 | - $edit_query_args = array( |
|
| 95 | - 'action' => 'edit_category', |
|
| 96 | - 'EVT_CAT_ID' => $item->get('term_id'), |
|
| 97 | - ); |
|
| 98 | - |
|
| 99 | - $delete_query_args = array( |
|
| 100 | - 'action' => 'delete_category', |
|
| 101 | - 'EVT_CAT_ID' => $item->get('term_id'), |
|
| 102 | - ); |
|
| 103 | - |
|
| 104 | - $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
| 105 | - $delete_link = EE_Admin_Page::add_query_args_and_nonce($delete_query_args, EVENTS_ADMIN_URL); |
|
| 106 | - |
|
| 107 | - $actions = array( |
|
| 108 | - 'edit' => '<a href="' . $edit_link . '" aria-label="' . esc_attr__( |
|
| 109 | - 'Edit Category', |
|
| 110 | - 'event_espresso' |
|
| 111 | - ) . '">' . esc_html__('Edit', 'event_espresso') . '</a>', |
|
| 112 | - ); |
|
| 113 | - |
|
| 114 | - $actions['delete'] = '<a href="' . $delete_link . '" aria-label="' . esc_attr__( |
|
| 115 | - 'Delete Category', |
|
| 116 | - 'event_espresso' |
|
| 117 | - ) . '">' . esc_html__('Delete', 'event_espresso') . '</a>'; |
|
| 118 | - |
|
| 119 | - $actions['view'] = sprintf( |
|
| 120 | - '<a href="%s" aria-label="%s">%s</a>', |
|
| 121 | - get_term_link($item->get('term_id')), |
|
| 122 | - esc_attr( |
|
| 123 | - sprintf( |
|
| 124 | - /* translators: %s: event category name */ |
|
| 125 | - __('View “%s” archive', 'event_espresso'), |
|
| 126 | - $item->get_first_related('Term')->get('name') |
|
| 127 | - ) |
|
| 128 | - ), |
|
| 129 | - esc_html__('View', 'event_espresso') |
|
| 130 | - ); |
|
| 131 | - |
|
| 132 | - $content = '<strong><a class="row-title" href="' . $edit_link . '">' . $item->get_first_related('Term')->get( |
|
| 133 | - 'name' |
|
| 134 | - ) . '</a></strong>'; |
|
| 135 | - $content .= $this->row_actions($actions); |
|
| 136 | - return $content; |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - public function column_shortcode($item) |
|
| 141 | - { |
|
| 142 | - $content = '[ESPRESSO_EVENTS category_slug=' . $item->get_first_related('Term')->get('slug') . ']'; |
|
| 143 | - return $content; |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - |
|
| 147 | - public function column_count($item) |
|
| 148 | - { |
|
| 149 | - $e_args = array( |
|
| 150 | - 'action' => 'default', |
|
| 151 | - 'EVT_CAT' => $item->get_first_related('Term')->ID(), |
|
| 152 | - ); |
|
| 153 | - $e_link = EE_Admin_Page::add_query_args_and_nonce($e_args, EVENTS_ADMIN_URL); |
|
| 154 | - $content = '<a href="' . $e_link . '">' . $item->get('term_count') . '</a>'; |
|
| 155 | - return $content; |
|
| 156 | - } |
|
| 19 | + public function __construct($admin_page) |
|
| 20 | + { |
|
| 21 | + parent::__construct($admin_page); |
|
| 22 | + } |
|
| 23 | + |
|
| 24 | + |
|
| 25 | + protected function _setup_data() |
|
| 26 | + { |
|
| 27 | + $this->_data = $this->_admin_page->get_categories($this->_per_page, $this->_current_page); |
|
| 28 | + $this->_all_data_count = EEM_Term_Taxonomy::instance()->count( |
|
| 29 | + array(array('taxonomy' => 'espresso_event_categories')) |
|
| 30 | + ); |
|
| 31 | + } |
|
| 32 | + |
|
| 33 | + |
|
| 34 | + protected function _set_properties() |
|
| 35 | + { |
|
| 36 | + $this->_wp_list_args = array( |
|
| 37 | + 'singular' => esc_html__('event category', 'event_espresso'), |
|
| 38 | + 'plural' => esc_html__('event categories', 'event_espresso'), |
|
| 39 | + 'ajax' => true, // for now, |
|
| 40 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 41 | + ); |
|
| 42 | + |
|
| 43 | + $this->_columns = array( |
|
| 44 | + 'cb' => '<input type="checkbox" />', |
|
| 45 | + 'id' => esc_html__('ID', 'event_espresso'), |
|
| 46 | + 'name' => esc_html__('Name', 'event_espresso'), |
|
| 47 | + 'shortcode' => esc_html__('Shortcode', 'event_espresso'), |
|
| 48 | + 'count' => esc_html__('Events', 'event_espresso'), |
|
| 49 | + ); |
|
| 50 | + |
|
| 51 | + $this->_sortable_columns = array( |
|
| 52 | + 'id' => array('Term.term_id' => true), |
|
| 53 | + 'name' => array('Term.slug' => false), |
|
| 54 | + 'count' => array('term_count' => false), |
|
| 55 | + ); |
|
| 56 | + |
|
| 57 | + $this->_primary_column = 'id'; |
|
| 58 | + |
|
| 59 | + $this->_hidden_columns = array(); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + // not needed |
|
| 64 | + protected function _get_table_filters() |
|
| 65 | + { |
|
| 66 | + return array(); |
|
| 67 | + } |
|
| 68 | + |
|
| 69 | + |
|
| 70 | + protected function _add_view_counts() |
|
| 71 | + { |
|
| 72 | + $this->_views['all']['count'] = $this->_all_data_count; |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + |
|
| 76 | + public function column_cb($item) |
|
| 77 | + { |
|
| 78 | + return sprintf('<input type="checkbox" name="EVT_CAT_ID[]" value="%s" />', $item->get('term_id')); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + |
|
| 82 | + public function column_id($item) |
|
| 83 | + { |
|
| 84 | + $content = $item->get('term_id'); |
|
| 85 | + $content .= ' <span class="show-on-mobile-view-only">' . $item->get_first_related('Term')->get( |
|
| 86 | + 'name' |
|
| 87 | + ) . '</span>'; |
|
| 88 | + return $content; |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + |
|
| 92 | + public function column_name($item) |
|
| 93 | + { |
|
| 94 | + $edit_query_args = array( |
|
| 95 | + 'action' => 'edit_category', |
|
| 96 | + 'EVT_CAT_ID' => $item->get('term_id'), |
|
| 97 | + ); |
|
| 98 | + |
|
| 99 | + $delete_query_args = array( |
|
| 100 | + 'action' => 'delete_category', |
|
| 101 | + 'EVT_CAT_ID' => $item->get('term_id'), |
|
| 102 | + ); |
|
| 103 | + |
|
| 104 | + $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
| 105 | + $delete_link = EE_Admin_Page::add_query_args_and_nonce($delete_query_args, EVENTS_ADMIN_URL); |
|
| 106 | + |
|
| 107 | + $actions = array( |
|
| 108 | + 'edit' => '<a href="' . $edit_link . '" aria-label="' . esc_attr__( |
|
| 109 | + 'Edit Category', |
|
| 110 | + 'event_espresso' |
|
| 111 | + ) . '">' . esc_html__('Edit', 'event_espresso') . '</a>', |
|
| 112 | + ); |
|
| 113 | + |
|
| 114 | + $actions['delete'] = '<a href="' . $delete_link . '" aria-label="' . esc_attr__( |
|
| 115 | + 'Delete Category', |
|
| 116 | + 'event_espresso' |
|
| 117 | + ) . '">' . esc_html__('Delete', 'event_espresso') . '</a>'; |
|
| 118 | + |
|
| 119 | + $actions['view'] = sprintf( |
|
| 120 | + '<a href="%s" aria-label="%s">%s</a>', |
|
| 121 | + get_term_link($item->get('term_id')), |
|
| 122 | + esc_attr( |
|
| 123 | + sprintf( |
|
| 124 | + /* translators: %s: event category name */ |
|
| 125 | + __('View “%s” archive', 'event_espresso'), |
|
| 126 | + $item->get_first_related('Term')->get('name') |
|
| 127 | + ) |
|
| 128 | + ), |
|
| 129 | + esc_html__('View', 'event_espresso') |
|
| 130 | + ); |
|
| 131 | + |
|
| 132 | + $content = '<strong><a class="row-title" href="' . $edit_link . '">' . $item->get_first_related('Term')->get( |
|
| 133 | + 'name' |
|
| 134 | + ) . '</a></strong>'; |
|
| 135 | + $content .= $this->row_actions($actions); |
|
| 136 | + return $content; |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + public function column_shortcode($item) |
|
| 141 | + { |
|
| 142 | + $content = '[ESPRESSO_EVENTS category_slug=' . $item->get_first_related('Term')->get('slug') . ']'; |
|
| 143 | + return $content; |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + |
|
| 147 | + public function column_count($item) |
|
| 148 | + { |
|
| 149 | + $e_args = array( |
|
| 150 | + 'action' => 'default', |
|
| 151 | + 'EVT_CAT' => $item->get_first_related('Term')->ID(), |
|
| 152 | + ); |
|
| 153 | + $e_link = EE_Admin_Page::add_query_args_and_nonce($e_args, EVENTS_ADMIN_URL); |
|
| 154 | + $content = '<a href="' . $e_link . '">' . $item->get('term_count') . '</a>'; |
|
| 155 | + return $content; |
|
| 156 | + } |
|
| 157 | 157 | } |
@@ -82,9 +82,9 @@ discard block |
||
| 82 | 82 | public function column_id($item) |
| 83 | 83 | { |
| 84 | 84 | $content = $item->get('term_id'); |
| 85 | - $content .= ' <span class="show-on-mobile-view-only">' . $item->get_first_related('Term')->get( |
|
| 85 | + $content .= ' <span class="show-on-mobile-view-only">'.$item->get_first_related('Term')->get( |
|
| 86 | 86 | 'name' |
| 87 | - ) . '</span>'; |
|
| 87 | + ).'</span>'; |
|
| 88 | 88 | return $content; |
| 89 | 89 | } |
| 90 | 90 | |
@@ -105,16 +105,16 @@ discard block |
||
| 105 | 105 | $delete_link = EE_Admin_Page::add_query_args_and_nonce($delete_query_args, EVENTS_ADMIN_URL); |
| 106 | 106 | |
| 107 | 107 | $actions = array( |
| 108 | - 'edit' => '<a href="' . $edit_link . '" aria-label="' . esc_attr__( |
|
| 108 | + 'edit' => '<a href="'.$edit_link.'" aria-label="'.esc_attr__( |
|
| 109 | 109 | 'Edit Category', |
| 110 | 110 | 'event_espresso' |
| 111 | - ) . '">' . esc_html__('Edit', 'event_espresso') . '</a>', |
|
| 111 | + ).'">'.esc_html__('Edit', 'event_espresso').'</a>', |
|
| 112 | 112 | ); |
| 113 | 113 | |
| 114 | - $actions['delete'] = '<a href="' . $delete_link . '" aria-label="' . esc_attr__( |
|
| 114 | + $actions['delete'] = '<a href="'.$delete_link.'" aria-label="'.esc_attr__( |
|
| 115 | 115 | 'Delete Category', |
| 116 | 116 | 'event_espresso' |
| 117 | - ) . '">' . esc_html__('Delete', 'event_espresso') . '</a>'; |
|
| 117 | + ).'">'.esc_html__('Delete', 'event_espresso').'</a>'; |
|
| 118 | 118 | |
| 119 | 119 | $actions['view'] = sprintf( |
| 120 | 120 | '<a href="%s" aria-label="%s">%s</a>', |
@@ -129,9 +129,9 @@ discard block |
||
| 129 | 129 | esc_html__('View', 'event_espresso') |
| 130 | 130 | ); |
| 131 | 131 | |
| 132 | - $content = '<strong><a class="row-title" href="' . $edit_link . '">' . $item->get_first_related('Term')->get( |
|
| 132 | + $content = '<strong><a class="row-title" href="'.$edit_link.'">'.$item->get_first_related('Term')->get( |
|
| 133 | 133 | 'name' |
| 134 | - ) . '</a></strong>'; |
|
| 134 | + ).'</a></strong>'; |
|
| 135 | 135 | $content .= $this->row_actions($actions); |
| 136 | 136 | return $content; |
| 137 | 137 | } |
@@ -139,7 +139,7 @@ discard block |
||
| 139 | 139 | |
| 140 | 140 | public function column_shortcode($item) |
| 141 | 141 | { |
| 142 | - $content = '[ESPRESSO_EVENTS category_slug=' . $item->get_first_related('Term')->get('slug') . ']'; |
|
| 142 | + $content = '[ESPRESSO_EVENTS category_slug='.$item->get_first_related('Term')->get('slug').']'; |
|
| 143 | 143 | return $content; |
| 144 | 144 | } |
| 145 | 145 | |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | 'EVT_CAT' => $item->get_first_related('Term')->ID(), |
| 152 | 152 | ); |
| 153 | 153 | $e_link = EE_Admin_Page::add_query_args_and_nonce($e_args, EVENTS_ADMIN_URL); |
| 154 | - $content = '<a href="' . $e_link . '">' . $item->get('term_count') . '</a>'; |
|
| 154 | + $content = '<a href="'.$e_link.'">'.$item->get('term_count').'</a>'; |
|
| 155 | 155 | return $content; |
| 156 | 156 | } |
| 157 | 157 | } |
@@ -18,519 +18,519 @@ |
||
| 18 | 18 | { |
| 19 | 19 | |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * user id for logged in user when data collected |
|
| 23 | - * |
|
| 24 | - * @var string $user_id |
|
| 25 | - */ |
|
| 26 | - public $user_id; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * IP Address of browser used |
|
| 30 | - * |
|
| 31 | - * @var string $ip_address |
|
| 32 | - */ |
|
| 33 | - public $ip_address; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * browser |
|
| 37 | - * |
|
| 38 | - * @var string $user_agent |
|
| 39 | - */ |
|
| 40 | - public $user_agent; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Unix timestamp |
|
| 44 | - * |
|
| 45 | - * @var string $init_access |
|
| 46 | - */ |
|
| 47 | - public $init_access; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Unix timestamp |
|
| 51 | - * |
|
| 52 | - * @var string $last_access |
|
| 53 | - */ |
|
| 54 | - public $last_access; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * The registrations details from the cart |
|
| 58 | - * |
|
| 59 | - * @var array $reg_info |
|
| 60 | - */ |
|
| 61 | - public $reg_info; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Some data handlers can set what reg status all the registrations are filtered by. |
|
| 65 | - * The status should match a EEM_Registration status constant. |
|
| 66 | - * |
|
| 67 | - * @var string $filtered_reg_status |
|
| 68 | - */ |
|
| 69 | - public $filtered_reg_status; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * will hold an array of events assembled from $reg_info |
|
| 73 | - * |
|
| 74 | - * @var EE_Event[] $events |
|
| 75 | - */ |
|
| 76 | - public $events; |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * holds an array of datetimes assembled from the incoming data. |
|
| 80 | - * |
|
| 81 | - * @var EE_Datetime[] $datetimes |
|
| 82 | - */ |
|
| 83 | - public $datetimes; |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * holds an array of tickets assembled from the incoming data. |
|
| 87 | - * |
|
| 88 | - * @var EE_Ticket[] $tickets |
|
| 89 | - */ |
|
| 90 | - public $tickets; |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * holds an array with a key of parent line item and values are an array of children of that line item. |
|
| 94 | - * |
|
| 95 | - * @since 4.5.0 |
|
| 96 | - * @var EE_Line_Item[] $line_items_with_children |
|
| 97 | - */ |
|
| 98 | - public $line_items_with_children; |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * will hold an array of attendees assembled from the $reg_info |
|
| 102 | - * |
|
| 103 | - * @var EE_Attendee[] $attendees |
|
| 104 | - */ |
|
| 105 | - public $attendees; |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * will hold an array of cached registration objects and info assembled from reg_info |
|
| 109 | - * |
|
| 110 | - * @var array $registrations |
|
| 111 | - */ |
|
| 112 | - public $registrations; |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * will hold an array of answers assembled from the $reg_info |
|
| 116 | - * |
|
| 117 | - * @var EE_Answer[] $answers |
|
| 118 | - */ |
|
| 119 | - public $answers; |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * will hold an array of questions assembled from the $reg_info (indexed by Answer ID); |
|
| 123 | - * |
|
| 124 | - * @var EE_Question[] $questions |
|
| 125 | - */ |
|
| 126 | - public $questions; |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * Will hold billing data assembled from $billing_info (if present) |
|
| 130 | - * |
|
| 131 | - * @var mixed (array|null) $billing |
|
| 132 | - */ |
|
| 133 | - public $billing; |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * The total amount of tax for the transaction |
|
| 137 | - * |
|
| 138 | - * @var float $taxes |
|
| 139 | - */ |
|
| 140 | - public $taxes; |
|
| 141 | - |
|
| 142 | - /** |
|
| 143 | - * Holds the line items related to taxes |
|
| 144 | - * |
|
| 145 | - * @since 4.5.0 |
|
| 146 | - * @var EE_Line_Item[] $tax_line_items |
|
| 147 | - */ |
|
| 148 | - public $tax_line_items; |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * Hold the line items which aren't taxes and don't relate |
|
| 152 | - * to tickets. So: promotions and miscellaneous charges |
|
| 153 | - * |
|
| 154 | - * @since 4.5 |
|
| 155 | - * @var EE_Line_Item[] $additional_line_items |
|
| 156 | - */ |
|
| 157 | - public $additional_line_items; |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * Holds the grand total EE_Line_Item |
|
| 161 | - * |
|
| 162 | - * @var EE_Line_Item $grand_total_line_item |
|
| 163 | - */ |
|
| 164 | - public $grand_total_line_item; |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * holds the grand total price object |
|
| 168 | - * currently not used. |
|
| 169 | - * |
|
| 170 | - * @var null $grand_total_price_object |
|
| 171 | - */ |
|
| 172 | - public $grand_total_price_object; |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * total number of tickets |
|
| 176 | - * |
|
| 177 | - * @var int $total_ticket_count |
|
| 178 | - */ |
|
| 179 | - public $total_ticket_count; |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Will hold the final transaction object (EE_Transaction) |
|
| 183 | - * |
|
| 184 | - * @var EE_Transaction $txn |
|
| 185 | - */ |
|
| 186 | - public $txn; |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Holds the payments related to a transaction |
|
| 190 | - * |
|
| 191 | - * @since 4.5.0 |
|
| 192 | - * @var EE_Payment[] $payments |
|
| 193 | - */ |
|
| 194 | - public $payments; |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * Holds the first related payment related for a transaction |
|
| 198 | - * |
|
| 199 | - * @since 4.5.0 |
|
| 200 | - * @var EE_Payment $payment |
|
| 201 | - */ |
|
| 202 | - public $payment; |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * Will hold the label for the txn status |
|
| 206 | - * |
|
| 207 | - * @var string $txn_status |
|
| 208 | - */ |
|
| 209 | - public $txn_status; |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * Will hold the final registration object (EE_Registration) |
|
| 213 | - * |
|
| 214 | - * @var EE_Registration[] $reg_objs |
|
| 215 | - */ |
|
| 216 | - public $reg_objs; |
|
| 217 | - |
|
| 218 | - /** |
|
| 219 | - * Will hold an array of primary attendee data (if present) |
|
| 220 | - * |
|
| 221 | - * @var array $primary_attendee_data |
|
| 222 | - */ |
|
| 223 | - public $primary_attendee_data; |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * This is just an internal object used for passing around the incoming data. |
|
| 227 | - * |
|
| 228 | - * @var mixed $_data |
|
| 229 | - */ |
|
| 230 | - protected $_data; |
|
| 231 | - |
|
| 232 | - /** |
|
| 233 | - * This is just an internal object used for passing around the incoming data. |
|
| 234 | - * |
|
| 235 | - * @var mixed $incoming_data |
|
| 236 | - */ |
|
| 237 | - public $incoming_data; |
|
| 238 | - |
|
| 239 | - /** |
|
| 240 | - * hold objects that might be created |
|
| 241 | - * |
|
| 242 | - * @type EE_Registration $reg_obj |
|
| 243 | - */ |
|
| 244 | - public $reg_obj; |
|
| 245 | - |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * constructor |
|
| 249 | - * |
|
| 250 | - * @param mixed $data incoming data object|array. Suggested that child classes use type hinting for expected |
|
| 251 | - * data object. But here parent will be generic because we don't know what's coming in. |
|
| 252 | - */ |
|
| 253 | - public function __construct($data) |
|
| 254 | - { |
|
| 255 | - $this->_data = $data; |
|
| 256 | - $this->_setup_data(); |
|
| 257 | - } |
|
| 258 | - |
|
| 259 | - |
|
| 260 | - /** |
|
| 261 | - * Every child class has to setup the data object ! |
|
| 262 | - * |
|
| 263 | - * @return void |
|
| 264 | - */ |
|
| 265 | - abstract protected function _setup_data(); |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Returns database safe representation of the data later used to when instantiating this object. |
|
| 270 | - * |
|
| 271 | - * @param mixed $data The incoming data to be prepped. |
|
| 272 | - * @return mixed The prepped data for db |
|
| 273 | - */ |
|
| 274 | - public static function convert_data_for_persistent_storage($data) |
|
| 275 | - { |
|
| 276 | - return $data; |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - |
|
| 280 | - /** |
|
| 281 | - * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage |
|
| 282 | - * can be sent into this method and converted back into the format used for instantiating with this data handler. |
|
| 283 | - * |
|
| 284 | - * @param $data |
|
| 285 | - * @return mixed |
|
| 286 | - */ |
|
| 287 | - public static function convert_data_from_persistent_storage($data) |
|
| 288 | - { |
|
| 289 | - return $data; |
|
| 290 | - } |
|
| 291 | - |
|
| 292 | - |
|
| 293 | - /** |
|
| 294 | - * only purpose is to return the data |
|
| 295 | - * |
|
| 296 | - * @access public |
|
| 297 | - * @return mixed the formatted data object! |
|
| 298 | - */ |
|
| 299 | - public function data() |
|
| 300 | - { |
|
| 301 | - return $this->_data; |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * This helper method can be used by any incoming data handlers to setup the data correctly. All that is required |
|
| 307 | - * is that $this->reg_objs be set. |
|
| 308 | - * |
|
| 309 | - * @throws EE_Error |
|
| 310 | - * @throws InvalidDataTypeException |
|
| 311 | - * @throws InvalidInterfaceException |
|
| 312 | - * @throws InvalidArgumentException |
|
| 313 | - * @throws EntityNotFoundException |
|
| 314 | - */ |
|
| 315 | - protected function _assemble_data() |
|
| 316 | - { |
|
| 317 | - // verify that reg_objs is set |
|
| 318 | - if (! is_array($this->reg_objs) |
|
| 319 | - && ! reset($this->reg_objs) instanceof EE_Registration |
|
| 320 | - ) { |
|
| 321 | - throw new EE_Error( |
|
| 322 | - esc_html__( |
|
| 323 | - 'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects', |
|
| 324 | - 'event_espresso' |
|
| 325 | - ) |
|
| 326 | - ); |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - // get all attendee and events associated with the registrations in this transaction |
|
| 330 | - $events = $event_setup = $evtcache = $tickets = $datetimes = array(); |
|
| 331 | - $answers = $questions = $attendees = $line_items = $registrations = array(); |
|
| 332 | - $total_ticket_count = 0; |
|
| 333 | - |
|
| 334 | - if (! empty($this->reg_objs)) { |
|
| 335 | - $event_attendee_count = array(); |
|
| 336 | - /** @var EE_Registration $reg */ |
|
| 337 | - foreach ($this->reg_objs as $reg) { |
|
| 338 | - if ($this->_skip_registration_for_processing($reg) |
|
| 339 | - ) { |
|
| 340 | - continue; |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - $evt_id = $reg->event_ID(); |
|
| 344 | - /** @type EE_Ticket $ticket */ |
|
| 345 | - $ticket = $reg->get_first_related('Ticket'); |
|
| 346 | - $attendee = $reg->attendee(); |
|
| 347 | - $event = $reg->event(); |
|
| 348 | - // if none of the following entities are available, then we can't setup other data reliably, |
|
| 349 | - // so let's just skip. |
|
| 350 | - if (! $ticket instanceof EE_Ticket |
|
| 351 | - || ! $attendee instanceof EE_Attendee |
|
| 352 | - || ! $event instanceof EE_Event |
|
| 353 | - ) { |
|
| 354 | - continue; |
|
| 355 | - } |
|
| 356 | - $relateddatetime = $ticket->datetimes(); |
|
| 357 | - $total_ticket_count++; |
|
| 358 | - $tickets[ $ticket->ID() ]['ticket'] = $ticket; |
|
| 359 | - $tickets[ $ticket->ID() ]['count'] = is_array($tickets[ $ticket->ID() ]) |
|
| 360 | - && isset($tickets[ $ticket->ID() ]['count']) |
|
| 361 | - ? $tickets[ $ticket->ID() ]['count'] + 1 |
|
| 362 | - : 1; |
|
| 363 | - $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee; |
|
| 364 | - $tickets[ $ticket->ID() ]['dtt_objs'] = $relateddatetime; |
|
| 365 | - $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 366 | - $tickets[ $ticket->ID() ]['EE_Event'] = $event; |
|
| 367 | - $evtcache[ $evt_id ] = $event; |
|
| 368 | - $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 369 | - $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ] = $ticket; |
|
| 370 | - $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ] = $attendee; |
|
| 371 | - $event_attendee_count[ $evt_id ] = isset($event_attendee_count[ $evt_id ]) |
|
| 372 | - ? $event_attendee_count[ $evt_id ] + 1 |
|
| 373 | - : 0; |
|
| 374 | - $attendees[ $reg->attendee_ID() ]['line_ref'][] = $evt_id; |
|
| 375 | - $attendees[ $reg->attendee_ID() ]['att_obj'] = $attendee; |
|
| 376 | - $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 377 | - // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID(); |
|
| 378 | - $attendees[ $reg->attendee_ID() ]['attendee_email'] = $attendee->email(); |
|
| 379 | - $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket; |
|
| 380 | - $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ] = $event; |
|
| 381 | - |
|
| 382 | - // registrations |
|
| 383 | - $registrations[ $reg->ID() ]['tkt_obj'] = $ticket; |
|
| 384 | - $registrations[ $reg->ID() ]['evt_obj'] = $event; |
|
| 385 | - $registrations[ $reg->ID() ]['reg_obj'] = $reg; |
|
| 386 | - $registrations[ $reg->ID() ]['att_obj'] = $attendee; |
|
| 387 | - |
|
| 388 | - // set up answer objects |
|
| 389 | - $rel_ans = $reg->get_many_related('Answer'); |
|
| 390 | - foreach ($rel_ans as $ansid => $answer) { |
|
| 391 | - if (! isset($questions[ $ansid ])) { |
|
| 392 | - $questions[ $ansid ] = $answer->get_first_related('Question'); |
|
| 393 | - } |
|
| 394 | - $answers[ $ansid ] = $answer; |
|
| 395 | - $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer; |
|
| 396 | - } |
|
| 397 | - /** |
|
| 398 | - * @var int $dtt_id |
|
| 399 | - * @var EE_Datetime $datetime |
|
| 400 | - */ |
|
| 401 | - foreach ($relateddatetime as $dtt_id => $datetime) { |
|
| 402 | - $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ] = $datetime; |
|
| 403 | - $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime; |
|
| 404 | - |
|
| 405 | - if (isset($datetimes[ $dtt_id ])) { |
|
| 406 | - continue; // already have this info in the datetimes array. |
|
| 407 | - } |
|
| 408 | - |
|
| 409 | - $datetimes[ $dtt_id ]['tkt_objs'][] = $ticket; |
|
| 410 | - $datetimes[ $dtt_id ]['datetime'] = $datetime; |
|
| 411 | - $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ] = $event; |
|
| 412 | - $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 413 | - } |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - // let's loop through the unique event=>reg items and setup data on them |
|
| 417 | - |
|
| 418 | - if (! empty($eventsetup)) { |
|
| 419 | - foreach ($eventsetup as $evt_id => $items) { |
|
| 420 | - $ticket_line_items_for_event = array(); |
|
| 421 | - if ($this->txn instanceof EE_Transaction) { |
|
| 422 | - $ticket_line_items_for_event = EEM_Line_Item::instance()->get_all( |
|
| 423 | - array( |
|
| 424 | - array( |
|
| 425 | - 'Ticket.Datetime.EVT_ID' => $evt_id, |
|
| 426 | - 'TXN_ID' => $this->txn->ID(), |
|
| 427 | - ), |
|
| 428 | - 'default_where_conditions' => 'none', |
|
| 429 | - ) |
|
| 430 | - ); |
|
| 431 | - } |
|
| 432 | - $events[ $evt_id ] = array( |
|
| 433 | - 'ID' => $evt_id, |
|
| 434 | - 'event' => $evtcache[ $evt_id ], |
|
| 435 | - 'name' => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '', |
|
| 436 | - 'total_attendees' => $event_attendee_count[ $evt_id ], |
|
| 437 | - 'reg_objs' => $items['reg_objs'], |
|
| 438 | - 'tkt_objs' => $items['tkt_objs'], |
|
| 439 | - 'att_objs' => $items['att_objs'], |
|
| 440 | - 'dtt_objs' => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(), |
|
| 441 | - 'line_items' => $ticket_line_items_for_event, |
|
| 442 | - ); |
|
| 443 | - |
|
| 444 | - // make sure the tickets have the line items setup for them. |
|
| 445 | - foreach ($ticket_line_items_for_event as $line_id => $line_item) { |
|
| 446 | - // only add the ticket line items if we already have this ticket in the $tickets array. |
|
| 447 | - if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) { |
|
| 448 | - $tickets[ $line_item->ticket()->ID() ]['line_item'] = $line_item; |
|
| 449 | - $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children(); |
|
| 450 | - $line_items[ $line_item->ID() ]['children'] = $line_item->children(); |
|
| 451 | - $line_items[ $line_item->ID() ]['EE_Ticket'] = $line_item->ticket(); |
|
| 452 | - } |
|
| 453 | - } |
|
| 454 | - } |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - $this->grand_total_line_item = $this->txn instanceof EE_Transaction |
|
| 458 | - ? $this->txn->total_line_item() |
|
| 459 | - : null; |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - // lets set the attendees and events properties |
|
| 463 | - $this->attendees = $attendees; |
|
| 464 | - $this->events = $events; |
|
| 465 | - $this->tickets = $tickets; |
|
| 466 | - $this->line_items_with_children = $line_items; |
|
| 467 | - $this->datetimes = $datetimes; |
|
| 468 | - $this->questions = $questions; |
|
| 469 | - $this->answers = $answers; |
|
| 470 | - $this->total_ticket_count = $total_ticket_count; |
|
| 471 | - $this->registrations = $registrations; |
|
| 472 | - |
|
| 473 | - if ($this->txn instanceof EE_Transaction) { |
|
| 474 | - $this->tax_line_items = $this->txn->tax_items(); |
|
| 475 | - $this->additional_line_items = $this->txn->non_ticket_line_items(); |
|
| 476 | - $this->payments = $this->txn->payments(); |
|
| 477 | - |
|
| 478 | - // setup primary registration if we have a single transaction object to work with |
|
| 479 | - |
|
| 480 | - // let's get just the primary_attendee_data! First we get the primary registration object. |
|
| 481 | - $primary_reg = $this->txn->primary_registration(); |
|
| 482 | - // verify |
|
| 483 | - if ($primary_reg instanceof EE_Registration) { |
|
| 484 | - // get attendee object |
|
| 485 | - if ($primary_reg->attendee() instanceof EE_Attendee) { |
|
| 486 | - // now we can setup the primary_attendee_data array |
|
| 487 | - $this->primary_attendee_data = array( |
|
| 488 | - 'registration_id' => $primary_reg->ID(), |
|
| 489 | - 'att_obj' => $primary_reg->attendee(), |
|
| 490 | - 'reg_obj' => $primary_reg, |
|
| 491 | - 'primary_att_obj' => $primary_reg->attendee(), |
|
| 492 | - 'primary_reg_obj' => $primary_reg, |
|
| 493 | - ); |
|
| 494 | - } else { |
|
| 495 | - EE_Error::add_error( |
|
| 496 | - esc_html__( |
|
| 497 | - 'Incoming data does not have a valid Attendee object for the primary registrant.', |
|
| 498 | - 'event_espresso' |
|
| 499 | - ), |
|
| 500 | - __FILE__, |
|
| 501 | - __FUNCTION__, |
|
| 502 | - __LINE__ |
|
| 503 | - ); |
|
| 504 | - } |
|
| 505 | - } else { |
|
| 506 | - EE_Error::add_error( |
|
| 507 | - esc_html__( |
|
| 508 | - 'Incoming data does not have a valid Registration object for the primary registrant.', |
|
| 509 | - 'event_espresso' |
|
| 510 | - ), |
|
| 511 | - __FILE__, |
|
| 512 | - __FUNCTION__, |
|
| 513 | - __LINE__ |
|
| 514 | - ); |
|
| 515 | - } |
|
| 516 | - } |
|
| 517 | - } |
|
| 518 | - |
|
| 519 | - /** |
|
| 520 | - * This simply considers whether the given registration should be processed or not based on comparison with the |
|
| 521 | - * filtered_reg_status property. |
|
| 522 | - * |
|
| 523 | - * @param EE_Registration $registration |
|
| 524 | - * @return bool returning true means we DO want to skip processing. returning false means we DON'T want to skip |
|
| 525 | - * processing |
|
| 526 | - */ |
|
| 527 | - protected function _skip_registration_for_processing(EE_Registration $registration) |
|
| 528 | - { |
|
| 529 | - if (empty($this->filtered_reg_status)) { |
|
| 530 | - return false; |
|
| 531 | - } |
|
| 532 | - |
|
| 533 | - // if we made it here then we just compare the filtered_reg_status with the registration status and return that |
|
| 534 | - return $this->filtered_reg_status !== $registration->status_ID(); |
|
| 535 | - } |
|
| 21 | + /** |
|
| 22 | + * user id for logged in user when data collected |
|
| 23 | + * |
|
| 24 | + * @var string $user_id |
|
| 25 | + */ |
|
| 26 | + public $user_id; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * IP Address of browser used |
|
| 30 | + * |
|
| 31 | + * @var string $ip_address |
|
| 32 | + */ |
|
| 33 | + public $ip_address; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * browser |
|
| 37 | + * |
|
| 38 | + * @var string $user_agent |
|
| 39 | + */ |
|
| 40 | + public $user_agent; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Unix timestamp |
|
| 44 | + * |
|
| 45 | + * @var string $init_access |
|
| 46 | + */ |
|
| 47 | + public $init_access; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Unix timestamp |
|
| 51 | + * |
|
| 52 | + * @var string $last_access |
|
| 53 | + */ |
|
| 54 | + public $last_access; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * The registrations details from the cart |
|
| 58 | + * |
|
| 59 | + * @var array $reg_info |
|
| 60 | + */ |
|
| 61 | + public $reg_info; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Some data handlers can set what reg status all the registrations are filtered by. |
|
| 65 | + * The status should match a EEM_Registration status constant. |
|
| 66 | + * |
|
| 67 | + * @var string $filtered_reg_status |
|
| 68 | + */ |
|
| 69 | + public $filtered_reg_status; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * will hold an array of events assembled from $reg_info |
|
| 73 | + * |
|
| 74 | + * @var EE_Event[] $events |
|
| 75 | + */ |
|
| 76 | + public $events; |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * holds an array of datetimes assembled from the incoming data. |
|
| 80 | + * |
|
| 81 | + * @var EE_Datetime[] $datetimes |
|
| 82 | + */ |
|
| 83 | + public $datetimes; |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * holds an array of tickets assembled from the incoming data. |
|
| 87 | + * |
|
| 88 | + * @var EE_Ticket[] $tickets |
|
| 89 | + */ |
|
| 90 | + public $tickets; |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * holds an array with a key of parent line item and values are an array of children of that line item. |
|
| 94 | + * |
|
| 95 | + * @since 4.5.0 |
|
| 96 | + * @var EE_Line_Item[] $line_items_with_children |
|
| 97 | + */ |
|
| 98 | + public $line_items_with_children; |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * will hold an array of attendees assembled from the $reg_info |
|
| 102 | + * |
|
| 103 | + * @var EE_Attendee[] $attendees |
|
| 104 | + */ |
|
| 105 | + public $attendees; |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * will hold an array of cached registration objects and info assembled from reg_info |
|
| 109 | + * |
|
| 110 | + * @var array $registrations |
|
| 111 | + */ |
|
| 112 | + public $registrations; |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * will hold an array of answers assembled from the $reg_info |
|
| 116 | + * |
|
| 117 | + * @var EE_Answer[] $answers |
|
| 118 | + */ |
|
| 119 | + public $answers; |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * will hold an array of questions assembled from the $reg_info (indexed by Answer ID); |
|
| 123 | + * |
|
| 124 | + * @var EE_Question[] $questions |
|
| 125 | + */ |
|
| 126 | + public $questions; |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * Will hold billing data assembled from $billing_info (if present) |
|
| 130 | + * |
|
| 131 | + * @var mixed (array|null) $billing |
|
| 132 | + */ |
|
| 133 | + public $billing; |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * The total amount of tax for the transaction |
|
| 137 | + * |
|
| 138 | + * @var float $taxes |
|
| 139 | + */ |
|
| 140 | + public $taxes; |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * Holds the line items related to taxes |
|
| 144 | + * |
|
| 145 | + * @since 4.5.0 |
|
| 146 | + * @var EE_Line_Item[] $tax_line_items |
|
| 147 | + */ |
|
| 148 | + public $tax_line_items; |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * Hold the line items which aren't taxes and don't relate |
|
| 152 | + * to tickets. So: promotions and miscellaneous charges |
|
| 153 | + * |
|
| 154 | + * @since 4.5 |
|
| 155 | + * @var EE_Line_Item[] $additional_line_items |
|
| 156 | + */ |
|
| 157 | + public $additional_line_items; |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * Holds the grand total EE_Line_Item |
|
| 161 | + * |
|
| 162 | + * @var EE_Line_Item $grand_total_line_item |
|
| 163 | + */ |
|
| 164 | + public $grand_total_line_item; |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * holds the grand total price object |
|
| 168 | + * currently not used. |
|
| 169 | + * |
|
| 170 | + * @var null $grand_total_price_object |
|
| 171 | + */ |
|
| 172 | + public $grand_total_price_object; |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * total number of tickets |
|
| 176 | + * |
|
| 177 | + * @var int $total_ticket_count |
|
| 178 | + */ |
|
| 179 | + public $total_ticket_count; |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Will hold the final transaction object (EE_Transaction) |
|
| 183 | + * |
|
| 184 | + * @var EE_Transaction $txn |
|
| 185 | + */ |
|
| 186 | + public $txn; |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Holds the payments related to a transaction |
|
| 190 | + * |
|
| 191 | + * @since 4.5.0 |
|
| 192 | + * @var EE_Payment[] $payments |
|
| 193 | + */ |
|
| 194 | + public $payments; |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * Holds the first related payment related for a transaction |
|
| 198 | + * |
|
| 199 | + * @since 4.5.0 |
|
| 200 | + * @var EE_Payment $payment |
|
| 201 | + */ |
|
| 202 | + public $payment; |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * Will hold the label for the txn status |
|
| 206 | + * |
|
| 207 | + * @var string $txn_status |
|
| 208 | + */ |
|
| 209 | + public $txn_status; |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * Will hold the final registration object (EE_Registration) |
|
| 213 | + * |
|
| 214 | + * @var EE_Registration[] $reg_objs |
|
| 215 | + */ |
|
| 216 | + public $reg_objs; |
|
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * Will hold an array of primary attendee data (if present) |
|
| 220 | + * |
|
| 221 | + * @var array $primary_attendee_data |
|
| 222 | + */ |
|
| 223 | + public $primary_attendee_data; |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * This is just an internal object used for passing around the incoming data. |
|
| 227 | + * |
|
| 228 | + * @var mixed $_data |
|
| 229 | + */ |
|
| 230 | + protected $_data; |
|
| 231 | + |
|
| 232 | + /** |
|
| 233 | + * This is just an internal object used for passing around the incoming data. |
|
| 234 | + * |
|
| 235 | + * @var mixed $incoming_data |
|
| 236 | + */ |
|
| 237 | + public $incoming_data; |
|
| 238 | + |
|
| 239 | + /** |
|
| 240 | + * hold objects that might be created |
|
| 241 | + * |
|
| 242 | + * @type EE_Registration $reg_obj |
|
| 243 | + */ |
|
| 244 | + public $reg_obj; |
|
| 245 | + |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * constructor |
|
| 249 | + * |
|
| 250 | + * @param mixed $data incoming data object|array. Suggested that child classes use type hinting for expected |
|
| 251 | + * data object. But here parent will be generic because we don't know what's coming in. |
|
| 252 | + */ |
|
| 253 | + public function __construct($data) |
|
| 254 | + { |
|
| 255 | + $this->_data = $data; |
|
| 256 | + $this->_setup_data(); |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + |
|
| 260 | + /** |
|
| 261 | + * Every child class has to setup the data object ! |
|
| 262 | + * |
|
| 263 | + * @return void |
|
| 264 | + */ |
|
| 265 | + abstract protected function _setup_data(); |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Returns database safe representation of the data later used to when instantiating this object. |
|
| 270 | + * |
|
| 271 | + * @param mixed $data The incoming data to be prepped. |
|
| 272 | + * @return mixed The prepped data for db |
|
| 273 | + */ |
|
| 274 | + public static function convert_data_for_persistent_storage($data) |
|
| 275 | + { |
|
| 276 | + return $data; |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + |
|
| 280 | + /** |
|
| 281 | + * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage |
|
| 282 | + * can be sent into this method and converted back into the format used for instantiating with this data handler. |
|
| 283 | + * |
|
| 284 | + * @param $data |
|
| 285 | + * @return mixed |
|
| 286 | + */ |
|
| 287 | + public static function convert_data_from_persistent_storage($data) |
|
| 288 | + { |
|
| 289 | + return $data; |
|
| 290 | + } |
|
| 291 | + |
|
| 292 | + |
|
| 293 | + /** |
|
| 294 | + * only purpose is to return the data |
|
| 295 | + * |
|
| 296 | + * @access public |
|
| 297 | + * @return mixed the formatted data object! |
|
| 298 | + */ |
|
| 299 | + public function data() |
|
| 300 | + { |
|
| 301 | + return $this->_data; |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * This helper method can be used by any incoming data handlers to setup the data correctly. All that is required |
|
| 307 | + * is that $this->reg_objs be set. |
|
| 308 | + * |
|
| 309 | + * @throws EE_Error |
|
| 310 | + * @throws InvalidDataTypeException |
|
| 311 | + * @throws InvalidInterfaceException |
|
| 312 | + * @throws InvalidArgumentException |
|
| 313 | + * @throws EntityNotFoundException |
|
| 314 | + */ |
|
| 315 | + protected function _assemble_data() |
|
| 316 | + { |
|
| 317 | + // verify that reg_objs is set |
|
| 318 | + if (! is_array($this->reg_objs) |
|
| 319 | + && ! reset($this->reg_objs) instanceof EE_Registration |
|
| 320 | + ) { |
|
| 321 | + throw new EE_Error( |
|
| 322 | + esc_html__( |
|
| 323 | + 'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects', |
|
| 324 | + 'event_espresso' |
|
| 325 | + ) |
|
| 326 | + ); |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + // get all attendee and events associated with the registrations in this transaction |
|
| 330 | + $events = $event_setup = $evtcache = $tickets = $datetimes = array(); |
|
| 331 | + $answers = $questions = $attendees = $line_items = $registrations = array(); |
|
| 332 | + $total_ticket_count = 0; |
|
| 333 | + |
|
| 334 | + if (! empty($this->reg_objs)) { |
|
| 335 | + $event_attendee_count = array(); |
|
| 336 | + /** @var EE_Registration $reg */ |
|
| 337 | + foreach ($this->reg_objs as $reg) { |
|
| 338 | + if ($this->_skip_registration_for_processing($reg) |
|
| 339 | + ) { |
|
| 340 | + continue; |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + $evt_id = $reg->event_ID(); |
|
| 344 | + /** @type EE_Ticket $ticket */ |
|
| 345 | + $ticket = $reg->get_first_related('Ticket'); |
|
| 346 | + $attendee = $reg->attendee(); |
|
| 347 | + $event = $reg->event(); |
|
| 348 | + // if none of the following entities are available, then we can't setup other data reliably, |
|
| 349 | + // so let's just skip. |
|
| 350 | + if (! $ticket instanceof EE_Ticket |
|
| 351 | + || ! $attendee instanceof EE_Attendee |
|
| 352 | + || ! $event instanceof EE_Event |
|
| 353 | + ) { |
|
| 354 | + continue; |
|
| 355 | + } |
|
| 356 | + $relateddatetime = $ticket->datetimes(); |
|
| 357 | + $total_ticket_count++; |
|
| 358 | + $tickets[ $ticket->ID() ]['ticket'] = $ticket; |
|
| 359 | + $tickets[ $ticket->ID() ]['count'] = is_array($tickets[ $ticket->ID() ]) |
|
| 360 | + && isset($tickets[ $ticket->ID() ]['count']) |
|
| 361 | + ? $tickets[ $ticket->ID() ]['count'] + 1 |
|
| 362 | + : 1; |
|
| 363 | + $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee; |
|
| 364 | + $tickets[ $ticket->ID() ]['dtt_objs'] = $relateddatetime; |
|
| 365 | + $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 366 | + $tickets[ $ticket->ID() ]['EE_Event'] = $event; |
|
| 367 | + $evtcache[ $evt_id ] = $event; |
|
| 368 | + $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 369 | + $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ] = $ticket; |
|
| 370 | + $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ] = $attendee; |
|
| 371 | + $event_attendee_count[ $evt_id ] = isset($event_attendee_count[ $evt_id ]) |
|
| 372 | + ? $event_attendee_count[ $evt_id ] + 1 |
|
| 373 | + : 0; |
|
| 374 | + $attendees[ $reg->attendee_ID() ]['line_ref'][] = $evt_id; |
|
| 375 | + $attendees[ $reg->attendee_ID() ]['att_obj'] = $attendee; |
|
| 376 | + $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 377 | + // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID(); |
|
| 378 | + $attendees[ $reg->attendee_ID() ]['attendee_email'] = $attendee->email(); |
|
| 379 | + $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket; |
|
| 380 | + $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ] = $event; |
|
| 381 | + |
|
| 382 | + // registrations |
|
| 383 | + $registrations[ $reg->ID() ]['tkt_obj'] = $ticket; |
|
| 384 | + $registrations[ $reg->ID() ]['evt_obj'] = $event; |
|
| 385 | + $registrations[ $reg->ID() ]['reg_obj'] = $reg; |
|
| 386 | + $registrations[ $reg->ID() ]['att_obj'] = $attendee; |
|
| 387 | + |
|
| 388 | + // set up answer objects |
|
| 389 | + $rel_ans = $reg->get_many_related('Answer'); |
|
| 390 | + foreach ($rel_ans as $ansid => $answer) { |
|
| 391 | + if (! isset($questions[ $ansid ])) { |
|
| 392 | + $questions[ $ansid ] = $answer->get_first_related('Question'); |
|
| 393 | + } |
|
| 394 | + $answers[ $ansid ] = $answer; |
|
| 395 | + $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer; |
|
| 396 | + } |
|
| 397 | + /** |
|
| 398 | + * @var int $dtt_id |
|
| 399 | + * @var EE_Datetime $datetime |
|
| 400 | + */ |
|
| 401 | + foreach ($relateddatetime as $dtt_id => $datetime) { |
|
| 402 | + $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ] = $datetime; |
|
| 403 | + $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime; |
|
| 404 | + |
|
| 405 | + if (isset($datetimes[ $dtt_id ])) { |
|
| 406 | + continue; // already have this info in the datetimes array. |
|
| 407 | + } |
|
| 408 | + |
|
| 409 | + $datetimes[ $dtt_id ]['tkt_objs'][] = $ticket; |
|
| 410 | + $datetimes[ $dtt_id ]['datetime'] = $datetime; |
|
| 411 | + $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ] = $event; |
|
| 412 | + $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 413 | + } |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + // let's loop through the unique event=>reg items and setup data on them |
|
| 417 | + |
|
| 418 | + if (! empty($eventsetup)) { |
|
| 419 | + foreach ($eventsetup as $evt_id => $items) { |
|
| 420 | + $ticket_line_items_for_event = array(); |
|
| 421 | + if ($this->txn instanceof EE_Transaction) { |
|
| 422 | + $ticket_line_items_for_event = EEM_Line_Item::instance()->get_all( |
|
| 423 | + array( |
|
| 424 | + array( |
|
| 425 | + 'Ticket.Datetime.EVT_ID' => $evt_id, |
|
| 426 | + 'TXN_ID' => $this->txn->ID(), |
|
| 427 | + ), |
|
| 428 | + 'default_where_conditions' => 'none', |
|
| 429 | + ) |
|
| 430 | + ); |
|
| 431 | + } |
|
| 432 | + $events[ $evt_id ] = array( |
|
| 433 | + 'ID' => $evt_id, |
|
| 434 | + 'event' => $evtcache[ $evt_id ], |
|
| 435 | + 'name' => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '', |
|
| 436 | + 'total_attendees' => $event_attendee_count[ $evt_id ], |
|
| 437 | + 'reg_objs' => $items['reg_objs'], |
|
| 438 | + 'tkt_objs' => $items['tkt_objs'], |
|
| 439 | + 'att_objs' => $items['att_objs'], |
|
| 440 | + 'dtt_objs' => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(), |
|
| 441 | + 'line_items' => $ticket_line_items_for_event, |
|
| 442 | + ); |
|
| 443 | + |
|
| 444 | + // make sure the tickets have the line items setup for them. |
|
| 445 | + foreach ($ticket_line_items_for_event as $line_id => $line_item) { |
|
| 446 | + // only add the ticket line items if we already have this ticket in the $tickets array. |
|
| 447 | + if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) { |
|
| 448 | + $tickets[ $line_item->ticket()->ID() ]['line_item'] = $line_item; |
|
| 449 | + $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children(); |
|
| 450 | + $line_items[ $line_item->ID() ]['children'] = $line_item->children(); |
|
| 451 | + $line_items[ $line_item->ID() ]['EE_Ticket'] = $line_item->ticket(); |
|
| 452 | + } |
|
| 453 | + } |
|
| 454 | + } |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + $this->grand_total_line_item = $this->txn instanceof EE_Transaction |
|
| 458 | + ? $this->txn->total_line_item() |
|
| 459 | + : null; |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + // lets set the attendees and events properties |
|
| 463 | + $this->attendees = $attendees; |
|
| 464 | + $this->events = $events; |
|
| 465 | + $this->tickets = $tickets; |
|
| 466 | + $this->line_items_with_children = $line_items; |
|
| 467 | + $this->datetimes = $datetimes; |
|
| 468 | + $this->questions = $questions; |
|
| 469 | + $this->answers = $answers; |
|
| 470 | + $this->total_ticket_count = $total_ticket_count; |
|
| 471 | + $this->registrations = $registrations; |
|
| 472 | + |
|
| 473 | + if ($this->txn instanceof EE_Transaction) { |
|
| 474 | + $this->tax_line_items = $this->txn->tax_items(); |
|
| 475 | + $this->additional_line_items = $this->txn->non_ticket_line_items(); |
|
| 476 | + $this->payments = $this->txn->payments(); |
|
| 477 | + |
|
| 478 | + // setup primary registration if we have a single transaction object to work with |
|
| 479 | + |
|
| 480 | + // let's get just the primary_attendee_data! First we get the primary registration object. |
|
| 481 | + $primary_reg = $this->txn->primary_registration(); |
|
| 482 | + // verify |
|
| 483 | + if ($primary_reg instanceof EE_Registration) { |
|
| 484 | + // get attendee object |
|
| 485 | + if ($primary_reg->attendee() instanceof EE_Attendee) { |
|
| 486 | + // now we can setup the primary_attendee_data array |
|
| 487 | + $this->primary_attendee_data = array( |
|
| 488 | + 'registration_id' => $primary_reg->ID(), |
|
| 489 | + 'att_obj' => $primary_reg->attendee(), |
|
| 490 | + 'reg_obj' => $primary_reg, |
|
| 491 | + 'primary_att_obj' => $primary_reg->attendee(), |
|
| 492 | + 'primary_reg_obj' => $primary_reg, |
|
| 493 | + ); |
|
| 494 | + } else { |
|
| 495 | + EE_Error::add_error( |
|
| 496 | + esc_html__( |
|
| 497 | + 'Incoming data does not have a valid Attendee object for the primary registrant.', |
|
| 498 | + 'event_espresso' |
|
| 499 | + ), |
|
| 500 | + __FILE__, |
|
| 501 | + __FUNCTION__, |
|
| 502 | + __LINE__ |
|
| 503 | + ); |
|
| 504 | + } |
|
| 505 | + } else { |
|
| 506 | + EE_Error::add_error( |
|
| 507 | + esc_html__( |
|
| 508 | + 'Incoming data does not have a valid Registration object for the primary registrant.', |
|
| 509 | + 'event_espresso' |
|
| 510 | + ), |
|
| 511 | + __FILE__, |
|
| 512 | + __FUNCTION__, |
|
| 513 | + __LINE__ |
|
| 514 | + ); |
|
| 515 | + } |
|
| 516 | + } |
|
| 517 | + } |
|
| 518 | + |
|
| 519 | + /** |
|
| 520 | + * This simply considers whether the given registration should be processed or not based on comparison with the |
|
| 521 | + * filtered_reg_status property. |
|
| 522 | + * |
|
| 523 | + * @param EE_Registration $registration |
|
| 524 | + * @return bool returning true means we DO want to skip processing. returning false means we DON'T want to skip |
|
| 525 | + * processing |
|
| 526 | + */ |
|
| 527 | + protected function _skip_registration_for_processing(EE_Registration $registration) |
|
| 528 | + { |
|
| 529 | + if (empty($this->filtered_reg_status)) { |
|
| 530 | + return false; |
|
| 531 | + } |
|
| 532 | + |
|
| 533 | + // if we made it here then we just compare the filtered_reg_status with the registration status and return that |
|
| 534 | + return $this->filtered_reg_status !== $registration->status_ID(); |
|
| 535 | + } |
|
| 536 | 536 | } |
@@ -315,7 +315,7 @@ discard block |
||
| 315 | 315 | protected function _assemble_data() |
| 316 | 316 | { |
| 317 | 317 | // verify that reg_objs is set |
| 318 | - if (! is_array($this->reg_objs) |
|
| 318 | + if ( ! is_array($this->reg_objs) |
|
| 319 | 319 | && ! reset($this->reg_objs) instanceof EE_Registration |
| 320 | 320 | ) { |
| 321 | 321 | throw new EE_Error( |
@@ -331,7 +331,7 @@ discard block |
||
| 331 | 331 | $answers = $questions = $attendees = $line_items = $registrations = array(); |
| 332 | 332 | $total_ticket_count = 0; |
| 333 | 333 | |
| 334 | - if (! empty($this->reg_objs)) { |
|
| 334 | + if ( ! empty($this->reg_objs)) { |
|
| 335 | 335 | $event_attendee_count = array(); |
| 336 | 336 | /** @var EE_Registration $reg */ |
| 337 | 337 | foreach ($this->reg_objs as $reg) { |
@@ -342,12 +342,12 @@ discard block |
||
| 342 | 342 | |
| 343 | 343 | $evt_id = $reg->event_ID(); |
| 344 | 344 | /** @type EE_Ticket $ticket */ |
| 345 | - $ticket = $reg->get_first_related('Ticket'); |
|
| 345 | + $ticket = $reg->get_first_related('Ticket'); |
|
| 346 | 346 | $attendee = $reg->attendee(); |
| 347 | 347 | $event = $reg->event(); |
| 348 | 348 | // if none of the following entities are available, then we can't setup other data reliably, |
| 349 | 349 | // so let's just skip. |
| 350 | - if (! $ticket instanceof EE_Ticket |
|
| 350 | + if ( ! $ticket instanceof EE_Ticket |
|
| 351 | 351 | || ! $attendee instanceof EE_Attendee |
| 352 | 352 | || ! $event instanceof EE_Event |
| 353 | 353 | ) { |
@@ -355,67 +355,67 @@ discard block |
||
| 355 | 355 | } |
| 356 | 356 | $relateddatetime = $ticket->datetimes(); |
| 357 | 357 | $total_ticket_count++; |
| 358 | - $tickets[ $ticket->ID() ]['ticket'] = $ticket; |
|
| 359 | - $tickets[ $ticket->ID() ]['count'] = is_array($tickets[ $ticket->ID() ]) |
|
| 360 | - && isset($tickets[ $ticket->ID() ]['count']) |
|
| 361 | - ? $tickets[ $ticket->ID() ]['count'] + 1 |
|
| 358 | + $tickets[$ticket->ID()]['ticket'] = $ticket; |
|
| 359 | + $tickets[$ticket->ID()]['count'] = is_array($tickets[$ticket->ID()]) |
|
| 360 | + && isset($tickets[$ticket->ID()]['count']) |
|
| 361 | + ? $tickets[$ticket->ID()]['count'] + 1 |
|
| 362 | 362 | : 1; |
| 363 | - $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee; |
|
| 364 | - $tickets[ $ticket->ID() ]['dtt_objs'] = $relateddatetime; |
|
| 365 | - $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 366 | - $tickets[ $ticket->ID() ]['EE_Event'] = $event; |
|
| 367 | - $evtcache[ $evt_id ] = $event; |
|
| 368 | - $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 369 | - $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ] = $ticket; |
|
| 370 | - $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ] = $attendee; |
|
| 371 | - $event_attendee_count[ $evt_id ] = isset($event_attendee_count[ $evt_id ]) |
|
| 372 | - ? $event_attendee_count[ $evt_id ] + 1 |
|
| 363 | + $tickets[$ticket->ID()]['att_objs'][$attendee->ID()] = $attendee; |
|
| 364 | + $tickets[$ticket->ID()]['dtt_objs'] = $relateddatetime; |
|
| 365 | + $tickets[$ticket->ID()]['reg_objs'][$reg->ID()] = $reg; |
|
| 366 | + $tickets[$ticket->ID()]['EE_Event'] = $event; |
|
| 367 | + $evtcache[$evt_id] = $event; |
|
| 368 | + $eventsetup[$evt_id]['reg_objs'][$reg->ID()] = $reg; |
|
| 369 | + $eventsetup[$evt_id]['tkt_objs'][$ticket->ID()] = $ticket; |
|
| 370 | + $eventsetup[$evt_id]['att_objs'][$attendee->ID()] = $attendee; |
|
| 371 | + $event_attendee_count[$evt_id] = isset($event_attendee_count[$evt_id]) |
|
| 372 | + ? $event_attendee_count[$evt_id] + 1 |
|
| 373 | 373 | : 0; |
| 374 | - $attendees[ $reg->attendee_ID() ]['line_ref'][] = $evt_id; |
|
| 375 | - $attendees[ $reg->attendee_ID() ]['att_obj'] = $attendee; |
|
| 376 | - $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 374 | + $attendees[$reg->attendee_ID()]['line_ref'][] = $evt_id; |
|
| 375 | + $attendees[$reg->attendee_ID()]['att_obj'] = $attendee; |
|
| 376 | + $attendees[$reg->attendee_ID()]['reg_objs'][$reg->ID()] = $reg; |
|
| 377 | 377 | // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID(); |
| 378 | - $attendees[ $reg->attendee_ID() ]['attendee_email'] = $attendee->email(); |
|
| 379 | - $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket; |
|
| 380 | - $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ] = $event; |
|
| 378 | + $attendees[$reg->attendee_ID()]['attendee_email'] = $attendee->email(); |
|
| 379 | + $attendees[$reg->attendee_ID()]['tkt_objs'][$ticket->ID()] = $ticket; |
|
| 380 | + $attendees[$reg->attendee_ID()]['evt_objs'][$evt_id] = $event; |
|
| 381 | 381 | |
| 382 | 382 | // registrations |
| 383 | - $registrations[ $reg->ID() ]['tkt_obj'] = $ticket; |
|
| 384 | - $registrations[ $reg->ID() ]['evt_obj'] = $event; |
|
| 385 | - $registrations[ $reg->ID() ]['reg_obj'] = $reg; |
|
| 386 | - $registrations[ $reg->ID() ]['att_obj'] = $attendee; |
|
| 383 | + $registrations[$reg->ID()]['tkt_obj'] = $ticket; |
|
| 384 | + $registrations[$reg->ID()]['evt_obj'] = $event; |
|
| 385 | + $registrations[$reg->ID()]['reg_obj'] = $reg; |
|
| 386 | + $registrations[$reg->ID()]['att_obj'] = $attendee; |
|
| 387 | 387 | |
| 388 | 388 | // set up answer objects |
| 389 | 389 | $rel_ans = $reg->get_many_related('Answer'); |
| 390 | 390 | foreach ($rel_ans as $ansid => $answer) { |
| 391 | - if (! isset($questions[ $ansid ])) { |
|
| 392 | - $questions[ $ansid ] = $answer->get_first_related('Question'); |
|
| 391 | + if ( ! isset($questions[$ansid])) { |
|
| 392 | + $questions[$ansid] = $answer->get_first_related('Question'); |
|
| 393 | 393 | } |
| 394 | - $answers[ $ansid ] = $answer; |
|
| 395 | - $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer; |
|
| 394 | + $answers[$ansid] = $answer; |
|
| 395 | + $registrations[$reg->ID()]['ans_objs'][$ansid] = $answer; |
|
| 396 | 396 | } |
| 397 | 397 | /** |
| 398 | 398 | * @var int $dtt_id |
| 399 | 399 | * @var EE_Datetime $datetime |
| 400 | 400 | */ |
| 401 | 401 | foreach ($relateddatetime as $dtt_id => $datetime) { |
| 402 | - $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ] = $datetime; |
|
| 403 | - $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime; |
|
| 402 | + $eventsetup[$evt_id]['dtt_objs'][$dtt_id] = $datetime; |
|
| 403 | + $registrations[$reg->ID()]['dtt_objs'][$dtt_id] = $datetime; |
|
| 404 | 404 | |
| 405 | - if (isset($datetimes[ $dtt_id ])) { |
|
| 405 | + if (isset($datetimes[$dtt_id])) { |
|
| 406 | 406 | continue; // already have this info in the datetimes array. |
| 407 | 407 | } |
| 408 | 408 | |
| 409 | - $datetimes[ $dtt_id ]['tkt_objs'][] = $ticket; |
|
| 410 | - $datetimes[ $dtt_id ]['datetime'] = $datetime; |
|
| 411 | - $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ] = $event; |
|
| 412 | - $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg; |
|
| 409 | + $datetimes[$dtt_id]['tkt_objs'][] = $ticket; |
|
| 410 | + $datetimes[$dtt_id]['datetime'] = $datetime; |
|
| 411 | + $datetimes[$dtt_id]['evt_objs'][$evt_id] = $event; |
|
| 412 | + $datetimes[$dtt_id]['reg_objs'][$reg->ID()] = $reg; |
|
| 413 | 413 | } |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | 416 | // let's loop through the unique event=>reg items and setup data on them |
| 417 | 417 | |
| 418 | - if (! empty($eventsetup)) { |
|
| 418 | + if ( ! empty($eventsetup)) { |
|
| 419 | 419 | foreach ($eventsetup as $evt_id => $items) { |
| 420 | 420 | $ticket_line_items_for_event = array(); |
| 421 | 421 | if ($this->txn instanceof EE_Transaction) { |
@@ -429,11 +429,11 @@ discard block |
||
| 429 | 429 | ) |
| 430 | 430 | ); |
| 431 | 431 | } |
| 432 | - $events[ $evt_id ] = array( |
|
| 432 | + $events[$evt_id] = array( |
|
| 433 | 433 | 'ID' => $evt_id, |
| 434 | - 'event' => $evtcache[ $evt_id ], |
|
| 435 | - 'name' => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '', |
|
| 436 | - 'total_attendees' => $event_attendee_count[ $evt_id ], |
|
| 434 | + 'event' => $evtcache[$evt_id], |
|
| 435 | + 'name' => $evtcache[$evt_id] instanceof EE_Event ? $evtcache[$evt_id]->name() : '', |
|
| 436 | + 'total_attendees' => $event_attendee_count[$evt_id], |
|
| 437 | 437 | 'reg_objs' => $items['reg_objs'], |
| 438 | 438 | 'tkt_objs' => $items['tkt_objs'], |
| 439 | 439 | 'att_objs' => $items['att_objs'], |
@@ -444,11 +444,11 @@ discard block |
||
| 444 | 444 | // make sure the tickets have the line items setup for them. |
| 445 | 445 | foreach ($ticket_line_items_for_event as $line_id => $line_item) { |
| 446 | 446 | // only add the ticket line items if we already have this ticket in the $tickets array. |
| 447 | - if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) { |
|
| 448 | - $tickets[ $line_item->ticket()->ID() ]['line_item'] = $line_item; |
|
| 449 | - $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children(); |
|
| 450 | - $line_items[ $line_item->ID() ]['children'] = $line_item->children(); |
|
| 451 | - $line_items[ $line_item->ID() ]['EE_Ticket'] = $line_item->ticket(); |
|
| 447 | + if ($line_item instanceof EE_Line_Item && isset($tickets[$line_item->ticket()->ID()])) { |
|
| 448 | + $tickets[$line_item->ticket()->ID()]['line_item'] = $line_item; |
|
| 449 | + $tickets[$line_item->ticket()->ID()]['sub_line_items'] = $line_item->children(); |
|
| 450 | + $line_items[$line_item->ID()]['children'] = $line_item->children(); |
|
| 451 | + $line_items[$line_item->ID()]['EE_Ticket'] = $line_item->ticket(); |
|
| 452 | 452 | } |
| 453 | 453 | } |
| 454 | 454 | } |
@@ -19,2396 +19,2396 @@ discard block |
||
| 19 | 19 | class Registrations_Admin_Page extends EE_Admin_Page_CPT |
| 20 | 20 | { |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var EE_Registration |
|
| 24 | - */ |
|
| 25 | - private $_registration; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * @var EE_Event |
|
| 29 | - */ |
|
| 30 | - private $_reg_event; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var EE_Session |
|
| 34 | - */ |
|
| 35 | - private $_session; |
|
| 36 | - |
|
| 37 | - private static $_reg_status; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * Form for displaying the custom questions for this registration. |
|
| 41 | - * This gets used a few times throughout the request so its best to cache it |
|
| 42 | - * |
|
| 43 | - * @var EE_Registration_Custom_Questions_Form |
|
| 44 | - */ |
|
| 45 | - protected $_reg_custom_questions_form = null; |
|
| 46 | - |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * constructor |
|
| 50 | - * |
|
| 51 | - * @Constructor |
|
| 52 | - * @access public |
|
| 53 | - * @param bool $routing |
|
| 54 | - * @return Registrations_Admin_Page |
|
| 55 | - */ |
|
| 56 | - public function __construct($routing = true) |
|
| 57 | - { |
|
| 58 | - parent::__construct($routing); |
|
| 59 | - add_action('wp_loaded', array($this, 'wp_loaded')); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - public function wp_loaded() |
|
| 64 | - { |
|
| 65 | - // when adding a new registration... |
|
| 66 | - if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') { |
|
| 67 | - EE_System::do_not_cache(); |
|
| 68 | - if (! isset($this->_req_data['processing_registration']) |
|
| 69 | - || absint($this->_req_data['processing_registration']) !== 1 |
|
| 70 | - ) { |
|
| 71 | - // and it's NOT the attendee information reg step |
|
| 72 | - // force cookie expiration by setting time to last week |
|
| 73 | - setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/'); |
|
| 74 | - // and update the global |
|
| 75 | - $_COOKIE['ee_registration_added'] = 0; |
|
| 76 | - } |
|
| 77 | - } |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - |
|
| 81 | - protected function _init_page_props() |
|
| 82 | - { |
|
| 83 | - $this->page_slug = REG_PG_SLUG; |
|
| 84 | - $this->_admin_base_url = REG_ADMIN_URL; |
|
| 85 | - $this->_admin_base_path = REG_ADMIN; |
|
| 86 | - $this->page_label = esc_html__('Registrations', 'event_espresso'); |
|
| 87 | - $this->_cpt_routes = array( |
|
| 88 | - 'add_new_attendee' => 'espresso_attendees', |
|
| 89 | - 'edit_attendee' => 'espresso_attendees', |
|
| 90 | - 'insert_attendee' => 'espresso_attendees', |
|
| 91 | - 'update_attendee' => 'espresso_attendees', |
|
| 92 | - ); |
|
| 93 | - $this->_cpt_model_names = array( |
|
| 94 | - 'add_new_attendee' => 'EEM_Attendee', |
|
| 95 | - 'edit_attendee' => 'EEM_Attendee', |
|
| 96 | - ); |
|
| 97 | - $this->_cpt_edit_routes = array( |
|
| 98 | - 'espresso_attendees' => 'edit_attendee', |
|
| 99 | - ); |
|
| 100 | - $this->_pagenow_map = array( |
|
| 101 | - 'add_new_attendee' => 'post-new.php', |
|
| 102 | - 'edit_attendee' => 'post.php', |
|
| 103 | - 'trash' => 'post.php', |
|
| 104 | - ); |
|
| 105 | - add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10); |
|
| 106 | - // add filters so that the comment urls don't take users to a confusing 404 page |
|
| 107 | - add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - |
|
| 111 | - public function clear_comment_link($link, $comment, $args) |
|
| 112 | - { |
|
| 113 | - // gotta make sure this only happens on this route |
|
| 114 | - $post_type = get_post_type($comment->comment_post_ID); |
|
| 115 | - if ($post_type === 'espresso_attendees') { |
|
| 116 | - return '#commentsdiv'; |
|
| 117 | - } |
|
| 118 | - return $link; |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - |
|
| 122 | - protected function _ajax_hooks() |
|
| 123 | - { |
|
| 124 | - // todo: all hooks for registrations ajax goes in here |
|
| 125 | - add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status')); |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - |
|
| 129 | - protected function _define_page_props() |
|
| 130 | - { |
|
| 131 | - $this->_admin_page_title = $this->page_label; |
|
| 132 | - $this->_labels = array( |
|
| 133 | - 'buttons' => array( |
|
| 134 | - 'add-registrant' => esc_html__('Add New Registration', 'event_espresso'), |
|
| 135 | - 'add-attendee' => esc_html__('Add Contact', 'event_espresso'), |
|
| 136 | - 'edit' => esc_html__('Edit Contact', 'event_espresso'), |
|
| 137 | - 'report' => esc_html__("Event Registrations CSV Report", "event_espresso"), |
|
| 138 | - 'report_all' => esc_html__('All Registrations CSV Report', 'event_espresso'), |
|
| 139 | - 'report_filtered' => esc_html__('Filtered CSV Report', 'event_espresso'), |
|
| 140 | - 'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'), |
|
| 141 | - 'contact_list_export' => esc_html__("Export Data", "event_espresso"), |
|
| 142 | - ), |
|
| 143 | - 'publishbox' => array( |
|
| 144 | - 'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'), |
|
| 145 | - 'edit_attendee' => esc_html__("Update Contact Record", 'event_espresso'), |
|
| 146 | - ), |
|
| 147 | - 'hide_add_button_on_cpt_route' => array( |
|
| 148 | - 'edit_attendee' => true, |
|
| 149 | - ), |
|
| 150 | - ); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * grab url requests and route them |
|
| 156 | - * |
|
| 157 | - * @access private |
|
| 158 | - * @return void |
|
| 159 | - */ |
|
| 160 | - public function _set_page_routes() |
|
| 161 | - { |
|
| 162 | - $this->_get_registration_status_array(); |
|
| 163 | - $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
| 164 | - ? $this->_req_data['_REG_ID'] : 0; |
|
| 165 | - $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID']) |
|
| 166 | - ? $this->_req_data['reg_status_change_form']['REG_ID'] |
|
| 167 | - : $reg_id; |
|
| 168 | - $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID']) |
|
| 169 | - ? $this->_req_data['ATT_ID'] : 0; |
|
| 170 | - $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) |
|
| 171 | - ? $this->_req_data['post'] |
|
| 172 | - : $att_id; |
|
| 173 | - $this->_page_routes = array( |
|
| 174 | - 'default' => array( |
|
| 175 | - 'func' => '_registrations_overview_list_table', |
|
| 176 | - 'capability' => 'ee_read_registrations', |
|
| 177 | - ), |
|
| 178 | - 'view_registration' => array( |
|
| 179 | - 'func' => '_registration_details', |
|
| 180 | - 'capability' => 'ee_read_registration', |
|
| 181 | - 'obj_id' => $reg_id, |
|
| 182 | - ), |
|
| 183 | - 'edit_registration' => array( |
|
| 184 | - 'func' => '_update_attendee_registration_form', |
|
| 185 | - 'noheader' => true, |
|
| 186 | - 'headers_sent_route' => 'view_registration', |
|
| 187 | - 'capability' => 'ee_edit_registration', |
|
| 188 | - 'obj_id' => $reg_id, |
|
| 189 | - '_REG_ID' => $reg_id, |
|
| 190 | - ), |
|
| 191 | - 'trash_registrations' => array( |
|
| 192 | - 'func' => '_trash_or_restore_registrations', |
|
| 193 | - 'args' => array('trash' => true), |
|
| 194 | - 'noheader' => true, |
|
| 195 | - 'capability' => 'ee_delete_registrations', |
|
| 196 | - ), |
|
| 197 | - 'restore_registrations' => array( |
|
| 198 | - 'func' => '_trash_or_restore_registrations', |
|
| 199 | - 'args' => array('trash' => false), |
|
| 200 | - 'noheader' => true, |
|
| 201 | - 'capability' => 'ee_delete_registrations', |
|
| 202 | - ), |
|
| 203 | - 'delete_registrations' => array( |
|
| 204 | - 'func' => '_delete_registrations', |
|
| 205 | - 'noheader' => true, |
|
| 206 | - 'capability' => 'ee_delete_registrations', |
|
| 207 | - ), |
|
| 208 | - 'new_registration' => array( |
|
| 209 | - 'func' => 'new_registration', |
|
| 210 | - 'capability' => 'ee_edit_registrations', |
|
| 211 | - ), |
|
| 212 | - 'process_reg_step' => array( |
|
| 213 | - 'func' => 'process_reg_step', |
|
| 214 | - 'noheader' => true, |
|
| 215 | - 'capability' => 'ee_edit_registrations', |
|
| 216 | - ), |
|
| 217 | - 'redirect_to_txn' => array( |
|
| 218 | - 'func' => 'redirect_to_txn', |
|
| 219 | - 'noheader' => true, |
|
| 220 | - 'capability' => 'ee_edit_registrations', |
|
| 221 | - ), |
|
| 222 | - 'change_reg_status' => array( |
|
| 223 | - 'func' => '_change_reg_status', |
|
| 224 | - 'noheader' => true, |
|
| 225 | - 'capability' => 'ee_edit_registration', |
|
| 226 | - 'obj_id' => $reg_id, |
|
| 227 | - ), |
|
| 228 | - 'approve_registration' => array( |
|
| 229 | - 'func' => 'approve_registration', |
|
| 230 | - 'noheader' => true, |
|
| 231 | - 'capability' => 'ee_edit_registration', |
|
| 232 | - 'obj_id' => $reg_id, |
|
| 233 | - ), |
|
| 234 | - 'approve_and_notify_registration' => array( |
|
| 235 | - 'func' => 'approve_registration', |
|
| 236 | - 'noheader' => true, |
|
| 237 | - 'args' => array(true), |
|
| 238 | - 'capability' => 'ee_edit_registration', |
|
| 239 | - 'obj_id' => $reg_id, |
|
| 240 | - ), |
|
| 241 | - 'approve_registrations' => array( |
|
| 242 | - 'func' => 'bulk_action_on_registrations', |
|
| 243 | - 'noheader' => true, |
|
| 244 | - 'capability' => 'ee_edit_registrations', |
|
| 245 | - 'args' => array('approve'), |
|
| 246 | - ), |
|
| 247 | - 'approve_and_notify_registrations' => array( |
|
| 248 | - 'func' => 'bulk_action_on_registrations', |
|
| 249 | - 'noheader' => true, |
|
| 250 | - 'capability' => 'ee_edit_registrations', |
|
| 251 | - 'args' => array('approve', true), |
|
| 252 | - ), |
|
| 253 | - 'decline_registration' => array( |
|
| 254 | - 'func' => 'decline_registration', |
|
| 255 | - 'noheader' => true, |
|
| 256 | - 'capability' => 'ee_edit_registration', |
|
| 257 | - 'obj_id' => $reg_id, |
|
| 258 | - ), |
|
| 259 | - 'decline_and_notify_registration' => array( |
|
| 260 | - 'func' => 'decline_registration', |
|
| 261 | - 'noheader' => true, |
|
| 262 | - 'args' => array(true), |
|
| 263 | - 'capability' => 'ee_edit_registration', |
|
| 264 | - 'obj_id' => $reg_id, |
|
| 265 | - ), |
|
| 266 | - 'decline_registrations' => array( |
|
| 267 | - 'func' => 'bulk_action_on_registrations', |
|
| 268 | - 'noheader' => true, |
|
| 269 | - 'capability' => 'ee_edit_registrations', |
|
| 270 | - 'args' => array('decline'), |
|
| 271 | - ), |
|
| 272 | - 'decline_and_notify_registrations' => array( |
|
| 273 | - 'func' => 'bulk_action_on_registrations', |
|
| 274 | - 'noheader' => true, |
|
| 275 | - 'capability' => 'ee_edit_registrations', |
|
| 276 | - 'args' => array('decline', true), |
|
| 277 | - ), |
|
| 278 | - 'pending_registration' => array( |
|
| 279 | - 'func' => 'pending_registration', |
|
| 280 | - 'noheader' => true, |
|
| 281 | - 'capability' => 'ee_edit_registration', |
|
| 282 | - 'obj_id' => $reg_id, |
|
| 283 | - ), |
|
| 284 | - 'pending_and_notify_registration' => array( |
|
| 285 | - 'func' => 'pending_registration', |
|
| 286 | - 'noheader' => true, |
|
| 287 | - 'args' => array(true), |
|
| 288 | - 'capability' => 'ee_edit_registration', |
|
| 289 | - 'obj_id' => $reg_id, |
|
| 290 | - ), |
|
| 291 | - 'pending_registrations' => array( |
|
| 292 | - 'func' => 'bulk_action_on_registrations', |
|
| 293 | - 'noheader' => true, |
|
| 294 | - 'capability' => 'ee_edit_registrations', |
|
| 295 | - 'args' => array('pending'), |
|
| 296 | - ), |
|
| 297 | - 'pending_and_notify_registrations' => array( |
|
| 298 | - 'func' => 'bulk_action_on_registrations', |
|
| 299 | - 'noheader' => true, |
|
| 300 | - 'capability' => 'ee_edit_registrations', |
|
| 301 | - 'args' => array('pending', true), |
|
| 302 | - ), |
|
| 303 | - 'no_approve_registration' => array( |
|
| 304 | - 'func' => 'not_approve_registration', |
|
| 305 | - 'noheader' => true, |
|
| 306 | - 'capability' => 'ee_edit_registration', |
|
| 307 | - 'obj_id' => $reg_id, |
|
| 308 | - ), |
|
| 309 | - 'no_approve_and_notify_registration' => array( |
|
| 310 | - 'func' => 'not_approve_registration', |
|
| 311 | - 'noheader' => true, |
|
| 312 | - 'args' => array(true), |
|
| 313 | - 'capability' => 'ee_edit_registration', |
|
| 314 | - 'obj_id' => $reg_id, |
|
| 315 | - ), |
|
| 316 | - 'no_approve_registrations' => array( |
|
| 317 | - 'func' => 'bulk_action_on_registrations', |
|
| 318 | - 'noheader' => true, |
|
| 319 | - 'capability' => 'ee_edit_registrations', |
|
| 320 | - 'args' => array('not_approve'), |
|
| 321 | - ), |
|
| 322 | - 'no_approve_and_notify_registrations' => array( |
|
| 323 | - 'func' => 'bulk_action_on_registrations', |
|
| 324 | - 'noheader' => true, |
|
| 325 | - 'capability' => 'ee_edit_registrations', |
|
| 326 | - 'args' => array('not_approve', true), |
|
| 327 | - ), |
|
| 328 | - 'cancel_registration' => array( |
|
| 329 | - 'func' => 'cancel_registration', |
|
| 330 | - 'noheader' => true, |
|
| 331 | - 'capability' => 'ee_edit_registration', |
|
| 332 | - 'obj_id' => $reg_id, |
|
| 333 | - ), |
|
| 334 | - 'cancel_and_notify_registration' => array( |
|
| 335 | - 'func' => 'cancel_registration', |
|
| 336 | - 'noheader' => true, |
|
| 337 | - 'args' => array(true), |
|
| 338 | - 'capability' => 'ee_edit_registration', |
|
| 339 | - 'obj_id' => $reg_id, |
|
| 340 | - ), |
|
| 341 | - 'cancel_registrations' => array( |
|
| 342 | - 'func' => 'bulk_action_on_registrations', |
|
| 343 | - 'noheader' => true, |
|
| 344 | - 'capability' => 'ee_edit_registrations', |
|
| 345 | - 'args' => array('cancel'), |
|
| 346 | - ), |
|
| 347 | - 'cancel_and_notify_registrations' => array( |
|
| 348 | - 'func' => 'bulk_action_on_registrations', |
|
| 349 | - 'noheader' => true, |
|
| 350 | - 'capability' => 'ee_edit_registrations', |
|
| 351 | - 'args' => array('cancel', true), |
|
| 352 | - ), |
|
| 353 | - 'wait_list_registration' => array( |
|
| 354 | - 'func' => 'wait_list_registration', |
|
| 355 | - 'noheader' => true, |
|
| 356 | - 'capability' => 'ee_edit_registration', |
|
| 357 | - 'obj_id' => $reg_id, |
|
| 358 | - ), |
|
| 359 | - 'wait_list_and_notify_registration' => array( |
|
| 360 | - 'func' => 'wait_list_registration', |
|
| 361 | - 'noheader' => true, |
|
| 362 | - 'args' => array(true), |
|
| 363 | - 'capability' => 'ee_edit_registration', |
|
| 364 | - 'obj_id' => $reg_id, |
|
| 365 | - ), |
|
| 366 | - 'contact_list' => array( |
|
| 367 | - 'func' => '_attendee_contact_list_table', |
|
| 368 | - 'capability' => 'ee_read_contacts', |
|
| 369 | - ), |
|
| 370 | - 'add_new_attendee' => array( |
|
| 371 | - 'func' => '_create_new_cpt_item', |
|
| 372 | - 'args' => array( |
|
| 373 | - 'new_attendee' => true, |
|
| 374 | - 'capability' => 'ee_edit_contacts', |
|
| 375 | - ), |
|
| 376 | - ), |
|
| 377 | - 'edit_attendee' => array( |
|
| 378 | - 'func' => '_edit_cpt_item', |
|
| 379 | - 'capability' => 'ee_edit_contacts', |
|
| 380 | - 'obj_id' => $att_id, |
|
| 381 | - ), |
|
| 382 | - 'duplicate_attendee' => array( |
|
| 383 | - 'func' => '_duplicate_attendee', |
|
| 384 | - 'noheader' => true, |
|
| 385 | - 'capability' => 'ee_edit_contacts', |
|
| 386 | - 'obj_id' => $att_id, |
|
| 387 | - ), |
|
| 388 | - 'insert_attendee' => array( |
|
| 389 | - 'func' => '_insert_or_update_attendee', |
|
| 390 | - 'args' => array( |
|
| 391 | - 'new_attendee' => true, |
|
| 392 | - ), |
|
| 393 | - 'noheader' => true, |
|
| 394 | - 'capability' => 'ee_edit_contacts', |
|
| 395 | - ), |
|
| 396 | - 'update_attendee' => array( |
|
| 397 | - 'func' => '_insert_or_update_attendee', |
|
| 398 | - 'args' => array( |
|
| 399 | - 'new_attendee' => false, |
|
| 400 | - ), |
|
| 401 | - 'noheader' => true, |
|
| 402 | - 'capability' => 'ee_edit_contacts', |
|
| 403 | - 'obj_id' => $att_id, |
|
| 404 | - ), |
|
| 405 | - 'trash_attendees' => array( |
|
| 406 | - 'func' => '_trash_or_restore_attendees', |
|
| 407 | - 'args' => array( |
|
| 408 | - 'trash' => 'true', |
|
| 409 | - ), |
|
| 410 | - 'noheader' => true, |
|
| 411 | - 'capability' => 'ee_delete_contacts', |
|
| 412 | - ), |
|
| 413 | - 'trash_attendee' => array( |
|
| 414 | - 'func' => '_trash_or_restore_attendees', |
|
| 415 | - 'args' => array( |
|
| 416 | - 'trash' => true, |
|
| 417 | - ), |
|
| 418 | - 'noheader' => true, |
|
| 419 | - 'capability' => 'ee_delete_contacts', |
|
| 420 | - 'obj_id' => $att_id, |
|
| 421 | - ), |
|
| 422 | - 'restore_attendees' => array( |
|
| 423 | - 'func' => '_trash_or_restore_attendees', |
|
| 424 | - 'args' => array( |
|
| 425 | - 'trash' => false, |
|
| 426 | - ), |
|
| 427 | - 'noheader' => true, |
|
| 428 | - 'capability' => 'ee_delete_contacts', |
|
| 429 | - 'obj_id' => $att_id, |
|
| 430 | - ), |
|
| 431 | - 'resend_registration' => array( |
|
| 432 | - 'func' => '_resend_registration', |
|
| 433 | - 'noheader' => true, |
|
| 434 | - 'capability' => 'ee_send_message', |
|
| 435 | - ), |
|
| 436 | - 'registrations_report' => array( |
|
| 437 | - 'func' => '_registrations_report', |
|
| 438 | - 'noheader' => true, |
|
| 439 | - 'capability' => 'ee_read_registrations', |
|
| 440 | - ), |
|
| 441 | - 'contact_list_export' => array( |
|
| 442 | - 'func' => '_contact_list_export', |
|
| 443 | - 'noheader' => true, |
|
| 444 | - 'capability' => 'export', |
|
| 445 | - ), |
|
| 446 | - 'contact_list_report' => array( |
|
| 447 | - 'func' => '_contact_list_report', |
|
| 448 | - 'noheader' => true, |
|
| 449 | - 'capability' => 'ee_read_contacts', |
|
| 450 | - ), |
|
| 451 | - ); |
|
| 452 | - } |
|
| 453 | - |
|
| 454 | - |
|
| 455 | - protected function _set_page_config() |
|
| 456 | - { |
|
| 457 | - $this->_page_config = array( |
|
| 458 | - 'default' => array( |
|
| 459 | - 'nav' => array( |
|
| 460 | - 'label' => esc_html__('Overview', 'event_espresso'), |
|
| 461 | - 'order' => 5, |
|
| 462 | - ), |
|
| 463 | - 'help_tabs' => array( |
|
| 464 | - 'registrations_overview_help_tab' => array( |
|
| 465 | - 'title' => esc_html__('Registrations Overview', 'event_espresso'), |
|
| 466 | - 'filename' => 'registrations_overview', |
|
| 467 | - ), |
|
| 468 | - 'registrations_overview_table_column_headings_help_tab' => array( |
|
| 469 | - 'title' => esc_html__('Registrations Table Column Headings', 'event_espresso'), |
|
| 470 | - 'filename' => 'registrations_overview_table_column_headings', |
|
| 471 | - ), |
|
| 472 | - 'registrations_overview_filters_help_tab' => array( |
|
| 473 | - 'title' => esc_html__('Registration Filters', 'event_espresso'), |
|
| 474 | - 'filename' => 'registrations_overview_filters', |
|
| 475 | - ), |
|
| 476 | - 'registrations_overview_views_help_tab' => array( |
|
| 477 | - 'title' => esc_html__('Registration Views', 'event_espresso'), |
|
| 478 | - 'filename' => 'registrations_overview_views', |
|
| 479 | - ), |
|
| 480 | - 'registrations_regoverview_other_help_tab' => array( |
|
| 481 | - 'title' => esc_html__('Registrations Other', 'event_espresso'), |
|
| 482 | - 'filename' => 'registrations_overview_other', |
|
| 483 | - ), |
|
| 484 | - ), |
|
| 485 | - 'help_tour' => array('Registration_Overview_Help_Tour'), |
|
| 486 | - 'qtips' => array('Registration_List_Table_Tips'), |
|
| 487 | - 'list_table' => 'EE_Registrations_List_Table', |
|
| 488 | - 'require_nonce' => false, |
|
| 489 | - ), |
|
| 490 | - 'view_registration' => array( |
|
| 491 | - 'nav' => array( |
|
| 492 | - 'label' => esc_html__('REG Details', 'event_espresso'), |
|
| 493 | - 'order' => 15, |
|
| 494 | - 'url' => isset($this->_req_data['_REG_ID']) |
|
| 495 | - ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url) |
|
| 496 | - : $this->_admin_base_url, |
|
| 497 | - 'persistent' => false, |
|
| 498 | - ), |
|
| 499 | - 'help_tabs' => array( |
|
| 500 | - 'registrations_details_help_tab' => array( |
|
| 501 | - 'title' => esc_html__('Registration Details', 'event_espresso'), |
|
| 502 | - 'filename' => 'registrations_details', |
|
| 503 | - ), |
|
| 504 | - 'registrations_details_table_help_tab' => array( |
|
| 505 | - 'title' => esc_html__('Registration Details Table', 'event_espresso'), |
|
| 506 | - 'filename' => 'registrations_details_table', |
|
| 507 | - ), |
|
| 508 | - 'registrations_details_form_answers_help_tab' => array( |
|
| 509 | - 'title' => esc_html__('Registration Form Answers', 'event_espresso'), |
|
| 510 | - 'filename' => 'registrations_details_form_answers', |
|
| 511 | - ), |
|
| 512 | - 'registrations_details_registrant_details_help_tab' => array( |
|
| 513 | - 'title' => esc_html__('Contact Details', 'event_espresso'), |
|
| 514 | - 'filename' => 'registrations_details_registrant_details', |
|
| 515 | - ), |
|
| 516 | - ), |
|
| 517 | - 'help_tour' => array('Registration_Details_Help_Tour'), |
|
| 518 | - 'metaboxes' => array_merge( |
|
| 519 | - $this->_default_espresso_metaboxes, |
|
| 520 | - array('_registration_details_metaboxes') |
|
| 521 | - ), |
|
| 522 | - 'require_nonce' => false, |
|
| 523 | - ), |
|
| 524 | - 'new_registration' => array( |
|
| 525 | - 'nav' => array( |
|
| 526 | - 'label' => esc_html__('Add New Registration', 'event_espresso'), |
|
| 527 | - 'url' => '#', |
|
| 528 | - 'order' => 15, |
|
| 529 | - 'persistent' => false, |
|
| 530 | - ), |
|
| 531 | - 'metaboxes' => $this->_default_espresso_metaboxes, |
|
| 532 | - 'labels' => array( |
|
| 533 | - 'publishbox' => esc_html__('Save Registration', 'event_espresso'), |
|
| 534 | - ), |
|
| 535 | - 'require_nonce' => false, |
|
| 536 | - ), |
|
| 537 | - 'add_new_attendee' => array( |
|
| 538 | - 'nav' => array( |
|
| 539 | - 'label' => esc_html__('Add Contact', 'event_espresso'), |
|
| 540 | - 'order' => 15, |
|
| 541 | - 'persistent' => false, |
|
| 542 | - ), |
|
| 543 | - 'metaboxes' => array_merge( |
|
| 544 | - $this->_default_espresso_metaboxes, |
|
| 545 | - array('_publish_post_box', 'attendee_editor_metaboxes') |
|
| 546 | - ), |
|
| 547 | - 'require_nonce' => false, |
|
| 548 | - ), |
|
| 549 | - 'edit_attendee' => array( |
|
| 550 | - 'nav' => array( |
|
| 551 | - 'label' => esc_html__('Edit Contact', 'event_espresso'), |
|
| 552 | - 'order' => 15, |
|
| 553 | - 'persistent' => false, |
|
| 554 | - 'url' => isset($this->_req_data['ATT_ID']) |
|
| 555 | - ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url) |
|
| 556 | - : $this->_admin_base_url, |
|
| 557 | - ), |
|
| 558 | - 'metaboxes' => array('attendee_editor_metaboxes'), |
|
| 559 | - 'require_nonce' => false, |
|
| 560 | - ), |
|
| 561 | - 'contact_list' => array( |
|
| 562 | - 'nav' => array( |
|
| 563 | - 'label' => esc_html__('Contact List', 'event_espresso'), |
|
| 564 | - 'order' => 20, |
|
| 565 | - ), |
|
| 566 | - 'list_table' => 'EE_Attendee_Contact_List_Table', |
|
| 567 | - 'help_tabs' => array( |
|
| 568 | - 'registrations_contact_list_help_tab' => array( |
|
| 569 | - 'title' => esc_html__('Registrations Contact List', 'event_espresso'), |
|
| 570 | - 'filename' => 'registrations_contact_list', |
|
| 571 | - ), |
|
| 572 | - 'registrations_contact-list_table_column_headings_help_tab' => array( |
|
| 573 | - 'title' => esc_html__('Contact List Table Column Headings', 'event_espresso'), |
|
| 574 | - 'filename' => 'registrations_contact_list_table_column_headings', |
|
| 575 | - ), |
|
| 576 | - 'registrations_contact_list_views_help_tab' => array( |
|
| 577 | - 'title' => esc_html__('Contact List Views', 'event_espresso'), |
|
| 578 | - 'filename' => 'registrations_contact_list_views', |
|
| 579 | - ), |
|
| 580 | - 'registrations_contact_list_other_help_tab' => array( |
|
| 581 | - 'title' => esc_html__('Contact List Other', 'event_espresso'), |
|
| 582 | - 'filename' => 'registrations_contact_list_other', |
|
| 583 | - ), |
|
| 584 | - ), |
|
| 585 | - 'help_tour' => array('Contact_List_Help_Tour'), |
|
| 586 | - 'metaboxes' => array(), |
|
| 587 | - 'require_nonce' => false, |
|
| 588 | - ), |
|
| 589 | - // override default cpt routes |
|
| 590 | - 'create_new' => '', |
|
| 591 | - 'edit' => '', |
|
| 592 | - ); |
|
| 593 | - } |
|
| 594 | - |
|
| 595 | - |
|
| 596 | - /** |
|
| 597 | - * The below methods aren't used by this class currently |
|
| 598 | - */ |
|
| 599 | - protected function _add_screen_options() |
|
| 600 | - { |
|
| 601 | - } |
|
| 602 | - |
|
| 603 | - |
|
| 604 | - protected function _add_feature_pointers() |
|
| 605 | - { |
|
| 606 | - } |
|
| 607 | - |
|
| 608 | - |
|
| 609 | - public function admin_init() |
|
| 610 | - { |
|
| 611 | - EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__( |
|
| 612 | - 'click "Update Registration Questions" to save your changes', |
|
| 613 | - 'event_espresso' |
|
| 614 | - ); |
|
| 615 | - } |
|
| 616 | - |
|
| 617 | - |
|
| 618 | - public function admin_notices() |
|
| 619 | - { |
|
| 620 | - } |
|
| 621 | - |
|
| 622 | - |
|
| 623 | - public function admin_footer_scripts() |
|
| 624 | - { |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - |
|
| 628 | - /** |
|
| 629 | - * get list of registration statuses |
|
| 630 | - * |
|
| 631 | - * @access private |
|
| 632 | - * @return void |
|
| 633 | - * @throws EE_Error |
|
| 634 | - */ |
|
| 635 | - private function _get_registration_status_array() |
|
| 636 | - { |
|
| 637 | - self::$_reg_status = EEM_Registration::reg_status_array(array(), true); |
|
| 638 | - } |
|
| 639 | - |
|
| 640 | - |
|
| 641 | - protected function _add_screen_options_default() |
|
| 642 | - { |
|
| 643 | - $this->_per_page_screen_option(); |
|
| 644 | - } |
|
| 645 | - |
|
| 646 | - |
|
| 647 | - protected function _add_screen_options_contact_list() |
|
| 648 | - { |
|
| 649 | - $page_title = $this->_admin_page_title; |
|
| 650 | - $this->_admin_page_title = esc_html__("Contacts", 'event_espresso'); |
|
| 651 | - $this->_per_page_screen_option(); |
|
| 652 | - $this->_admin_page_title = $page_title; |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - |
|
| 656 | - public function load_scripts_styles() |
|
| 657 | - { |
|
| 658 | - // style |
|
| 659 | - wp_register_style( |
|
| 660 | - 'espresso_reg', |
|
| 661 | - REG_ASSETS_URL . 'espresso_registrations_admin.css', |
|
| 662 | - array('ee-admin-css'), |
|
| 663 | - EVENT_ESPRESSO_VERSION |
|
| 664 | - ); |
|
| 665 | - wp_enqueue_style('espresso_reg'); |
|
| 666 | - // script |
|
| 667 | - wp_register_script( |
|
| 668 | - 'espresso_reg', |
|
| 669 | - REG_ASSETS_URL . 'espresso_registrations_admin.js', |
|
| 670 | - array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), |
|
| 671 | - EVENT_ESPRESSO_VERSION, |
|
| 672 | - true |
|
| 673 | - ); |
|
| 674 | - wp_enqueue_script('espresso_reg'); |
|
| 675 | - } |
|
| 676 | - |
|
| 677 | - |
|
| 678 | - public function load_scripts_styles_edit_attendee() |
|
| 679 | - { |
|
| 680 | - // stuff to only show up on our attendee edit details page. |
|
| 681 | - $attendee_details_translations = array( |
|
| 682 | - 'att_publish_text' => sprintf( |
|
| 683 | - esc_html__('Created on: <b>%1$s</b>', 'event_espresso'), |
|
| 684 | - $this->_cpt_model_obj->get_datetime('ATT_created') |
|
| 685 | - ), |
|
| 686 | - ); |
|
| 687 | - wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations); |
|
| 688 | - wp_enqueue_script('jquery-validate'); |
|
| 689 | - } |
|
| 690 | - |
|
| 691 | - |
|
| 692 | - public function load_scripts_styles_view_registration() |
|
| 693 | - { |
|
| 694 | - // styles |
|
| 695 | - wp_enqueue_style('espresso-ui-theme'); |
|
| 696 | - // scripts |
|
| 697 | - $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
| 698 | - $this->_reg_custom_questions_form->wp_enqueue_scripts(true); |
|
| 699 | - } |
|
| 700 | - |
|
| 701 | - |
|
| 702 | - public function load_scripts_styles_contact_list() |
|
| 703 | - { |
|
| 704 | - wp_dequeue_style('espresso_reg'); |
|
| 705 | - wp_register_style( |
|
| 706 | - 'espresso_att', |
|
| 707 | - REG_ASSETS_URL . 'espresso_attendees_admin.css', |
|
| 708 | - array('ee-admin-css'), |
|
| 709 | - EVENT_ESPRESSO_VERSION |
|
| 710 | - ); |
|
| 711 | - wp_enqueue_style('espresso_att'); |
|
| 712 | - } |
|
| 713 | - |
|
| 714 | - |
|
| 715 | - public function load_scripts_styles_new_registration() |
|
| 716 | - { |
|
| 717 | - wp_register_script( |
|
| 718 | - 'ee-spco-for-admin', |
|
| 719 | - REG_ASSETS_URL . 'spco_for_admin.js', |
|
| 720 | - array('underscore', 'jquery'), |
|
| 721 | - EVENT_ESPRESSO_VERSION, |
|
| 722 | - true |
|
| 723 | - ); |
|
| 724 | - wp_enqueue_script('ee-spco-for-admin'); |
|
| 725 | - add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
| 726 | - EE_Form_Section_Proper::wp_enqueue_scripts(); |
|
| 727 | - EED_Ticket_Selector::load_tckt_slctr_assets(); |
|
| 728 | - EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
| 729 | - } |
|
| 730 | - |
|
| 731 | - |
|
| 732 | - public function AHEE__EE_Admin_Page__route_admin_request_resend_registration() |
|
| 733 | - { |
|
| 734 | - add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - |
|
| 738 | - public function AHEE__EE_Admin_Page__route_admin_request_approve_registration() |
|
| 739 | - { |
|
| 740 | - add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 741 | - } |
|
| 742 | - |
|
| 743 | - |
|
| 744 | - protected function _set_list_table_views_default() |
|
| 745 | - { |
|
| 746 | - // for notification related bulk actions we need to make sure only active messengers have an option. |
|
| 747 | - EED_Messages::set_autoloaders(); |
|
| 748 | - /** @type EE_Message_Resource_Manager $message_resource_manager */ |
|
| 749 | - $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 750 | - $active_mts = $message_resource_manager->list_of_active_message_types(); |
|
| 751 | - // key= bulk_action_slug, value= message type. |
|
| 752 | - $match_array = array( |
|
| 753 | - 'approve_registrations' => 'registration', |
|
| 754 | - 'decline_registrations' => 'declined_registration', |
|
| 755 | - 'pending_registrations' => 'pending_approval', |
|
| 756 | - 'no_approve_registrations' => 'not_approved_registration', |
|
| 757 | - 'cancel_registrations' => 'cancelled_registration', |
|
| 758 | - ); |
|
| 759 | - $can_send = EE_Registry::instance()->CAP->current_user_can( |
|
| 760 | - 'ee_send_message', |
|
| 761 | - 'batch_send_messages' |
|
| 762 | - ); |
|
| 763 | - /** setup reg status bulk actions **/ |
|
| 764 | - $def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso'); |
|
| 765 | - if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) { |
|
| 766 | - $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__( |
|
| 767 | - 'Approve and Notify Registrations', |
|
| 768 | - 'event_espresso' |
|
| 769 | - ); |
|
| 770 | - } |
|
| 771 | - $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso'); |
|
| 772 | - if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) { |
|
| 773 | - $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__( |
|
| 774 | - 'Decline and Notify Registrations', |
|
| 775 | - 'event_espresso' |
|
| 776 | - ); |
|
| 777 | - } |
|
| 778 | - $def_reg_status_actions['pending_registrations'] = esc_html__( |
|
| 779 | - 'Set Registrations to Pending Payment', |
|
| 780 | - 'event_espresso' |
|
| 781 | - ); |
|
| 782 | - if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) { |
|
| 783 | - $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__( |
|
| 784 | - 'Set Registrations to Pending Payment and Notify', |
|
| 785 | - 'event_espresso' |
|
| 786 | - ); |
|
| 787 | - } |
|
| 788 | - $def_reg_status_actions['no_approve_registrations'] = esc_html__( |
|
| 789 | - 'Set Registrations to Not Approved', |
|
| 790 | - 'event_espresso' |
|
| 791 | - ); |
|
| 792 | - if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) { |
|
| 793 | - $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__( |
|
| 794 | - 'Set Registrations to Not Approved and Notify', |
|
| 795 | - 'event_espresso' |
|
| 796 | - ); |
|
| 797 | - } |
|
| 798 | - $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso'); |
|
| 799 | - if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) { |
|
| 800 | - $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__( |
|
| 801 | - 'Cancel Registrations and Notify', |
|
| 802 | - 'event_espresso' |
|
| 803 | - ); |
|
| 804 | - } |
|
| 805 | - $def_reg_status_actions = apply_filters( |
|
| 806 | - 'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array', |
|
| 807 | - $def_reg_status_actions, |
|
| 808 | - $active_mts, |
|
| 809 | - $can_send |
|
| 810 | - ); |
|
| 811 | - |
|
| 812 | - $this->_views = array( |
|
| 813 | - 'all' => array( |
|
| 814 | - 'slug' => 'all', |
|
| 815 | - 'label' => esc_html__('View All Registrations', 'event_espresso'), |
|
| 816 | - 'count' => 0, |
|
| 817 | - 'bulk_action' => array_merge( |
|
| 818 | - $def_reg_status_actions, |
|
| 819 | - array( |
|
| 820 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 821 | - ) |
|
| 822 | - ), |
|
| 823 | - ), |
|
| 824 | - 'month' => array( |
|
| 825 | - 'slug' => 'month', |
|
| 826 | - 'label' => esc_html__('This Month', 'event_espresso'), |
|
| 827 | - 'count' => 0, |
|
| 828 | - 'bulk_action' => array_merge( |
|
| 829 | - $def_reg_status_actions, |
|
| 830 | - array( |
|
| 831 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 832 | - ) |
|
| 833 | - ), |
|
| 834 | - ), |
|
| 835 | - 'today' => array( |
|
| 836 | - 'slug' => 'today', |
|
| 837 | - 'label' => sprintf( |
|
| 838 | - esc_html__('Today - %s', 'event_espresso'), |
|
| 839 | - date('M d, Y', current_time('timestamp')) |
|
| 840 | - ), |
|
| 841 | - 'count' => 0, |
|
| 842 | - 'bulk_action' => array_merge( |
|
| 843 | - $def_reg_status_actions, |
|
| 844 | - array( |
|
| 845 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 846 | - ) |
|
| 847 | - ), |
|
| 848 | - ), |
|
| 849 | - ); |
|
| 850 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 851 | - 'ee_delete_registrations', |
|
| 852 | - 'espresso_registrations_delete_registration' |
|
| 853 | - )) { |
|
| 854 | - $this->_views['incomplete'] = array( |
|
| 855 | - 'slug' => 'incomplete', |
|
| 856 | - 'label' => esc_html__('Incomplete', 'event_espresso'), |
|
| 857 | - 'count' => 0, |
|
| 858 | - 'bulk_action' => array( |
|
| 859 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 860 | - ), |
|
| 861 | - ); |
|
| 862 | - $this->_views['trash'] = array( |
|
| 863 | - 'slug' => 'trash', |
|
| 864 | - 'label' => esc_html__('Trash', 'event_espresso'), |
|
| 865 | - 'count' => 0, |
|
| 866 | - 'bulk_action' => array( |
|
| 867 | - 'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'), |
|
| 868 | - 'delete_registrations' => esc_html__('Delete Registrations Permanently', 'event_espresso'), |
|
| 869 | - ), |
|
| 870 | - ); |
|
| 871 | - } |
|
| 872 | - } |
|
| 873 | - |
|
| 874 | - |
|
| 875 | - protected function _set_list_table_views_contact_list() |
|
| 876 | - { |
|
| 877 | - $this->_views = array( |
|
| 878 | - 'in_use' => array( |
|
| 879 | - 'slug' => 'in_use', |
|
| 880 | - 'label' => esc_html__('In Use', 'event_espresso'), |
|
| 881 | - 'count' => 0, |
|
| 882 | - 'bulk_action' => array( |
|
| 883 | - 'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'), |
|
| 884 | - ), |
|
| 885 | - ), |
|
| 886 | - ); |
|
| 887 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 888 | - 'ee_delete_contacts', |
|
| 889 | - 'espresso_registrations_trash_attendees' |
|
| 890 | - ) |
|
| 891 | - ) { |
|
| 892 | - $this->_views['trash'] = array( |
|
| 893 | - 'slug' => 'trash', |
|
| 894 | - 'label' => esc_html__('Trash', 'event_espresso'), |
|
| 895 | - 'count' => 0, |
|
| 896 | - 'bulk_action' => array( |
|
| 897 | - 'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'), |
|
| 898 | - ), |
|
| 899 | - ); |
|
| 900 | - } |
|
| 901 | - } |
|
| 902 | - |
|
| 903 | - |
|
| 904 | - protected function _registration_legend_items() |
|
| 905 | - { |
|
| 906 | - $fc_items = array( |
|
| 907 | - 'star-icon' => array( |
|
| 908 | - 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
| 909 | - 'desc' => esc_html__('This is the Primary Registrant', 'event_espresso'), |
|
| 910 | - ), |
|
| 911 | - 'view_details' => array( |
|
| 912 | - 'class' => 'dashicons dashicons-clipboard', |
|
| 913 | - 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
| 914 | - ), |
|
| 915 | - 'edit_attendee' => array( |
|
| 916 | - 'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16', |
|
| 917 | - 'desc' => esc_html__('Edit Contact Details', 'event_espresso'), |
|
| 918 | - ), |
|
| 919 | - 'view_transaction' => array( |
|
| 920 | - 'class' => 'dashicons dashicons-cart', |
|
| 921 | - 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
| 922 | - ), |
|
| 923 | - 'view_invoice' => array( |
|
| 924 | - 'class' => 'dashicons dashicons-media-spreadsheet', |
|
| 925 | - 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
| 926 | - ), |
|
| 927 | - ); |
|
| 928 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 929 | - 'ee_send_message', |
|
| 930 | - 'espresso_registrations_resend_registration' |
|
| 931 | - )) { |
|
| 932 | - $fc_items['resend_registration'] = array( |
|
| 933 | - 'class' => 'dashicons dashicons-email-alt', |
|
| 934 | - 'desc' => esc_html__('Resend Registration Details', 'event_espresso'), |
|
| 935 | - ); |
|
| 936 | - } else { |
|
| 937 | - $fc_items['blank'] = array('class' => 'blank', 'desc' => ''); |
|
| 938 | - } |
|
| 939 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 940 | - 'ee_read_global_messages', |
|
| 941 | - 'view_filtered_messages' |
|
| 942 | - )) { |
|
| 943 | - $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
| 944 | - if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) { |
|
| 945 | - $fc_items['view_related_messages'] = array( |
|
| 946 | - 'class' => $related_for_icon['css_class'], |
|
| 947 | - 'desc' => $related_for_icon['label'], |
|
| 948 | - ); |
|
| 949 | - } |
|
| 950 | - } |
|
| 951 | - $sc_items = array( |
|
| 952 | - 'approved_status' => array( |
|
| 953 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 954 | - 'desc' => EEH_Template::pretty_status( |
|
| 955 | - EEM_Registration::status_id_approved, |
|
| 956 | - false, |
|
| 957 | - 'sentence' |
|
| 958 | - ), |
|
| 959 | - ), |
|
| 960 | - 'pending_status' => array( |
|
| 961 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 962 | - 'desc' => EEH_Template::pretty_status( |
|
| 963 | - EEM_Registration::status_id_pending_payment, |
|
| 964 | - false, |
|
| 965 | - 'sentence' |
|
| 966 | - ), |
|
| 967 | - ), |
|
| 968 | - 'wait_list' => array( |
|
| 969 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 970 | - 'desc' => EEH_Template::pretty_status( |
|
| 971 | - EEM_Registration::status_id_wait_list, |
|
| 972 | - false, |
|
| 973 | - 'sentence' |
|
| 974 | - ), |
|
| 975 | - ), |
|
| 976 | - 'incomplete_status' => array( |
|
| 977 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete, |
|
| 978 | - 'desc' => EEH_Template::pretty_status( |
|
| 979 | - EEM_Registration::status_id_incomplete, |
|
| 980 | - false, |
|
| 981 | - 'sentence' |
|
| 982 | - ), |
|
| 983 | - ), |
|
| 984 | - 'not_approved' => array( |
|
| 985 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 986 | - 'desc' => EEH_Template::pretty_status( |
|
| 987 | - EEM_Registration::status_id_not_approved, |
|
| 988 | - false, |
|
| 989 | - 'sentence' |
|
| 990 | - ), |
|
| 991 | - ), |
|
| 992 | - 'declined_status' => array( |
|
| 993 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 994 | - 'desc' => EEH_Template::pretty_status( |
|
| 995 | - EEM_Registration::status_id_declined, |
|
| 996 | - false, |
|
| 997 | - 'sentence' |
|
| 998 | - ), |
|
| 999 | - ), |
|
| 1000 | - 'cancelled_status' => array( |
|
| 1001 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 1002 | - 'desc' => EEH_Template::pretty_status( |
|
| 1003 | - EEM_Registration::status_id_cancelled, |
|
| 1004 | - false, |
|
| 1005 | - 'sentence' |
|
| 1006 | - ), |
|
| 1007 | - ), |
|
| 1008 | - ); |
|
| 1009 | - return array_merge($fc_items, $sc_items); |
|
| 1010 | - } |
|
| 1011 | - |
|
| 1012 | - |
|
| 1013 | - |
|
| 1014 | - /*************************************** REGISTRATION OVERVIEW **************************************/ |
|
| 1015 | - /** |
|
| 1016 | - * @throws \EE_Error |
|
| 1017 | - */ |
|
| 1018 | - protected function _registrations_overview_list_table() |
|
| 1019 | - { |
|
| 1020 | - $this->_template_args['admin_page_header'] = ''; |
|
| 1021 | - $EVT_ID = ! empty($this->_req_data['event_id']) |
|
| 1022 | - ? absint($this->_req_data['event_id']) |
|
| 1023 | - : 0; |
|
| 1024 | - $ATT_ID = ! empty($this->_req_data['ATT_ID']) |
|
| 1025 | - ? absint($this->_req_data['ATT_ID']) |
|
| 1026 | - : 0; |
|
| 1027 | - if ($ATT_ID) { |
|
| 1028 | - $attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID); |
|
| 1029 | - if ($attendee instanceof EE_Attendee) { |
|
| 1030 | - $this->_template_args['admin_page_header'] = sprintf( |
|
| 1031 | - esc_html__( |
|
| 1032 | - '%1$s Viewing registrations for %2$s%3$s', |
|
| 1033 | - 'event_espresso' |
|
| 1034 | - ), |
|
| 1035 | - '<h3 style="line-height:1.5em;">', |
|
| 1036 | - '<a href="' . EE_Admin_Page::add_query_args_and_nonce( |
|
| 1037 | - array( |
|
| 1038 | - 'action' => 'edit_attendee', |
|
| 1039 | - 'post' => $ATT_ID, |
|
| 1040 | - ), |
|
| 1041 | - REG_ADMIN_URL |
|
| 1042 | - ) . '">' . $attendee->full_name() . '</a>', |
|
| 1043 | - '</h3>' |
|
| 1044 | - ); |
|
| 1045 | - } |
|
| 1046 | - } |
|
| 1047 | - if ($EVT_ID) { |
|
| 1048 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 1049 | - 'ee_edit_registrations', |
|
| 1050 | - 'espresso_registrations_new_registration', |
|
| 1051 | - $EVT_ID |
|
| 1052 | - )) { |
|
| 1053 | - $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
| 1054 | - 'new_registration', |
|
| 1055 | - 'add-registrant', |
|
| 1056 | - array('event_id' => $EVT_ID), |
|
| 1057 | - 'add-new-h2' |
|
| 1058 | - ); |
|
| 1059 | - } |
|
| 1060 | - $event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 1061 | - if ($event instanceof EE_Event) { |
|
| 1062 | - $this->_template_args['admin_page_header'] = sprintf( |
|
| 1063 | - esc_html__( |
|
| 1064 | - '%s Viewing registrations for the event: %s%s', |
|
| 1065 | - 'event_espresso' |
|
| 1066 | - ), |
|
| 1067 | - '<h3 style="line-height:1.5em;">', |
|
| 1068 | - '<br /><a href="' |
|
| 1069 | - . EE_Admin_Page::add_query_args_and_nonce( |
|
| 1070 | - array( |
|
| 1071 | - 'action' => 'edit', |
|
| 1072 | - 'post' => $event->ID(), |
|
| 1073 | - ), |
|
| 1074 | - EVENTS_ADMIN_URL |
|
| 1075 | - ) |
|
| 1076 | - . '"> ' |
|
| 1077 | - . $event->get('EVT_name') |
|
| 1078 | - . ' </a> ', |
|
| 1079 | - '</h3>' |
|
| 1080 | - ); |
|
| 1081 | - } |
|
| 1082 | - $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0; |
|
| 1083 | - $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
| 1084 | - if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') { |
|
| 1085 | - $this->_template_args['admin_page_header'] = substr( |
|
| 1086 | - $this->_template_args['admin_page_header'], |
|
| 1087 | - 0, |
|
| 1088 | - -5 |
|
| 1089 | - ); |
|
| 1090 | - $this->_template_args['admin_page_header'] .= ' <span class="drk-grey-text">'; |
|
| 1091 | - $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
| 1092 | - $this->_template_args['admin_page_header'] .= $datetime->name(); |
|
| 1093 | - $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )'; |
|
| 1094 | - $this->_template_args['admin_page_header'] .= '</span></h3>'; |
|
| 1095 | - } |
|
| 1096 | - } |
|
| 1097 | - $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items()); |
|
| 1098 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 1099 | - } |
|
| 1100 | - |
|
| 1101 | - |
|
| 1102 | - /** |
|
| 1103 | - * This sets the _registration property for the registration details screen |
|
| 1104 | - * |
|
| 1105 | - * @access private |
|
| 1106 | - * @return bool |
|
| 1107 | - * @throws EE_Error |
|
| 1108 | - * @throws InvalidArgumentException |
|
| 1109 | - * @throws InvalidDataTypeException |
|
| 1110 | - * @throws InvalidInterfaceException |
|
| 1111 | - */ |
|
| 1112 | - private function _set_registration_object() |
|
| 1113 | - { |
|
| 1114 | - // get out if we've already set the object |
|
| 1115 | - if ($this->_registration instanceof EE_Registration) { |
|
| 1116 | - return true; |
|
| 1117 | - } |
|
| 1118 | - $REG = EEM_Registration::instance(); |
|
| 1119 | - $REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 1120 | - if ($this->_registration = $REG->get_one_by_ID($REG_ID)) { |
|
| 1121 | - return true; |
|
| 1122 | - } else { |
|
| 1123 | - $error_msg = sprintf( |
|
| 1124 | - esc_html__( |
|
| 1125 | - 'An error occurred and the details for Registration ID #%s could not be retrieved.', |
|
| 1126 | - 'event_espresso' |
|
| 1127 | - ), |
|
| 1128 | - $REG_ID |
|
| 1129 | - ); |
|
| 1130 | - EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1131 | - $this->_registration = null; |
|
| 1132 | - return false; |
|
| 1133 | - } |
|
| 1134 | - } |
|
| 1135 | - |
|
| 1136 | - |
|
| 1137 | - /** |
|
| 1138 | - * Used to retrieve registrations for the list table. |
|
| 1139 | - * |
|
| 1140 | - * @param int $per_page |
|
| 1141 | - * @param bool $count |
|
| 1142 | - * @param bool $this_month |
|
| 1143 | - * @param bool $today |
|
| 1144 | - * @return EE_Registration[]|int |
|
| 1145 | - * @throws EE_Error |
|
| 1146 | - * @throws InvalidArgumentException |
|
| 1147 | - * @throws InvalidDataTypeException |
|
| 1148 | - * @throws InvalidInterfaceException |
|
| 1149 | - */ |
|
| 1150 | - public function get_registrations( |
|
| 1151 | - $per_page = 10, |
|
| 1152 | - $count = false, |
|
| 1153 | - $this_month = false, |
|
| 1154 | - $today = false |
|
| 1155 | - ) { |
|
| 1156 | - if ($this_month) { |
|
| 1157 | - $this->_req_data['status'] = 'month'; |
|
| 1158 | - } |
|
| 1159 | - if ($today) { |
|
| 1160 | - $this->_req_data['status'] = 'today'; |
|
| 1161 | - } |
|
| 1162 | - $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count); |
|
| 1163 | - /** |
|
| 1164 | - * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
| 1165 | - * |
|
| 1166 | - * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
| 1167 | - * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1168 | - * or if you have the development copy of EE you can view this at the path: |
|
| 1169 | - * /docs/G--Model-System/model-query-params.md |
|
| 1170 | - */ |
|
| 1171 | - $query_params['group_by'] = ''; |
|
| 1172 | - |
|
| 1173 | - return $count |
|
| 1174 | - ? EEM_Registration::instance()->count($query_params) |
|
| 1175 | - /** @type EE_Registration[] */ |
|
| 1176 | - : EEM_Registration::instance()->get_all($query_params); |
|
| 1177 | - } |
|
| 1178 | - |
|
| 1179 | - |
|
| 1180 | - /** |
|
| 1181 | - * Retrieves the query parameters to be used by the Registration model for getting registrations. |
|
| 1182 | - * Note: this listens to values on the request for some of the query parameters. |
|
| 1183 | - * |
|
| 1184 | - * @param array $request |
|
| 1185 | - * @param int $per_page |
|
| 1186 | - * @param bool $count |
|
| 1187 | - * @return array |
|
| 1188 | - * @throws EE_Error |
|
| 1189 | - */ |
|
| 1190 | - protected function _get_registration_query_parameters( |
|
| 1191 | - $request = array(), |
|
| 1192 | - $per_page = 10, |
|
| 1193 | - $count = false |
|
| 1194 | - ) { |
|
| 1195 | - |
|
| 1196 | - $query_params = array( |
|
| 1197 | - 0 => $this->_get_where_conditions_for_registrations_query( |
|
| 1198 | - $request |
|
| 1199 | - ), |
|
| 1200 | - 'caps' => EEM_Registration::caps_read_admin, |
|
| 1201 | - 'default_where_conditions' => 'this_model_only', |
|
| 1202 | - ); |
|
| 1203 | - if (! $count) { |
|
| 1204 | - $query_params = array_merge( |
|
| 1205 | - $query_params, |
|
| 1206 | - $this->_get_orderby_for_registrations_query(), |
|
| 1207 | - $this->_get_limit($per_page) |
|
| 1208 | - ); |
|
| 1209 | - } |
|
| 1210 | - |
|
| 1211 | - return $query_params; |
|
| 1212 | - } |
|
| 1213 | - |
|
| 1214 | - |
|
| 1215 | - /** |
|
| 1216 | - * This will add ATT_ID to the provided $where array for EE model query parameters. |
|
| 1217 | - * |
|
| 1218 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1219 | - * @return array |
|
| 1220 | - */ |
|
| 1221 | - protected function addAttendeeIdToWhereConditions(array $request) |
|
| 1222 | - { |
|
| 1223 | - $where = array(); |
|
| 1224 | - if (! empty($request['ATT_ID'])) { |
|
| 1225 | - $where['ATT_ID'] = absint($request['ATT_ID']); |
|
| 1226 | - } |
|
| 1227 | - return $where; |
|
| 1228 | - } |
|
| 1229 | - |
|
| 1230 | - |
|
| 1231 | - /** |
|
| 1232 | - * This will add EVT_ID to the provided $where array for EE model query parameters. |
|
| 1233 | - * |
|
| 1234 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1235 | - * @return array |
|
| 1236 | - */ |
|
| 1237 | - protected function _add_event_id_to_where_conditions(array $request) |
|
| 1238 | - { |
|
| 1239 | - $where = array(); |
|
| 1240 | - if (! empty($request['event_id'])) { |
|
| 1241 | - $where['EVT_ID'] = absint($request['event_id']); |
|
| 1242 | - } |
|
| 1243 | - return $where; |
|
| 1244 | - } |
|
| 1245 | - |
|
| 1246 | - |
|
| 1247 | - /** |
|
| 1248 | - * Adds category ID if it exists in the request to the where conditions for the registrations query. |
|
| 1249 | - * |
|
| 1250 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1251 | - * @return array |
|
| 1252 | - */ |
|
| 1253 | - protected function _add_category_id_to_where_conditions(array $request) |
|
| 1254 | - { |
|
| 1255 | - $where = array(); |
|
| 1256 | - if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) { |
|
| 1257 | - $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']); |
|
| 1258 | - } |
|
| 1259 | - return $where; |
|
| 1260 | - } |
|
| 1261 | - |
|
| 1262 | - |
|
| 1263 | - /** |
|
| 1264 | - * Adds the datetime ID if it exists in the request to the where conditions for the registrations query. |
|
| 1265 | - * |
|
| 1266 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1267 | - * @return array |
|
| 1268 | - */ |
|
| 1269 | - protected function _add_datetime_id_to_where_conditions(array $request) |
|
| 1270 | - { |
|
| 1271 | - $where = array(); |
|
| 1272 | - if (! empty($request['datetime_id'])) { |
|
| 1273 | - $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']); |
|
| 1274 | - } |
|
| 1275 | - if (! empty($request['DTT_ID'])) { |
|
| 1276 | - $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']); |
|
| 1277 | - } |
|
| 1278 | - return $where; |
|
| 1279 | - } |
|
| 1280 | - |
|
| 1281 | - |
|
| 1282 | - /** |
|
| 1283 | - * Adds the correct registration status to the where conditions for the registrations query. |
|
| 1284 | - * |
|
| 1285 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1286 | - * @return array |
|
| 1287 | - */ |
|
| 1288 | - protected function _add_registration_status_to_where_conditions(array $request) |
|
| 1289 | - { |
|
| 1290 | - $where = array(); |
|
| 1291 | - $view = EEH_Array::is_set($request, 'status', ''); |
|
| 1292 | - $registration_status = ! empty($request['_reg_status']) |
|
| 1293 | - ? sanitize_text_field($request['_reg_status']) |
|
| 1294 | - : ''; |
|
| 1295 | - |
|
| 1296 | - /* |
|
| 22 | + /** |
|
| 23 | + * @var EE_Registration |
|
| 24 | + */ |
|
| 25 | + private $_registration; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * @var EE_Event |
|
| 29 | + */ |
|
| 30 | + private $_reg_event; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var EE_Session |
|
| 34 | + */ |
|
| 35 | + private $_session; |
|
| 36 | + |
|
| 37 | + private static $_reg_status; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * Form for displaying the custom questions for this registration. |
|
| 41 | + * This gets used a few times throughout the request so its best to cache it |
|
| 42 | + * |
|
| 43 | + * @var EE_Registration_Custom_Questions_Form |
|
| 44 | + */ |
|
| 45 | + protected $_reg_custom_questions_form = null; |
|
| 46 | + |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * constructor |
|
| 50 | + * |
|
| 51 | + * @Constructor |
|
| 52 | + * @access public |
|
| 53 | + * @param bool $routing |
|
| 54 | + * @return Registrations_Admin_Page |
|
| 55 | + */ |
|
| 56 | + public function __construct($routing = true) |
|
| 57 | + { |
|
| 58 | + parent::__construct($routing); |
|
| 59 | + add_action('wp_loaded', array($this, 'wp_loaded')); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + public function wp_loaded() |
|
| 64 | + { |
|
| 65 | + // when adding a new registration... |
|
| 66 | + if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') { |
|
| 67 | + EE_System::do_not_cache(); |
|
| 68 | + if (! isset($this->_req_data['processing_registration']) |
|
| 69 | + || absint($this->_req_data['processing_registration']) !== 1 |
|
| 70 | + ) { |
|
| 71 | + // and it's NOT the attendee information reg step |
|
| 72 | + // force cookie expiration by setting time to last week |
|
| 73 | + setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/'); |
|
| 74 | + // and update the global |
|
| 75 | + $_COOKIE['ee_registration_added'] = 0; |
|
| 76 | + } |
|
| 77 | + } |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + |
|
| 81 | + protected function _init_page_props() |
|
| 82 | + { |
|
| 83 | + $this->page_slug = REG_PG_SLUG; |
|
| 84 | + $this->_admin_base_url = REG_ADMIN_URL; |
|
| 85 | + $this->_admin_base_path = REG_ADMIN; |
|
| 86 | + $this->page_label = esc_html__('Registrations', 'event_espresso'); |
|
| 87 | + $this->_cpt_routes = array( |
|
| 88 | + 'add_new_attendee' => 'espresso_attendees', |
|
| 89 | + 'edit_attendee' => 'espresso_attendees', |
|
| 90 | + 'insert_attendee' => 'espresso_attendees', |
|
| 91 | + 'update_attendee' => 'espresso_attendees', |
|
| 92 | + ); |
|
| 93 | + $this->_cpt_model_names = array( |
|
| 94 | + 'add_new_attendee' => 'EEM_Attendee', |
|
| 95 | + 'edit_attendee' => 'EEM_Attendee', |
|
| 96 | + ); |
|
| 97 | + $this->_cpt_edit_routes = array( |
|
| 98 | + 'espresso_attendees' => 'edit_attendee', |
|
| 99 | + ); |
|
| 100 | + $this->_pagenow_map = array( |
|
| 101 | + 'add_new_attendee' => 'post-new.php', |
|
| 102 | + 'edit_attendee' => 'post.php', |
|
| 103 | + 'trash' => 'post.php', |
|
| 104 | + ); |
|
| 105 | + add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10); |
|
| 106 | + // add filters so that the comment urls don't take users to a confusing 404 page |
|
| 107 | + add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + |
|
| 111 | + public function clear_comment_link($link, $comment, $args) |
|
| 112 | + { |
|
| 113 | + // gotta make sure this only happens on this route |
|
| 114 | + $post_type = get_post_type($comment->comment_post_ID); |
|
| 115 | + if ($post_type === 'espresso_attendees') { |
|
| 116 | + return '#commentsdiv'; |
|
| 117 | + } |
|
| 118 | + return $link; |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + |
|
| 122 | + protected function _ajax_hooks() |
|
| 123 | + { |
|
| 124 | + // todo: all hooks for registrations ajax goes in here |
|
| 125 | + add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status')); |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + |
|
| 129 | + protected function _define_page_props() |
|
| 130 | + { |
|
| 131 | + $this->_admin_page_title = $this->page_label; |
|
| 132 | + $this->_labels = array( |
|
| 133 | + 'buttons' => array( |
|
| 134 | + 'add-registrant' => esc_html__('Add New Registration', 'event_espresso'), |
|
| 135 | + 'add-attendee' => esc_html__('Add Contact', 'event_espresso'), |
|
| 136 | + 'edit' => esc_html__('Edit Contact', 'event_espresso'), |
|
| 137 | + 'report' => esc_html__("Event Registrations CSV Report", "event_espresso"), |
|
| 138 | + 'report_all' => esc_html__('All Registrations CSV Report', 'event_espresso'), |
|
| 139 | + 'report_filtered' => esc_html__('Filtered CSV Report', 'event_espresso'), |
|
| 140 | + 'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'), |
|
| 141 | + 'contact_list_export' => esc_html__("Export Data", "event_espresso"), |
|
| 142 | + ), |
|
| 143 | + 'publishbox' => array( |
|
| 144 | + 'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'), |
|
| 145 | + 'edit_attendee' => esc_html__("Update Contact Record", 'event_espresso'), |
|
| 146 | + ), |
|
| 147 | + 'hide_add_button_on_cpt_route' => array( |
|
| 148 | + 'edit_attendee' => true, |
|
| 149 | + ), |
|
| 150 | + ); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * grab url requests and route them |
|
| 156 | + * |
|
| 157 | + * @access private |
|
| 158 | + * @return void |
|
| 159 | + */ |
|
| 160 | + public function _set_page_routes() |
|
| 161 | + { |
|
| 162 | + $this->_get_registration_status_array(); |
|
| 163 | + $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
| 164 | + ? $this->_req_data['_REG_ID'] : 0; |
|
| 165 | + $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID']) |
|
| 166 | + ? $this->_req_data['reg_status_change_form']['REG_ID'] |
|
| 167 | + : $reg_id; |
|
| 168 | + $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID']) |
|
| 169 | + ? $this->_req_data['ATT_ID'] : 0; |
|
| 170 | + $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) |
|
| 171 | + ? $this->_req_data['post'] |
|
| 172 | + : $att_id; |
|
| 173 | + $this->_page_routes = array( |
|
| 174 | + 'default' => array( |
|
| 175 | + 'func' => '_registrations_overview_list_table', |
|
| 176 | + 'capability' => 'ee_read_registrations', |
|
| 177 | + ), |
|
| 178 | + 'view_registration' => array( |
|
| 179 | + 'func' => '_registration_details', |
|
| 180 | + 'capability' => 'ee_read_registration', |
|
| 181 | + 'obj_id' => $reg_id, |
|
| 182 | + ), |
|
| 183 | + 'edit_registration' => array( |
|
| 184 | + 'func' => '_update_attendee_registration_form', |
|
| 185 | + 'noheader' => true, |
|
| 186 | + 'headers_sent_route' => 'view_registration', |
|
| 187 | + 'capability' => 'ee_edit_registration', |
|
| 188 | + 'obj_id' => $reg_id, |
|
| 189 | + '_REG_ID' => $reg_id, |
|
| 190 | + ), |
|
| 191 | + 'trash_registrations' => array( |
|
| 192 | + 'func' => '_trash_or_restore_registrations', |
|
| 193 | + 'args' => array('trash' => true), |
|
| 194 | + 'noheader' => true, |
|
| 195 | + 'capability' => 'ee_delete_registrations', |
|
| 196 | + ), |
|
| 197 | + 'restore_registrations' => array( |
|
| 198 | + 'func' => '_trash_or_restore_registrations', |
|
| 199 | + 'args' => array('trash' => false), |
|
| 200 | + 'noheader' => true, |
|
| 201 | + 'capability' => 'ee_delete_registrations', |
|
| 202 | + ), |
|
| 203 | + 'delete_registrations' => array( |
|
| 204 | + 'func' => '_delete_registrations', |
|
| 205 | + 'noheader' => true, |
|
| 206 | + 'capability' => 'ee_delete_registrations', |
|
| 207 | + ), |
|
| 208 | + 'new_registration' => array( |
|
| 209 | + 'func' => 'new_registration', |
|
| 210 | + 'capability' => 'ee_edit_registrations', |
|
| 211 | + ), |
|
| 212 | + 'process_reg_step' => array( |
|
| 213 | + 'func' => 'process_reg_step', |
|
| 214 | + 'noheader' => true, |
|
| 215 | + 'capability' => 'ee_edit_registrations', |
|
| 216 | + ), |
|
| 217 | + 'redirect_to_txn' => array( |
|
| 218 | + 'func' => 'redirect_to_txn', |
|
| 219 | + 'noheader' => true, |
|
| 220 | + 'capability' => 'ee_edit_registrations', |
|
| 221 | + ), |
|
| 222 | + 'change_reg_status' => array( |
|
| 223 | + 'func' => '_change_reg_status', |
|
| 224 | + 'noheader' => true, |
|
| 225 | + 'capability' => 'ee_edit_registration', |
|
| 226 | + 'obj_id' => $reg_id, |
|
| 227 | + ), |
|
| 228 | + 'approve_registration' => array( |
|
| 229 | + 'func' => 'approve_registration', |
|
| 230 | + 'noheader' => true, |
|
| 231 | + 'capability' => 'ee_edit_registration', |
|
| 232 | + 'obj_id' => $reg_id, |
|
| 233 | + ), |
|
| 234 | + 'approve_and_notify_registration' => array( |
|
| 235 | + 'func' => 'approve_registration', |
|
| 236 | + 'noheader' => true, |
|
| 237 | + 'args' => array(true), |
|
| 238 | + 'capability' => 'ee_edit_registration', |
|
| 239 | + 'obj_id' => $reg_id, |
|
| 240 | + ), |
|
| 241 | + 'approve_registrations' => array( |
|
| 242 | + 'func' => 'bulk_action_on_registrations', |
|
| 243 | + 'noheader' => true, |
|
| 244 | + 'capability' => 'ee_edit_registrations', |
|
| 245 | + 'args' => array('approve'), |
|
| 246 | + ), |
|
| 247 | + 'approve_and_notify_registrations' => array( |
|
| 248 | + 'func' => 'bulk_action_on_registrations', |
|
| 249 | + 'noheader' => true, |
|
| 250 | + 'capability' => 'ee_edit_registrations', |
|
| 251 | + 'args' => array('approve', true), |
|
| 252 | + ), |
|
| 253 | + 'decline_registration' => array( |
|
| 254 | + 'func' => 'decline_registration', |
|
| 255 | + 'noheader' => true, |
|
| 256 | + 'capability' => 'ee_edit_registration', |
|
| 257 | + 'obj_id' => $reg_id, |
|
| 258 | + ), |
|
| 259 | + 'decline_and_notify_registration' => array( |
|
| 260 | + 'func' => 'decline_registration', |
|
| 261 | + 'noheader' => true, |
|
| 262 | + 'args' => array(true), |
|
| 263 | + 'capability' => 'ee_edit_registration', |
|
| 264 | + 'obj_id' => $reg_id, |
|
| 265 | + ), |
|
| 266 | + 'decline_registrations' => array( |
|
| 267 | + 'func' => 'bulk_action_on_registrations', |
|
| 268 | + 'noheader' => true, |
|
| 269 | + 'capability' => 'ee_edit_registrations', |
|
| 270 | + 'args' => array('decline'), |
|
| 271 | + ), |
|
| 272 | + 'decline_and_notify_registrations' => array( |
|
| 273 | + 'func' => 'bulk_action_on_registrations', |
|
| 274 | + 'noheader' => true, |
|
| 275 | + 'capability' => 'ee_edit_registrations', |
|
| 276 | + 'args' => array('decline', true), |
|
| 277 | + ), |
|
| 278 | + 'pending_registration' => array( |
|
| 279 | + 'func' => 'pending_registration', |
|
| 280 | + 'noheader' => true, |
|
| 281 | + 'capability' => 'ee_edit_registration', |
|
| 282 | + 'obj_id' => $reg_id, |
|
| 283 | + ), |
|
| 284 | + 'pending_and_notify_registration' => array( |
|
| 285 | + 'func' => 'pending_registration', |
|
| 286 | + 'noheader' => true, |
|
| 287 | + 'args' => array(true), |
|
| 288 | + 'capability' => 'ee_edit_registration', |
|
| 289 | + 'obj_id' => $reg_id, |
|
| 290 | + ), |
|
| 291 | + 'pending_registrations' => array( |
|
| 292 | + 'func' => 'bulk_action_on_registrations', |
|
| 293 | + 'noheader' => true, |
|
| 294 | + 'capability' => 'ee_edit_registrations', |
|
| 295 | + 'args' => array('pending'), |
|
| 296 | + ), |
|
| 297 | + 'pending_and_notify_registrations' => array( |
|
| 298 | + 'func' => 'bulk_action_on_registrations', |
|
| 299 | + 'noheader' => true, |
|
| 300 | + 'capability' => 'ee_edit_registrations', |
|
| 301 | + 'args' => array('pending', true), |
|
| 302 | + ), |
|
| 303 | + 'no_approve_registration' => array( |
|
| 304 | + 'func' => 'not_approve_registration', |
|
| 305 | + 'noheader' => true, |
|
| 306 | + 'capability' => 'ee_edit_registration', |
|
| 307 | + 'obj_id' => $reg_id, |
|
| 308 | + ), |
|
| 309 | + 'no_approve_and_notify_registration' => array( |
|
| 310 | + 'func' => 'not_approve_registration', |
|
| 311 | + 'noheader' => true, |
|
| 312 | + 'args' => array(true), |
|
| 313 | + 'capability' => 'ee_edit_registration', |
|
| 314 | + 'obj_id' => $reg_id, |
|
| 315 | + ), |
|
| 316 | + 'no_approve_registrations' => array( |
|
| 317 | + 'func' => 'bulk_action_on_registrations', |
|
| 318 | + 'noheader' => true, |
|
| 319 | + 'capability' => 'ee_edit_registrations', |
|
| 320 | + 'args' => array('not_approve'), |
|
| 321 | + ), |
|
| 322 | + 'no_approve_and_notify_registrations' => array( |
|
| 323 | + 'func' => 'bulk_action_on_registrations', |
|
| 324 | + 'noheader' => true, |
|
| 325 | + 'capability' => 'ee_edit_registrations', |
|
| 326 | + 'args' => array('not_approve', true), |
|
| 327 | + ), |
|
| 328 | + 'cancel_registration' => array( |
|
| 329 | + 'func' => 'cancel_registration', |
|
| 330 | + 'noheader' => true, |
|
| 331 | + 'capability' => 'ee_edit_registration', |
|
| 332 | + 'obj_id' => $reg_id, |
|
| 333 | + ), |
|
| 334 | + 'cancel_and_notify_registration' => array( |
|
| 335 | + 'func' => 'cancel_registration', |
|
| 336 | + 'noheader' => true, |
|
| 337 | + 'args' => array(true), |
|
| 338 | + 'capability' => 'ee_edit_registration', |
|
| 339 | + 'obj_id' => $reg_id, |
|
| 340 | + ), |
|
| 341 | + 'cancel_registrations' => array( |
|
| 342 | + 'func' => 'bulk_action_on_registrations', |
|
| 343 | + 'noheader' => true, |
|
| 344 | + 'capability' => 'ee_edit_registrations', |
|
| 345 | + 'args' => array('cancel'), |
|
| 346 | + ), |
|
| 347 | + 'cancel_and_notify_registrations' => array( |
|
| 348 | + 'func' => 'bulk_action_on_registrations', |
|
| 349 | + 'noheader' => true, |
|
| 350 | + 'capability' => 'ee_edit_registrations', |
|
| 351 | + 'args' => array('cancel', true), |
|
| 352 | + ), |
|
| 353 | + 'wait_list_registration' => array( |
|
| 354 | + 'func' => 'wait_list_registration', |
|
| 355 | + 'noheader' => true, |
|
| 356 | + 'capability' => 'ee_edit_registration', |
|
| 357 | + 'obj_id' => $reg_id, |
|
| 358 | + ), |
|
| 359 | + 'wait_list_and_notify_registration' => array( |
|
| 360 | + 'func' => 'wait_list_registration', |
|
| 361 | + 'noheader' => true, |
|
| 362 | + 'args' => array(true), |
|
| 363 | + 'capability' => 'ee_edit_registration', |
|
| 364 | + 'obj_id' => $reg_id, |
|
| 365 | + ), |
|
| 366 | + 'contact_list' => array( |
|
| 367 | + 'func' => '_attendee_contact_list_table', |
|
| 368 | + 'capability' => 'ee_read_contacts', |
|
| 369 | + ), |
|
| 370 | + 'add_new_attendee' => array( |
|
| 371 | + 'func' => '_create_new_cpt_item', |
|
| 372 | + 'args' => array( |
|
| 373 | + 'new_attendee' => true, |
|
| 374 | + 'capability' => 'ee_edit_contacts', |
|
| 375 | + ), |
|
| 376 | + ), |
|
| 377 | + 'edit_attendee' => array( |
|
| 378 | + 'func' => '_edit_cpt_item', |
|
| 379 | + 'capability' => 'ee_edit_contacts', |
|
| 380 | + 'obj_id' => $att_id, |
|
| 381 | + ), |
|
| 382 | + 'duplicate_attendee' => array( |
|
| 383 | + 'func' => '_duplicate_attendee', |
|
| 384 | + 'noheader' => true, |
|
| 385 | + 'capability' => 'ee_edit_contacts', |
|
| 386 | + 'obj_id' => $att_id, |
|
| 387 | + ), |
|
| 388 | + 'insert_attendee' => array( |
|
| 389 | + 'func' => '_insert_or_update_attendee', |
|
| 390 | + 'args' => array( |
|
| 391 | + 'new_attendee' => true, |
|
| 392 | + ), |
|
| 393 | + 'noheader' => true, |
|
| 394 | + 'capability' => 'ee_edit_contacts', |
|
| 395 | + ), |
|
| 396 | + 'update_attendee' => array( |
|
| 397 | + 'func' => '_insert_or_update_attendee', |
|
| 398 | + 'args' => array( |
|
| 399 | + 'new_attendee' => false, |
|
| 400 | + ), |
|
| 401 | + 'noheader' => true, |
|
| 402 | + 'capability' => 'ee_edit_contacts', |
|
| 403 | + 'obj_id' => $att_id, |
|
| 404 | + ), |
|
| 405 | + 'trash_attendees' => array( |
|
| 406 | + 'func' => '_trash_or_restore_attendees', |
|
| 407 | + 'args' => array( |
|
| 408 | + 'trash' => 'true', |
|
| 409 | + ), |
|
| 410 | + 'noheader' => true, |
|
| 411 | + 'capability' => 'ee_delete_contacts', |
|
| 412 | + ), |
|
| 413 | + 'trash_attendee' => array( |
|
| 414 | + 'func' => '_trash_or_restore_attendees', |
|
| 415 | + 'args' => array( |
|
| 416 | + 'trash' => true, |
|
| 417 | + ), |
|
| 418 | + 'noheader' => true, |
|
| 419 | + 'capability' => 'ee_delete_contacts', |
|
| 420 | + 'obj_id' => $att_id, |
|
| 421 | + ), |
|
| 422 | + 'restore_attendees' => array( |
|
| 423 | + 'func' => '_trash_or_restore_attendees', |
|
| 424 | + 'args' => array( |
|
| 425 | + 'trash' => false, |
|
| 426 | + ), |
|
| 427 | + 'noheader' => true, |
|
| 428 | + 'capability' => 'ee_delete_contacts', |
|
| 429 | + 'obj_id' => $att_id, |
|
| 430 | + ), |
|
| 431 | + 'resend_registration' => array( |
|
| 432 | + 'func' => '_resend_registration', |
|
| 433 | + 'noheader' => true, |
|
| 434 | + 'capability' => 'ee_send_message', |
|
| 435 | + ), |
|
| 436 | + 'registrations_report' => array( |
|
| 437 | + 'func' => '_registrations_report', |
|
| 438 | + 'noheader' => true, |
|
| 439 | + 'capability' => 'ee_read_registrations', |
|
| 440 | + ), |
|
| 441 | + 'contact_list_export' => array( |
|
| 442 | + 'func' => '_contact_list_export', |
|
| 443 | + 'noheader' => true, |
|
| 444 | + 'capability' => 'export', |
|
| 445 | + ), |
|
| 446 | + 'contact_list_report' => array( |
|
| 447 | + 'func' => '_contact_list_report', |
|
| 448 | + 'noheader' => true, |
|
| 449 | + 'capability' => 'ee_read_contacts', |
|
| 450 | + ), |
|
| 451 | + ); |
|
| 452 | + } |
|
| 453 | + |
|
| 454 | + |
|
| 455 | + protected function _set_page_config() |
|
| 456 | + { |
|
| 457 | + $this->_page_config = array( |
|
| 458 | + 'default' => array( |
|
| 459 | + 'nav' => array( |
|
| 460 | + 'label' => esc_html__('Overview', 'event_espresso'), |
|
| 461 | + 'order' => 5, |
|
| 462 | + ), |
|
| 463 | + 'help_tabs' => array( |
|
| 464 | + 'registrations_overview_help_tab' => array( |
|
| 465 | + 'title' => esc_html__('Registrations Overview', 'event_espresso'), |
|
| 466 | + 'filename' => 'registrations_overview', |
|
| 467 | + ), |
|
| 468 | + 'registrations_overview_table_column_headings_help_tab' => array( |
|
| 469 | + 'title' => esc_html__('Registrations Table Column Headings', 'event_espresso'), |
|
| 470 | + 'filename' => 'registrations_overview_table_column_headings', |
|
| 471 | + ), |
|
| 472 | + 'registrations_overview_filters_help_tab' => array( |
|
| 473 | + 'title' => esc_html__('Registration Filters', 'event_espresso'), |
|
| 474 | + 'filename' => 'registrations_overview_filters', |
|
| 475 | + ), |
|
| 476 | + 'registrations_overview_views_help_tab' => array( |
|
| 477 | + 'title' => esc_html__('Registration Views', 'event_espresso'), |
|
| 478 | + 'filename' => 'registrations_overview_views', |
|
| 479 | + ), |
|
| 480 | + 'registrations_regoverview_other_help_tab' => array( |
|
| 481 | + 'title' => esc_html__('Registrations Other', 'event_espresso'), |
|
| 482 | + 'filename' => 'registrations_overview_other', |
|
| 483 | + ), |
|
| 484 | + ), |
|
| 485 | + 'help_tour' => array('Registration_Overview_Help_Tour'), |
|
| 486 | + 'qtips' => array('Registration_List_Table_Tips'), |
|
| 487 | + 'list_table' => 'EE_Registrations_List_Table', |
|
| 488 | + 'require_nonce' => false, |
|
| 489 | + ), |
|
| 490 | + 'view_registration' => array( |
|
| 491 | + 'nav' => array( |
|
| 492 | + 'label' => esc_html__('REG Details', 'event_espresso'), |
|
| 493 | + 'order' => 15, |
|
| 494 | + 'url' => isset($this->_req_data['_REG_ID']) |
|
| 495 | + ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url) |
|
| 496 | + : $this->_admin_base_url, |
|
| 497 | + 'persistent' => false, |
|
| 498 | + ), |
|
| 499 | + 'help_tabs' => array( |
|
| 500 | + 'registrations_details_help_tab' => array( |
|
| 501 | + 'title' => esc_html__('Registration Details', 'event_espresso'), |
|
| 502 | + 'filename' => 'registrations_details', |
|
| 503 | + ), |
|
| 504 | + 'registrations_details_table_help_tab' => array( |
|
| 505 | + 'title' => esc_html__('Registration Details Table', 'event_espresso'), |
|
| 506 | + 'filename' => 'registrations_details_table', |
|
| 507 | + ), |
|
| 508 | + 'registrations_details_form_answers_help_tab' => array( |
|
| 509 | + 'title' => esc_html__('Registration Form Answers', 'event_espresso'), |
|
| 510 | + 'filename' => 'registrations_details_form_answers', |
|
| 511 | + ), |
|
| 512 | + 'registrations_details_registrant_details_help_tab' => array( |
|
| 513 | + 'title' => esc_html__('Contact Details', 'event_espresso'), |
|
| 514 | + 'filename' => 'registrations_details_registrant_details', |
|
| 515 | + ), |
|
| 516 | + ), |
|
| 517 | + 'help_tour' => array('Registration_Details_Help_Tour'), |
|
| 518 | + 'metaboxes' => array_merge( |
|
| 519 | + $this->_default_espresso_metaboxes, |
|
| 520 | + array('_registration_details_metaboxes') |
|
| 521 | + ), |
|
| 522 | + 'require_nonce' => false, |
|
| 523 | + ), |
|
| 524 | + 'new_registration' => array( |
|
| 525 | + 'nav' => array( |
|
| 526 | + 'label' => esc_html__('Add New Registration', 'event_espresso'), |
|
| 527 | + 'url' => '#', |
|
| 528 | + 'order' => 15, |
|
| 529 | + 'persistent' => false, |
|
| 530 | + ), |
|
| 531 | + 'metaboxes' => $this->_default_espresso_metaboxes, |
|
| 532 | + 'labels' => array( |
|
| 533 | + 'publishbox' => esc_html__('Save Registration', 'event_espresso'), |
|
| 534 | + ), |
|
| 535 | + 'require_nonce' => false, |
|
| 536 | + ), |
|
| 537 | + 'add_new_attendee' => array( |
|
| 538 | + 'nav' => array( |
|
| 539 | + 'label' => esc_html__('Add Contact', 'event_espresso'), |
|
| 540 | + 'order' => 15, |
|
| 541 | + 'persistent' => false, |
|
| 542 | + ), |
|
| 543 | + 'metaboxes' => array_merge( |
|
| 544 | + $this->_default_espresso_metaboxes, |
|
| 545 | + array('_publish_post_box', 'attendee_editor_metaboxes') |
|
| 546 | + ), |
|
| 547 | + 'require_nonce' => false, |
|
| 548 | + ), |
|
| 549 | + 'edit_attendee' => array( |
|
| 550 | + 'nav' => array( |
|
| 551 | + 'label' => esc_html__('Edit Contact', 'event_espresso'), |
|
| 552 | + 'order' => 15, |
|
| 553 | + 'persistent' => false, |
|
| 554 | + 'url' => isset($this->_req_data['ATT_ID']) |
|
| 555 | + ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url) |
|
| 556 | + : $this->_admin_base_url, |
|
| 557 | + ), |
|
| 558 | + 'metaboxes' => array('attendee_editor_metaboxes'), |
|
| 559 | + 'require_nonce' => false, |
|
| 560 | + ), |
|
| 561 | + 'contact_list' => array( |
|
| 562 | + 'nav' => array( |
|
| 563 | + 'label' => esc_html__('Contact List', 'event_espresso'), |
|
| 564 | + 'order' => 20, |
|
| 565 | + ), |
|
| 566 | + 'list_table' => 'EE_Attendee_Contact_List_Table', |
|
| 567 | + 'help_tabs' => array( |
|
| 568 | + 'registrations_contact_list_help_tab' => array( |
|
| 569 | + 'title' => esc_html__('Registrations Contact List', 'event_espresso'), |
|
| 570 | + 'filename' => 'registrations_contact_list', |
|
| 571 | + ), |
|
| 572 | + 'registrations_contact-list_table_column_headings_help_tab' => array( |
|
| 573 | + 'title' => esc_html__('Contact List Table Column Headings', 'event_espresso'), |
|
| 574 | + 'filename' => 'registrations_contact_list_table_column_headings', |
|
| 575 | + ), |
|
| 576 | + 'registrations_contact_list_views_help_tab' => array( |
|
| 577 | + 'title' => esc_html__('Contact List Views', 'event_espresso'), |
|
| 578 | + 'filename' => 'registrations_contact_list_views', |
|
| 579 | + ), |
|
| 580 | + 'registrations_contact_list_other_help_tab' => array( |
|
| 581 | + 'title' => esc_html__('Contact List Other', 'event_espresso'), |
|
| 582 | + 'filename' => 'registrations_contact_list_other', |
|
| 583 | + ), |
|
| 584 | + ), |
|
| 585 | + 'help_tour' => array('Contact_List_Help_Tour'), |
|
| 586 | + 'metaboxes' => array(), |
|
| 587 | + 'require_nonce' => false, |
|
| 588 | + ), |
|
| 589 | + // override default cpt routes |
|
| 590 | + 'create_new' => '', |
|
| 591 | + 'edit' => '', |
|
| 592 | + ); |
|
| 593 | + } |
|
| 594 | + |
|
| 595 | + |
|
| 596 | + /** |
|
| 597 | + * The below methods aren't used by this class currently |
|
| 598 | + */ |
|
| 599 | + protected function _add_screen_options() |
|
| 600 | + { |
|
| 601 | + } |
|
| 602 | + |
|
| 603 | + |
|
| 604 | + protected function _add_feature_pointers() |
|
| 605 | + { |
|
| 606 | + } |
|
| 607 | + |
|
| 608 | + |
|
| 609 | + public function admin_init() |
|
| 610 | + { |
|
| 611 | + EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__( |
|
| 612 | + 'click "Update Registration Questions" to save your changes', |
|
| 613 | + 'event_espresso' |
|
| 614 | + ); |
|
| 615 | + } |
|
| 616 | + |
|
| 617 | + |
|
| 618 | + public function admin_notices() |
|
| 619 | + { |
|
| 620 | + } |
|
| 621 | + |
|
| 622 | + |
|
| 623 | + public function admin_footer_scripts() |
|
| 624 | + { |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + |
|
| 628 | + /** |
|
| 629 | + * get list of registration statuses |
|
| 630 | + * |
|
| 631 | + * @access private |
|
| 632 | + * @return void |
|
| 633 | + * @throws EE_Error |
|
| 634 | + */ |
|
| 635 | + private function _get_registration_status_array() |
|
| 636 | + { |
|
| 637 | + self::$_reg_status = EEM_Registration::reg_status_array(array(), true); |
|
| 638 | + } |
|
| 639 | + |
|
| 640 | + |
|
| 641 | + protected function _add_screen_options_default() |
|
| 642 | + { |
|
| 643 | + $this->_per_page_screen_option(); |
|
| 644 | + } |
|
| 645 | + |
|
| 646 | + |
|
| 647 | + protected function _add_screen_options_contact_list() |
|
| 648 | + { |
|
| 649 | + $page_title = $this->_admin_page_title; |
|
| 650 | + $this->_admin_page_title = esc_html__("Contacts", 'event_espresso'); |
|
| 651 | + $this->_per_page_screen_option(); |
|
| 652 | + $this->_admin_page_title = $page_title; |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + |
|
| 656 | + public function load_scripts_styles() |
|
| 657 | + { |
|
| 658 | + // style |
|
| 659 | + wp_register_style( |
|
| 660 | + 'espresso_reg', |
|
| 661 | + REG_ASSETS_URL . 'espresso_registrations_admin.css', |
|
| 662 | + array('ee-admin-css'), |
|
| 663 | + EVENT_ESPRESSO_VERSION |
|
| 664 | + ); |
|
| 665 | + wp_enqueue_style('espresso_reg'); |
|
| 666 | + // script |
|
| 667 | + wp_register_script( |
|
| 668 | + 'espresso_reg', |
|
| 669 | + REG_ASSETS_URL . 'espresso_registrations_admin.js', |
|
| 670 | + array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), |
|
| 671 | + EVENT_ESPRESSO_VERSION, |
|
| 672 | + true |
|
| 673 | + ); |
|
| 674 | + wp_enqueue_script('espresso_reg'); |
|
| 675 | + } |
|
| 676 | + |
|
| 677 | + |
|
| 678 | + public function load_scripts_styles_edit_attendee() |
|
| 679 | + { |
|
| 680 | + // stuff to only show up on our attendee edit details page. |
|
| 681 | + $attendee_details_translations = array( |
|
| 682 | + 'att_publish_text' => sprintf( |
|
| 683 | + esc_html__('Created on: <b>%1$s</b>', 'event_espresso'), |
|
| 684 | + $this->_cpt_model_obj->get_datetime('ATT_created') |
|
| 685 | + ), |
|
| 686 | + ); |
|
| 687 | + wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations); |
|
| 688 | + wp_enqueue_script('jquery-validate'); |
|
| 689 | + } |
|
| 690 | + |
|
| 691 | + |
|
| 692 | + public function load_scripts_styles_view_registration() |
|
| 693 | + { |
|
| 694 | + // styles |
|
| 695 | + wp_enqueue_style('espresso-ui-theme'); |
|
| 696 | + // scripts |
|
| 697 | + $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
| 698 | + $this->_reg_custom_questions_form->wp_enqueue_scripts(true); |
|
| 699 | + } |
|
| 700 | + |
|
| 701 | + |
|
| 702 | + public function load_scripts_styles_contact_list() |
|
| 703 | + { |
|
| 704 | + wp_dequeue_style('espresso_reg'); |
|
| 705 | + wp_register_style( |
|
| 706 | + 'espresso_att', |
|
| 707 | + REG_ASSETS_URL . 'espresso_attendees_admin.css', |
|
| 708 | + array('ee-admin-css'), |
|
| 709 | + EVENT_ESPRESSO_VERSION |
|
| 710 | + ); |
|
| 711 | + wp_enqueue_style('espresso_att'); |
|
| 712 | + } |
|
| 713 | + |
|
| 714 | + |
|
| 715 | + public function load_scripts_styles_new_registration() |
|
| 716 | + { |
|
| 717 | + wp_register_script( |
|
| 718 | + 'ee-spco-for-admin', |
|
| 719 | + REG_ASSETS_URL . 'spco_for_admin.js', |
|
| 720 | + array('underscore', 'jquery'), |
|
| 721 | + EVENT_ESPRESSO_VERSION, |
|
| 722 | + true |
|
| 723 | + ); |
|
| 724 | + wp_enqueue_script('ee-spco-for-admin'); |
|
| 725 | + add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
| 726 | + EE_Form_Section_Proper::wp_enqueue_scripts(); |
|
| 727 | + EED_Ticket_Selector::load_tckt_slctr_assets(); |
|
| 728 | + EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
| 729 | + } |
|
| 730 | + |
|
| 731 | + |
|
| 732 | + public function AHEE__EE_Admin_Page__route_admin_request_resend_registration() |
|
| 733 | + { |
|
| 734 | + add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + |
|
| 738 | + public function AHEE__EE_Admin_Page__route_admin_request_approve_registration() |
|
| 739 | + { |
|
| 740 | + add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 741 | + } |
|
| 742 | + |
|
| 743 | + |
|
| 744 | + protected function _set_list_table_views_default() |
|
| 745 | + { |
|
| 746 | + // for notification related bulk actions we need to make sure only active messengers have an option. |
|
| 747 | + EED_Messages::set_autoloaders(); |
|
| 748 | + /** @type EE_Message_Resource_Manager $message_resource_manager */ |
|
| 749 | + $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 750 | + $active_mts = $message_resource_manager->list_of_active_message_types(); |
|
| 751 | + // key= bulk_action_slug, value= message type. |
|
| 752 | + $match_array = array( |
|
| 753 | + 'approve_registrations' => 'registration', |
|
| 754 | + 'decline_registrations' => 'declined_registration', |
|
| 755 | + 'pending_registrations' => 'pending_approval', |
|
| 756 | + 'no_approve_registrations' => 'not_approved_registration', |
|
| 757 | + 'cancel_registrations' => 'cancelled_registration', |
|
| 758 | + ); |
|
| 759 | + $can_send = EE_Registry::instance()->CAP->current_user_can( |
|
| 760 | + 'ee_send_message', |
|
| 761 | + 'batch_send_messages' |
|
| 762 | + ); |
|
| 763 | + /** setup reg status bulk actions **/ |
|
| 764 | + $def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso'); |
|
| 765 | + if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) { |
|
| 766 | + $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__( |
|
| 767 | + 'Approve and Notify Registrations', |
|
| 768 | + 'event_espresso' |
|
| 769 | + ); |
|
| 770 | + } |
|
| 771 | + $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso'); |
|
| 772 | + if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) { |
|
| 773 | + $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__( |
|
| 774 | + 'Decline and Notify Registrations', |
|
| 775 | + 'event_espresso' |
|
| 776 | + ); |
|
| 777 | + } |
|
| 778 | + $def_reg_status_actions['pending_registrations'] = esc_html__( |
|
| 779 | + 'Set Registrations to Pending Payment', |
|
| 780 | + 'event_espresso' |
|
| 781 | + ); |
|
| 782 | + if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) { |
|
| 783 | + $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__( |
|
| 784 | + 'Set Registrations to Pending Payment and Notify', |
|
| 785 | + 'event_espresso' |
|
| 786 | + ); |
|
| 787 | + } |
|
| 788 | + $def_reg_status_actions['no_approve_registrations'] = esc_html__( |
|
| 789 | + 'Set Registrations to Not Approved', |
|
| 790 | + 'event_espresso' |
|
| 791 | + ); |
|
| 792 | + if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) { |
|
| 793 | + $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__( |
|
| 794 | + 'Set Registrations to Not Approved and Notify', |
|
| 795 | + 'event_espresso' |
|
| 796 | + ); |
|
| 797 | + } |
|
| 798 | + $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso'); |
|
| 799 | + if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) { |
|
| 800 | + $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__( |
|
| 801 | + 'Cancel Registrations and Notify', |
|
| 802 | + 'event_espresso' |
|
| 803 | + ); |
|
| 804 | + } |
|
| 805 | + $def_reg_status_actions = apply_filters( |
|
| 806 | + 'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array', |
|
| 807 | + $def_reg_status_actions, |
|
| 808 | + $active_mts, |
|
| 809 | + $can_send |
|
| 810 | + ); |
|
| 811 | + |
|
| 812 | + $this->_views = array( |
|
| 813 | + 'all' => array( |
|
| 814 | + 'slug' => 'all', |
|
| 815 | + 'label' => esc_html__('View All Registrations', 'event_espresso'), |
|
| 816 | + 'count' => 0, |
|
| 817 | + 'bulk_action' => array_merge( |
|
| 818 | + $def_reg_status_actions, |
|
| 819 | + array( |
|
| 820 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 821 | + ) |
|
| 822 | + ), |
|
| 823 | + ), |
|
| 824 | + 'month' => array( |
|
| 825 | + 'slug' => 'month', |
|
| 826 | + 'label' => esc_html__('This Month', 'event_espresso'), |
|
| 827 | + 'count' => 0, |
|
| 828 | + 'bulk_action' => array_merge( |
|
| 829 | + $def_reg_status_actions, |
|
| 830 | + array( |
|
| 831 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 832 | + ) |
|
| 833 | + ), |
|
| 834 | + ), |
|
| 835 | + 'today' => array( |
|
| 836 | + 'slug' => 'today', |
|
| 837 | + 'label' => sprintf( |
|
| 838 | + esc_html__('Today - %s', 'event_espresso'), |
|
| 839 | + date('M d, Y', current_time('timestamp')) |
|
| 840 | + ), |
|
| 841 | + 'count' => 0, |
|
| 842 | + 'bulk_action' => array_merge( |
|
| 843 | + $def_reg_status_actions, |
|
| 844 | + array( |
|
| 845 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 846 | + ) |
|
| 847 | + ), |
|
| 848 | + ), |
|
| 849 | + ); |
|
| 850 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 851 | + 'ee_delete_registrations', |
|
| 852 | + 'espresso_registrations_delete_registration' |
|
| 853 | + )) { |
|
| 854 | + $this->_views['incomplete'] = array( |
|
| 855 | + 'slug' => 'incomplete', |
|
| 856 | + 'label' => esc_html__('Incomplete', 'event_espresso'), |
|
| 857 | + 'count' => 0, |
|
| 858 | + 'bulk_action' => array( |
|
| 859 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
| 860 | + ), |
|
| 861 | + ); |
|
| 862 | + $this->_views['trash'] = array( |
|
| 863 | + 'slug' => 'trash', |
|
| 864 | + 'label' => esc_html__('Trash', 'event_espresso'), |
|
| 865 | + 'count' => 0, |
|
| 866 | + 'bulk_action' => array( |
|
| 867 | + 'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'), |
|
| 868 | + 'delete_registrations' => esc_html__('Delete Registrations Permanently', 'event_espresso'), |
|
| 869 | + ), |
|
| 870 | + ); |
|
| 871 | + } |
|
| 872 | + } |
|
| 873 | + |
|
| 874 | + |
|
| 875 | + protected function _set_list_table_views_contact_list() |
|
| 876 | + { |
|
| 877 | + $this->_views = array( |
|
| 878 | + 'in_use' => array( |
|
| 879 | + 'slug' => 'in_use', |
|
| 880 | + 'label' => esc_html__('In Use', 'event_espresso'), |
|
| 881 | + 'count' => 0, |
|
| 882 | + 'bulk_action' => array( |
|
| 883 | + 'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'), |
|
| 884 | + ), |
|
| 885 | + ), |
|
| 886 | + ); |
|
| 887 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 888 | + 'ee_delete_contacts', |
|
| 889 | + 'espresso_registrations_trash_attendees' |
|
| 890 | + ) |
|
| 891 | + ) { |
|
| 892 | + $this->_views['trash'] = array( |
|
| 893 | + 'slug' => 'trash', |
|
| 894 | + 'label' => esc_html__('Trash', 'event_espresso'), |
|
| 895 | + 'count' => 0, |
|
| 896 | + 'bulk_action' => array( |
|
| 897 | + 'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'), |
|
| 898 | + ), |
|
| 899 | + ); |
|
| 900 | + } |
|
| 901 | + } |
|
| 902 | + |
|
| 903 | + |
|
| 904 | + protected function _registration_legend_items() |
|
| 905 | + { |
|
| 906 | + $fc_items = array( |
|
| 907 | + 'star-icon' => array( |
|
| 908 | + 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
| 909 | + 'desc' => esc_html__('This is the Primary Registrant', 'event_espresso'), |
|
| 910 | + ), |
|
| 911 | + 'view_details' => array( |
|
| 912 | + 'class' => 'dashicons dashicons-clipboard', |
|
| 913 | + 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
| 914 | + ), |
|
| 915 | + 'edit_attendee' => array( |
|
| 916 | + 'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16', |
|
| 917 | + 'desc' => esc_html__('Edit Contact Details', 'event_espresso'), |
|
| 918 | + ), |
|
| 919 | + 'view_transaction' => array( |
|
| 920 | + 'class' => 'dashicons dashicons-cart', |
|
| 921 | + 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
| 922 | + ), |
|
| 923 | + 'view_invoice' => array( |
|
| 924 | + 'class' => 'dashicons dashicons-media-spreadsheet', |
|
| 925 | + 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
| 926 | + ), |
|
| 927 | + ); |
|
| 928 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 929 | + 'ee_send_message', |
|
| 930 | + 'espresso_registrations_resend_registration' |
|
| 931 | + )) { |
|
| 932 | + $fc_items['resend_registration'] = array( |
|
| 933 | + 'class' => 'dashicons dashicons-email-alt', |
|
| 934 | + 'desc' => esc_html__('Resend Registration Details', 'event_espresso'), |
|
| 935 | + ); |
|
| 936 | + } else { |
|
| 937 | + $fc_items['blank'] = array('class' => 'blank', 'desc' => ''); |
|
| 938 | + } |
|
| 939 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 940 | + 'ee_read_global_messages', |
|
| 941 | + 'view_filtered_messages' |
|
| 942 | + )) { |
|
| 943 | + $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
| 944 | + if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) { |
|
| 945 | + $fc_items['view_related_messages'] = array( |
|
| 946 | + 'class' => $related_for_icon['css_class'], |
|
| 947 | + 'desc' => $related_for_icon['label'], |
|
| 948 | + ); |
|
| 949 | + } |
|
| 950 | + } |
|
| 951 | + $sc_items = array( |
|
| 952 | + 'approved_status' => array( |
|
| 953 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 954 | + 'desc' => EEH_Template::pretty_status( |
|
| 955 | + EEM_Registration::status_id_approved, |
|
| 956 | + false, |
|
| 957 | + 'sentence' |
|
| 958 | + ), |
|
| 959 | + ), |
|
| 960 | + 'pending_status' => array( |
|
| 961 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 962 | + 'desc' => EEH_Template::pretty_status( |
|
| 963 | + EEM_Registration::status_id_pending_payment, |
|
| 964 | + false, |
|
| 965 | + 'sentence' |
|
| 966 | + ), |
|
| 967 | + ), |
|
| 968 | + 'wait_list' => array( |
|
| 969 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 970 | + 'desc' => EEH_Template::pretty_status( |
|
| 971 | + EEM_Registration::status_id_wait_list, |
|
| 972 | + false, |
|
| 973 | + 'sentence' |
|
| 974 | + ), |
|
| 975 | + ), |
|
| 976 | + 'incomplete_status' => array( |
|
| 977 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete, |
|
| 978 | + 'desc' => EEH_Template::pretty_status( |
|
| 979 | + EEM_Registration::status_id_incomplete, |
|
| 980 | + false, |
|
| 981 | + 'sentence' |
|
| 982 | + ), |
|
| 983 | + ), |
|
| 984 | + 'not_approved' => array( |
|
| 985 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 986 | + 'desc' => EEH_Template::pretty_status( |
|
| 987 | + EEM_Registration::status_id_not_approved, |
|
| 988 | + false, |
|
| 989 | + 'sentence' |
|
| 990 | + ), |
|
| 991 | + ), |
|
| 992 | + 'declined_status' => array( |
|
| 993 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 994 | + 'desc' => EEH_Template::pretty_status( |
|
| 995 | + EEM_Registration::status_id_declined, |
|
| 996 | + false, |
|
| 997 | + 'sentence' |
|
| 998 | + ), |
|
| 999 | + ), |
|
| 1000 | + 'cancelled_status' => array( |
|
| 1001 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 1002 | + 'desc' => EEH_Template::pretty_status( |
|
| 1003 | + EEM_Registration::status_id_cancelled, |
|
| 1004 | + false, |
|
| 1005 | + 'sentence' |
|
| 1006 | + ), |
|
| 1007 | + ), |
|
| 1008 | + ); |
|
| 1009 | + return array_merge($fc_items, $sc_items); |
|
| 1010 | + } |
|
| 1011 | + |
|
| 1012 | + |
|
| 1013 | + |
|
| 1014 | + /*************************************** REGISTRATION OVERVIEW **************************************/ |
|
| 1015 | + /** |
|
| 1016 | + * @throws \EE_Error |
|
| 1017 | + */ |
|
| 1018 | + protected function _registrations_overview_list_table() |
|
| 1019 | + { |
|
| 1020 | + $this->_template_args['admin_page_header'] = ''; |
|
| 1021 | + $EVT_ID = ! empty($this->_req_data['event_id']) |
|
| 1022 | + ? absint($this->_req_data['event_id']) |
|
| 1023 | + : 0; |
|
| 1024 | + $ATT_ID = ! empty($this->_req_data['ATT_ID']) |
|
| 1025 | + ? absint($this->_req_data['ATT_ID']) |
|
| 1026 | + : 0; |
|
| 1027 | + if ($ATT_ID) { |
|
| 1028 | + $attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID); |
|
| 1029 | + if ($attendee instanceof EE_Attendee) { |
|
| 1030 | + $this->_template_args['admin_page_header'] = sprintf( |
|
| 1031 | + esc_html__( |
|
| 1032 | + '%1$s Viewing registrations for %2$s%3$s', |
|
| 1033 | + 'event_espresso' |
|
| 1034 | + ), |
|
| 1035 | + '<h3 style="line-height:1.5em;">', |
|
| 1036 | + '<a href="' . EE_Admin_Page::add_query_args_and_nonce( |
|
| 1037 | + array( |
|
| 1038 | + 'action' => 'edit_attendee', |
|
| 1039 | + 'post' => $ATT_ID, |
|
| 1040 | + ), |
|
| 1041 | + REG_ADMIN_URL |
|
| 1042 | + ) . '">' . $attendee->full_name() . '</a>', |
|
| 1043 | + '</h3>' |
|
| 1044 | + ); |
|
| 1045 | + } |
|
| 1046 | + } |
|
| 1047 | + if ($EVT_ID) { |
|
| 1048 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 1049 | + 'ee_edit_registrations', |
|
| 1050 | + 'espresso_registrations_new_registration', |
|
| 1051 | + $EVT_ID |
|
| 1052 | + )) { |
|
| 1053 | + $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
| 1054 | + 'new_registration', |
|
| 1055 | + 'add-registrant', |
|
| 1056 | + array('event_id' => $EVT_ID), |
|
| 1057 | + 'add-new-h2' |
|
| 1058 | + ); |
|
| 1059 | + } |
|
| 1060 | + $event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 1061 | + if ($event instanceof EE_Event) { |
|
| 1062 | + $this->_template_args['admin_page_header'] = sprintf( |
|
| 1063 | + esc_html__( |
|
| 1064 | + '%s Viewing registrations for the event: %s%s', |
|
| 1065 | + 'event_espresso' |
|
| 1066 | + ), |
|
| 1067 | + '<h3 style="line-height:1.5em;">', |
|
| 1068 | + '<br /><a href="' |
|
| 1069 | + . EE_Admin_Page::add_query_args_and_nonce( |
|
| 1070 | + array( |
|
| 1071 | + 'action' => 'edit', |
|
| 1072 | + 'post' => $event->ID(), |
|
| 1073 | + ), |
|
| 1074 | + EVENTS_ADMIN_URL |
|
| 1075 | + ) |
|
| 1076 | + . '"> ' |
|
| 1077 | + . $event->get('EVT_name') |
|
| 1078 | + . ' </a> ', |
|
| 1079 | + '</h3>' |
|
| 1080 | + ); |
|
| 1081 | + } |
|
| 1082 | + $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0; |
|
| 1083 | + $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
| 1084 | + if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') { |
|
| 1085 | + $this->_template_args['admin_page_header'] = substr( |
|
| 1086 | + $this->_template_args['admin_page_header'], |
|
| 1087 | + 0, |
|
| 1088 | + -5 |
|
| 1089 | + ); |
|
| 1090 | + $this->_template_args['admin_page_header'] .= ' <span class="drk-grey-text">'; |
|
| 1091 | + $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
| 1092 | + $this->_template_args['admin_page_header'] .= $datetime->name(); |
|
| 1093 | + $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )'; |
|
| 1094 | + $this->_template_args['admin_page_header'] .= '</span></h3>'; |
|
| 1095 | + } |
|
| 1096 | + } |
|
| 1097 | + $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items()); |
|
| 1098 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 1099 | + } |
|
| 1100 | + |
|
| 1101 | + |
|
| 1102 | + /** |
|
| 1103 | + * This sets the _registration property for the registration details screen |
|
| 1104 | + * |
|
| 1105 | + * @access private |
|
| 1106 | + * @return bool |
|
| 1107 | + * @throws EE_Error |
|
| 1108 | + * @throws InvalidArgumentException |
|
| 1109 | + * @throws InvalidDataTypeException |
|
| 1110 | + * @throws InvalidInterfaceException |
|
| 1111 | + */ |
|
| 1112 | + private function _set_registration_object() |
|
| 1113 | + { |
|
| 1114 | + // get out if we've already set the object |
|
| 1115 | + if ($this->_registration instanceof EE_Registration) { |
|
| 1116 | + return true; |
|
| 1117 | + } |
|
| 1118 | + $REG = EEM_Registration::instance(); |
|
| 1119 | + $REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 1120 | + if ($this->_registration = $REG->get_one_by_ID($REG_ID)) { |
|
| 1121 | + return true; |
|
| 1122 | + } else { |
|
| 1123 | + $error_msg = sprintf( |
|
| 1124 | + esc_html__( |
|
| 1125 | + 'An error occurred and the details for Registration ID #%s could not be retrieved.', |
|
| 1126 | + 'event_espresso' |
|
| 1127 | + ), |
|
| 1128 | + $REG_ID |
|
| 1129 | + ); |
|
| 1130 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1131 | + $this->_registration = null; |
|
| 1132 | + return false; |
|
| 1133 | + } |
|
| 1134 | + } |
|
| 1135 | + |
|
| 1136 | + |
|
| 1137 | + /** |
|
| 1138 | + * Used to retrieve registrations for the list table. |
|
| 1139 | + * |
|
| 1140 | + * @param int $per_page |
|
| 1141 | + * @param bool $count |
|
| 1142 | + * @param bool $this_month |
|
| 1143 | + * @param bool $today |
|
| 1144 | + * @return EE_Registration[]|int |
|
| 1145 | + * @throws EE_Error |
|
| 1146 | + * @throws InvalidArgumentException |
|
| 1147 | + * @throws InvalidDataTypeException |
|
| 1148 | + * @throws InvalidInterfaceException |
|
| 1149 | + */ |
|
| 1150 | + public function get_registrations( |
|
| 1151 | + $per_page = 10, |
|
| 1152 | + $count = false, |
|
| 1153 | + $this_month = false, |
|
| 1154 | + $today = false |
|
| 1155 | + ) { |
|
| 1156 | + if ($this_month) { |
|
| 1157 | + $this->_req_data['status'] = 'month'; |
|
| 1158 | + } |
|
| 1159 | + if ($today) { |
|
| 1160 | + $this->_req_data['status'] = 'today'; |
|
| 1161 | + } |
|
| 1162 | + $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count); |
|
| 1163 | + /** |
|
| 1164 | + * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
| 1165 | + * |
|
| 1166 | + * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
| 1167 | + * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1168 | + * or if you have the development copy of EE you can view this at the path: |
|
| 1169 | + * /docs/G--Model-System/model-query-params.md |
|
| 1170 | + */ |
|
| 1171 | + $query_params['group_by'] = ''; |
|
| 1172 | + |
|
| 1173 | + return $count |
|
| 1174 | + ? EEM_Registration::instance()->count($query_params) |
|
| 1175 | + /** @type EE_Registration[] */ |
|
| 1176 | + : EEM_Registration::instance()->get_all($query_params); |
|
| 1177 | + } |
|
| 1178 | + |
|
| 1179 | + |
|
| 1180 | + /** |
|
| 1181 | + * Retrieves the query parameters to be used by the Registration model for getting registrations. |
|
| 1182 | + * Note: this listens to values on the request for some of the query parameters. |
|
| 1183 | + * |
|
| 1184 | + * @param array $request |
|
| 1185 | + * @param int $per_page |
|
| 1186 | + * @param bool $count |
|
| 1187 | + * @return array |
|
| 1188 | + * @throws EE_Error |
|
| 1189 | + */ |
|
| 1190 | + protected function _get_registration_query_parameters( |
|
| 1191 | + $request = array(), |
|
| 1192 | + $per_page = 10, |
|
| 1193 | + $count = false |
|
| 1194 | + ) { |
|
| 1195 | + |
|
| 1196 | + $query_params = array( |
|
| 1197 | + 0 => $this->_get_where_conditions_for_registrations_query( |
|
| 1198 | + $request |
|
| 1199 | + ), |
|
| 1200 | + 'caps' => EEM_Registration::caps_read_admin, |
|
| 1201 | + 'default_where_conditions' => 'this_model_only', |
|
| 1202 | + ); |
|
| 1203 | + if (! $count) { |
|
| 1204 | + $query_params = array_merge( |
|
| 1205 | + $query_params, |
|
| 1206 | + $this->_get_orderby_for_registrations_query(), |
|
| 1207 | + $this->_get_limit($per_page) |
|
| 1208 | + ); |
|
| 1209 | + } |
|
| 1210 | + |
|
| 1211 | + return $query_params; |
|
| 1212 | + } |
|
| 1213 | + |
|
| 1214 | + |
|
| 1215 | + /** |
|
| 1216 | + * This will add ATT_ID to the provided $where array for EE model query parameters. |
|
| 1217 | + * |
|
| 1218 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1219 | + * @return array |
|
| 1220 | + */ |
|
| 1221 | + protected function addAttendeeIdToWhereConditions(array $request) |
|
| 1222 | + { |
|
| 1223 | + $where = array(); |
|
| 1224 | + if (! empty($request['ATT_ID'])) { |
|
| 1225 | + $where['ATT_ID'] = absint($request['ATT_ID']); |
|
| 1226 | + } |
|
| 1227 | + return $where; |
|
| 1228 | + } |
|
| 1229 | + |
|
| 1230 | + |
|
| 1231 | + /** |
|
| 1232 | + * This will add EVT_ID to the provided $where array for EE model query parameters. |
|
| 1233 | + * |
|
| 1234 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1235 | + * @return array |
|
| 1236 | + */ |
|
| 1237 | + protected function _add_event_id_to_where_conditions(array $request) |
|
| 1238 | + { |
|
| 1239 | + $where = array(); |
|
| 1240 | + if (! empty($request['event_id'])) { |
|
| 1241 | + $where['EVT_ID'] = absint($request['event_id']); |
|
| 1242 | + } |
|
| 1243 | + return $where; |
|
| 1244 | + } |
|
| 1245 | + |
|
| 1246 | + |
|
| 1247 | + /** |
|
| 1248 | + * Adds category ID if it exists in the request to the where conditions for the registrations query. |
|
| 1249 | + * |
|
| 1250 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1251 | + * @return array |
|
| 1252 | + */ |
|
| 1253 | + protected function _add_category_id_to_where_conditions(array $request) |
|
| 1254 | + { |
|
| 1255 | + $where = array(); |
|
| 1256 | + if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) { |
|
| 1257 | + $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']); |
|
| 1258 | + } |
|
| 1259 | + return $where; |
|
| 1260 | + } |
|
| 1261 | + |
|
| 1262 | + |
|
| 1263 | + /** |
|
| 1264 | + * Adds the datetime ID if it exists in the request to the where conditions for the registrations query. |
|
| 1265 | + * |
|
| 1266 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1267 | + * @return array |
|
| 1268 | + */ |
|
| 1269 | + protected function _add_datetime_id_to_where_conditions(array $request) |
|
| 1270 | + { |
|
| 1271 | + $where = array(); |
|
| 1272 | + if (! empty($request['datetime_id'])) { |
|
| 1273 | + $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']); |
|
| 1274 | + } |
|
| 1275 | + if (! empty($request['DTT_ID'])) { |
|
| 1276 | + $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']); |
|
| 1277 | + } |
|
| 1278 | + return $where; |
|
| 1279 | + } |
|
| 1280 | + |
|
| 1281 | + |
|
| 1282 | + /** |
|
| 1283 | + * Adds the correct registration status to the where conditions for the registrations query. |
|
| 1284 | + * |
|
| 1285 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1286 | + * @return array |
|
| 1287 | + */ |
|
| 1288 | + protected function _add_registration_status_to_where_conditions(array $request) |
|
| 1289 | + { |
|
| 1290 | + $where = array(); |
|
| 1291 | + $view = EEH_Array::is_set($request, 'status', ''); |
|
| 1292 | + $registration_status = ! empty($request['_reg_status']) |
|
| 1293 | + ? sanitize_text_field($request['_reg_status']) |
|
| 1294 | + : ''; |
|
| 1295 | + |
|
| 1296 | + /* |
|
| 1297 | 1297 | * If filtering by registration status, then we show registrations matching that status. |
| 1298 | 1298 | * If not filtering by specified status, then we show all registrations excluding incomplete registrations |
| 1299 | 1299 | * UNLESS viewing trashed registrations. |
| 1300 | 1300 | */ |
| 1301 | - if (! empty($registration_status)) { |
|
| 1302 | - $where['STS_ID'] = $registration_status; |
|
| 1303 | - } else { |
|
| 1304 | - // make sure we exclude incomplete registrations, but only if not trashed. |
|
| 1305 | - if ($view === 'trash') { |
|
| 1306 | - $where['REG_deleted'] = true; |
|
| 1307 | - } elseif ($view === 'incomplete') { |
|
| 1308 | - $where['STS_ID'] = EEM_Registration::status_id_incomplete; |
|
| 1309 | - } else { |
|
| 1310 | - $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete); |
|
| 1311 | - } |
|
| 1312 | - } |
|
| 1313 | - return $where; |
|
| 1314 | - } |
|
| 1315 | - |
|
| 1316 | - |
|
| 1317 | - /** |
|
| 1318 | - * Adds any provided date restraints to the where conditions for the registrations query. |
|
| 1319 | - * |
|
| 1320 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1321 | - * @return array |
|
| 1322 | - * @throws EE_Error |
|
| 1323 | - * @throws InvalidArgumentException |
|
| 1324 | - * @throws InvalidDataTypeException |
|
| 1325 | - * @throws InvalidInterfaceException |
|
| 1326 | - */ |
|
| 1327 | - protected function _add_date_to_where_conditions(array $request) |
|
| 1328 | - { |
|
| 1329 | - $where = array(); |
|
| 1330 | - $view = EEH_Array::is_set($request, 'status', ''); |
|
| 1331 | - $month_range = ! empty($request['month_range']) |
|
| 1332 | - ? sanitize_text_field($request['month_range']) |
|
| 1333 | - : ''; |
|
| 1334 | - $retrieve_for_today = $view === 'today'; |
|
| 1335 | - $retrieve_for_this_month = $view === 'month'; |
|
| 1336 | - |
|
| 1337 | - if ($retrieve_for_today) { |
|
| 1338 | - $now = date('Y-m-d', current_time('timestamp')); |
|
| 1339 | - $where['REG_date'] = array( |
|
| 1340 | - 'BETWEEN', |
|
| 1341 | - array( |
|
| 1342 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1343 | - 'REG_date', |
|
| 1344 | - $now . ' 00:00:00', |
|
| 1345 | - 'Y-m-d H:i:s' |
|
| 1346 | - ), |
|
| 1347 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1348 | - 'REG_date', |
|
| 1349 | - $now . ' 23:59:59', |
|
| 1350 | - 'Y-m-d H:i:s' |
|
| 1351 | - ), |
|
| 1352 | - ), |
|
| 1353 | - ); |
|
| 1354 | - } elseif ($retrieve_for_this_month) { |
|
| 1355 | - $current_year_and_month = date('Y-m', current_time('timestamp')); |
|
| 1356 | - $days_this_month = date('t', current_time('timestamp')); |
|
| 1357 | - $where['REG_date'] = array( |
|
| 1358 | - 'BETWEEN', |
|
| 1359 | - array( |
|
| 1360 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1361 | - 'REG_date', |
|
| 1362 | - $current_year_and_month . '-01 00:00:00', |
|
| 1363 | - 'Y-m-d H:i:s' |
|
| 1364 | - ), |
|
| 1365 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1366 | - 'REG_date', |
|
| 1367 | - $current_year_and_month . '-' . $days_this_month . ' 23:59:59', |
|
| 1368 | - 'Y-m-d H:i:s' |
|
| 1369 | - ), |
|
| 1370 | - ), |
|
| 1371 | - ); |
|
| 1372 | - } elseif ($month_range) { |
|
| 1373 | - $pieces = explode(' ', $month_range, 3); |
|
| 1374 | - $month_requested = ! empty($pieces[0]) |
|
| 1375 | - ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) |
|
| 1376 | - : ''; |
|
| 1377 | - $year_requested = ! empty($pieces[1]) |
|
| 1378 | - ? $pieces[1] |
|
| 1379 | - : ''; |
|
| 1380 | - // if there is not a month or year then we can't go further |
|
| 1381 | - if ($month_requested && $year_requested) { |
|
| 1382 | - $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01')); |
|
| 1383 | - $where['REG_date'] = array( |
|
| 1384 | - 'BETWEEN', |
|
| 1385 | - array( |
|
| 1386 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1387 | - 'REG_date', |
|
| 1388 | - $year_requested . '-' . $month_requested . '-01 00:00:00', |
|
| 1389 | - 'Y-m-d H:i:s' |
|
| 1390 | - ), |
|
| 1391 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1392 | - 'REG_date', |
|
| 1393 | - $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59', |
|
| 1394 | - 'Y-m-d H:i:s' |
|
| 1395 | - ), |
|
| 1396 | - ), |
|
| 1397 | - ); |
|
| 1398 | - } |
|
| 1399 | - } |
|
| 1400 | - return $where; |
|
| 1401 | - } |
|
| 1402 | - |
|
| 1403 | - |
|
| 1404 | - /** |
|
| 1405 | - * Adds any provided search restraints to the where conditions for the registrations query |
|
| 1406 | - * |
|
| 1407 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1408 | - * @return array |
|
| 1409 | - */ |
|
| 1410 | - protected function _add_search_to_where_conditions(array $request) |
|
| 1411 | - { |
|
| 1412 | - $where = array(); |
|
| 1413 | - if (! empty($request['s'])) { |
|
| 1414 | - $search_string = '%' . sanitize_text_field($request['s']) . '%'; |
|
| 1415 | - $where['OR*search_conditions'] = array( |
|
| 1416 | - 'Event.EVT_name' => array('LIKE', $search_string), |
|
| 1417 | - 'Event.EVT_desc' => array('LIKE', $search_string), |
|
| 1418 | - 'Event.EVT_short_desc' => array('LIKE', $search_string), |
|
| 1419 | - 'Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
| 1420 | - 'Attendee.ATT_fname' => array('LIKE', $search_string), |
|
| 1421 | - 'Attendee.ATT_lname' => array('LIKE', $search_string), |
|
| 1422 | - 'Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
| 1423 | - 'Attendee.ATT_email' => array('LIKE', $search_string), |
|
| 1424 | - 'Attendee.ATT_address' => array('LIKE', $search_string), |
|
| 1425 | - 'Attendee.ATT_address2' => array('LIKE', $search_string), |
|
| 1426 | - 'Attendee.ATT_city' => array('LIKE', $search_string), |
|
| 1427 | - 'REG_final_price' => array('LIKE', $search_string), |
|
| 1428 | - 'REG_code' => array('LIKE', $search_string), |
|
| 1429 | - 'REG_count' => array('LIKE', $search_string), |
|
| 1430 | - 'REG_group_size' => array('LIKE', $search_string), |
|
| 1431 | - 'Ticket.TKT_name' => array('LIKE', $search_string), |
|
| 1432 | - 'Ticket.TKT_description' => array('LIKE', $search_string), |
|
| 1433 | - 'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
| 1434 | - ); |
|
| 1435 | - } |
|
| 1436 | - return $where; |
|
| 1437 | - } |
|
| 1438 | - |
|
| 1439 | - |
|
| 1440 | - /** |
|
| 1441 | - * Sets up the where conditions for the registrations query. |
|
| 1442 | - * |
|
| 1443 | - * @param array $request |
|
| 1444 | - * @return array |
|
| 1445 | - * @throws EE_Error |
|
| 1446 | - */ |
|
| 1447 | - protected function _get_where_conditions_for_registrations_query($request) |
|
| 1448 | - { |
|
| 1449 | - return apply_filters( |
|
| 1450 | - 'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query', |
|
| 1451 | - array_merge( |
|
| 1452 | - $this->addAttendeeIdToWhereConditions($request), |
|
| 1453 | - $this->_add_event_id_to_where_conditions($request), |
|
| 1454 | - $this->_add_category_id_to_where_conditions($request), |
|
| 1455 | - $this->_add_datetime_id_to_where_conditions($request), |
|
| 1456 | - $this->_add_registration_status_to_where_conditions($request), |
|
| 1457 | - $this->_add_date_to_where_conditions($request), |
|
| 1458 | - $this->_add_search_to_where_conditions($request) |
|
| 1459 | - ), |
|
| 1460 | - $request |
|
| 1461 | - ); |
|
| 1462 | - } |
|
| 1463 | - |
|
| 1464 | - |
|
| 1465 | - /** |
|
| 1466 | - * Sets up the orderby for the registrations query. |
|
| 1467 | - * |
|
| 1468 | - * @return array |
|
| 1469 | - */ |
|
| 1470 | - protected function _get_orderby_for_registrations_query() |
|
| 1471 | - { |
|
| 1472 | - $orderby_field = ! empty($this->_req_data['orderby']) |
|
| 1473 | - ? sanitize_text_field($this->_req_data['orderby']) |
|
| 1474 | - : '_REG_date'; |
|
| 1475 | - switch ($orderby_field) { |
|
| 1476 | - case '_REG_ID': |
|
| 1477 | - $orderby = array('REG_ID'); |
|
| 1478 | - break; |
|
| 1479 | - case '_Reg_status': |
|
| 1480 | - $orderby = array('STS_ID'); |
|
| 1481 | - break; |
|
| 1482 | - case 'ATT_fname': |
|
| 1483 | - $orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname'); |
|
| 1484 | - break; |
|
| 1485 | - case 'ATT_lname': |
|
| 1486 | - $orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname'); |
|
| 1487 | - break; |
|
| 1488 | - case 'event_name': |
|
| 1489 | - $orderby = array('Event.EVT_name'); |
|
| 1490 | - break; |
|
| 1491 | - case 'DTT_EVT_start': |
|
| 1492 | - $orderby = array('Event.Datetime.DTT_EVT_start'); |
|
| 1493 | - break; |
|
| 1494 | - case '_REG_date': |
|
| 1495 | - $orderby = array('REG_date'); |
|
| 1496 | - break; |
|
| 1497 | - default: |
|
| 1498 | - $orderby = array($orderby_field); |
|
| 1499 | - break; |
|
| 1500 | - } |
|
| 1501 | - |
|
| 1502 | - // order |
|
| 1503 | - $order = ! empty($this->_req_data['order']) |
|
| 1504 | - ? sanitize_text_field($this->_req_data['order']) |
|
| 1505 | - : 'DESC'; |
|
| 1506 | - $orderby = array_combine( |
|
| 1507 | - $orderby, |
|
| 1508 | - array_fill(0, count($orderby), $order) |
|
| 1509 | - ); |
|
| 1510 | - // because there are many registrations with the same date, define |
|
| 1511 | - // a secondary way to order them, otherwise MySQL seems to be a bit random |
|
| 1512 | - if (empty($orderby['REG_ID'])) { |
|
| 1513 | - $orderby['REG_ID'] = $order; |
|
| 1514 | - } |
|
| 1515 | - |
|
| 1516 | - $orderby = apply_filters( |
|
| 1517 | - 'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query', |
|
| 1518 | - $orderby, |
|
| 1519 | - $this->_req_data |
|
| 1520 | - ); |
|
| 1521 | - |
|
| 1522 | - return array('order_by' => $orderby); |
|
| 1523 | - } |
|
| 1524 | - |
|
| 1525 | - |
|
| 1526 | - /** |
|
| 1527 | - * Sets up the limit for the registrations query. |
|
| 1528 | - * |
|
| 1529 | - * @param $per_page |
|
| 1530 | - * @return array |
|
| 1531 | - */ |
|
| 1532 | - protected function _get_limit($per_page) |
|
| 1533 | - { |
|
| 1534 | - $current_page = ! empty($this->_req_data['paged']) |
|
| 1535 | - ? absint($this->_req_data['paged']) |
|
| 1536 | - : 1; |
|
| 1537 | - $per_page = ! empty($this->_req_data['perpage']) |
|
| 1538 | - ? $this->_req_data['perpage'] |
|
| 1539 | - : $per_page; |
|
| 1540 | - |
|
| 1541 | - // -1 means return all results so get out if that's set. |
|
| 1542 | - if ((int) $per_page === -1) { |
|
| 1543 | - return array(); |
|
| 1544 | - } |
|
| 1545 | - $per_page = absint($per_page); |
|
| 1546 | - $offset = ($current_page - 1) * $per_page; |
|
| 1547 | - return array('limit' => array($offset, $per_page)); |
|
| 1548 | - } |
|
| 1549 | - |
|
| 1550 | - |
|
| 1551 | - public function get_registration_status_array() |
|
| 1552 | - { |
|
| 1553 | - return self::$_reg_status; |
|
| 1554 | - } |
|
| 1555 | - |
|
| 1556 | - |
|
| 1557 | - |
|
| 1558 | - |
|
| 1559 | - /*************************************** REGISTRATION DETAILS ***************************************/ |
|
| 1560 | - /** |
|
| 1561 | - * generates HTML for the View Registration Details Admin page |
|
| 1562 | - * |
|
| 1563 | - * @access protected |
|
| 1564 | - * @return void |
|
| 1565 | - * @throws DomainException |
|
| 1566 | - * @throws EE_Error |
|
| 1567 | - * @throws InvalidArgumentException |
|
| 1568 | - * @throws InvalidDataTypeException |
|
| 1569 | - * @throws InvalidInterfaceException |
|
| 1570 | - * @throws EntityNotFoundException |
|
| 1571 | - */ |
|
| 1572 | - protected function _registration_details() |
|
| 1573 | - { |
|
| 1574 | - $this->_template_args = array(); |
|
| 1575 | - $this->_set_registration_object(); |
|
| 1576 | - if (is_object($this->_registration)) { |
|
| 1577 | - $transaction = $this->_registration->transaction() |
|
| 1578 | - ? $this->_registration->transaction() |
|
| 1579 | - : EE_Transaction::new_instance(); |
|
| 1580 | - $this->_session = $transaction->session_data(); |
|
| 1581 | - $event_id = $this->_registration->event_ID(); |
|
| 1582 | - $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID(); |
|
| 1583 | - $this->_template_args['reg_nmbr']['label'] = esc_html__('Registration Number', 'event_espresso'); |
|
| 1584 | - $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date'); |
|
| 1585 | - $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
| 1586 | - $this->_template_args['grand_total'] = $transaction->total(); |
|
| 1587 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 1588 | - // link back to overview |
|
| 1589 | - $this->_template_args['reg_overview_url'] = REG_ADMIN_URL; |
|
| 1590 | - $this->_template_args['registration'] = $this->_registration; |
|
| 1591 | - $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1592 | - array( |
|
| 1593 | - 'action' => 'default', |
|
| 1594 | - 'event_id' => $event_id, |
|
| 1595 | - ), |
|
| 1596 | - REG_ADMIN_URL |
|
| 1597 | - ); |
|
| 1598 | - $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1599 | - array( |
|
| 1600 | - 'action' => 'default', |
|
| 1601 | - 'EVT_ID' => $event_id, |
|
| 1602 | - 'page' => 'espresso_transactions', |
|
| 1603 | - ), |
|
| 1604 | - admin_url('admin.php') |
|
| 1605 | - ); |
|
| 1606 | - $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1607 | - array( |
|
| 1608 | - 'page' => 'espresso_events', |
|
| 1609 | - 'action' => 'edit', |
|
| 1610 | - 'post' => $event_id, |
|
| 1611 | - ), |
|
| 1612 | - admin_url('admin.php') |
|
| 1613 | - ); |
|
| 1614 | - // next and previous links |
|
| 1615 | - $next_reg = $this->_registration->next( |
|
| 1616 | - null, |
|
| 1617 | - array(), |
|
| 1618 | - 'REG_ID' |
|
| 1619 | - ); |
|
| 1620 | - $this->_template_args['next_registration'] = $next_reg |
|
| 1621 | - ? $this->_next_link( |
|
| 1622 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 1623 | - array( |
|
| 1624 | - 'action' => 'view_registration', |
|
| 1625 | - '_REG_ID' => $next_reg['REG_ID'], |
|
| 1626 | - ), |
|
| 1627 | - REG_ADMIN_URL |
|
| 1628 | - ), |
|
| 1629 | - 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
| 1630 | - ) |
|
| 1631 | - : ''; |
|
| 1632 | - $previous_reg = $this->_registration->previous( |
|
| 1633 | - null, |
|
| 1634 | - array(), |
|
| 1635 | - 'REG_ID' |
|
| 1636 | - ); |
|
| 1637 | - $this->_template_args['previous_registration'] = $previous_reg |
|
| 1638 | - ? $this->_previous_link( |
|
| 1639 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 1640 | - array( |
|
| 1641 | - 'action' => 'view_registration', |
|
| 1642 | - '_REG_ID' => $previous_reg['REG_ID'], |
|
| 1643 | - ), |
|
| 1644 | - REG_ADMIN_URL |
|
| 1645 | - ), |
|
| 1646 | - 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
| 1647 | - ) |
|
| 1648 | - : ''; |
|
| 1649 | - // grab header |
|
| 1650 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php'; |
|
| 1651 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1652 | - $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
| 1653 | - $template_path, |
|
| 1654 | - $this->_template_args, |
|
| 1655 | - true |
|
| 1656 | - ); |
|
| 1657 | - } else { |
|
| 1658 | - $this->_template_args['admin_page_header'] = $this->display_espresso_notices(); |
|
| 1659 | - } |
|
| 1660 | - // the details template wrapper |
|
| 1661 | - $this->display_admin_page_with_sidebar(); |
|
| 1662 | - } |
|
| 1663 | - |
|
| 1664 | - |
|
| 1665 | - protected function _registration_details_metaboxes() |
|
| 1666 | - { |
|
| 1667 | - do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this); |
|
| 1668 | - $this->_set_registration_object(); |
|
| 1669 | - $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null; |
|
| 1670 | - add_meta_box( |
|
| 1671 | - 'edit-reg-status-mbox', |
|
| 1672 | - esc_html__('Registration Status', 'event_espresso'), |
|
| 1673 | - array($this, 'set_reg_status_buttons_metabox'), |
|
| 1674 | - $this->wp_page_slug, |
|
| 1675 | - 'normal', |
|
| 1676 | - 'high' |
|
| 1677 | - ); |
|
| 1678 | - add_meta_box( |
|
| 1679 | - 'edit-reg-details-mbox', |
|
| 1680 | - esc_html__('Registration Details', 'event_espresso'), |
|
| 1681 | - array($this, '_reg_details_meta_box'), |
|
| 1682 | - $this->wp_page_slug, |
|
| 1683 | - 'normal', |
|
| 1684 | - 'high' |
|
| 1685 | - ); |
|
| 1686 | - if ($attendee instanceof EE_Attendee |
|
| 1687 | - && EE_Registry::instance()->CAP->current_user_can( |
|
| 1688 | - 'ee_read_registration', |
|
| 1689 | - 'edit-reg-questions-mbox', |
|
| 1690 | - $this->_registration->ID() |
|
| 1691 | - ) |
|
| 1692 | - ) { |
|
| 1693 | - add_meta_box( |
|
| 1694 | - 'edit-reg-questions-mbox', |
|
| 1695 | - esc_html__('Registration Form Answers', 'event_espresso'), |
|
| 1696 | - array($this, '_reg_questions_meta_box'), |
|
| 1697 | - $this->wp_page_slug, |
|
| 1698 | - 'normal', |
|
| 1699 | - 'high' |
|
| 1700 | - ); |
|
| 1701 | - } |
|
| 1702 | - add_meta_box( |
|
| 1703 | - 'edit-reg-registrant-mbox', |
|
| 1704 | - esc_html__('Contact Details', 'event_espresso'), |
|
| 1705 | - array($this, '_reg_registrant_side_meta_box'), |
|
| 1706 | - $this->wp_page_slug, |
|
| 1707 | - 'side', |
|
| 1708 | - 'high' |
|
| 1709 | - ); |
|
| 1710 | - if ($this->_registration->group_size() > 1) { |
|
| 1711 | - add_meta_box( |
|
| 1712 | - 'edit-reg-attendees-mbox', |
|
| 1713 | - esc_html__('Other Registrations in this Transaction', 'event_espresso'), |
|
| 1714 | - array($this, '_reg_attendees_meta_box'), |
|
| 1715 | - $this->wp_page_slug, |
|
| 1716 | - 'normal', |
|
| 1717 | - 'high' |
|
| 1718 | - ); |
|
| 1719 | - } |
|
| 1720 | - } |
|
| 1721 | - |
|
| 1722 | - |
|
| 1723 | - /** |
|
| 1724 | - * set_reg_status_buttons_metabox |
|
| 1725 | - * |
|
| 1726 | - * @access protected |
|
| 1727 | - * @return string |
|
| 1728 | - * @throws \EE_Error |
|
| 1729 | - */ |
|
| 1730 | - public function set_reg_status_buttons_metabox() |
|
| 1731 | - { |
|
| 1732 | - $this->_set_registration_object(); |
|
| 1733 | - $change_reg_status_form = $this->_generate_reg_status_change_form(); |
|
| 1734 | - echo $change_reg_status_form->form_open( |
|
| 1735 | - self::add_query_args_and_nonce( |
|
| 1736 | - array( |
|
| 1737 | - 'action' => 'change_reg_status', |
|
| 1738 | - ), |
|
| 1739 | - REG_ADMIN_URL |
|
| 1740 | - ) |
|
| 1741 | - ); |
|
| 1742 | - echo $change_reg_status_form->get_html(); |
|
| 1743 | - echo $change_reg_status_form->form_close(); |
|
| 1744 | - } |
|
| 1745 | - |
|
| 1746 | - |
|
| 1747 | - /** |
|
| 1748 | - * @return EE_Form_Section_Proper |
|
| 1749 | - * @throws EE_Error |
|
| 1750 | - * @throws InvalidArgumentException |
|
| 1751 | - * @throws InvalidDataTypeException |
|
| 1752 | - * @throws InvalidInterfaceException |
|
| 1753 | - * @throws \EventEspresso\core\exceptions\EntityNotFoundException |
|
| 1754 | - */ |
|
| 1755 | - protected function _generate_reg_status_change_form() |
|
| 1756 | - { |
|
| 1757 | - $reg_status_change_form_array = array( |
|
| 1758 | - 'name' => 'reg_status_change_form', |
|
| 1759 | - 'html_id' => 'reg-status-change-form', |
|
| 1760 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
| 1761 | - 'subsections' => array( |
|
| 1762 | - 'return' => new EE_Hidden_Input( |
|
| 1763 | - array( |
|
| 1764 | - 'name' => 'return', |
|
| 1765 | - 'default' => 'view_registration', |
|
| 1766 | - ) |
|
| 1767 | - ), |
|
| 1768 | - 'REG_ID' => new EE_Hidden_Input( |
|
| 1769 | - array( |
|
| 1770 | - 'name' => 'REG_ID', |
|
| 1771 | - 'default' => $this->_registration->ID(), |
|
| 1772 | - ) |
|
| 1773 | - ), |
|
| 1774 | - 'current_status' => new EE_Form_Section_HTML( |
|
| 1775 | - EEH_HTML::tr( |
|
| 1776 | - EEH_HTML::th( |
|
| 1777 | - EEH_HTML::label( |
|
| 1778 | - EEH_HTML::strong( |
|
| 1779 | - esc_html__('Current Registration Status', 'event_espresso') |
|
| 1780 | - ) |
|
| 1781 | - ) |
|
| 1782 | - ) |
|
| 1783 | - . EEH_HTML::td( |
|
| 1784 | - EEH_HTML::strong( |
|
| 1785 | - $this->_registration->pretty_status(), |
|
| 1786 | - '', |
|
| 1787 | - 'status-' . $this->_registration->status_ID(), |
|
| 1788 | - 'line-height: 1em; font-size: 1.5em; font-weight: bold;' |
|
| 1789 | - ) |
|
| 1790 | - ) |
|
| 1791 | - ) |
|
| 1792 | - ) |
|
| 1793 | - ) |
|
| 1794 | - ); |
|
| 1795 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 1796 | - 'ee_edit_registration', |
|
| 1797 | - 'toggle_registration_status', |
|
| 1798 | - $this->_registration->ID() |
|
| 1799 | - )) { |
|
| 1800 | - $reg_status_change_form_array['subsections']['reg_status'] = new EE_Select_Input( |
|
| 1801 | - $this->_get_reg_statuses(), |
|
| 1802 | - array( |
|
| 1803 | - 'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'), |
|
| 1804 | - 'default' => $this->_registration->status_ID(), |
|
| 1805 | - ) |
|
| 1806 | - ); |
|
| 1807 | - $reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input( |
|
| 1808 | - array( |
|
| 1809 | - 'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'), |
|
| 1810 | - 'default' => false, |
|
| 1811 | - 'html_help_text' => esc_html__( |
|
| 1812 | - 'If set to "Yes", then the related messages will be sent to the registrant.', |
|
| 1813 | - 'event_espresso' |
|
| 1814 | - ) |
|
| 1815 | - ) |
|
| 1816 | - ); |
|
| 1817 | - $reg_status_change_form_array['subsections']['submit'] = new EE_Submit_Input( |
|
| 1818 | - array( |
|
| 1819 | - 'html_class' => 'button-primary', |
|
| 1820 | - 'html_label_text' => ' ', |
|
| 1821 | - 'default' => esc_html__('Update Registration Status', 'event_espresso'), |
|
| 1822 | - ) |
|
| 1823 | - ); |
|
| 1824 | - } |
|
| 1825 | - return new EE_Form_Section_Proper($reg_status_change_form_array); |
|
| 1826 | - } |
|
| 1827 | - |
|
| 1828 | - |
|
| 1829 | - /** |
|
| 1830 | - * Returns an array of all the buttons for the various statuses and switch status actions |
|
| 1831 | - * |
|
| 1832 | - * @return array |
|
| 1833 | - * @throws EE_Error |
|
| 1834 | - * @throws InvalidArgumentException |
|
| 1835 | - * @throws InvalidDataTypeException |
|
| 1836 | - * @throws InvalidInterfaceException |
|
| 1837 | - * @throws EntityNotFoundException |
|
| 1838 | - */ |
|
| 1839 | - protected function _get_reg_statuses() |
|
| 1840 | - { |
|
| 1841 | - $reg_status_array = EEM_Registration::instance()->reg_status_array(); |
|
| 1842 | - unset($reg_status_array[ EEM_Registration::status_id_incomplete ]); |
|
| 1843 | - // get current reg status |
|
| 1844 | - $current_status = $this->_registration->status_ID(); |
|
| 1845 | - // is registration for free event? This will determine whether to display the pending payment option |
|
| 1846 | - if ($current_status !== EEM_Registration::status_id_pending_payment |
|
| 1847 | - && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00) |
|
| 1848 | - ) { |
|
| 1849 | - unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]); |
|
| 1850 | - } |
|
| 1851 | - return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence'); |
|
| 1852 | - } |
|
| 1853 | - |
|
| 1854 | - |
|
| 1855 | - /** |
|
| 1856 | - * This method is used when using _REG_ID from request which may or may not be an array of reg_ids. |
|
| 1857 | - * |
|
| 1858 | - * @param bool $status REG status given for changing registrations to. |
|
| 1859 | - * @param bool $notify Whether to send messages notifications or not. |
|
| 1860 | - * @return array (array with reg_id(s) updated and whether update was successful. |
|
| 1861 | - * @throws EE_Error |
|
| 1862 | - * @throws InvalidArgumentException |
|
| 1863 | - * @throws InvalidDataTypeException |
|
| 1864 | - * @throws InvalidInterfaceException |
|
| 1865 | - * @throws ReflectionException |
|
| 1866 | - * @throws RuntimeException |
|
| 1867 | - * @throws EntityNotFoundException |
|
| 1868 | - */ |
|
| 1869 | - protected function _set_registration_status_from_request($status = false, $notify = false) |
|
| 1870 | - { |
|
| 1871 | - if (isset($this->_req_data['reg_status_change_form'])) { |
|
| 1872 | - $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID']) |
|
| 1873 | - ? (array) $this->_req_data['reg_status_change_form']['REG_ID'] |
|
| 1874 | - : array(); |
|
| 1875 | - } else { |
|
| 1876 | - $REG_IDs = isset($this->_req_data['_REG_ID']) |
|
| 1877 | - ? (array) $this->_req_data['_REG_ID'] |
|
| 1878 | - : array(); |
|
| 1879 | - } |
|
| 1880 | - // sanitize $REG_IDs |
|
| 1881 | - $REG_IDs = array_map('absint', $REG_IDs); |
|
| 1882 | - // and remove empty entries |
|
| 1883 | - $REG_IDs = array_filter($REG_IDs); |
|
| 1884 | - |
|
| 1885 | - $result = $this->_set_registration_status($REG_IDs, $status, $notify); |
|
| 1886 | - |
|
| 1887 | - /** |
|
| 1888 | - * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications. |
|
| 1889 | - * Currently this value is used downstream by the _process_resend_registration method. |
|
| 1890 | - * |
|
| 1891 | - * @param int|array $registration_ids The registration ids that have had their status changed successfully. |
|
| 1892 | - * @param bool $status The status registrations were changed to. |
|
| 1893 | - * @param bool $success If the status was changed successfully for all registrations. |
|
| 1894 | - * @param Registrations_Admin_Page $admin_page_object |
|
| 1895 | - */ |
|
| 1896 | - $this->_req_data['_REG_ID'] = apply_filters( |
|
| 1897 | - 'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs', |
|
| 1898 | - $result['REG_ID'], |
|
| 1899 | - $status, |
|
| 1900 | - $result['success'], |
|
| 1901 | - $this |
|
| 1902 | - ); |
|
| 1903 | - |
|
| 1904 | - // notify? |
|
| 1905 | - if ($notify |
|
| 1906 | - && $result['success'] |
|
| 1907 | - && ! empty($this->_req_data['_REG_ID']) |
|
| 1908 | - && EE_Registry::instance()->CAP->current_user_can( |
|
| 1909 | - 'ee_send_message', |
|
| 1910 | - 'espresso_registrations_resend_registration' |
|
| 1911 | - ) |
|
| 1912 | - ) { |
|
| 1913 | - $this->_process_resend_registration(); |
|
| 1914 | - } |
|
| 1915 | - return $result; |
|
| 1916 | - } |
|
| 1917 | - |
|
| 1918 | - |
|
| 1919 | - /** |
|
| 1920 | - * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an |
|
| 1921 | - * array). Note, this method does NOT take care of possible notifications. That is required by calling code. |
|
| 1922 | - * |
|
| 1923 | - * @param array $REG_IDs |
|
| 1924 | - * @param string $status |
|
| 1925 | - * @param bool $notify Used to indicate whether notification was requested or not. This determines the context |
|
| 1926 | - * slug sent with setting the registration status. |
|
| 1927 | - * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as |
|
| 1928 | - * @throws EE_Error |
|
| 1929 | - * @throws InvalidArgumentException |
|
| 1930 | - * @throws InvalidDataTypeException |
|
| 1931 | - * @throws InvalidInterfaceException |
|
| 1932 | - * @throws ReflectionException |
|
| 1933 | - * @throws RuntimeException |
|
| 1934 | - * @throws EntityNotFoundException |
|
| 1935 | - */ |
|
| 1936 | - protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false) |
|
| 1937 | - { |
|
| 1938 | - $success = false; |
|
| 1939 | - // typecast $REG_IDs |
|
| 1940 | - $REG_IDs = (array) $REG_IDs; |
|
| 1941 | - if (! empty($REG_IDs)) { |
|
| 1942 | - $success = true; |
|
| 1943 | - // set default status if none is passed |
|
| 1944 | - $status = $status ? $status : EEM_Registration::status_id_pending_payment; |
|
| 1945 | - $status_context = $notify |
|
| 1946 | - ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY |
|
| 1947 | - : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN; |
|
| 1948 | - // loop through REG_ID's and change status |
|
| 1949 | - foreach ($REG_IDs as $REG_ID) { |
|
| 1950 | - $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 1951 | - if ($registration instanceof EE_Registration) { |
|
| 1952 | - $registration->set_status( |
|
| 1953 | - $status, |
|
| 1954 | - false, |
|
| 1955 | - new Context( |
|
| 1956 | - $status_context, |
|
| 1957 | - esc_html__( |
|
| 1958 | - 'Manually triggered status change on a Registration Admin Page route.', |
|
| 1959 | - 'event_espresso' |
|
| 1960 | - ) |
|
| 1961 | - ) |
|
| 1962 | - ); |
|
| 1963 | - $result = $registration->save(); |
|
| 1964 | - // verifying explicit fails because update *may* just return 0 for 0 rows affected |
|
| 1965 | - $success = $result !== false ? $success : false; |
|
| 1966 | - } |
|
| 1967 | - } |
|
| 1968 | - } |
|
| 1969 | - |
|
| 1970 | - // return $success and processed registrations |
|
| 1971 | - return array('REG_ID' => $REG_IDs, 'success' => $success); |
|
| 1972 | - } |
|
| 1973 | - |
|
| 1974 | - |
|
| 1975 | - /** |
|
| 1976 | - * Common logic for setting up success message and redirecting to appropriate route |
|
| 1977 | - * |
|
| 1978 | - * @param string $STS_ID status id for the registration changed to |
|
| 1979 | - * @param bool $notify indicates whether the _set_registration_status_from_request does notifications or not. |
|
| 1980 | - * @return void |
|
| 1981 | - * @throws EE_Error |
|
| 1982 | - */ |
|
| 1983 | - protected function _reg_status_change_return($STS_ID, $notify = false) |
|
| 1984 | - { |
|
| 1985 | - $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify) |
|
| 1986 | - : array('success' => false); |
|
| 1987 | - $success = isset($result['success']) && $result['success']; |
|
| 1988 | - // setup success message |
|
| 1989 | - if ($success) { |
|
| 1990 | - if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) { |
|
| 1991 | - $msg = sprintf( |
|
| 1992 | - esc_html__('Registration status has been set to %s', 'event_espresso'), |
|
| 1993 | - EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
| 1994 | - ); |
|
| 1995 | - } else { |
|
| 1996 | - $msg = sprintf( |
|
| 1997 | - esc_html__('Registrations have been set to %s.', 'event_espresso'), |
|
| 1998 | - EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
| 1999 | - ); |
|
| 2000 | - } |
|
| 2001 | - EE_Error::add_success($msg); |
|
| 2002 | - } else { |
|
| 2003 | - EE_Error::add_error( |
|
| 2004 | - esc_html__( |
|
| 2005 | - 'Something went wrong, and the status was not changed', |
|
| 2006 | - 'event_espresso' |
|
| 2007 | - ), |
|
| 2008 | - __FILE__, |
|
| 2009 | - __LINE__, |
|
| 2010 | - __FUNCTION__ |
|
| 2011 | - ); |
|
| 2012 | - } |
|
| 2013 | - if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') { |
|
| 2014 | - $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])); |
|
| 2015 | - } else { |
|
| 2016 | - $route = array('action' => 'default'); |
|
| 2017 | - } |
|
| 2018 | - $route = $this->mergeExistingRequestParamsWithRedirectArgs($route); |
|
| 2019 | - $this->_redirect_after_action($success, '', '', $route, true); |
|
| 2020 | - } |
|
| 2021 | - |
|
| 2022 | - |
|
| 2023 | - /** |
|
| 2024 | - * incoming reg status change from reg details page. |
|
| 2025 | - * |
|
| 2026 | - * @return void |
|
| 2027 | - */ |
|
| 2028 | - protected function _change_reg_status() |
|
| 2029 | - { |
|
| 2030 | - $this->_req_data['return'] = 'view_registration'; |
|
| 2031 | - // set notify based on whether the send notifications toggle is set or not |
|
| 2032 | - $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']); |
|
| 2033 | - // $notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] ); |
|
| 2034 | - $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status']) |
|
| 2035 | - ? $this->_req_data['reg_status_change_form']['reg_status'] : ''; |
|
| 2036 | - switch ($this->_req_data['reg_status_change_form']['reg_status']) { |
|
| 2037 | - case EEM_Registration::status_id_approved: |
|
| 2038 | - case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'): |
|
| 2039 | - $this->approve_registration($notify); |
|
| 2040 | - break; |
|
| 2041 | - case EEM_Registration::status_id_pending_payment: |
|
| 2042 | - case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'): |
|
| 2043 | - $this->pending_registration($notify); |
|
| 2044 | - break; |
|
| 2045 | - case EEM_Registration::status_id_not_approved: |
|
| 2046 | - case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'): |
|
| 2047 | - $this->not_approve_registration($notify); |
|
| 2048 | - break; |
|
| 2049 | - case EEM_Registration::status_id_declined: |
|
| 2050 | - case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'): |
|
| 2051 | - $this->decline_registration($notify); |
|
| 2052 | - break; |
|
| 2053 | - case EEM_Registration::status_id_cancelled: |
|
| 2054 | - case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'): |
|
| 2055 | - $this->cancel_registration($notify); |
|
| 2056 | - break; |
|
| 2057 | - case EEM_Registration::status_id_wait_list: |
|
| 2058 | - case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'): |
|
| 2059 | - $this->wait_list_registration($notify); |
|
| 2060 | - break; |
|
| 2061 | - case EEM_Registration::status_id_incomplete: |
|
| 2062 | - default: |
|
| 2063 | - $result['success'] = false; |
|
| 2064 | - unset($this->_req_data['return']); |
|
| 2065 | - $this->_reg_status_change_return('', false); |
|
| 2066 | - break; |
|
| 2067 | - } |
|
| 2068 | - } |
|
| 2069 | - |
|
| 2070 | - |
|
| 2071 | - /** |
|
| 2072 | - * Callback for bulk action routes. |
|
| 2073 | - * Note: although we could just register the singular route callbacks for each bulk action route as well, this |
|
| 2074 | - * method was chosen so there is one central place all the registration status bulk actions are going through. |
|
| 2075 | - * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to |
|
| 2076 | - * when an action is happening on just a single registration). |
|
| 2077 | - * |
|
| 2078 | - * @param $action |
|
| 2079 | - * @param bool $notify |
|
| 2080 | - */ |
|
| 2081 | - protected function bulk_action_on_registrations($action, $notify = false) |
|
| 2082 | - { |
|
| 2083 | - do_action( |
|
| 2084 | - 'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution', |
|
| 2085 | - $this, |
|
| 2086 | - $action, |
|
| 2087 | - $notify |
|
| 2088 | - ); |
|
| 2089 | - $method = $action . '_registration'; |
|
| 2090 | - if (method_exists($this, $method)) { |
|
| 2091 | - $this->$method($notify); |
|
| 2092 | - } |
|
| 2093 | - } |
|
| 2094 | - |
|
| 2095 | - |
|
| 2096 | - /** |
|
| 2097 | - * approve_registration |
|
| 2098 | - * |
|
| 2099 | - * @access protected |
|
| 2100 | - * @param bool $notify whether or not to notify the registrant about their approval. |
|
| 2101 | - * @return void |
|
| 2102 | - */ |
|
| 2103 | - protected function approve_registration($notify = false) |
|
| 2104 | - { |
|
| 2105 | - $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify); |
|
| 2106 | - } |
|
| 2107 | - |
|
| 2108 | - |
|
| 2109 | - /** |
|
| 2110 | - * decline_registration |
|
| 2111 | - * |
|
| 2112 | - * @access protected |
|
| 2113 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2114 | - * @return void |
|
| 2115 | - */ |
|
| 2116 | - protected function decline_registration($notify = false) |
|
| 2117 | - { |
|
| 2118 | - $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify); |
|
| 2119 | - } |
|
| 2120 | - |
|
| 2121 | - |
|
| 2122 | - /** |
|
| 2123 | - * cancel_registration |
|
| 2124 | - * |
|
| 2125 | - * @access protected |
|
| 2126 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2127 | - * @return void |
|
| 2128 | - */ |
|
| 2129 | - protected function cancel_registration($notify = false) |
|
| 2130 | - { |
|
| 2131 | - $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify); |
|
| 2132 | - } |
|
| 2133 | - |
|
| 2134 | - |
|
| 2135 | - /** |
|
| 2136 | - * not_approve_registration |
|
| 2137 | - * |
|
| 2138 | - * @access protected |
|
| 2139 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2140 | - * @return void |
|
| 2141 | - */ |
|
| 2142 | - protected function not_approve_registration($notify = false) |
|
| 2143 | - { |
|
| 2144 | - $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify); |
|
| 2145 | - } |
|
| 2146 | - |
|
| 2147 | - |
|
| 2148 | - /** |
|
| 2149 | - * decline_registration |
|
| 2150 | - * |
|
| 2151 | - * @access protected |
|
| 2152 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2153 | - * @return void |
|
| 2154 | - */ |
|
| 2155 | - protected function pending_registration($notify = false) |
|
| 2156 | - { |
|
| 2157 | - $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify); |
|
| 2158 | - } |
|
| 2159 | - |
|
| 2160 | - |
|
| 2161 | - /** |
|
| 2162 | - * waitlist_registration |
|
| 2163 | - * |
|
| 2164 | - * @access protected |
|
| 2165 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2166 | - * @return void |
|
| 2167 | - */ |
|
| 2168 | - protected function wait_list_registration($notify = false) |
|
| 2169 | - { |
|
| 2170 | - $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify); |
|
| 2171 | - } |
|
| 2172 | - |
|
| 2173 | - |
|
| 2174 | - /** |
|
| 2175 | - * generates HTML for the Registration main meta box |
|
| 2176 | - * |
|
| 2177 | - * @access public |
|
| 2178 | - * @return void |
|
| 2179 | - * @throws DomainException |
|
| 2180 | - * @throws EE_Error |
|
| 2181 | - * @throws InvalidArgumentException |
|
| 2182 | - * @throws InvalidDataTypeException |
|
| 2183 | - * @throws InvalidInterfaceException |
|
| 2184 | - * @throws ReflectionException |
|
| 2185 | - * @throws EntityNotFoundException |
|
| 2186 | - */ |
|
| 2187 | - public function _reg_details_meta_box() |
|
| 2188 | - { |
|
| 2189 | - EEH_Autoloader::register_line_item_display_autoloaders(); |
|
| 2190 | - EEH_Autoloader::register_line_item_filter_autoloaders(); |
|
| 2191 | - EE_Registry::instance()->load_helper('Line_Item'); |
|
| 2192 | - $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
| 2193 | - : EE_Transaction::new_instance(); |
|
| 2194 | - $this->_session = $transaction->session_data(); |
|
| 2195 | - $filters = new EE_Line_Item_Filter_Collection(); |
|
| 2196 | - // $filters->add( new EE_Non_Zero_Line_Item_Filter() ); |
|
| 2197 | - $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration)); |
|
| 2198 | - $line_item_filter_processor = new EE_Line_Item_Filter_Processor( |
|
| 2199 | - $filters, |
|
| 2200 | - $transaction->total_line_item() |
|
| 2201 | - ); |
|
| 2202 | - $filtered_line_item_tree = $line_item_filter_processor->process(); |
|
| 2203 | - $line_item_display = new EE_Line_Item_Display( |
|
| 2204 | - 'reg_admin_table', |
|
| 2205 | - 'EE_Admin_Table_Registration_Line_Item_Display_Strategy' |
|
| 2206 | - ); |
|
| 2207 | - $this->_template_args['line_item_table'] = $line_item_display->display_line_item( |
|
| 2208 | - $filtered_line_item_tree, |
|
| 2209 | - array('EE_Registration' => $this->_registration) |
|
| 2210 | - ); |
|
| 2211 | - $attendee = $this->_registration->attendee(); |
|
| 2212 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 2213 | - 'ee_read_transaction', |
|
| 2214 | - 'espresso_transactions_view_transaction' |
|
| 2215 | - )) { |
|
| 2216 | - $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link( |
|
| 2217 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 2218 | - array( |
|
| 2219 | - 'action' => 'view_transaction', |
|
| 2220 | - 'TXN_ID' => $transaction->ID(), |
|
| 2221 | - ), |
|
| 2222 | - TXN_ADMIN_URL |
|
| 2223 | - ), |
|
| 2224 | - esc_html__(' View Transaction', 'event_espresso'), |
|
| 2225 | - 'button secondary-button right', |
|
| 2226 | - 'dashicons dashicons-cart' |
|
| 2227 | - ); |
|
| 2228 | - } else { |
|
| 2229 | - $this->_template_args['view_transaction_button'] = ''; |
|
| 2230 | - } |
|
| 2231 | - if ($attendee instanceof EE_Attendee |
|
| 2232 | - && EE_Registry::instance()->CAP->current_user_can( |
|
| 2233 | - 'ee_send_message', |
|
| 2234 | - 'espresso_registrations_resend_registration' |
|
| 2235 | - ) |
|
| 2236 | - ) { |
|
| 2237 | - $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link( |
|
| 2238 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 2239 | - array( |
|
| 2240 | - 'action' => 'resend_registration', |
|
| 2241 | - '_REG_ID' => $this->_registration->ID(), |
|
| 2242 | - 'redirect_to' => 'view_registration', |
|
| 2243 | - ), |
|
| 2244 | - REG_ADMIN_URL |
|
| 2245 | - ), |
|
| 2246 | - esc_html__(' Resend Registration', 'event_espresso'), |
|
| 2247 | - 'button secondary-button right', |
|
| 2248 | - 'dashicons dashicons-email-alt' |
|
| 2249 | - ); |
|
| 2250 | - } else { |
|
| 2251 | - $this->_template_args['resend_registration_button'] = ''; |
|
| 2252 | - } |
|
| 2253 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 2254 | - $payment = $transaction->get_first_related('Payment'); |
|
| 2255 | - $payment = ! $payment instanceof EE_Payment |
|
| 2256 | - ? EE_Payment::new_instance() |
|
| 2257 | - : $payment; |
|
| 2258 | - $payment_method = $payment->get_first_related('Payment_Method'); |
|
| 2259 | - $payment_method = ! $payment_method instanceof EE_Payment_Method |
|
| 2260 | - ? EE_Payment_Method::new_instance() |
|
| 2261 | - : $payment_method; |
|
| 2262 | - $reg_details = array( |
|
| 2263 | - 'payment_method' => $payment_method->name(), |
|
| 2264 | - 'response_msg' => $payment->gateway_response(), |
|
| 2265 | - 'registration_id' => $this->_registration->get('REG_code'), |
|
| 2266 | - 'registration_session' => $this->_registration->session_ID(), |
|
| 2267 | - 'ip_address' => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '', |
|
| 2268 | - 'user_agent' => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '', |
|
| 2269 | - ); |
|
| 2270 | - if (isset($reg_details['registration_id'])) { |
|
| 2271 | - $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id']; |
|
| 2272 | - $this->_template_args['reg_details']['registration_id']['label'] = esc_html__( |
|
| 2273 | - 'Registration ID', |
|
| 2274 | - 'event_espresso' |
|
| 2275 | - ); |
|
| 2276 | - $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text'; |
|
| 2277 | - } |
|
| 2278 | - if (isset($reg_details['payment_method'])) { |
|
| 2279 | - $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method']; |
|
| 2280 | - $this->_template_args['reg_details']['payment_method']['label'] = esc_html__( |
|
| 2281 | - 'Most Recent Payment Method', |
|
| 2282 | - 'event_espresso' |
|
| 2283 | - ); |
|
| 2284 | - $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text'; |
|
| 2285 | - $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg']; |
|
| 2286 | - $this->_template_args['reg_details']['response_msg']['label'] = esc_html__( |
|
| 2287 | - 'Payment method response', |
|
| 2288 | - 'event_espresso' |
|
| 2289 | - ); |
|
| 2290 | - $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text'; |
|
| 2291 | - } |
|
| 2292 | - $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session']; |
|
| 2293 | - $this->_template_args['reg_details']['registration_session']['label'] = esc_html__( |
|
| 2294 | - 'Registration Session', |
|
| 2295 | - 'event_espresso' |
|
| 2296 | - ); |
|
| 2297 | - $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text'; |
|
| 2298 | - $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address']; |
|
| 2299 | - $this->_template_args['reg_details']['ip_address']['label'] = esc_html__( |
|
| 2300 | - 'Registration placed from IP', |
|
| 2301 | - 'event_espresso' |
|
| 2302 | - ); |
|
| 2303 | - $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text'; |
|
| 2304 | - $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent']; |
|
| 2305 | - $this->_template_args['reg_details']['user_agent']['label'] = esc_html__( |
|
| 2306 | - 'Registrant User Agent', |
|
| 2307 | - 'event_espresso' |
|
| 2308 | - ); |
|
| 2309 | - $this->_template_args['reg_details']['user_agent']['class'] = 'large-text'; |
|
| 2310 | - $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 2311 | - array( |
|
| 2312 | - 'action' => 'default', |
|
| 2313 | - 'event_id' => $this->_registration->event_ID(), |
|
| 2314 | - ), |
|
| 2315 | - REG_ADMIN_URL |
|
| 2316 | - ); |
|
| 2317 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 2318 | - $this->_template_args['event_id'] = $this->_registration->event_ID(); |
|
| 2319 | - $template_path = |
|
| 2320 | - REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
| 2321 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2322 | - } |
|
| 2323 | - |
|
| 2324 | - |
|
| 2325 | - /** |
|
| 2326 | - * generates HTML for the Registration Questions meta box. |
|
| 2327 | - * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters), |
|
| 2328 | - * otherwise uses new forms system |
|
| 2329 | - * |
|
| 2330 | - * @access public |
|
| 2331 | - * @return void |
|
| 2332 | - * @throws DomainException |
|
| 2333 | - * @throws EE_Error |
|
| 2334 | - */ |
|
| 2335 | - public function _reg_questions_meta_box() |
|
| 2336 | - { |
|
| 2337 | - // allow someone to override this method entirely |
|
| 2338 | - if (apply_filters( |
|
| 2339 | - 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', |
|
| 2340 | - true, |
|
| 2341 | - $this, |
|
| 2342 | - $this->_registration |
|
| 2343 | - )) { |
|
| 2344 | - $form = $this->_get_reg_custom_questions_form( |
|
| 2345 | - $this->_registration->ID() |
|
| 2346 | - ); |
|
| 2347 | - $this->_template_args['att_questions'] = count($form->subforms()) > 0 |
|
| 2348 | - ? $form->get_html_and_js() |
|
| 2349 | - : ''; |
|
| 2350 | - $this->_template_args['reg_questions_form_action'] = 'edit_registration'; |
|
| 2351 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 2352 | - $template_path = |
|
| 2353 | - REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 2354 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2355 | - } |
|
| 2356 | - } |
|
| 2357 | - |
|
| 2358 | - |
|
| 2359 | - /** |
|
| 2360 | - * form_before_question_group |
|
| 2361 | - * |
|
| 2362 | - * @deprecated as of 4.8.32.rc.000 |
|
| 2363 | - * @access public |
|
| 2364 | - * @param string $output |
|
| 2365 | - * @return string |
|
| 2366 | - */ |
|
| 2367 | - public function form_before_question_group($output) |
|
| 2368 | - { |
|
| 2369 | - EE_Error::doing_it_wrong( |
|
| 2370 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2371 | - esc_html__( |
|
| 2372 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2373 | - 'event_espresso' |
|
| 2374 | - ), |
|
| 2375 | - '4.8.32.rc.000' |
|
| 2376 | - ); |
|
| 2377 | - return ' |
|
| 1301 | + if (! empty($registration_status)) { |
|
| 1302 | + $where['STS_ID'] = $registration_status; |
|
| 1303 | + } else { |
|
| 1304 | + // make sure we exclude incomplete registrations, but only if not trashed. |
|
| 1305 | + if ($view === 'trash') { |
|
| 1306 | + $where['REG_deleted'] = true; |
|
| 1307 | + } elseif ($view === 'incomplete') { |
|
| 1308 | + $where['STS_ID'] = EEM_Registration::status_id_incomplete; |
|
| 1309 | + } else { |
|
| 1310 | + $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete); |
|
| 1311 | + } |
|
| 1312 | + } |
|
| 1313 | + return $where; |
|
| 1314 | + } |
|
| 1315 | + |
|
| 1316 | + |
|
| 1317 | + /** |
|
| 1318 | + * Adds any provided date restraints to the where conditions for the registrations query. |
|
| 1319 | + * |
|
| 1320 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1321 | + * @return array |
|
| 1322 | + * @throws EE_Error |
|
| 1323 | + * @throws InvalidArgumentException |
|
| 1324 | + * @throws InvalidDataTypeException |
|
| 1325 | + * @throws InvalidInterfaceException |
|
| 1326 | + */ |
|
| 1327 | + protected function _add_date_to_where_conditions(array $request) |
|
| 1328 | + { |
|
| 1329 | + $where = array(); |
|
| 1330 | + $view = EEH_Array::is_set($request, 'status', ''); |
|
| 1331 | + $month_range = ! empty($request['month_range']) |
|
| 1332 | + ? sanitize_text_field($request['month_range']) |
|
| 1333 | + : ''; |
|
| 1334 | + $retrieve_for_today = $view === 'today'; |
|
| 1335 | + $retrieve_for_this_month = $view === 'month'; |
|
| 1336 | + |
|
| 1337 | + if ($retrieve_for_today) { |
|
| 1338 | + $now = date('Y-m-d', current_time('timestamp')); |
|
| 1339 | + $where['REG_date'] = array( |
|
| 1340 | + 'BETWEEN', |
|
| 1341 | + array( |
|
| 1342 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1343 | + 'REG_date', |
|
| 1344 | + $now . ' 00:00:00', |
|
| 1345 | + 'Y-m-d H:i:s' |
|
| 1346 | + ), |
|
| 1347 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1348 | + 'REG_date', |
|
| 1349 | + $now . ' 23:59:59', |
|
| 1350 | + 'Y-m-d H:i:s' |
|
| 1351 | + ), |
|
| 1352 | + ), |
|
| 1353 | + ); |
|
| 1354 | + } elseif ($retrieve_for_this_month) { |
|
| 1355 | + $current_year_and_month = date('Y-m', current_time('timestamp')); |
|
| 1356 | + $days_this_month = date('t', current_time('timestamp')); |
|
| 1357 | + $where['REG_date'] = array( |
|
| 1358 | + 'BETWEEN', |
|
| 1359 | + array( |
|
| 1360 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1361 | + 'REG_date', |
|
| 1362 | + $current_year_and_month . '-01 00:00:00', |
|
| 1363 | + 'Y-m-d H:i:s' |
|
| 1364 | + ), |
|
| 1365 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1366 | + 'REG_date', |
|
| 1367 | + $current_year_and_month . '-' . $days_this_month . ' 23:59:59', |
|
| 1368 | + 'Y-m-d H:i:s' |
|
| 1369 | + ), |
|
| 1370 | + ), |
|
| 1371 | + ); |
|
| 1372 | + } elseif ($month_range) { |
|
| 1373 | + $pieces = explode(' ', $month_range, 3); |
|
| 1374 | + $month_requested = ! empty($pieces[0]) |
|
| 1375 | + ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) |
|
| 1376 | + : ''; |
|
| 1377 | + $year_requested = ! empty($pieces[1]) |
|
| 1378 | + ? $pieces[1] |
|
| 1379 | + : ''; |
|
| 1380 | + // if there is not a month or year then we can't go further |
|
| 1381 | + if ($month_requested && $year_requested) { |
|
| 1382 | + $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01')); |
|
| 1383 | + $where['REG_date'] = array( |
|
| 1384 | + 'BETWEEN', |
|
| 1385 | + array( |
|
| 1386 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1387 | + 'REG_date', |
|
| 1388 | + $year_requested . '-' . $month_requested . '-01 00:00:00', |
|
| 1389 | + 'Y-m-d H:i:s' |
|
| 1390 | + ), |
|
| 1391 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1392 | + 'REG_date', |
|
| 1393 | + $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59', |
|
| 1394 | + 'Y-m-d H:i:s' |
|
| 1395 | + ), |
|
| 1396 | + ), |
|
| 1397 | + ); |
|
| 1398 | + } |
|
| 1399 | + } |
|
| 1400 | + return $where; |
|
| 1401 | + } |
|
| 1402 | + |
|
| 1403 | + |
|
| 1404 | + /** |
|
| 1405 | + * Adds any provided search restraints to the where conditions for the registrations query |
|
| 1406 | + * |
|
| 1407 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1408 | + * @return array |
|
| 1409 | + */ |
|
| 1410 | + protected function _add_search_to_where_conditions(array $request) |
|
| 1411 | + { |
|
| 1412 | + $where = array(); |
|
| 1413 | + if (! empty($request['s'])) { |
|
| 1414 | + $search_string = '%' . sanitize_text_field($request['s']) . '%'; |
|
| 1415 | + $where['OR*search_conditions'] = array( |
|
| 1416 | + 'Event.EVT_name' => array('LIKE', $search_string), |
|
| 1417 | + 'Event.EVT_desc' => array('LIKE', $search_string), |
|
| 1418 | + 'Event.EVT_short_desc' => array('LIKE', $search_string), |
|
| 1419 | + 'Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
| 1420 | + 'Attendee.ATT_fname' => array('LIKE', $search_string), |
|
| 1421 | + 'Attendee.ATT_lname' => array('LIKE', $search_string), |
|
| 1422 | + 'Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
| 1423 | + 'Attendee.ATT_email' => array('LIKE', $search_string), |
|
| 1424 | + 'Attendee.ATT_address' => array('LIKE', $search_string), |
|
| 1425 | + 'Attendee.ATT_address2' => array('LIKE', $search_string), |
|
| 1426 | + 'Attendee.ATT_city' => array('LIKE', $search_string), |
|
| 1427 | + 'REG_final_price' => array('LIKE', $search_string), |
|
| 1428 | + 'REG_code' => array('LIKE', $search_string), |
|
| 1429 | + 'REG_count' => array('LIKE', $search_string), |
|
| 1430 | + 'REG_group_size' => array('LIKE', $search_string), |
|
| 1431 | + 'Ticket.TKT_name' => array('LIKE', $search_string), |
|
| 1432 | + 'Ticket.TKT_description' => array('LIKE', $search_string), |
|
| 1433 | + 'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
| 1434 | + ); |
|
| 1435 | + } |
|
| 1436 | + return $where; |
|
| 1437 | + } |
|
| 1438 | + |
|
| 1439 | + |
|
| 1440 | + /** |
|
| 1441 | + * Sets up the where conditions for the registrations query. |
|
| 1442 | + * |
|
| 1443 | + * @param array $request |
|
| 1444 | + * @return array |
|
| 1445 | + * @throws EE_Error |
|
| 1446 | + */ |
|
| 1447 | + protected function _get_where_conditions_for_registrations_query($request) |
|
| 1448 | + { |
|
| 1449 | + return apply_filters( |
|
| 1450 | + 'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query', |
|
| 1451 | + array_merge( |
|
| 1452 | + $this->addAttendeeIdToWhereConditions($request), |
|
| 1453 | + $this->_add_event_id_to_where_conditions($request), |
|
| 1454 | + $this->_add_category_id_to_where_conditions($request), |
|
| 1455 | + $this->_add_datetime_id_to_where_conditions($request), |
|
| 1456 | + $this->_add_registration_status_to_where_conditions($request), |
|
| 1457 | + $this->_add_date_to_where_conditions($request), |
|
| 1458 | + $this->_add_search_to_where_conditions($request) |
|
| 1459 | + ), |
|
| 1460 | + $request |
|
| 1461 | + ); |
|
| 1462 | + } |
|
| 1463 | + |
|
| 1464 | + |
|
| 1465 | + /** |
|
| 1466 | + * Sets up the orderby for the registrations query. |
|
| 1467 | + * |
|
| 1468 | + * @return array |
|
| 1469 | + */ |
|
| 1470 | + protected function _get_orderby_for_registrations_query() |
|
| 1471 | + { |
|
| 1472 | + $orderby_field = ! empty($this->_req_data['orderby']) |
|
| 1473 | + ? sanitize_text_field($this->_req_data['orderby']) |
|
| 1474 | + : '_REG_date'; |
|
| 1475 | + switch ($orderby_field) { |
|
| 1476 | + case '_REG_ID': |
|
| 1477 | + $orderby = array('REG_ID'); |
|
| 1478 | + break; |
|
| 1479 | + case '_Reg_status': |
|
| 1480 | + $orderby = array('STS_ID'); |
|
| 1481 | + break; |
|
| 1482 | + case 'ATT_fname': |
|
| 1483 | + $orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname'); |
|
| 1484 | + break; |
|
| 1485 | + case 'ATT_lname': |
|
| 1486 | + $orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname'); |
|
| 1487 | + break; |
|
| 1488 | + case 'event_name': |
|
| 1489 | + $orderby = array('Event.EVT_name'); |
|
| 1490 | + break; |
|
| 1491 | + case 'DTT_EVT_start': |
|
| 1492 | + $orderby = array('Event.Datetime.DTT_EVT_start'); |
|
| 1493 | + break; |
|
| 1494 | + case '_REG_date': |
|
| 1495 | + $orderby = array('REG_date'); |
|
| 1496 | + break; |
|
| 1497 | + default: |
|
| 1498 | + $orderby = array($orderby_field); |
|
| 1499 | + break; |
|
| 1500 | + } |
|
| 1501 | + |
|
| 1502 | + // order |
|
| 1503 | + $order = ! empty($this->_req_data['order']) |
|
| 1504 | + ? sanitize_text_field($this->_req_data['order']) |
|
| 1505 | + : 'DESC'; |
|
| 1506 | + $orderby = array_combine( |
|
| 1507 | + $orderby, |
|
| 1508 | + array_fill(0, count($orderby), $order) |
|
| 1509 | + ); |
|
| 1510 | + // because there are many registrations with the same date, define |
|
| 1511 | + // a secondary way to order them, otherwise MySQL seems to be a bit random |
|
| 1512 | + if (empty($orderby['REG_ID'])) { |
|
| 1513 | + $orderby['REG_ID'] = $order; |
|
| 1514 | + } |
|
| 1515 | + |
|
| 1516 | + $orderby = apply_filters( |
|
| 1517 | + 'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query', |
|
| 1518 | + $orderby, |
|
| 1519 | + $this->_req_data |
|
| 1520 | + ); |
|
| 1521 | + |
|
| 1522 | + return array('order_by' => $orderby); |
|
| 1523 | + } |
|
| 1524 | + |
|
| 1525 | + |
|
| 1526 | + /** |
|
| 1527 | + * Sets up the limit for the registrations query. |
|
| 1528 | + * |
|
| 1529 | + * @param $per_page |
|
| 1530 | + * @return array |
|
| 1531 | + */ |
|
| 1532 | + protected function _get_limit($per_page) |
|
| 1533 | + { |
|
| 1534 | + $current_page = ! empty($this->_req_data['paged']) |
|
| 1535 | + ? absint($this->_req_data['paged']) |
|
| 1536 | + : 1; |
|
| 1537 | + $per_page = ! empty($this->_req_data['perpage']) |
|
| 1538 | + ? $this->_req_data['perpage'] |
|
| 1539 | + : $per_page; |
|
| 1540 | + |
|
| 1541 | + // -1 means return all results so get out if that's set. |
|
| 1542 | + if ((int) $per_page === -1) { |
|
| 1543 | + return array(); |
|
| 1544 | + } |
|
| 1545 | + $per_page = absint($per_page); |
|
| 1546 | + $offset = ($current_page - 1) * $per_page; |
|
| 1547 | + return array('limit' => array($offset, $per_page)); |
|
| 1548 | + } |
|
| 1549 | + |
|
| 1550 | + |
|
| 1551 | + public function get_registration_status_array() |
|
| 1552 | + { |
|
| 1553 | + return self::$_reg_status; |
|
| 1554 | + } |
|
| 1555 | + |
|
| 1556 | + |
|
| 1557 | + |
|
| 1558 | + |
|
| 1559 | + /*************************************** REGISTRATION DETAILS ***************************************/ |
|
| 1560 | + /** |
|
| 1561 | + * generates HTML for the View Registration Details Admin page |
|
| 1562 | + * |
|
| 1563 | + * @access protected |
|
| 1564 | + * @return void |
|
| 1565 | + * @throws DomainException |
|
| 1566 | + * @throws EE_Error |
|
| 1567 | + * @throws InvalidArgumentException |
|
| 1568 | + * @throws InvalidDataTypeException |
|
| 1569 | + * @throws InvalidInterfaceException |
|
| 1570 | + * @throws EntityNotFoundException |
|
| 1571 | + */ |
|
| 1572 | + protected function _registration_details() |
|
| 1573 | + { |
|
| 1574 | + $this->_template_args = array(); |
|
| 1575 | + $this->_set_registration_object(); |
|
| 1576 | + if (is_object($this->_registration)) { |
|
| 1577 | + $transaction = $this->_registration->transaction() |
|
| 1578 | + ? $this->_registration->transaction() |
|
| 1579 | + : EE_Transaction::new_instance(); |
|
| 1580 | + $this->_session = $transaction->session_data(); |
|
| 1581 | + $event_id = $this->_registration->event_ID(); |
|
| 1582 | + $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID(); |
|
| 1583 | + $this->_template_args['reg_nmbr']['label'] = esc_html__('Registration Number', 'event_espresso'); |
|
| 1584 | + $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date'); |
|
| 1585 | + $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
| 1586 | + $this->_template_args['grand_total'] = $transaction->total(); |
|
| 1587 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 1588 | + // link back to overview |
|
| 1589 | + $this->_template_args['reg_overview_url'] = REG_ADMIN_URL; |
|
| 1590 | + $this->_template_args['registration'] = $this->_registration; |
|
| 1591 | + $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1592 | + array( |
|
| 1593 | + 'action' => 'default', |
|
| 1594 | + 'event_id' => $event_id, |
|
| 1595 | + ), |
|
| 1596 | + REG_ADMIN_URL |
|
| 1597 | + ); |
|
| 1598 | + $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1599 | + array( |
|
| 1600 | + 'action' => 'default', |
|
| 1601 | + 'EVT_ID' => $event_id, |
|
| 1602 | + 'page' => 'espresso_transactions', |
|
| 1603 | + ), |
|
| 1604 | + admin_url('admin.php') |
|
| 1605 | + ); |
|
| 1606 | + $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 1607 | + array( |
|
| 1608 | + 'page' => 'espresso_events', |
|
| 1609 | + 'action' => 'edit', |
|
| 1610 | + 'post' => $event_id, |
|
| 1611 | + ), |
|
| 1612 | + admin_url('admin.php') |
|
| 1613 | + ); |
|
| 1614 | + // next and previous links |
|
| 1615 | + $next_reg = $this->_registration->next( |
|
| 1616 | + null, |
|
| 1617 | + array(), |
|
| 1618 | + 'REG_ID' |
|
| 1619 | + ); |
|
| 1620 | + $this->_template_args['next_registration'] = $next_reg |
|
| 1621 | + ? $this->_next_link( |
|
| 1622 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 1623 | + array( |
|
| 1624 | + 'action' => 'view_registration', |
|
| 1625 | + '_REG_ID' => $next_reg['REG_ID'], |
|
| 1626 | + ), |
|
| 1627 | + REG_ADMIN_URL |
|
| 1628 | + ), |
|
| 1629 | + 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
| 1630 | + ) |
|
| 1631 | + : ''; |
|
| 1632 | + $previous_reg = $this->_registration->previous( |
|
| 1633 | + null, |
|
| 1634 | + array(), |
|
| 1635 | + 'REG_ID' |
|
| 1636 | + ); |
|
| 1637 | + $this->_template_args['previous_registration'] = $previous_reg |
|
| 1638 | + ? $this->_previous_link( |
|
| 1639 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 1640 | + array( |
|
| 1641 | + 'action' => 'view_registration', |
|
| 1642 | + '_REG_ID' => $previous_reg['REG_ID'], |
|
| 1643 | + ), |
|
| 1644 | + REG_ADMIN_URL |
|
| 1645 | + ), |
|
| 1646 | + 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
| 1647 | + ) |
|
| 1648 | + : ''; |
|
| 1649 | + // grab header |
|
| 1650 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php'; |
|
| 1651 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1652 | + $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
| 1653 | + $template_path, |
|
| 1654 | + $this->_template_args, |
|
| 1655 | + true |
|
| 1656 | + ); |
|
| 1657 | + } else { |
|
| 1658 | + $this->_template_args['admin_page_header'] = $this->display_espresso_notices(); |
|
| 1659 | + } |
|
| 1660 | + // the details template wrapper |
|
| 1661 | + $this->display_admin_page_with_sidebar(); |
|
| 1662 | + } |
|
| 1663 | + |
|
| 1664 | + |
|
| 1665 | + protected function _registration_details_metaboxes() |
|
| 1666 | + { |
|
| 1667 | + do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this); |
|
| 1668 | + $this->_set_registration_object(); |
|
| 1669 | + $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null; |
|
| 1670 | + add_meta_box( |
|
| 1671 | + 'edit-reg-status-mbox', |
|
| 1672 | + esc_html__('Registration Status', 'event_espresso'), |
|
| 1673 | + array($this, 'set_reg_status_buttons_metabox'), |
|
| 1674 | + $this->wp_page_slug, |
|
| 1675 | + 'normal', |
|
| 1676 | + 'high' |
|
| 1677 | + ); |
|
| 1678 | + add_meta_box( |
|
| 1679 | + 'edit-reg-details-mbox', |
|
| 1680 | + esc_html__('Registration Details', 'event_espresso'), |
|
| 1681 | + array($this, '_reg_details_meta_box'), |
|
| 1682 | + $this->wp_page_slug, |
|
| 1683 | + 'normal', |
|
| 1684 | + 'high' |
|
| 1685 | + ); |
|
| 1686 | + if ($attendee instanceof EE_Attendee |
|
| 1687 | + && EE_Registry::instance()->CAP->current_user_can( |
|
| 1688 | + 'ee_read_registration', |
|
| 1689 | + 'edit-reg-questions-mbox', |
|
| 1690 | + $this->_registration->ID() |
|
| 1691 | + ) |
|
| 1692 | + ) { |
|
| 1693 | + add_meta_box( |
|
| 1694 | + 'edit-reg-questions-mbox', |
|
| 1695 | + esc_html__('Registration Form Answers', 'event_espresso'), |
|
| 1696 | + array($this, '_reg_questions_meta_box'), |
|
| 1697 | + $this->wp_page_slug, |
|
| 1698 | + 'normal', |
|
| 1699 | + 'high' |
|
| 1700 | + ); |
|
| 1701 | + } |
|
| 1702 | + add_meta_box( |
|
| 1703 | + 'edit-reg-registrant-mbox', |
|
| 1704 | + esc_html__('Contact Details', 'event_espresso'), |
|
| 1705 | + array($this, '_reg_registrant_side_meta_box'), |
|
| 1706 | + $this->wp_page_slug, |
|
| 1707 | + 'side', |
|
| 1708 | + 'high' |
|
| 1709 | + ); |
|
| 1710 | + if ($this->_registration->group_size() > 1) { |
|
| 1711 | + add_meta_box( |
|
| 1712 | + 'edit-reg-attendees-mbox', |
|
| 1713 | + esc_html__('Other Registrations in this Transaction', 'event_espresso'), |
|
| 1714 | + array($this, '_reg_attendees_meta_box'), |
|
| 1715 | + $this->wp_page_slug, |
|
| 1716 | + 'normal', |
|
| 1717 | + 'high' |
|
| 1718 | + ); |
|
| 1719 | + } |
|
| 1720 | + } |
|
| 1721 | + |
|
| 1722 | + |
|
| 1723 | + /** |
|
| 1724 | + * set_reg_status_buttons_metabox |
|
| 1725 | + * |
|
| 1726 | + * @access protected |
|
| 1727 | + * @return string |
|
| 1728 | + * @throws \EE_Error |
|
| 1729 | + */ |
|
| 1730 | + public function set_reg_status_buttons_metabox() |
|
| 1731 | + { |
|
| 1732 | + $this->_set_registration_object(); |
|
| 1733 | + $change_reg_status_form = $this->_generate_reg_status_change_form(); |
|
| 1734 | + echo $change_reg_status_form->form_open( |
|
| 1735 | + self::add_query_args_and_nonce( |
|
| 1736 | + array( |
|
| 1737 | + 'action' => 'change_reg_status', |
|
| 1738 | + ), |
|
| 1739 | + REG_ADMIN_URL |
|
| 1740 | + ) |
|
| 1741 | + ); |
|
| 1742 | + echo $change_reg_status_form->get_html(); |
|
| 1743 | + echo $change_reg_status_form->form_close(); |
|
| 1744 | + } |
|
| 1745 | + |
|
| 1746 | + |
|
| 1747 | + /** |
|
| 1748 | + * @return EE_Form_Section_Proper |
|
| 1749 | + * @throws EE_Error |
|
| 1750 | + * @throws InvalidArgumentException |
|
| 1751 | + * @throws InvalidDataTypeException |
|
| 1752 | + * @throws InvalidInterfaceException |
|
| 1753 | + * @throws \EventEspresso\core\exceptions\EntityNotFoundException |
|
| 1754 | + */ |
|
| 1755 | + protected function _generate_reg_status_change_form() |
|
| 1756 | + { |
|
| 1757 | + $reg_status_change_form_array = array( |
|
| 1758 | + 'name' => 'reg_status_change_form', |
|
| 1759 | + 'html_id' => 'reg-status-change-form', |
|
| 1760 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
| 1761 | + 'subsections' => array( |
|
| 1762 | + 'return' => new EE_Hidden_Input( |
|
| 1763 | + array( |
|
| 1764 | + 'name' => 'return', |
|
| 1765 | + 'default' => 'view_registration', |
|
| 1766 | + ) |
|
| 1767 | + ), |
|
| 1768 | + 'REG_ID' => new EE_Hidden_Input( |
|
| 1769 | + array( |
|
| 1770 | + 'name' => 'REG_ID', |
|
| 1771 | + 'default' => $this->_registration->ID(), |
|
| 1772 | + ) |
|
| 1773 | + ), |
|
| 1774 | + 'current_status' => new EE_Form_Section_HTML( |
|
| 1775 | + EEH_HTML::tr( |
|
| 1776 | + EEH_HTML::th( |
|
| 1777 | + EEH_HTML::label( |
|
| 1778 | + EEH_HTML::strong( |
|
| 1779 | + esc_html__('Current Registration Status', 'event_espresso') |
|
| 1780 | + ) |
|
| 1781 | + ) |
|
| 1782 | + ) |
|
| 1783 | + . EEH_HTML::td( |
|
| 1784 | + EEH_HTML::strong( |
|
| 1785 | + $this->_registration->pretty_status(), |
|
| 1786 | + '', |
|
| 1787 | + 'status-' . $this->_registration->status_ID(), |
|
| 1788 | + 'line-height: 1em; font-size: 1.5em; font-weight: bold;' |
|
| 1789 | + ) |
|
| 1790 | + ) |
|
| 1791 | + ) |
|
| 1792 | + ) |
|
| 1793 | + ) |
|
| 1794 | + ); |
|
| 1795 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 1796 | + 'ee_edit_registration', |
|
| 1797 | + 'toggle_registration_status', |
|
| 1798 | + $this->_registration->ID() |
|
| 1799 | + )) { |
|
| 1800 | + $reg_status_change_form_array['subsections']['reg_status'] = new EE_Select_Input( |
|
| 1801 | + $this->_get_reg_statuses(), |
|
| 1802 | + array( |
|
| 1803 | + 'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'), |
|
| 1804 | + 'default' => $this->_registration->status_ID(), |
|
| 1805 | + ) |
|
| 1806 | + ); |
|
| 1807 | + $reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input( |
|
| 1808 | + array( |
|
| 1809 | + 'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'), |
|
| 1810 | + 'default' => false, |
|
| 1811 | + 'html_help_text' => esc_html__( |
|
| 1812 | + 'If set to "Yes", then the related messages will be sent to the registrant.', |
|
| 1813 | + 'event_espresso' |
|
| 1814 | + ) |
|
| 1815 | + ) |
|
| 1816 | + ); |
|
| 1817 | + $reg_status_change_form_array['subsections']['submit'] = new EE_Submit_Input( |
|
| 1818 | + array( |
|
| 1819 | + 'html_class' => 'button-primary', |
|
| 1820 | + 'html_label_text' => ' ', |
|
| 1821 | + 'default' => esc_html__('Update Registration Status', 'event_espresso'), |
|
| 1822 | + ) |
|
| 1823 | + ); |
|
| 1824 | + } |
|
| 1825 | + return new EE_Form_Section_Proper($reg_status_change_form_array); |
|
| 1826 | + } |
|
| 1827 | + |
|
| 1828 | + |
|
| 1829 | + /** |
|
| 1830 | + * Returns an array of all the buttons for the various statuses and switch status actions |
|
| 1831 | + * |
|
| 1832 | + * @return array |
|
| 1833 | + * @throws EE_Error |
|
| 1834 | + * @throws InvalidArgumentException |
|
| 1835 | + * @throws InvalidDataTypeException |
|
| 1836 | + * @throws InvalidInterfaceException |
|
| 1837 | + * @throws EntityNotFoundException |
|
| 1838 | + */ |
|
| 1839 | + protected function _get_reg_statuses() |
|
| 1840 | + { |
|
| 1841 | + $reg_status_array = EEM_Registration::instance()->reg_status_array(); |
|
| 1842 | + unset($reg_status_array[ EEM_Registration::status_id_incomplete ]); |
|
| 1843 | + // get current reg status |
|
| 1844 | + $current_status = $this->_registration->status_ID(); |
|
| 1845 | + // is registration for free event? This will determine whether to display the pending payment option |
|
| 1846 | + if ($current_status !== EEM_Registration::status_id_pending_payment |
|
| 1847 | + && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00) |
|
| 1848 | + ) { |
|
| 1849 | + unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]); |
|
| 1850 | + } |
|
| 1851 | + return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence'); |
|
| 1852 | + } |
|
| 1853 | + |
|
| 1854 | + |
|
| 1855 | + /** |
|
| 1856 | + * This method is used when using _REG_ID from request which may or may not be an array of reg_ids. |
|
| 1857 | + * |
|
| 1858 | + * @param bool $status REG status given for changing registrations to. |
|
| 1859 | + * @param bool $notify Whether to send messages notifications or not. |
|
| 1860 | + * @return array (array with reg_id(s) updated and whether update was successful. |
|
| 1861 | + * @throws EE_Error |
|
| 1862 | + * @throws InvalidArgumentException |
|
| 1863 | + * @throws InvalidDataTypeException |
|
| 1864 | + * @throws InvalidInterfaceException |
|
| 1865 | + * @throws ReflectionException |
|
| 1866 | + * @throws RuntimeException |
|
| 1867 | + * @throws EntityNotFoundException |
|
| 1868 | + */ |
|
| 1869 | + protected function _set_registration_status_from_request($status = false, $notify = false) |
|
| 1870 | + { |
|
| 1871 | + if (isset($this->_req_data['reg_status_change_form'])) { |
|
| 1872 | + $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID']) |
|
| 1873 | + ? (array) $this->_req_data['reg_status_change_form']['REG_ID'] |
|
| 1874 | + : array(); |
|
| 1875 | + } else { |
|
| 1876 | + $REG_IDs = isset($this->_req_data['_REG_ID']) |
|
| 1877 | + ? (array) $this->_req_data['_REG_ID'] |
|
| 1878 | + : array(); |
|
| 1879 | + } |
|
| 1880 | + // sanitize $REG_IDs |
|
| 1881 | + $REG_IDs = array_map('absint', $REG_IDs); |
|
| 1882 | + // and remove empty entries |
|
| 1883 | + $REG_IDs = array_filter($REG_IDs); |
|
| 1884 | + |
|
| 1885 | + $result = $this->_set_registration_status($REG_IDs, $status, $notify); |
|
| 1886 | + |
|
| 1887 | + /** |
|
| 1888 | + * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications. |
|
| 1889 | + * Currently this value is used downstream by the _process_resend_registration method. |
|
| 1890 | + * |
|
| 1891 | + * @param int|array $registration_ids The registration ids that have had their status changed successfully. |
|
| 1892 | + * @param bool $status The status registrations were changed to. |
|
| 1893 | + * @param bool $success If the status was changed successfully for all registrations. |
|
| 1894 | + * @param Registrations_Admin_Page $admin_page_object |
|
| 1895 | + */ |
|
| 1896 | + $this->_req_data['_REG_ID'] = apply_filters( |
|
| 1897 | + 'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs', |
|
| 1898 | + $result['REG_ID'], |
|
| 1899 | + $status, |
|
| 1900 | + $result['success'], |
|
| 1901 | + $this |
|
| 1902 | + ); |
|
| 1903 | + |
|
| 1904 | + // notify? |
|
| 1905 | + if ($notify |
|
| 1906 | + && $result['success'] |
|
| 1907 | + && ! empty($this->_req_data['_REG_ID']) |
|
| 1908 | + && EE_Registry::instance()->CAP->current_user_can( |
|
| 1909 | + 'ee_send_message', |
|
| 1910 | + 'espresso_registrations_resend_registration' |
|
| 1911 | + ) |
|
| 1912 | + ) { |
|
| 1913 | + $this->_process_resend_registration(); |
|
| 1914 | + } |
|
| 1915 | + return $result; |
|
| 1916 | + } |
|
| 1917 | + |
|
| 1918 | + |
|
| 1919 | + /** |
|
| 1920 | + * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an |
|
| 1921 | + * array). Note, this method does NOT take care of possible notifications. That is required by calling code. |
|
| 1922 | + * |
|
| 1923 | + * @param array $REG_IDs |
|
| 1924 | + * @param string $status |
|
| 1925 | + * @param bool $notify Used to indicate whether notification was requested or not. This determines the context |
|
| 1926 | + * slug sent with setting the registration status. |
|
| 1927 | + * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as |
|
| 1928 | + * @throws EE_Error |
|
| 1929 | + * @throws InvalidArgumentException |
|
| 1930 | + * @throws InvalidDataTypeException |
|
| 1931 | + * @throws InvalidInterfaceException |
|
| 1932 | + * @throws ReflectionException |
|
| 1933 | + * @throws RuntimeException |
|
| 1934 | + * @throws EntityNotFoundException |
|
| 1935 | + */ |
|
| 1936 | + protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false) |
|
| 1937 | + { |
|
| 1938 | + $success = false; |
|
| 1939 | + // typecast $REG_IDs |
|
| 1940 | + $REG_IDs = (array) $REG_IDs; |
|
| 1941 | + if (! empty($REG_IDs)) { |
|
| 1942 | + $success = true; |
|
| 1943 | + // set default status if none is passed |
|
| 1944 | + $status = $status ? $status : EEM_Registration::status_id_pending_payment; |
|
| 1945 | + $status_context = $notify |
|
| 1946 | + ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY |
|
| 1947 | + : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN; |
|
| 1948 | + // loop through REG_ID's and change status |
|
| 1949 | + foreach ($REG_IDs as $REG_ID) { |
|
| 1950 | + $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 1951 | + if ($registration instanceof EE_Registration) { |
|
| 1952 | + $registration->set_status( |
|
| 1953 | + $status, |
|
| 1954 | + false, |
|
| 1955 | + new Context( |
|
| 1956 | + $status_context, |
|
| 1957 | + esc_html__( |
|
| 1958 | + 'Manually triggered status change on a Registration Admin Page route.', |
|
| 1959 | + 'event_espresso' |
|
| 1960 | + ) |
|
| 1961 | + ) |
|
| 1962 | + ); |
|
| 1963 | + $result = $registration->save(); |
|
| 1964 | + // verifying explicit fails because update *may* just return 0 for 0 rows affected |
|
| 1965 | + $success = $result !== false ? $success : false; |
|
| 1966 | + } |
|
| 1967 | + } |
|
| 1968 | + } |
|
| 1969 | + |
|
| 1970 | + // return $success and processed registrations |
|
| 1971 | + return array('REG_ID' => $REG_IDs, 'success' => $success); |
|
| 1972 | + } |
|
| 1973 | + |
|
| 1974 | + |
|
| 1975 | + /** |
|
| 1976 | + * Common logic for setting up success message and redirecting to appropriate route |
|
| 1977 | + * |
|
| 1978 | + * @param string $STS_ID status id for the registration changed to |
|
| 1979 | + * @param bool $notify indicates whether the _set_registration_status_from_request does notifications or not. |
|
| 1980 | + * @return void |
|
| 1981 | + * @throws EE_Error |
|
| 1982 | + */ |
|
| 1983 | + protected function _reg_status_change_return($STS_ID, $notify = false) |
|
| 1984 | + { |
|
| 1985 | + $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify) |
|
| 1986 | + : array('success' => false); |
|
| 1987 | + $success = isset($result['success']) && $result['success']; |
|
| 1988 | + // setup success message |
|
| 1989 | + if ($success) { |
|
| 1990 | + if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) { |
|
| 1991 | + $msg = sprintf( |
|
| 1992 | + esc_html__('Registration status has been set to %s', 'event_espresso'), |
|
| 1993 | + EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
| 1994 | + ); |
|
| 1995 | + } else { |
|
| 1996 | + $msg = sprintf( |
|
| 1997 | + esc_html__('Registrations have been set to %s.', 'event_espresso'), |
|
| 1998 | + EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
| 1999 | + ); |
|
| 2000 | + } |
|
| 2001 | + EE_Error::add_success($msg); |
|
| 2002 | + } else { |
|
| 2003 | + EE_Error::add_error( |
|
| 2004 | + esc_html__( |
|
| 2005 | + 'Something went wrong, and the status was not changed', |
|
| 2006 | + 'event_espresso' |
|
| 2007 | + ), |
|
| 2008 | + __FILE__, |
|
| 2009 | + __LINE__, |
|
| 2010 | + __FUNCTION__ |
|
| 2011 | + ); |
|
| 2012 | + } |
|
| 2013 | + if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') { |
|
| 2014 | + $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])); |
|
| 2015 | + } else { |
|
| 2016 | + $route = array('action' => 'default'); |
|
| 2017 | + } |
|
| 2018 | + $route = $this->mergeExistingRequestParamsWithRedirectArgs($route); |
|
| 2019 | + $this->_redirect_after_action($success, '', '', $route, true); |
|
| 2020 | + } |
|
| 2021 | + |
|
| 2022 | + |
|
| 2023 | + /** |
|
| 2024 | + * incoming reg status change from reg details page. |
|
| 2025 | + * |
|
| 2026 | + * @return void |
|
| 2027 | + */ |
|
| 2028 | + protected function _change_reg_status() |
|
| 2029 | + { |
|
| 2030 | + $this->_req_data['return'] = 'view_registration'; |
|
| 2031 | + // set notify based on whether the send notifications toggle is set or not |
|
| 2032 | + $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']); |
|
| 2033 | + // $notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] ); |
|
| 2034 | + $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status']) |
|
| 2035 | + ? $this->_req_data['reg_status_change_form']['reg_status'] : ''; |
|
| 2036 | + switch ($this->_req_data['reg_status_change_form']['reg_status']) { |
|
| 2037 | + case EEM_Registration::status_id_approved: |
|
| 2038 | + case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'): |
|
| 2039 | + $this->approve_registration($notify); |
|
| 2040 | + break; |
|
| 2041 | + case EEM_Registration::status_id_pending_payment: |
|
| 2042 | + case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'): |
|
| 2043 | + $this->pending_registration($notify); |
|
| 2044 | + break; |
|
| 2045 | + case EEM_Registration::status_id_not_approved: |
|
| 2046 | + case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'): |
|
| 2047 | + $this->not_approve_registration($notify); |
|
| 2048 | + break; |
|
| 2049 | + case EEM_Registration::status_id_declined: |
|
| 2050 | + case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'): |
|
| 2051 | + $this->decline_registration($notify); |
|
| 2052 | + break; |
|
| 2053 | + case EEM_Registration::status_id_cancelled: |
|
| 2054 | + case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'): |
|
| 2055 | + $this->cancel_registration($notify); |
|
| 2056 | + break; |
|
| 2057 | + case EEM_Registration::status_id_wait_list: |
|
| 2058 | + case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'): |
|
| 2059 | + $this->wait_list_registration($notify); |
|
| 2060 | + break; |
|
| 2061 | + case EEM_Registration::status_id_incomplete: |
|
| 2062 | + default: |
|
| 2063 | + $result['success'] = false; |
|
| 2064 | + unset($this->_req_data['return']); |
|
| 2065 | + $this->_reg_status_change_return('', false); |
|
| 2066 | + break; |
|
| 2067 | + } |
|
| 2068 | + } |
|
| 2069 | + |
|
| 2070 | + |
|
| 2071 | + /** |
|
| 2072 | + * Callback for bulk action routes. |
|
| 2073 | + * Note: although we could just register the singular route callbacks for each bulk action route as well, this |
|
| 2074 | + * method was chosen so there is one central place all the registration status bulk actions are going through. |
|
| 2075 | + * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to |
|
| 2076 | + * when an action is happening on just a single registration). |
|
| 2077 | + * |
|
| 2078 | + * @param $action |
|
| 2079 | + * @param bool $notify |
|
| 2080 | + */ |
|
| 2081 | + protected function bulk_action_on_registrations($action, $notify = false) |
|
| 2082 | + { |
|
| 2083 | + do_action( |
|
| 2084 | + 'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution', |
|
| 2085 | + $this, |
|
| 2086 | + $action, |
|
| 2087 | + $notify |
|
| 2088 | + ); |
|
| 2089 | + $method = $action . '_registration'; |
|
| 2090 | + if (method_exists($this, $method)) { |
|
| 2091 | + $this->$method($notify); |
|
| 2092 | + } |
|
| 2093 | + } |
|
| 2094 | + |
|
| 2095 | + |
|
| 2096 | + /** |
|
| 2097 | + * approve_registration |
|
| 2098 | + * |
|
| 2099 | + * @access protected |
|
| 2100 | + * @param bool $notify whether or not to notify the registrant about their approval. |
|
| 2101 | + * @return void |
|
| 2102 | + */ |
|
| 2103 | + protected function approve_registration($notify = false) |
|
| 2104 | + { |
|
| 2105 | + $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify); |
|
| 2106 | + } |
|
| 2107 | + |
|
| 2108 | + |
|
| 2109 | + /** |
|
| 2110 | + * decline_registration |
|
| 2111 | + * |
|
| 2112 | + * @access protected |
|
| 2113 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2114 | + * @return void |
|
| 2115 | + */ |
|
| 2116 | + protected function decline_registration($notify = false) |
|
| 2117 | + { |
|
| 2118 | + $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify); |
|
| 2119 | + } |
|
| 2120 | + |
|
| 2121 | + |
|
| 2122 | + /** |
|
| 2123 | + * cancel_registration |
|
| 2124 | + * |
|
| 2125 | + * @access protected |
|
| 2126 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2127 | + * @return void |
|
| 2128 | + */ |
|
| 2129 | + protected function cancel_registration($notify = false) |
|
| 2130 | + { |
|
| 2131 | + $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify); |
|
| 2132 | + } |
|
| 2133 | + |
|
| 2134 | + |
|
| 2135 | + /** |
|
| 2136 | + * not_approve_registration |
|
| 2137 | + * |
|
| 2138 | + * @access protected |
|
| 2139 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2140 | + * @return void |
|
| 2141 | + */ |
|
| 2142 | + protected function not_approve_registration($notify = false) |
|
| 2143 | + { |
|
| 2144 | + $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify); |
|
| 2145 | + } |
|
| 2146 | + |
|
| 2147 | + |
|
| 2148 | + /** |
|
| 2149 | + * decline_registration |
|
| 2150 | + * |
|
| 2151 | + * @access protected |
|
| 2152 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2153 | + * @return void |
|
| 2154 | + */ |
|
| 2155 | + protected function pending_registration($notify = false) |
|
| 2156 | + { |
|
| 2157 | + $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify); |
|
| 2158 | + } |
|
| 2159 | + |
|
| 2160 | + |
|
| 2161 | + /** |
|
| 2162 | + * waitlist_registration |
|
| 2163 | + * |
|
| 2164 | + * @access protected |
|
| 2165 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 2166 | + * @return void |
|
| 2167 | + */ |
|
| 2168 | + protected function wait_list_registration($notify = false) |
|
| 2169 | + { |
|
| 2170 | + $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify); |
|
| 2171 | + } |
|
| 2172 | + |
|
| 2173 | + |
|
| 2174 | + /** |
|
| 2175 | + * generates HTML for the Registration main meta box |
|
| 2176 | + * |
|
| 2177 | + * @access public |
|
| 2178 | + * @return void |
|
| 2179 | + * @throws DomainException |
|
| 2180 | + * @throws EE_Error |
|
| 2181 | + * @throws InvalidArgumentException |
|
| 2182 | + * @throws InvalidDataTypeException |
|
| 2183 | + * @throws InvalidInterfaceException |
|
| 2184 | + * @throws ReflectionException |
|
| 2185 | + * @throws EntityNotFoundException |
|
| 2186 | + */ |
|
| 2187 | + public function _reg_details_meta_box() |
|
| 2188 | + { |
|
| 2189 | + EEH_Autoloader::register_line_item_display_autoloaders(); |
|
| 2190 | + EEH_Autoloader::register_line_item_filter_autoloaders(); |
|
| 2191 | + EE_Registry::instance()->load_helper('Line_Item'); |
|
| 2192 | + $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
| 2193 | + : EE_Transaction::new_instance(); |
|
| 2194 | + $this->_session = $transaction->session_data(); |
|
| 2195 | + $filters = new EE_Line_Item_Filter_Collection(); |
|
| 2196 | + // $filters->add( new EE_Non_Zero_Line_Item_Filter() ); |
|
| 2197 | + $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration)); |
|
| 2198 | + $line_item_filter_processor = new EE_Line_Item_Filter_Processor( |
|
| 2199 | + $filters, |
|
| 2200 | + $transaction->total_line_item() |
|
| 2201 | + ); |
|
| 2202 | + $filtered_line_item_tree = $line_item_filter_processor->process(); |
|
| 2203 | + $line_item_display = new EE_Line_Item_Display( |
|
| 2204 | + 'reg_admin_table', |
|
| 2205 | + 'EE_Admin_Table_Registration_Line_Item_Display_Strategy' |
|
| 2206 | + ); |
|
| 2207 | + $this->_template_args['line_item_table'] = $line_item_display->display_line_item( |
|
| 2208 | + $filtered_line_item_tree, |
|
| 2209 | + array('EE_Registration' => $this->_registration) |
|
| 2210 | + ); |
|
| 2211 | + $attendee = $this->_registration->attendee(); |
|
| 2212 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 2213 | + 'ee_read_transaction', |
|
| 2214 | + 'espresso_transactions_view_transaction' |
|
| 2215 | + )) { |
|
| 2216 | + $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link( |
|
| 2217 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 2218 | + array( |
|
| 2219 | + 'action' => 'view_transaction', |
|
| 2220 | + 'TXN_ID' => $transaction->ID(), |
|
| 2221 | + ), |
|
| 2222 | + TXN_ADMIN_URL |
|
| 2223 | + ), |
|
| 2224 | + esc_html__(' View Transaction', 'event_espresso'), |
|
| 2225 | + 'button secondary-button right', |
|
| 2226 | + 'dashicons dashicons-cart' |
|
| 2227 | + ); |
|
| 2228 | + } else { |
|
| 2229 | + $this->_template_args['view_transaction_button'] = ''; |
|
| 2230 | + } |
|
| 2231 | + if ($attendee instanceof EE_Attendee |
|
| 2232 | + && EE_Registry::instance()->CAP->current_user_can( |
|
| 2233 | + 'ee_send_message', |
|
| 2234 | + 'espresso_registrations_resend_registration' |
|
| 2235 | + ) |
|
| 2236 | + ) { |
|
| 2237 | + $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link( |
|
| 2238 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 2239 | + array( |
|
| 2240 | + 'action' => 'resend_registration', |
|
| 2241 | + '_REG_ID' => $this->_registration->ID(), |
|
| 2242 | + 'redirect_to' => 'view_registration', |
|
| 2243 | + ), |
|
| 2244 | + REG_ADMIN_URL |
|
| 2245 | + ), |
|
| 2246 | + esc_html__(' Resend Registration', 'event_espresso'), |
|
| 2247 | + 'button secondary-button right', |
|
| 2248 | + 'dashicons dashicons-email-alt' |
|
| 2249 | + ); |
|
| 2250 | + } else { |
|
| 2251 | + $this->_template_args['resend_registration_button'] = ''; |
|
| 2252 | + } |
|
| 2253 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 2254 | + $payment = $transaction->get_first_related('Payment'); |
|
| 2255 | + $payment = ! $payment instanceof EE_Payment |
|
| 2256 | + ? EE_Payment::new_instance() |
|
| 2257 | + : $payment; |
|
| 2258 | + $payment_method = $payment->get_first_related('Payment_Method'); |
|
| 2259 | + $payment_method = ! $payment_method instanceof EE_Payment_Method |
|
| 2260 | + ? EE_Payment_Method::new_instance() |
|
| 2261 | + : $payment_method; |
|
| 2262 | + $reg_details = array( |
|
| 2263 | + 'payment_method' => $payment_method->name(), |
|
| 2264 | + 'response_msg' => $payment->gateway_response(), |
|
| 2265 | + 'registration_id' => $this->_registration->get('REG_code'), |
|
| 2266 | + 'registration_session' => $this->_registration->session_ID(), |
|
| 2267 | + 'ip_address' => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '', |
|
| 2268 | + 'user_agent' => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '', |
|
| 2269 | + ); |
|
| 2270 | + if (isset($reg_details['registration_id'])) { |
|
| 2271 | + $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id']; |
|
| 2272 | + $this->_template_args['reg_details']['registration_id']['label'] = esc_html__( |
|
| 2273 | + 'Registration ID', |
|
| 2274 | + 'event_espresso' |
|
| 2275 | + ); |
|
| 2276 | + $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text'; |
|
| 2277 | + } |
|
| 2278 | + if (isset($reg_details['payment_method'])) { |
|
| 2279 | + $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method']; |
|
| 2280 | + $this->_template_args['reg_details']['payment_method']['label'] = esc_html__( |
|
| 2281 | + 'Most Recent Payment Method', |
|
| 2282 | + 'event_espresso' |
|
| 2283 | + ); |
|
| 2284 | + $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text'; |
|
| 2285 | + $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg']; |
|
| 2286 | + $this->_template_args['reg_details']['response_msg']['label'] = esc_html__( |
|
| 2287 | + 'Payment method response', |
|
| 2288 | + 'event_espresso' |
|
| 2289 | + ); |
|
| 2290 | + $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text'; |
|
| 2291 | + } |
|
| 2292 | + $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session']; |
|
| 2293 | + $this->_template_args['reg_details']['registration_session']['label'] = esc_html__( |
|
| 2294 | + 'Registration Session', |
|
| 2295 | + 'event_espresso' |
|
| 2296 | + ); |
|
| 2297 | + $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text'; |
|
| 2298 | + $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address']; |
|
| 2299 | + $this->_template_args['reg_details']['ip_address']['label'] = esc_html__( |
|
| 2300 | + 'Registration placed from IP', |
|
| 2301 | + 'event_espresso' |
|
| 2302 | + ); |
|
| 2303 | + $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text'; |
|
| 2304 | + $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent']; |
|
| 2305 | + $this->_template_args['reg_details']['user_agent']['label'] = esc_html__( |
|
| 2306 | + 'Registrant User Agent', |
|
| 2307 | + 'event_espresso' |
|
| 2308 | + ); |
|
| 2309 | + $this->_template_args['reg_details']['user_agent']['class'] = 'large-text'; |
|
| 2310 | + $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 2311 | + array( |
|
| 2312 | + 'action' => 'default', |
|
| 2313 | + 'event_id' => $this->_registration->event_ID(), |
|
| 2314 | + ), |
|
| 2315 | + REG_ADMIN_URL |
|
| 2316 | + ); |
|
| 2317 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 2318 | + $this->_template_args['event_id'] = $this->_registration->event_ID(); |
|
| 2319 | + $template_path = |
|
| 2320 | + REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
| 2321 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2322 | + } |
|
| 2323 | + |
|
| 2324 | + |
|
| 2325 | + /** |
|
| 2326 | + * generates HTML for the Registration Questions meta box. |
|
| 2327 | + * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters), |
|
| 2328 | + * otherwise uses new forms system |
|
| 2329 | + * |
|
| 2330 | + * @access public |
|
| 2331 | + * @return void |
|
| 2332 | + * @throws DomainException |
|
| 2333 | + * @throws EE_Error |
|
| 2334 | + */ |
|
| 2335 | + public function _reg_questions_meta_box() |
|
| 2336 | + { |
|
| 2337 | + // allow someone to override this method entirely |
|
| 2338 | + if (apply_filters( |
|
| 2339 | + 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', |
|
| 2340 | + true, |
|
| 2341 | + $this, |
|
| 2342 | + $this->_registration |
|
| 2343 | + )) { |
|
| 2344 | + $form = $this->_get_reg_custom_questions_form( |
|
| 2345 | + $this->_registration->ID() |
|
| 2346 | + ); |
|
| 2347 | + $this->_template_args['att_questions'] = count($form->subforms()) > 0 |
|
| 2348 | + ? $form->get_html_and_js() |
|
| 2349 | + : ''; |
|
| 2350 | + $this->_template_args['reg_questions_form_action'] = 'edit_registration'; |
|
| 2351 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 2352 | + $template_path = |
|
| 2353 | + REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 2354 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2355 | + } |
|
| 2356 | + } |
|
| 2357 | + |
|
| 2358 | + |
|
| 2359 | + /** |
|
| 2360 | + * form_before_question_group |
|
| 2361 | + * |
|
| 2362 | + * @deprecated as of 4.8.32.rc.000 |
|
| 2363 | + * @access public |
|
| 2364 | + * @param string $output |
|
| 2365 | + * @return string |
|
| 2366 | + */ |
|
| 2367 | + public function form_before_question_group($output) |
|
| 2368 | + { |
|
| 2369 | + EE_Error::doing_it_wrong( |
|
| 2370 | + __CLASS__ . '::' . __FUNCTION__, |
|
| 2371 | + esc_html__( |
|
| 2372 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2373 | + 'event_espresso' |
|
| 2374 | + ), |
|
| 2375 | + '4.8.32.rc.000' |
|
| 2376 | + ); |
|
| 2377 | + return ' |
|
| 2378 | 2378 | <table class="form-table ee-width-100"> |
| 2379 | 2379 | <tbody> |
| 2380 | 2380 | '; |
| 2381 | - } |
|
| 2382 | - |
|
| 2383 | - |
|
| 2384 | - /** |
|
| 2385 | - * form_after_question_group |
|
| 2386 | - * |
|
| 2387 | - * @deprecated as of 4.8.32.rc.000 |
|
| 2388 | - * @access public |
|
| 2389 | - * @param string $output |
|
| 2390 | - * @return string |
|
| 2391 | - */ |
|
| 2392 | - public function form_after_question_group($output) |
|
| 2393 | - { |
|
| 2394 | - EE_Error::doing_it_wrong( |
|
| 2395 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2396 | - esc_html__( |
|
| 2397 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2398 | - 'event_espresso' |
|
| 2399 | - ), |
|
| 2400 | - '4.8.32.rc.000' |
|
| 2401 | - ); |
|
| 2402 | - return ' |
|
| 2381 | + } |
|
| 2382 | + |
|
| 2383 | + |
|
| 2384 | + /** |
|
| 2385 | + * form_after_question_group |
|
| 2386 | + * |
|
| 2387 | + * @deprecated as of 4.8.32.rc.000 |
|
| 2388 | + * @access public |
|
| 2389 | + * @param string $output |
|
| 2390 | + * @return string |
|
| 2391 | + */ |
|
| 2392 | + public function form_after_question_group($output) |
|
| 2393 | + { |
|
| 2394 | + EE_Error::doing_it_wrong( |
|
| 2395 | + __CLASS__ . '::' . __FUNCTION__, |
|
| 2396 | + esc_html__( |
|
| 2397 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2398 | + 'event_espresso' |
|
| 2399 | + ), |
|
| 2400 | + '4.8.32.rc.000' |
|
| 2401 | + ); |
|
| 2402 | + return ' |
|
| 2403 | 2403 | <tr class="hide-if-no-js"> |
| 2404 | 2404 | <th> </th> |
| 2405 | 2405 | <td class="reg-admin-edit-attendee-question-td"> |
| 2406 | 2406 | <a class="reg-admin-edit-attendee-question-lnk" href="#" title="' |
| 2407 | - . esc_attr__('click to edit question', 'event_espresso') |
|
| 2408 | - . '"> |
|
| 2407 | + . esc_attr__('click to edit question', 'event_espresso') |
|
| 2408 | + . '"> |
|
| 2409 | 2409 | <span class="reg-admin-edit-question-group-spn lt-grey-txt">' |
| 2410 | - . esc_html__('edit the above question group', 'event_espresso') |
|
| 2411 | - . '</span> |
|
| 2410 | + . esc_html__('edit the above question group', 'event_espresso') |
|
| 2411 | + . '</span> |
|
| 2412 | 2412 | <div class="dashicons dashicons-edit"></div> |
| 2413 | 2413 | </a> |
| 2414 | 2414 | </td> |
@@ -2416,608 +2416,608 @@ discard block |
||
| 2416 | 2416 | </tbody> |
| 2417 | 2417 | </table> |
| 2418 | 2418 | '; |
| 2419 | - } |
|
| 2420 | - |
|
| 2421 | - |
|
| 2422 | - /** |
|
| 2423 | - * form_form_field_label_wrap |
|
| 2424 | - * |
|
| 2425 | - * @deprecated as of 4.8.32.rc.000 |
|
| 2426 | - * @access public |
|
| 2427 | - * @param string $label |
|
| 2428 | - * @return string |
|
| 2429 | - */ |
|
| 2430 | - public function form_form_field_label_wrap($label) |
|
| 2431 | - { |
|
| 2432 | - EE_Error::doing_it_wrong( |
|
| 2433 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2434 | - esc_html__( |
|
| 2435 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2436 | - 'event_espresso' |
|
| 2437 | - ), |
|
| 2438 | - '4.8.32.rc.000' |
|
| 2439 | - ); |
|
| 2440 | - return ' |
|
| 2419 | + } |
|
| 2420 | + |
|
| 2421 | + |
|
| 2422 | + /** |
|
| 2423 | + * form_form_field_label_wrap |
|
| 2424 | + * |
|
| 2425 | + * @deprecated as of 4.8.32.rc.000 |
|
| 2426 | + * @access public |
|
| 2427 | + * @param string $label |
|
| 2428 | + * @return string |
|
| 2429 | + */ |
|
| 2430 | + public function form_form_field_label_wrap($label) |
|
| 2431 | + { |
|
| 2432 | + EE_Error::doing_it_wrong( |
|
| 2433 | + __CLASS__ . '::' . __FUNCTION__, |
|
| 2434 | + esc_html__( |
|
| 2435 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2436 | + 'event_espresso' |
|
| 2437 | + ), |
|
| 2438 | + '4.8.32.rc.000' |
|
| 2439 | + ); |
|
| 2440 | + return ' |
|
| 2441 | 2441 | <tr> |
| 2442 | 2442 | <th> |
| 2443 | 2443 | ' . $label . ' |
| 2444 | 2444 | </th>'; |
| 2445 | - } |
|
| 2446 | - |
|
| 2447 | - |
|
| 2448 | - /** |
|
| 2449 | - * form_form_field_input__wrap |
|
| 2450 | - * |
|
| 2451 | - * @deprecated as of 4.8.32.rc.000 |
|
| 2452 | - * @access public |
|
| 2453 | - * @param string $input |
|
| 2454 | - * @return string |
|
| 2455 | - */ |
|
| 2456 | - public function form_form_field_input__wrap($input) |
|
| 2457 | - { |
|
| 2458 | - EE_Error::doing_it_wrong( |
|
| 2459 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2460 | - esc_html__( |
|
| 2461 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2462 | - 'event_espresso' |
|
| 2463 | - ), |
|
| 2464 | - '4.8.32.rc.000' |
|
| 2465 | - ); |
|
| 2466 | - return ' |
|
| 2445 | + } |
|
| 2446 | + |
|
| 2447 | + |
|
| 2448 | + /** |
|
| 2449 | + * form_form_field_input__wrap |
|
| 2450 | + * |
|
| 2451 | + * @deprecated as of 4.8.32.rc.000 |
|
| 2452 | + * @access public |
|
| 2453 | + * @param string $input |
|
| 2454 | + * @return string |
|
| 2455 | + */ |
|
| 2456 | + public function form_form_field_input__wrap($input) |
|
| 2457 | + { |
|
| 2458 | + EE_Error::doing_it_wrong( |
|
| 2459 | + __CLASS__ . '::' . __FUNCTION__, |
|
| 2460 | + esc_html__( |
|
| 2461 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
| 2462 | + 'event_espresso' |
|
| 2463 | + ), |
|
| 2464 | + '4.8.32.rc.000' |
|
| 2465 | + ); |
|
| 2466 | + return ' |
|
| 2467 | 2467 | <td class="reg-admin-attendee-questions-input-td disabled-input"> |
| 2468 | 2468 | ' . $input . ' |
| 2469 | 2469 | </td> |
| 2470 | 2470 | </tr>'; |
| 2471 | - } |
|
| 2472 | - |
|
| 2473 | - |
|
| 2474 | - /** |
|
| 2475 | - * Updates the registration's custom questions according to the form info, if the form is submitted. |
|
| 2476 | - * If it's not a post, the "view_registrations" route will be called next on the SAME request |
|
| 2477 | - * to display the page |
|
| 2478 | - * |
|
| 2479 | - * @access protected |
|
| 2480 | - * @return void |
|
| 2481 | - * @throws EE_Error |
|
| 2482 | - */ |
|
| 2483 | - protected function _update_attendee_registration_form() |
|
| 2484 | - { |
|
| 2485 | - do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this); |
|
| 2486 | - if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
| 2487 | - $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 2488 | - $success = $this->_save_reg_custom_questions_form($REG_ID); |
|
| 2489 | - if ($success) { |
|
| 2490 | - $what = esc_html__('Registration Form', 'event_espresso'); |
|
| 2491 | - $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) |
|
| 2492 | - : array('action' => 'default'); |
|
| 2493 | - $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route); |
|
| 2494 | - } |
|
| 2495 | - } |
|
| 2496 | - } |
|
| 2497 | - |
|
| 2498 | - |
|
| 2499 | - /** |
|
| 2500 | - * Gets the form for saving registrations custom questions (if done |
|
| 2501 | - * previously retrieves the cached form object, which may have validation errors in it) |
|
| 2502 | - * |
|
| 2503 | - * @param int $REG_ID |
|
| 2504 | - * @return EE_Registration_Custom_Questions_Form |
|
| 2505 | - * @throws EE_Error |
|
| 2506 | - * @throws InvalidArgumentException |
|
| 2507 | - * @throws InvalidDataTypeException |
|
| 2508 | - * @throws InvalidInterfaceException |
|
| 2509 | - */ |
|
| 2510 | - protected function _get_reg_custom_questions_form($REG_ID) |
|
| 2511 | - { |
|
| 2512 | - if (! $this->_reg_custom_questions_form) { |
|
| 2513 | - require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php'); |
|
| 2514 | - $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form( |
|
| 2515 | - EEM_Registration::instance()->get_one_by_ID($REG_ID) |
|
| 2516 | - ); |
|
| 2517 | - $this->_reg_custom_questions_form->_construct_finalize(null, null); |
|
| 2518 | - } |
|
| 2519 | - return $this->_reg_custom_questions_form; |
|
| 2520 | - } |
|
| 2521 | - |
|
| 2522 | - |
|
| 2523 | - /** |
|
| 2524 | - * Saves |
|
| 2525 | - * |
|
| 2526 | - * @access private |
|
| 2527 | - * @param bool $REG_ID |
|
| 2528 | - * @return bool |
|
| 2529 | - * @throws EE_Error |
|
| 2530 | - * @throws InvalidArgumentException |
|
| 2531 | - * @throws InvalidDataTypeException |
|
| 2532 | - * @throws InvalidInterfaceException |
|
| 2533 | - */ |
|
| 2534 | - private function _save_reg_custom_questions_form($REG_ID = false) |
|
| 2535 | - { |
|
| 2536 | - if (! $REG_ID) { |
|
| 2537 | - EE_Error::add_error( |
|
| 2538 | - esc_html__( |
|
| 2539 | - 'An error occurred. No registration ID was received.', |
|
| 2540 | - 'event_espresso' |
|
| 2541 | - ), |
|
| 2542 | - __FILE__, |
|
| 2543 | - __FUNCTION__, |
|
| 2544 | - __LINE__ |
|
| 2545 | - ); |
|
| 2546 | - } |
|
| 2547 | - $form = $this->_get_reg_custom_questions_form($REG_ID); |
|
| 2548 | - $form->receive_form_submission($this->_req_data); |
|
| 2549 | - $success = false; |
|
| 2550 | - if ($form->is_valid()) { |
|
| 2551 | - foreach ($form->subforms() as $question_group_id => $question_group_form) { |
|
| 2552 | - foreach ($question_group_form->inputs() as $question_id => $input) { |
|
| 2553 | - $where_conditions = array( |
|
| 2554 | - 'QST_ID' => $question_id, |
|
| 2555 | - 'REG_ID' => $REG_ID, |
|
| 2556 | - ); |
|
| 2557 | - $possibly_new_values = array( |
|
| 2558 | - 'ANS_value' => $input->normalized_value(), |
|
| 2559 | - ); |
|
| 2560 | - $answer = EEM_Answer::instance()->get_one(array($where_conditions)); |
|
| 2561 | - if ($answer instanceof EE_Answer) { |
|
| 2562 | - $success = $answer->save($possibly_new_values); |
|
| 2563 | - } else { |
|
| 2564 | - // insert it then |
|
| 2565 | - $cols_n_vals = array_merge($where_conditions, $possibly_new_values); |
|
| 2566 | - $answer = EE_Answer::new_instance($cols_n_vals); |
|
| 2567 | - $success = $answer->save(); |
|
| 2568 | - } |
|
| 2569 | - } |
|
| 2570 | - } |
|
| 2571 | - } else { |
|
| 2572 | - EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__); |
|
| 2573 | - } |
|
| 2574 | - return $success; |
|
| 2575 | - } |
|
| 2576 | - |
|
| 2577 | - |
|
| 2578 | - /** |
|
| 2579 | - * generates HTML for the Registration main meta box |
|
| 2580 | - * |
|
| 2581 | - * @access public |
|
| 2582 | - * @return void |
|
| 2583 | - * @throws DomainException |
|
| 2584 | - * @throws EE_Error |
|
| 2585 | - * @throws InvalidArgumentException |
|
| 2586 | - * @throws InvalidDataTypeException |
|
| 2587 | - * @throws InvalidInterfaceException |
|
| 2588 | - */ |
|
| 2589 | - public function _reg_attendees_meta_box() |
|
| 2590 | - { |
|
| 2591 | - $REG = EEM_Registration::instance(); |
|
| 2592 | - // get all other registrations on this transaction, and cache |
|
| 2593 | - // the attendees for them so we don't have to run another query using force_join |
|
| 2594 | - $registrations = $REG->get_all( |
|
| 2595 | - array( |
|
| 2596 | - array( |
|
| 2597 | - 'TXN_ID' => $this->_registration->transaction_ID(), |
|
| 2598 | - 'REG_ID' => array('!=', $this->_registration->ID()), |
|
| 2599 | - ), |
|
| 2600 | - 'force_join' => array('Attendee'), |
|
| 2601 | - ) |
|
| 2602 | - ); |
|
| 2603 | - $this->_template_args['attendees'] = array(); |
|
| 2604 | - $this->_template_args['attendee_notice'] = ''; |
|
| 2605 | - if (empty($registrations) |
|
| 2606 | - || (is_array($registrations) |
|
| 2607 | - && ! EEH_Array::get_one_item_from_array($registrations)) |
|
| 2608 | - ) { |
|
| 2609 | - EE_Error::add_error( |
|
| 2610 | - esc_html__( |
|
| 2611 | - 'There are no records attached to this registration. Something may have gone wrong with the registration', |
|
| 2612 | - 'event_espresso' |
|
| 2613 | - ), |
|
| 2614 | - __FILE__, |
|
| 2615 | - __FUNCTION__, |
|
| 2616 | - __LINE__ |
|
| 2617 | - ); |
|
| 2618 | - $this->_template_args['attendee_notice'] = EE_Error::get_notices(); |
|
| 2619 | - } else { |
|
| 2620 | - $att_nmbr = 1; |
|
| 2621 | - foreach ($registrations as $registration) { |
|
| 2622 | - /* @var $registration EE_Registration */ |
|
| 2623 | - $attendee = $registration->attendee() |
|
| 2624 | - ? $registration->attendee() |
|
| 2625 | - : EEM_Attendee::instance() |
|
| 2626 | - ->create_default_object(); |
|
| 2627 | - $this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID(); |
|
| 2628 | - $this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname(); |
|
| 2629 | - $this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname(); |
|
| 2630 | - $this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email(); |
|
| 2631 | - $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price(); |
|
| 2632 | - $this->_template_args['attendees'][ $att_nmbr ]['address'] = implode( |
|
| 2633 | - ', ', |
|
| 2634 | - $attendee->full_address_as_array() |
|
| 2635 | - ); |
|
| 2636 | - $this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce( |
|
| 2637 | - array( |
|
| 2638 | - 'action' => 'edit_attendee', |
|
| 2639 | - 'post' => $attendee->ID(), |
|
| 2640 | - ), |
|
| 2641 | - REG_ADMIN_URL |
|
| 2642 | - ); |
|
| 2643 | - $this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event |
|
| 2644 | - ? $registration->event_obj()->name() |
|
| 2645 | - : ''; |
|
| 2646 | - $att_nmbr++; |
|
| 2647 | - } |
|
| 2648 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 2649 | - } |
|
| 2650 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php'; |
|
| 2651 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2652 | - } |
|
| 2653 | - |
|
| 2654 | - |
|
| 2655 | - /** |
|
| 2656 | - * generates HTML for the Edit Registration side meta box |
|
| 2657 | - * |
|
| 2658 | - * @access public |
|
| 2659 | - * @return void |
|
| 2660 | - * @throws DomainException |
|
| 2661 | - * @throws EE_Error |
|
| 2662 | - * @throws InvalidArgumentException |
|
| 2663 | - * @throws InvalidDataTypeException |
|
| 2664 | - * @throws InvalidInterfaceException |
|
| 2665 | - */ |
|
| 2666 | - public function _reg_registrant_side_meta_box() |
|
| 2667 | - { |
|
| 2668 | - /*@var $attendee EE_Attendee */ |
|
| 2669 | - $att_check = $this->_registration->attendee(); |
|
| 2670 | - $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object(); |
|
| 2671 | - // now let's determine if this is not the primary registration. If it isn't then we set the |
|
| 2672 | - // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the |
|
| 2673 | - // primary registration object (that way we know if we need to show create button or not) |
|
| 2674 | - if (! $this->_registration->is_primary_registrant()) { |
|
| 2675 | - $primary_registration = $this->_registration->get_primary_registration(); |
|
| 2676 | - $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() |
|
| 2677 | - : null; |
|
| 2678 | - if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
| 2679 | - // in here? This means the displayed registration is not the primary registrant but ALREADY HAS its own |
|
| 2680 | - // custom attendee object so let's not worry about the primary reg. |
|
| 2681 | - $primary_registration = null; |
|
| 2682 | - } |
|
| 2683 | - } else { |
|
| 2684 | - $primary_registration = null; |
|
| 2685 | - } |
|
| 2686 | - $this->_template_args['ATT_ID'] = $attendee->ID(); |
|
| 2687 | - $this->_template_args['fname'] = $attendee->fname(); |
|
| 2688 | - $this->_template_args['lname'] = $attendee->lname(); |
|
| 2689 | - $this->_template_args['email'] = $attendee->email(); |
|
| 2690 | - $this->_template_args['phone'] = $attendee->phone(); |
|
| 2691 | - $this->_template_args['formatted_address'] = EEH_Address::format($attendee); |
|
| 2692 | - // edit link |
|
| 2693 | - $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 2694 | - array( |
|
| 2695 | - 'action' => 'edit_attendee', |
|
| 2696 | - 'post' => $attendee->ID(), |
|
| 2697 | - ), |
|
| 2698 | - REG_ADMIN_URL |
|
| 2699 | - ); |
|
| 2700 | - $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso'); |
|
| 2701 | - // create link |
|
| 2702 | - $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration |
|
| 2703 | - ? EE_Admin_Page::add_query_args_and_nonce( |
|
| 2704 | - array( |
|
| 2705 | - 'action' => 'duplicate_attendee', |
|
| 2706 | - '_REG_ID' => $this->_registration->ID(), |
|
| 2707 | - ), |
|
| 2708 | - REG_ADMIN_URL |
|
| 2709 | - ) : ''; |
|
| 2710 | - $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso'); |
|
| 2711 | - $this->_template_args['att_check'] = $att_check; |
|
| 2712 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php'; |
|
| 2713 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2714 | - } |
|
| 2715 | - |
|
| 2716 | - |
|
| 2717 | - /** |
|
| 2718 | - * trash or restore registrations |
|
| 2719 | - * |
|
| 2720 | - * @param boolean $trash whether to archive or restore |
|
| 2721 | - * @return void |
|
| 2722 | - * @throws EE_Error |
|
| 2723 | - * @throws InvalidArgumentException |
|
| 2724 | - * @throws InvalidDataTypeException |
|
| 2725 | - * @throws InvalidInterfaceException |
|
| 2726 | - * @throws RuntimeException |
|
| 2727 | - * @access protected |
|
| 2728 | - */ |
|
| 2729 | - protected function _trash_or_restore_registrations($trash = true) |
|
| 2730 | - { |
|
| 2731 | - // if empty _REG_ID then get out because there's nothing to do |
|
| 2732 | - if (empty($this->_req_data['_REG_ID'])) { |
|
| 2733 | - EE_Error::add_error( |
|
| 2734 | - sprintf( |
|
| 2735 | - esc_html__( |
|
| 2736 | - 'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.', |
|
| 2737 | - 'event_espresso' |
|
| 2738 | - ), |
|
| 2739 | - $trash ? 'trash' : 'restore' |
|
| 2740 | - ), |
|
| 2741 | - __FILE__, |
|
| 2742 | - __LINE__, |
|
| 2743 | - __FUNCTION__ |
|
| 2744 | - ); |
|
| 2745 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
| 2746 | - } |
|
| 2747 | - $success = 0; |
|
| 2748 | - $overwrite_msgs = false; |
|
| 2749 | - // Checkboxes |
|
| 2750 | - if (! is_array($this->_req_data['_REG_ID'])) { |
|
| 2751 | - $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']); |
|
| 2752 | - } |
|
| 2753 | - $reg_count = count($this->_req_data['_REG_ID']); |
|
| 2754 | - // cycle thru checkboxes |
|
| 2755 | - foreach ($this->_req_data['_REG_ID'] as $REG_ID) { |
|
| 2756 | - /** @var EE_Registration $REG */ |
|
| 2757 | - $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 2758 | - $payments = $REG->registration_payments(); |
|
| 2759 | - if (! empty($payments)) { |
|
| 2760 | - $name = $REG->attendee() instanceof EE_Attendee |
|
| 2761 | - ? $REG->attendee()->full_name() |
|
| 2762 | - : esc_html__('Unknown Attendee', 'event_espresso'); |
|
| 2763 | - $overwrite_msgs = true; |
|
| 2764 | - EE_Error::add_error( |
|
| 2765 | - sprintf( |
|
| 2766 | - esc_html__( |
|
| 2767 | - 'The registration for %s could not be trashed because it has payments attached to the related transaction. If you wish to trash this registration you must first delete the payments on the related transaction.', |
|
| 2768 | - 'event_espresso' |
|
| 2769 | - ), |
|
| 2770 | - $name |
|
| 2771 | - ), |
|
| 2772 | - __FILE__, |
|
| 2773 | - __FUNCTION__, |
|
| 2774 | - __LINE__ |
|
| 2775 | - ); |
|
| 2776 | - // can't trash this registration because it has payments. |
|
| 2777 | - continue; |
|
| 2778 | - } |
|
| 2779 | - $updated = $trash ? $REG->delete() : $REG->restore(); |
|
| 2780 | - if ($updated) { |
|
| 2781 | - $success++; |
|
| 2782 | - } |
|
| 2783 | - } |
|
| 2784 | - $this->_redirect_after_action( |
|
| 2785 | - $success === $reg_count, // were ALL registrations affected? |
|
| 2786 | - $success > 1 |
|
| 2787 | - ? esc_html__('Registrations', 'event_espresso') |
|
| 2788 | - : esc_html__('Registration', 'event_espresso'), |
|
| 2789 | - $trash |
|
| 2790 | - ? esc_html__('moved to the trash', 'event_espresso') |
|
| 2791 | - : esc_html__('restored', 'event_espresso'), |
|
| 2792 | - $this->mergeExistingRequestParamsWithRedirectArgs(array('action' => 'default')), |
|
| 2793 | - $overwrite_msgs |
|
| 2794 | - ); |
|
| 2795 | - } |
|
| 2796 | - |
|
| 2797 | - |
|
| 2798 | - /** |
|
| 2799 | - * This is used to permanently delete registrations. Note, this will handle not only deleting permanently the |
|
| 2800 | - * registration but also. |
|
| 2801 | - * 1. Removing relations to EE_Attendee |
|
| 2802 | - * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are |
|
| 2803 | - * ALSO trashed. |
|
| 2804 | - * 3. Deleting permanently any related Line items but only if the above conditions are met. |
|
| 2805 | - * 4. Removing relationships between all tickets and the related registrations |
|
| 2806 | - * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.) |
|
| 2807 | - * 6. Deleting permanently any related Checkins. |
|
| 2808 | - * |
|
| 2809 | - * @return void |
|
| 2810 | - * @throws EE_Error |
|
| 2811 | - * @throws InvalidArgumentException |
|
| 2812 | - * @throws InvalidDataTypeException |
|
| 2813 | - * @throws InvalidInterfaceException |
|
| 2814 | - */ |
|
| 2815 | - protected function _delete_registrations() |
|
| 2816 | - { |
|
| 2817 | - $REG_MDL = EEM_Registration::instance(); |
|
| 2818 | - $success = 1; |
|
| 2819 | - // Checkboxes |
|
| 2820 | - if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
| 2821 | - // if array has more than one element than success message should be plural |
|
| 2822 | - $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1; |
|
| 2823 | - // cycle thru checkboxes |
|
| 2824 | - while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) { |
|
| 2825 | - $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2826 | - if (! $REG instanceof EE_Registration) { |
|
| 2827 | - continue; |
|
| 2828 | - } |
|
| 2829 | - $deleted = $this->_delete_registration($REG); |
|
| 2830 | - if (! $deleted) { |
|
| 2831 | - $success = 0; |
|
| 2832 | - } |
|
| 2833 | - } |
|
| 2834 | - } else { |
|
| 2835 | - // grab single id and delete |
|
| 2836 | - $REG_ID = $this->_req_data['_REG_ID']; |
|
| 2837 | - $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2838 | - $deleted = $this->_delete_registration($REG); |
|
| 2839 | - if (! $deleted) { |
|
| 2840 | - $success = 0; |
|
| 2841 | - } |
|
| 2842 | - } |
|
| 2843 | - $what = $success > 1 |
|
| 2844 | - ? esc_html__('Registrations', 'event_espresso') |
|
| 2845 | - : esc_html__('Registration', 'event_espresso'); |
|
| 2846 | - $action_desc = esc_html__('permanently deleted.', 'event_espresso'); |
|
| 2847 | - $this->_redirect_after_action( |
|
| 2848 | - $success, |
|
| 2849 | - $what, |
|
| 2850 | - $action_desc, |
|
| 2851 | - $this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']), |
|
| 2852 | - true |
|
| 2853 | - ); |
|
| 2854 | - } |
|
| 2855 | - |
|
| 2856 | - |
|
| 2857 | - /** |
|
| 2858 | - * handles the permanent deletion of a registration. See comments with _delete_registrations() for details on what |
|
| 2859 | - * models get affected. |
|
| 2860 | - * |
|
| 2861 | - * @param EE_Registration $REG registration to be deleted permenantly |
|
| 2862 | - * @return bool true = successful deletion, false = fail. |
|
| 2863 | - * @throws EE_Error |
|
| 2864 | - */ |
|
| 2865 | - protected function _delete_registration(EE_Registration $REG) |
|
| 2866 | - { |
|
| 2867 | - // first we start with the transaction... ultimately, we WILL not delete permanently if there are any related |
|
| 2868 | - // registrations on the transaction that are NOT trashed. |
|
| 2869 | - $TXN = $REG->get_first_related('Transaction'); |
|
| 2870 | - $REGS = $TXN->get_many_related('Registration'); |
|
| 2871 | - $all_trashed = true; |
|
| 2872 | - foreach ($REGS as $registration) { |
|
| 2873 | - if (! $registration->get('REG_deleted')) { |
|
| 2874 | - $all_trashed = false; |
|
| 2875 | - } |
|
| 2876 | - } |
|
| 2877 | - if (! $all_trashed) { |
|
| 2878 | - EE_Error::add_error( |
|
| 2879 | - esc_html__( |
|
| 2880 | - 'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well. These registrations will be permanently deleted in the same action.', |
|
| 2881 | - 'event_espresso' |
|
| 2882 | - ), |
|
| 2883 | - __FILE__, |
|
| 2884 | - __FUNCTION__, |
|
| 2885 | - __LINE__ |
|
| 2886 | - ); |
|
| 2887 | - return false; |
|
| 2888 | - } |
|
| 2889 | - // k made it here so that means we can delete all the related transactions and their answers (but let's do them |
|
| 2890 | - // separately from THIS one). |
|
| 2891 | - foreach ($REGS as $registration) { |
|
| 2892 | - // delete related answers |
|
| 2893 | - $registration->delete_related_permanently('Answer'); |
|
| 2894 | - // remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact) |
|
| 2895 | - $attendee = $registration->get_first_related('Attendee'); |
|
| 2896 | - if ($attendee instanceof EE_Attendee) { |
|
| 2897 | - $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 2898 | - } |
|
| 2899 | - // now remove relationships to tickets on this registration. |
|
| 2900 | - $registration->_remove_relations('Ticket'); |
|
| 2901 | - // now delete permanently the checkins related to this registration. |
|
| 2902 | - $registration->delete_related_permanently('Checkin'); |
|
| 2903 | - if ($registration->ID() === $REG->ID()) { |
|
| 2904 | - continue; |
|
| 2905 | - } //we don't want to delete permanently the existing registration just yet. |
|
| 2906 | - // remove relation to transaction for these registrations if NOT the existing registrations |
|
| 2907 | - $registration->_remove_relations('Transaction'); |
|
| 2908 | - // delete permanently any related messages. |
|
| 2909 | - $registration->delete_related_permanently('Message'); |
|
| 2910 | - // now delete this registration permanently |
|
| 2911 | - $registration->delete_permanently(); |
|
| 2912 | - } |
|
| 2913 | - // now all related registrations on the transaction are handled. So let's just handle this registration itself |
|
| 2914 | - // (the transaction and line items should be all that's left). |
|
| 2915 | - // delete the line items related to the transaction for this registration. |
|
| 2916 | - $TXN->delete_related_permanently('Line_Item'); |
|
| 2917 | - // we need to remove all the relationships on the transaction |
|
| 2918 | - $TXN->delete_related_permanently('Payment'); |
|
| 2919 | - $TXN->delete_related_permanently('Extra_Meta'); |
|
| 2920 | - $TXN->delete_related_permanently('Message'); |
|
| 2921 | - // now we can delete this REG permanently (and the transaction of course) |
|
| 2922 | - $REG->delete_related_permanently('Transaction'); |
|
| 2923 | - return $REG->delete_permanently(); |
|
| 2924 | - } |
|
| 2925 | - |
|
| 2926 | - |
|
| 2927 | - /** |
|
| 2928 | - * generates HTML for the Register New Attendee Admin page |
|
| 2929 | - * |
|
| 2930 | - * @access private |
|
| 2931 | - * @throws DomainException |
|
| 2932 | - * @throws EE_Error |
|
| 2933 | - */ |
|
| 2934 | - public function new_registration() |
|
| 2935 | - { |
|
| 2936 | - if (! $this->_set_reg_event()) { |
|
| 2937 | - throw new EE_Error( |
|
| 2938 | - esc_html__( |
|
| 2939 | - 'Unable to continue with registering because there is no Event ID in the request', |
|
| 2940 | - 'event_espresso' |
|
| 2941 | - ) |
|
| 2942 | - ); |
|
| 2943 | - } |
|
| 2944 | - EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 2945 | - // gotta start with a clean slate if we're not coming here via ajax |
|
| 2946 | - if (! defined('DOING_AJAX') |
|
| 2947 | - && (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
| 2948 | - ) { |
|
| 2949 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2950 | - } |
|
| 2951 | - $this->_template_args['event_name'] = ''; |
|
| 2952 | - // event name |
|
| 2953 | - if ($this->_reg_event) { |
|
| 2954 | - $this->_template_args['event_name'] = $this->_reg_event->name(); |
|
| 2955 | - $edit_event_url = self::add_query_args_and_nonce( |
|
| 2956 | - array( |
|
| 2957 | - 'action' => 'edit', |
|
| 2958 | - 'post' => $this->_reg_event->ID(), |
|
| 2959 | - ), |
|
| 2960 | - EVENTS_ADMIN_URL |
|
| 2961 | - ); |
|
| 2962 | - $edit_event_lnk = '<a href="' |
|
| 2963 | - . $edit_event_url |
|
| 2964 | - . '" title="' |
|
| 2965 | - . esc_attr__('Edit ', 'event_espresso') |
|
| 2966 | - . $this->_reg_event->name() |
|
| 2967 | - . '">' |
|
| 2968 | - . esc_html__('Edit Event', 'event_espresso') |
|
| 2969 | - . '</a>'; |
|
| 2970 | - $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">' |
|
| 2971 | - . $edit_event_lnk |
|
| 2972 | - . '</span>'; |
|
| 2973 | - } |
|
| 2974 | - $this->_template_args['step_content'] = $this->_get_registration_step_content(); |
|
| 2975 | - if (defined('DOING_AJAX')) { |
|
| 2976 | - $this->_return_json(); |
|
| 2977 | - } |
|
| 2978 | - // grab header |
|
| 2979 | - $template_path = |
|
| 2980 | - REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php'; |
|
| 2981 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
| 2982 | - $template_path, |
|
| 2983 | - $this->_template_args, |
|
| 2984 | - true |
|
| 2985 | - ); |
|
| 2986 | - // $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE ); |
|
| 2987 | - // the details template wrapper |
|
| 2988 | - $this->display_admin_page_with_sidebar(); |
|
| 2989 | - } |
|
| 2990 | - |
|
| 2991 | - |
|
| 2992 | - /** |
|
| 2993 | - * This returns the content for a registration step |
|
| 2994 | - * |
|
| 2995 | - * @access protected |
|
| 2996 | - * @return string html |
|
| 2997 | - * @throws DomainException |
|
| 2998 | - * @throws EE_Error |
|
| 2999 | - * @throws InvalidArgumentException |
|
| 3000 | - * @throws InvalidDataTypeException |
|
| 3001 | - * @throws InvalidInterfaceException |
|
| 3002 | - */ |
|
| 3003 | - protected function _get_registration_step_content() |
|
| 3004 | - { |
|
| 3005 | - if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) { |
|
| 3006 | - $warning_msg = sprintf( |
|
| 3007 | - esc_html__( |
|
| 3008 | - '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s', |
|
| 3009 | - 'event_espresso' |
|
| 3010 | - ), |
|
| 3011 | - '<br />', |
|
| 3012 | - '<h3 class="important-notice">', |
|
| 3013 | - '</h3>', |
|
| 3014 | - '<div class="float-right">', |
|
| 3015 | - '<span id="redirect_timer" class="important-notice">30</span>', |
|
| 3016 | - '</div>', |
|
| 3017 | - '<b>', |
|
| 3018 | - '</b>' |
|
| 3019 | - ); |
|
| 3020 | - return ' |
|
| 2471 | + } |
|
| 2472 | + |
|
| 2473 | + |
|
| 2474 | + /** |
|
| 2475 | + * Updates the registration's custom questions according to the form info, if the form is submitted. |
|
| 2476 | + * If it's not a post, the "view_registrations" route will be called next on the SAME request |
|
| 2477 | + * to display the page |
|
| 2478 | + * |
|
| 2479 | + * @access protected |
|
| 2480 | + * @return void |
|
| 2481 | + * @throws EE_Error |
|
| 2482 | + */ |
|
| 2483 | + protected function _update_attendee_registration_form() |
|
| 2484 | + { |
|
| 2485 | + do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this); |
|
| 2486 | + if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
| 2487 | + $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 2488 | + $success = $this->_save_reg_custom_questions_form($REG_ID); |
|
| 2489 | + if ($success) { |
|
| 2490 | + $what = esc_html__('Registration Form', 'event_espresso'); |
|
| 2491 | + $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) |
|
| 2492 | + : array('action' => 'default'); |
|
| 2493 | + $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route); |
|
| 2494 | + } |
|
| 2495 | + } |
|
| 2496 | + } |
|
| 2497 | + |
|
| 2498 | + |
|
| 2499 | + /** |
|
| 2500 | + * Gets the form for saving registrations custom questions (if done |
|
| 2501 | + * previously retrieves the cached form object, which may have validation errors in it) |
|
| 2502 | + * |
|
| 2503 | + * @param int $REG_ID |
|
| 2504 | + * @return EE_Registration_Custom_Questions_Form |
|
| 2505 | + * @throws EE_Error |
|
| 2506 | + * @throws InvalidArgumentException |
|
| 2507 | + * @throws InvalidDataTypeException |
|
| 2508 | + * @throws InvalidInterfaceException |
|
| 2509 | + */ |
|
| 2510 | + protected function _get_reg_custom_questions_form($REG_ID) |
|
| 2511 | + { |
|
| 2512 | + if (! $this->_reg_custom_questions_form) { |
|
| 2513 | + require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php'); |
|
| 2514 | + $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form( |
|
| 2515 | + EEM_Registration::instance()->get_one_by_ID($REG_ID) |
|
| 2516 | + ); |
|
| 2517 | + $this->_reg_custom_questions_form->_construct_finalize(null, null); |
|
| 2518 | + } |
|
| 2519 | + return $this->_reg_custom_questions_form; |
|
| 2520 | + } |
|
| 2521 | + |
|
| 2522 | + |
|
| 2523 | + /** |
|
| 2524 | + * Saves |
|
| 2525 | + * |
|
| 2526 | + * @access private |
|
| 2527 | + * @param bool $REG_ID |
|
| 2528 | + * @return bool |
|
| 2529 | + * @throws EE_Error |
|
| 2530 | + * @throws InvalidArgumentException |
|
| 2531 | + * @throws InvalidDataTypeException |
|
| 2532 | + * @throws InvalidInterfaceException |
|
| 2533 | + */ |
|
| 2534 | + private function _save_reg_custom_questions_form($REG_ID = false) |
|
| 2535 | + { |
|
| 2536 | + if (! $REG_ID) { |
|
| 2537 | + EE_Error::add_error( |
|
| 2538 | + esc_html__( |
|
| 2539 | + 'An error occurred. No registration ID was received.', |
|
| 2540 | + 'event_espresso' |
|
| 2541 | + ), |
|
| 2542 | + __FILE__, |
|
| 2543 | + __FUNCTION__, |
|
| 2544 | + __LINE__ |
|
| 2545 | + ); |
|
| 2546 | + } |
|
| 2547 | + $form = $this->_get_reg_custom_questions_form($REG_ID); |
|
| 2548 | + $form->receive_form_submission($this->_req_data); |
|
| 2549 | + $success = false; |
|
| 2550 | + if ($form->is_valid()) { |
|
| 2551 | + foreach ($form->subforms() as $question_group_id => $question_group_form) { |
|
| 2552 | + foreach ($question_group_form->inputs() as $question_id => $input) { |
|
| 2553 | + $where_conditions = array( |
|
| 2554 | + 'QST_ID' => $question_id, |
|
| 2555 | + 'REG_ID' => $REG_ID, |
|
| 2556 | + ); |
|
| 2557 | + $possibly_new_values = array( |
|
| 2558 | + 'ANS_value' => $input->normalized_value(), |
|
| 2559 | + ); |
|
| 2560 | + $answer = EEM_Answer::instance()->get_one(array($where_conditions)); |
|
| 2561 | + if ($answer instanceof EE_Answer) { |
|
| 2562 | + $success = $answer->save($possibly_new_values); |
|
| 2563 | + } else { |
|
| 2564 | + // insert it then |
|
| 2565 | + $cols_n_vals = array_merge($where_conditions, $possibly_new_values); |
|
| 2566 | + $answer = EE_Answer::new_instance($cols_n_vals); |
|
| 2567 | + $success = $answer->save(); |
|
| 2568 | + } |
|
| 2569 | + } |
|
| 2570 | + } |
|
| 2571 | + } else { |
|
| 2572 | + EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__); |
|
| 2573 | + } |
|
| 2574 | + return $success; |
|
| 2575 | + } |
|
| 2576 | + |
|
| 2577 | + |
|
| 2578 | + /** |
|
| 2579 | + * generates HTML for the Registration main meta box |
|
| 2580 | + * |
|
| 2581 | + * @access public |
|
| 2582 | + * @return void |
|
| 2583 | + * @throws DomainException |
|
| 2584 | + * @throws EE_Error |
|
| 2585 | + * @throws InvalidArgumentException |
|
| 2586 | + * @throws InvalidDataTypeException |
|
| 2587 | + * @throws InvalidInterfaceException |
|
| 2588 | + */ |
|
| 2589 | + public function _reg_attendees_meta_box() |
|
| 2590 | + { |
|
| 2591 | + $REG = EEM_Registration::instance(); |
|
| 2592 | + // get all other registrations on this transaction, and cache |
|
| 2593 | + // the attendees for them so we don't have to run another query using force_join |
|
| 2594 | + $registrations = $REG->get_all( |
|
| 2595 | + array( |
|
| 2596 | + array( |
|
| 2597 | + 'TXN_ID' => $this->_registration->transaction_ID(), |
|
| 2598 | + 'REG_ID' => array('!=', $this->_registration->ID()), |
|
| 2599 | + ), |
|
| 2600 | + 'force_join' => array('Attendee'), |
|
| 2601 | + ) |
|
| 2602 | + ); |
|
| 2603 | + $this->_template_args['attendees'] = array(); |
|
| 2604 | + $this->_template_args['attendee_notice'] = ''; |
|
| 2605 | + if (empty($registrations) |
|
| 2606 | + || (is_array($registrations) |
|
| 2607 | + && ! EEH_Array::get_one_item_from_array($registrations)) |
|
| 2608 | + ) { |
|
| 2609 | + EE_Error::add_error( |
|
| 2610 | + esc_html__( |
|
| 2611 | + 'There are no records attached to this registration. Something may have gone wrong with the registration', |
|
| 2612 | + 'event_espresso' |
|
| 2613 | + ), |
|
| 2614 | + __FILE__, |
|
| 2615 | + __FUNCTION__, |
|
| 2616 | + __LINE__ |
|
| 2617 | + ); |
|
| 2618 | + $this->_template_args['attendee_notice'] = EE_Error::get_notices(); |
|
| 2619 | + } else { |
|
| 2620 | + $att_nmbr = 1; |
|
| 2621 | + foreach ($registrations as $registration) { |
|
| 2622 | + /* @var $registration EE_Registration */ |
|
| 2623 | + $attendee = $registration->attendee() |
|
| 2624 | + ? $registration->attendee() |
|
| 2625 | + : EEM_Attendee::instance() |
|
| 2626 | + ->create_default_object(); |
|
| 2627 | + $this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID(); |
|
| 2628 | + $this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname(); |
|
| 2629 | + $this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname(); |
|
| 2630 | + $this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email(); |
|
| 2631 | + $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price(); |
|
| 2632 | + $this->_template_args['attendees'][ $att_nmbr ]['address'] = implode( |
|
| 2633 | + ', ', |
|
| 2634 | + $attendee->full_address_as_array() |
|
| 2635 | + ); |
|
| 2636 | + $this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce( |
|
| 2637 | + array( |
|
| 2638 | + 'action' => 'edit_attendee', |
|
| 2639 | + 'post' => $attendee->ID(), |
|
| 2640 | + ), |
|
| 2641 | + REG_ADMIN_URL |
|
| 2642 | + ); |
|
| 2643 | + $this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event |
|
| 2644 | + ? $registration->event_obj()->name() |
|
| 2645 | + : ''; |
|
| 2646 | + $att_nmbr++; |
|
| 2647 | + } |
|
| 2648 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 2649 | + } |
|
| 2650 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php'; |
|
| 2651 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2652 | + } |
|
| 2653 | + |
|
| 2654 | + |
|
| 2655 | + /** |
|
| 2656 | + * generates HTML for the Edit Registration side meta box |
|
| 2657 | + * |
|
| 2658 | + * @access public |
|
| 2659 | + * @return void |
|
| 2660 | + * @throws DomainException |
|
| 2661 | + * @throws EE_Error |
|
| 2662 | + * @throws InvalidArgumentException |
|
| 2663 | + * @throws InvalidDataTypeException |
|
| 2664 | + * @throws InvalidInterfaceException |
|
| 2665 | + */ |
|
| 2666 | + public function _reg_registrant_side_meta_box() |
|
| 2667 | + { |
|
| 2668 | + /*@var $attendee EE_Attendee */ |
|
| 2669 | + $att_check = $this->_registration->attendee(); |
|
| 2670 | + $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object(); |
|
| 2671 | + // now let's determine if this is not the primary registration. If it isn't then we set the |
|
| 2672 | + // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the |
|
| 2673 | + // primary registration object (that way we know if we need to show create button or not) |
|
| 2674 | + if (! $this->_registration->is_primary_registrant()) { |
|
| 2675 | + $primary_registration = $this->_registration->get_primary_registration(); |
|
| 2676 | + $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() |
|
| 2677 | + : null; |
|
| 2678 | + if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
| 2679 | + // in here? This means the displayed registration is not the primary registrant but ALREADY HAS its own |
|
| 2680 | + // custom attendee object so let's not worry about the primary reg. |
|
| 2681 | + $primary_registration = null; |
|
| 2682 | + } |
|
| 2683 | + } else { |
|
| 2684 | + $primary_registration = null; |
|
| 2685 | + } |
|
| 2686 | + $this->_template_args['ATT_ID'] = $attendee->ID(); |
|
| 2687 | + $this->_template_args['fname'] = $attendee->fname(); |
|
| 2688 | + $this->_template_args['lname'] = $attendee->lname(); |
|
| 2689 | + $this->_template_args['email'] = $attendee->email(); |
|
| 2690 | + $this->_template_args['phone'] = $attendee->phone(); |
|
| 2691 | + $this->_template_args['formatted_address'] = EEH_Address::format($attendee); |
|
| 2692 | + // edit link |
|
| 2693 | + $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
| 2694 | + array( |
|
| 2695 | + 'action' => 'edit_attendee', |
|
| 2696 | + 'post' => $attendee->ID(), |
|
| 2697 | + ), |
|
| 2698 | + REG_ADMIN_URL |
|
| 2699 | + ); |
|
| 2700 | + $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso'); |
|
| 2701 | + // create link |
|
| 2702 | + $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration |
|
| 2703 | + ? EE_Admin_Page::add_query_args_and_nonce( |
|
| 2704 | + array( |
|
| 2705 | + 'action' => 'duplicate_attendee', |
|
| 2706 | + '_REG_ID' => $this->_registration->ID(), |
|
| 2707 | + ), |
|
| 2708 | + REG_ADMIN_URL |
|
| 2709 | + ) : ''; |
|
| 2710 | + $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso'); |
|
| 2711 | + $this->_template_args['att_check'] = $att_check; |
|
| 2712 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php'; |
|
| 2713 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2714 | + } |
|
| 2715 | + |
|
| 2716 | + |
|
| 2717 | + /** |
|
| 2718 | + * trash or restore registrations |
|
| 2719 | + * |
|
| 2720 | + * @param boolean $trash whether to archive or restore |
|
| 2721 | + * @return void |
|
| 2722 | + * @throws EE_Error |
|
| 2723 | + * @throws InvalidArgumentException |
|
| 2724 | + * @throws InvalidDataTypeException |
|
| 2725 | + * @throws InvalidInterfaceException |
|
| 2726 | + * @throws RuntimeException |
|
| 2727 | + * @access protected |
|
| 2728 | + */ |
|
| 2729 | + protected function _trash_or_restore_registrations($trash = true) |
|
| 2730 | + { |
|
| 2731 | + // if empty _REG_ID then get out because there's nothing to do |
|
| 2732 | + if (empty($this->_req_data['_REG_ID'])) { |
|
| 2733 | + EE_Error::add_error( |
|
| 2734 | + sprintf( |
|
| 2735 | + esc_html__( |
|
| 2736 | + 'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.', |
|
| 2737 | + 'event_espresso' |
|
| 2738 | + ), |
|
| 2739 | + $trash ? 'trash' : 'restore' |
|
| 2740 | + ), |
|
| 2741 | + __FILE__, |
|
| 2742 | + __LINE__, |
|
| 2743 | + __FUNCTION__ |
|
| 2744 | + ); |
|
| 2745 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
| 2746 | + } |
|
| 2747 | + $success = 0; |
|
| 2748 | + $overwrite_msgs = false; |
|
| 2749 | + // Checkboxes |
|
| 2750 | + if (! is_array($this->_req_data['_REG_ID'])) { |
|
| 2751 | + $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']); |
|
| 2752 | + } |
|
| 2753 | + $reg_count = count($this->_req_data['_REG_ID']); |
|
| 2754 | + // cycle thru checkboxes |
|
| 2755 | + foreach ($this->_req_data['_REG_ID'] as $REG_ID) { |
|
| 2756 | + /** @var EE_Registration $REG */ |
|
| 2757 | + $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 2758 | + $payments = $REG->registration_payments(); |
|
| 2759 | + if (! empty($payments)) { |
|
| 2760 | + $name = $REG->attendee() instanceof EE_Attendee |
|
| 2761 | + ? $REG->attendee()->full_name() |
|
| 2762 | + : esc_html__('Unknown Attendee', 'event_espresso'); |
|
| 2763 | + $overwrite_msgs = true; |
|
| 2764 | + EE_Error::add_error( |
|
| 2765 | + sprintf( |
|
| 2766 | + esc_html__( |
|
| 2767 | + 'The registration for %s could not be trashed because it has payments attached to the related transaction. If you wish to trash this registration you must first delete the payments on the related transaction.', |
|
| 2768 | + 'event_espresso' |
|
| 2769 | + ), |
|
| 2770 | + $name |
|
| 2771 | + ), |
|
| 2772 | + __FILE__, |
|
| 2773 | + __FUNCTION__, |
|
| 2774 | + __LINE__ |
|
| 2775 | + ); |
|
| 2776 | + // can't trash this registration because it has payments. |
|
| 2777 | + continue; |
|
| 2778 | + } |
|
| 2779 | + $updated = $trash ? $REG->delete() : $REG->restore(); |
|
| 2780 | + if ($updated) { |
|
| 2781 | + $success++; |
|
| 2782 | + } |
|
| 2783 | + } |
|
| 2784 | + $this->_redirect_after_action( |
|
| 2785 | + $success === $reg_count, // were ALL registrations affected? |
|
| 2786 | + $success > 1 |
|
| 2787 | + ? esc_html__('Registrations', 'event_espresso') |
|
| 2788 | + : esc_html__('Registration', 'event_espresso'), |
|
| 2789 | + $trash |
|
| 2790 | + ? esc_html__('moved to the trash', 'event_espresso') |
|
| 2791 | + : esc_html__('restored', 'event_espresso'), |
|
| 2792 | + $this->mergeExistingRequestParamsWithRedirectArgs(array('action' => 'default')), |
|
| 2793 | + $overwrite_msgs |
|
| 2794 | + ); |
|
| 2795 | + } |
|
| 2796 | + |
|
| 2797 | + |
|
| 2798 | + /** |
|
| 2799 | + * This is used to permanently delete registrations. Note, this will handle not only deleting permanently the |
|
| 2800 | + * registration but also. |
|
| 2801 | + * 1. Removing relations to EE_Attendee |
|
| 2802 | + * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are |
|
| 2803 | + * ALSO trashed. |
|
| 2804 | + * 3. Deleting permanently any related Line items but only if the above conditions are met. |
|
| 2805 | + * 4. Removing relationships between all tickets and the related registrations |
|
| 2806 | + * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.) |
|
| 2807 | + * 6. Deleting permanently any related Checkins. |
|
| 2808 | + * |
|
| 2809 | + * @return void |
|
| 2810 | + * @throws EE_Error |
|
| 2811 | + * @throws InvalidArgumentException |
|
| 2812 | + * @throws InvalidDataTypeException |
|
| 2813 | + * @throws InvalidInterfaceException |
|
| 2814 | + */ |
|
| 2815 | + protected function _delete_registrations() |
|
| 2816 | + { |
|
| 2817 | + $REG_MDL = EEM_Registration::instance(); |
|
| 2818 | + $success = 1; |
|
| 2819 | + // Checkboxes |
|
| 2820 | + if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
| 2821 | + // if array has more than one element than success message should be plural |
|
| 2822 | + $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1; |
|
| 2823 | + // cycle thru checkboxes |
|
| 2824 | + while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) { |
|
| 2825 | + $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2826 | + if (! $REG instanceof EE_Registration) { |
|
| 2827 | + continue; |
|
| 2828 | + } |
|
| 2829 | + $deleted = $this->_delete_registration($REG); |
|
| 2830 | + if (! $deleted) { |
|
| 2831 | + $success = 0; |
|
| 2832 | + } |
|
| 2833 | + } |
|
| 2834 | + } else { |
|
| 2835 | + // grab single id and delete |
|
| 2836 | + $REG_ID = $this->_req_data['_REG_ID']; |
|
| 2837 | + $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2838 | + $deleted = $this->_delete_registration($REG); |
|
| 2839 | + if (! $deleted) { |
|
| 2840 | + $success = 0; |
|
| 2841 | + } |
|
| 2842 | + } |
|
| 2843 | + $what = $success > 1 |
|
| 2844 | + ? esc_html__('Registrations', 'event_espresso') |
|
| 2845 | + : esc_html__('Registration', 'event_espresso'); |
|
| 2846 | + $action_desc = esc_html__('permanently deleted.', 'event_espresso'); |
|
| 2847 | + $this->_redirect_after_action( |
|
| 2848 | + $success, |
|
| 2849 | + $what, |
|
| 2850 | + $action_desc, |
|
| 2851 | + $this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']), |
|
| 2852 | + true |
|
| 2853 | + ); |
|
| 2854 | + } |
|
| 2855 | + |
|
| 2856 | + |
|
| 2857 | + /** |
|
| 2858 | + * handles the permanent deletion of a registration. See comments with _delete_registrations() for details on what |
|
| 2859 | + * models get affected. |
|
| 2860 | + * |
|
| 2861 | + * @param EE_Registration $REG registration to be deleted permenantly |
|
| 2862 | + * @return bool true = successful deletion, false = fail. |
|
| 2863 | + * @throws EE_Error |
|
| 2864 | + */ |
|
| 2865 | + protected function _delete_registration(EE_Registration $REG) |
|
| 2866 | + { |
|
| 2867 | + // first we start with the transaction... ultimately, we WILL not delete permanently if there are any related |
|
| 2868 | + // registrations on the transaction that are NOT trashed. |
|
| 2869 | + $TXN = $REG->get_first_related('Transaction'); |
|
| 2870 | + $REGS = $TXN->get_many_related('Registration'); |
|
| 2871 | + $all_trashed = true; |
|
| 2872 | + foreach ($REGS as $registration) { |
|
| 2873 | + if (! $registration->get('REG_deleted')) { |
|
| 2874 | + $all_trashed = false; |
|
| 2875 | + } |
|
| 2876 | + } |
|
| 2877 | + if (! $all_trashed) { |
|
| 2878 | + EE_Error::add_error( |
|
| 2879 | + esc_html__( |
|
| 2880 | + 'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well. These registrations will be permanently deleted in the same action.', |
|
| 2881 | + 'event_espresso' |
|
| 2882 | + ), |
|
| 2883 | + __FILE__, |
|
| 2884 | + __FUNCTION__, |
|
| 2885 | + __LINE__ |
|
| 2886 | + ); |
|
| 2887 | + return false; |
|
| 2888 | + } |
|
| 2889 | + // k made it here so that means we can delete all the related transactions and their answers (but let's do them |
|
| 2890 | + // separately from THIS one). |
|
| 2891 | + foreach ($REGS as $registration) { |
|
| 2892 | + // delete related answers |
|
| 2893 | + $registration->delete_related_permanently('Answer'); |
|
| 2894 | + // remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact) |
|
| 2895 | + $attendee = $registration->get_first_related('Attendee'); |
|
| 2896 | + if ($attendee instanceof EE_Attendee) { |
|
| 2897 | + $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 2898 | + } |
|
| 2899 | + // now remove relationships to tickets on this registration. |
|
| 2900 | + $registration->_remove_relations('Ticket'); |
|
| 2901 | + // now delete permanently the checkins related to this registration. |
|
| 2902 | + $registration->delete_related_permanently('Checkin'); |
|
| 2903 | + if ($registration->ID() === $REG->ID()) { |
|
| 2904 | + continue; |
|
| 2905 | + } //we don't want to delete permanently the existing registration just yet. |
|
| 2906 | + // remove relation to transaction for these registrations if NOT the existing registrations |
|
| 2907 | + $registration->_remove_relations('Transaction'); |
|
| 2908 | + // delete permanently any related messages. |
|
| 2909 | + $registration->delete_related_permanently('Message'); |
|
| 2910 | + // now delete this registration permanently |
|
| 2911 | + $registration->delete_permanently(); |
|
| 2912 | + } |
|
| 2913 | + // now all related registrations on the transaction are handled. So let's just handle this registration itself |
|
| 2914 | + // (the transaction and line items should be all that's left). |
|
| 2915 | + // delete the line items related to the transaction for this registration. |
|
| 2916 | + $TXN->delete_related_permanently('Line_Item'); |
|
| 2917 | + // we need to remove all the relationships on the transaction |
|
| 2918 | + $TXN->delete_related_permanently('Payment'); |
|
| 2919 | + $TXN->delete_related_permanently('Extra_Meta'); |
|
| 2920 | + $TXN->delete_related_permanently('Message'); |
|
| 2921 | + // now we can delete this REG permanently (and the transaction of course) |
|
| 2922 | + $REG->delete_related_permanently('Transaction'); |
|
| 2923 | + return $REG->delete_permanently(); |
|
| 2924 | + } |
|
| 2925 | + |
|
| 2926 | + |
|
| 2927 | + /** |
|
| 2928 | + * generates HTML for the Register New Attendee Admin page |
|
| 2929 | + * |
|
| 2930 | + * @access private |
|
| 2931 | + * @throws DomainException |
|
| 2932 | + * @throws EE_Error |
|
| 2933 | + */ |
|
| 2934 | + public function new_registration() |
|
| 2935 | + { |
|
| 2936 | + if (! $this->_set_reg_event()) { |
|
| 2937 | + throw new EE_Error( |
|
| 2938 | + esc_html__( |
|
| 2939 | + 'Unable to continue with registering because there is no Event ID in the request', |
|
| 2940 | + 'event_espresso' |
|
| 2941 | + ) |
|
| 2942 | + ); |
|
| 2943 | + } |
|
| 2944 | + EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 2945 | + // gotta start with a clean slate if we're not coming here via ajax |
|
| 2946 | + if (! defined('DOING_AJAX') |
|
| 2947 | + && (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
| 2948 | + ) { |
|
| 2949 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2950 | + } |
|
| 2951 | + $this->_template_args['event_name'] = ''; |
|
| 2952 | + // event name |
|
| 2953 | + if ($this->_reg_event) { |
|
| 2954 | + $this->_template_args['event_name'] = $this->_reg_event->name(); |
|
| 2955 | + $edit_event_url = self::add_query_args_and_nonce( |
|
| 2956 | + array( |
|
| 2957 | + 'action' => 'edit', |
|
| 2958 | + 'post' => $this->_reg_event->ID(), |
|
| 2959 | + ), |
|
| 2960 | + EVENTS_ADMIN_URL |
|
| 2961 | + ); |
|
| 2962 | + $edit_event_lnk = '<a href="' |
|
| 2963 | + . $edit_event_url |
|
| 2964 | + . '" title="' |
|
| 2965 | + . esc_attr__('Edit ', 'event_espresso') |
|
| 2966 | + . $this->_reg_event->name() |
|
| 2967 | + . '">' |
|
| 2968 | + . esc_html__('Edit Event', 'event_espresso') |
|
| 2969 | + . '</a>'; |
|
| 2970 | + $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">' |
|
| 2971 | + . $edit_event_lnk |
|
| 2972 | + . '</span>'; |
|
| 2973 | + } |
|
| 2974 | + $this->_template_args['step_content'] = $this->_get_registration_step_content(); |
|
| 2975 | + if (defined('DOING_AJAX')) { |
|
| 2976 | + $this->_return_json(); |
|
| 2977 | + } |
|
| 2978 | + // grab header |
|
| 2979 | + $template_path = |
|
| 2980 | + REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php'; |
|
| 2981 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
| 2982 | + $template_path, |
|
| 2983 | + $this->_template_args, |
|
| 2984 | + true |
|
| 2985 | + ); |
|
| 2986 | + // $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE ); |
|
| 2987 | + // the details template wrapper |
|
| 2988 | + $this->display_admin_page_with_sidebar(); |
|
| 2989 | + } |
|
| 2990 | + |
|
| 2991 | + |
|
| 2992 | + /** |
|
| 2993 | + * This returns the content for a registration step |
|
| 2994 | + * |
|
| 2995 | + * @access protected |
|
| 2996 | + * @return string html |
|
| 2997 | + * @throws DomainException |
|
| 2998 | + * @throws EE_Error |
|
| 2999 | + * @throws InvalidArgumentException |
|
| 3000 | + * @throws InvalidDataTypeException |
|
| 3001 | + * @throws InvalidInterfaceException |
|
| 3002 | + */ |
|
| 3003 | + protected function _get_registration_step_content() |
|
| 3004 | + { |
|
| 3005 | + if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) { |
|
| 3006 | + $warning_msg = sprintf( |
|
| 3007 | + esc_html__( |
|
| 3008 | + '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s', |
|
| 3009 | + 'event_espresso' |
|
| 3010 | + ), |
|
| 3011 | + '<br />', |
|
| 3012 | + '<h3 class="important-notice">', |
|
| 3013 | + '</h3>', |
|
| 3014 | + '<div class="float-right">', |
|
| 3015 | + '<span id="redirect_timer" class="important-notice">30</span>', |
|
| 3016 | + '</div>', |
|
| 3017 | + '<b>', |
|
| 3018 | + '</b>' |
|
| 3019 | + ); |
|
| 3020 | + return ' |
|
| 3021 | 3021 | <div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div> |
| 3022 | 3022 | <script > |
| 3023 | 3023 | // WHOAH !!! it appears that someone is using the back button from the Transaction admin page |
@@ -3030,855 +3030,855 @@ discard block |
||
| 3030 | 3030 | } |
| 3031 | 3031 | }, 800 ); |
| 3032 | 3032 | </script >'; |
| 3033 | - } |
|
| 3034 | - $template_args = array( |
|
| 3035 | - 'title' => '', |
|
| 3036 | - 'content' => '', |
|
| 3037 | - 'step_button_text' => '', |
|
| 3038 | - 'show_notification_toggle' => false, |
|
| 3039 | - ); |
|
| 3040 | - // to indicate we're processing a new registration |
|
| 3041 | - $hidden_fields = array( |
|
| 3042 | - 'processing_registration' => array( |
|
| 3043 | - 'type' => 'hidden', |
|
| 3044 | - 'value' => 0, |
|
| 3045 | - ), |
|
| 3046 | - 'event_id' => array( |
|
| 3047 | - 'type' => 'hidden', |
|
| 3048 | - 'value' => $this->_reg_event->ID(), |
|
| 3049 | - ), |
|
| 3050 | - ); |
|
| 3051 | - // if the cart is empty then we know we're at step one so we'll display ticket selector |
|
| 3052 | - $cart = EE_Registry::instance()->SSN->cart(); |
|
| 3053 | - $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 3054 | - switch ($step) { |
|
| 3055 | - case 'ticket': |
|
| 3056 | - $hidden_fields['processing_registration']['value'] = 1; |
|
| 3057 | - $template_args['title'] = esc_html__( |
|
| 3058 | - 'Step One: Select the Ticket for this registration', |
|
| 3059 | - 'event_espresso' |
|
| 3060 | - ); |
|
| 3061 | - $template_args['content'] = |
|
| 3062 | - EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event); |
|
| 3063 | - $template_args['step_button_text'] = esc_html__( |
|
| 3064 | - 'Add Tickets and Continue to Registrant Details', |
|
| 3065 | - 'event_espresso' |
|
| 3066 | - ); |
|
| 3067 | - $template_args['show_notification_toggle'] = false; |
|
| 3068 | - break; |
|
| 3069 | - case 'questions': |
|
| 3070 | - $hidden_fields['processing_registration']['value'] = 2; |
|
| 3071 | - $template_args['title'] = esc_html__( |
|
| 3072 | - 'Step Two: Add Registrant Details for this Registration', |
|
| 3073 | - 'event_espresso' |
|
| 3074 | - ); |
|
| 3075 | - // in theory we should be able to run EED_SPCO at this point because the cart should have been setup |
|
| 3076 | - // properly by the first process_reg_step run. |
|
| 3077 | - $template_args['content'] = |
|
| 3078 | - EED_Single_Page_Checkout::registration_checkout_for_admin(); |
|
| 3079 | - $template_args['step_button_text'] = esc_html__( |
|
| 3080 | - 'Save Registration and Continue to Details', |
|
| 3081 | - 'event_espresso' |
|
| 3082 | - ); |
|
| 3083 | - $template_args['show_notification_toggle'] = true; |
|
| 3084 | - break; |
|
| 3085 | - } |
|
| 3086 | - // we come back to the process_registration_step route. |
|
| 3087 | - $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields); |
|
| 3088 | - return EEH_Template::display_template( |
|
| 3089 | - REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php', |
|
| 3090 | - $template_args, |
|
| 3091 | - true |
|
| 3092 | - ); |
|
| 3093 | - } |
|
| 3094 | - |
|
| 3095 | - |
|
| 3096 | - /** |
|
| 3097 | - * set_reg_event |
|
| 3098 | - * |
|
| 3099 | - * @access private |
|
| 3100 | - * @return bool |
|
| 3101 | - * @throws EE_Error |
|
| 3102 | - * @throws InvalidArgumentException |
|
| 3103 | - * @throws InvalidDataTypeException |
|
| 3104 | - * @throws InvalidInterfaceException |
|
| 3105 | - */ |
|
| 3106 | - private function _set_reg_event() |
|
| 3107 | - { |
|
| 3108 | - if (is_object($this->_reg_event)) { |
|
| 3109 | - return true; |
|
| 3110 | - } |
|
| 3111 | - $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
| 3112 | - if (! $EVT_ID) { |
|
| 3113 | - return false; |
|
| 3114 | - } |
|
| 3115 | - $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 3116 | - return true; |
|
| 3117 | - } |
|
| 3118 | - |
|
| 3119 | - |
|
| 3120 | - /** |
|
| 3121 | - * process_reg_step |
|
| 3122 | - * |
|
| 3123 | - * @access public |
|
| 3124 | - * @return string |
|
| 3125 | - * @throws DomainException |
|
| 3126 | - * @throws EE_Error |
|
| 3127 | - * @throws InvalidArgumentException |
|
| 3128 | - * @throws InvalidDataTypeException |
|
| 3129 | - * @throws InvalidInterfaceException |
|
| 3130 | - * @throws ReflectionException |
|
| 3131 | - * @throws RuntimeException |
|
| 3132 | - */ |
|
| 3133 | - public function process_reg_step() |
|
| 3134 | - { |
|
| 3135 | - EE_System::do_not_cache(); |
|
| 3136 | - $this->_set_reg_event(); |
|
| 3137 | - EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 3138 | - EE_Registry::instance()->REQ->set('uts', time()); |
|
| 3139 | - // what step are we on? |
|
| 3140 | - $cart = EE_Registry::instance()->SSN->cart(); |
|
| 3141 | - $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 3142 | - // if doing ajax then we need to verify the nonce |
|
| 3143 | - if (defined('DOING_AJAX')) { |
|
| 3144 | - $nonce = isset($this->_req_data[ $this->_req_nonce ]) |
|
| 3145 | - ? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : ''; |
|
| 3146 | - $this->_verify_nonce($nonce, $this->_req_nonce); |
|
| 3147 | - } |
|
| 3148 | - switch ($step) { |
|
| 3149 | - case 'ticket': |
|
| 3150 | - // process ticket selection |
|
| 3151 | - $success = EED_Ticket_Selector::instance()->process_ticket_selections(); |
|
| 3152 | - if ($success) { |
|
| 3153 | - EE_Error::add_success( |
|
| 3154 | - esc_html__( |
|
| 3155 | - 'Tickets Selected. Now complete the registration.', |
|
| 3156 | - 'event_espresso' |
|
| 3157 | - ) |
|
| 3158 | - ); |
|
| 3159 | - } else { |
|
| 3160 | - $query_args['step_error'] = $this->_req_data['step_error'] = true; |
|
| 3161 | - } |
|
| 3162 | - if (defined('DOING_AJAX')) { |
|
| 3163 | - $this->new_registration(); // display next step |
|
| 3164 | - } else { |
|
| 3165 | - $query_args = array( |
|
| 3166 | - 'action' => 'new_registration', |
|
| 3167 | - 'processing_registration' => 1, |
|
| 3168 | - 'event_id' => $this->_reg_event->ID(), |
|
| 3169 | - 'uts' => time(), |
|
| 3170 | - ); |
|
| 3171 | - $this->_redirect_after_action( |
|
| 3172 | - false, |
|
| 3173 | - '', |
|
| 3174 | - '', |
|
| 3175 | - $query_args, |
|
| 3176 | - true |
|
| 3177 | - ); |
|
| 3178 | - } |
|
| 3179 | - break; |
|
| 3180 | - case 'questions': |
|
| 3181 | - if (! isset( |
|
| 3182 | - $this->_req_data['txn_reg_status_change'], |
|
| 3183 | - $this->_req_data['txn_reg_status_change']['send_notifications'] |
|
| 3184 | - ) |
|
| 3185 | - ) { |
|
| 3186 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15); |
|
| 3187 | - } |
|
| 3188 | - // process registration |
|
| 3189 | - $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin(); |
|
| 3190 | - if ($cart instanceof EE_Cart) { |
|
| 3191 | - $grand_total = $cart->get_cart_grand_total(); |
|
| 3192 | - if ($grand_total instanceof EE_Line_Item) { |
|
| 3193 | - $grand_total->save_this_and_descendants_to_txn(); |
|
| 3194 | - } |
|
| 3195 | - } |
|
| 3196 | - if (! $transaction instanceof EE_Transaction) { |
|
| 3197 | - $query_args = array( |
|
| 3198 | - 'action' => 'new_registration', |
|
| 3199 | - 'processing_registration' => 2, |
|
| 3200 | - 'event_id' => $this->_reg_event->ID(), |
|
| 3201 | - 'uts' => time(), |
|
| 3202 | - ); |
|
| 3203 | - if (defined('DOING_AJAX')) { |
|
| 3204 | - // display registration form again because there are errors (maybe validation?) |
|
| 3205 | - $this->new_registration(); |
|
| 3206 | - return; |
|
| 3207 | - } else { |
|
| 3208 | - $this->_redirect_after_action( |
|
| 3209 | - false, |
|
| 3210 | - '', |
|
| 3211 | - '', |
|
| 3212 | - $query_args, |
|
| 3213 | - true |
|
| 3214 | - ); |
|
| 3215 | - return; |
|
| 3216 | - } |
|
| 3217 | - } |
|
| 3218 | - // maybe update status, and make sure to save transaction if not done already |
|
| 3219 | - if (! $transaction->update_status_based_on_total_paid()) { |
|
| 3220 | - $transaction->save(); |
|
| 3221 | - } |
|
| 3222 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 3223 | - $this->_req_data = array(); |
|
| 3224 | - $query_args = array( |
|
| 3225 | - 'action' => 'redirect_to_txn', |
|
| 3226 | - 'TXN_ID' => $transaction->ID(), |
|
| 3227 | - 'EVT_ID' => $this->_reg_event->ID(), |
|
| 3228 | - 'event_name' => urlencode($this->_reg_event->name()), |
|
| 3229 | - 'redirect_from' => 'new_registration', |
|
| 3230 | - ); |
|
| 3231 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 3232 | - break; |
|
| 3233 | - } |
|
| 3234 | - // what are you looking here for? Should be nothing to do at this point. |
|
| 3235 | - } |
|
| 3236 | - |
|
| 3237 | - |
|
| 3238 | - /** |
|
| 3239 | - * redirect_to_txn |
|
| 3240 | - * |
|
| 3241 | - * @access public |
|
| 3242 | - * @return void |
|
| 3243 | - * @throws EE_Error |
|
| 3244 | - * @throws InvalidArgumentException |
|
| 3245 | - * @throws InvalidDataTypeException |
|
| 3246 | - * @throws InvalidInterfaceException |
|
| 3247 | - */ |
|
| 3248 | - public function redirect_to_txn() |
|
| 3249 | - { |
|
| 3250 | - EE_System::do_not_cache(); |
|
| 3251 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 3252 | - $query_args = array( |
|
| 3253 | - 'action' => 'view_transaction', |
|
| 3254 | - 'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0, |
|
| 3255 | - 'page' => 'espresso_transactions', |
|
| 3256 | - ); |
|
| 3257 | - if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) { |
|
| 3258 | - $query_args['EVT_ID'] = $this->_req_data['EVT_ID']; |
|
| 3259 | - $query_args['event_name'] = urlencode($this->_req_data['event_name']); |
|
| 3260 | - $query_args['redirect_from'] = $this->_req_data['redirect_from']; |
|
| 3261 | - } |
|
| 3262 | - EE_Error::add_success( |
|
| 3263 | - esc_html__( |
|
| 3264 | - 'Registration Created. Please review the transaction and add any payments as necessary', |
|
| 3265 | - 'event_espresso' |
|
| 3266 | - ) |
|
| 3267 | - ); |
|
| 3268 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 3269 | - } |
|
| 3270 | - |
|
| 3271 | - |
|
| 3272 | - /** |
|
| 3273 | - * generates HTML for the Attendee Contact List |
|
| 3274 | - * |
|
| 3275 | - * @access protected |
|
| 3276 | - * @return void |
|
| 3277 | - */ |
|
| 3278 | - protected function _attendee_contact_list_table() |
|
| 3279 | - { |
|
| 3280 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 3281 | - $this->_search_btn_label = esc_html__('Contacts', 'event_espresso'); |
|
| 3282 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 3283 | - } |
|
| 3284 | - |
|
| 3285 | - |
|
| 3286 | - /** |
|
| 3287 | - * get_attendees |
|
| 3288 | - * |
|
| 3289 | - * @param $per_page |
|
| 3290 | - * @param bool $count whether to return count or data. |
|
| 3291 | - * @param bool $trash |
|
| 3292 | - * @return array |
|
| 3293 | - * @throws EE_Error |
|
| 3294 | - * @throws InvalidArgumentException |
|
| 3295 | - * @throws InvalidDataTypeException |
|
| 3296 | - * @throws InvalidInterfaceException |
|
| 3297 | - * @access public |
|
| 3298 | - */ |
|
| 3299 | - public function get_attendees($per_page, $count = false, $trash = false) |
|
| 3300 | - { |
|
| 3301 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 3302 | - require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php'); |
|
| 3303 | - $ATT_MDL = EEM_Attendee::instance(); |
|
| 3304 | - $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
| 3305 | - switch ($this->_req_data['orderby']) { |
|
| 3306 | - case 'ATT_ID': |
|
| 3307 | - $orderby = 'ATT_ID'; |
|
| 3308 | - break; |
|
| 3309 | - case 'ATT_fname': |
|
| 3310 | - $orderby = 'ATT_fname'; |
|
| 3311 | - break; |
|
| 3312 | - case 'ATT_email': |
|
| 3313 | - $orderby = 'ATT_email'; |
|
| 3314 | - break; |
|
| 3315 | - case 'ATT_city': |
|
| 3316 | - $orderby = 'ATT_city'; |
|
| 3317 | - break; |
|
| 3318 | - case 'STA_ID': |
|
| 3319 | - $orderby = 'STA_ID'; |
|
| 3320 | - break; |
|
| 3321 | - case 'CNT_ID': |
|
| 3322 | - $orderby = 'CNT_ID'; |
|
| 3323 | - break; |
|
| 3324 | - case 'Registration_Count': |
|
| 3325 | - $orderby = 'Registration_Count'; |
|
| 3326 | - break; |
|
| 3327 | - default: |
|
| 3328 | - $orderby = 'ATT_lname'; |
|
| 3329 | - } |
|
| 3330 | - $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) |
|
| 3331 | - ? $this->_req_data['order'] |
|
| 3332 | - : 'ASC'; |
|
| 3333 | - $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) |
|
| 3334 | - ? $this->_req_data['paged'] |
|
| 3335 | - : 1; |
|
| 3336 | - $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10; |
|
| 3337 | - $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) |
|
| 3338 | - ? $this->_req_data['perpage'] |
|
| 3339 | - : $per_page; |
|
| 3340 | - $_where = array(); |
|
| 3341 | - if (! empty($this->_req_data['s'])) { |
|
| 3342 | - $sstr = '%' . $this->_req_data['s'] . '%'; |
|
| 3343 | - $_where['OR'] = array( |
|
| 3344 | - 'Registration.Event.EVT_name' => array('LIKE', $sstr), |
|
| 3345 | - 'Registration.Event.EVT_desc' => array('LIKE', $sstr), |
|
| 3346 | - 'Registration.Event.EVT_short_desc' => array('LIKE', $sstr), |
|
| 3347 | - 'ATT_fname' => array('LIKE', $sstr), |
|
| 3348 | - 'ATT_lname' => array('LIKE', $sstr), |
|
| 3349 | - 'ATT_short_bio' => array('LIKE', $sstr), |
|
| 3350 | - 'ATT_email' => array('LIKE', $sstr), |
|
| 3351 | - 'ATT_address' => array('LIKE', $sstr), |
|
| 3352 | - 'ATT_address2' => array('LIKE', $sstr), |
|
| 3353 | - 'ATT_city' => array('LIKE', $sstr), |
|
| 3354 | - 'Country.CNT_name' => array('LIKE', $sstr), |
|
| 3355 | - 'State.STA_name' => array('LIKE', $sstr), |
|
| 3356 | - 'ATT_phone' => array('LIKE', $sstr), |
|
| 3357 | - 'Registration.REG_final_price' => array('LIKE', $sstr), |
|
| 3358 | - 'Registration.REG_code' => array('LIKE', $sstr), |
|
| 3359 | - 'Registration.REG_group_size' => array('LIKE', $sstr), |
|
| 3360 | - ); |
|
| 3361 | - } |
|
| 3362 | - $offset = ($current_page - 1) * $per_page; |
|
| 3363 | - $limit = $count ? null : array($offset, $per_page); |
|
| 3364 | - $query_args = array( |
|
| 3365 | - $_where, |
|
| 3366 | - 'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')), |
|
| 3367 | - 'limit' => $limit, |
|
| 3368 | - ); |
|
| 3369 | - if (! $count) { |
|
| 3370 | - $query_args['order_by'] = array($orderby => $sort); |
|
| 3371 | - } |
|
| 3372 | - if ($trash) { |
|
| 3373 | - $query_args[0]['status'] = array('!=', 'publish'); |
|
| 3374 | - $all_attendees = $count |
|
| 3375 | - ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
| 3376 | - : $ATT_MDL->get_all($query_args); |
|
| 3377 | - } else { |
|
| 3378 | - $query_args[0]['status'] = array('IN', array('publish')); |
|
| 3379 | - $all_attendees = $count |
|
| 3380 | - ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
| 3381 | - : $ATT_MDL->get_all($query_args); |
|
| 3382 | - } |
|
| 3383 | - return $all_attendees; |
|
| 3384 | - } |
|
| 3385 | - |
|
| 3386 | - |
|
| 3387 | - /** |
|
| 3388 | - * This is just taking care of resending the registration confirmation |
|
| 3389 | - * |
|
| 3390 | - * @access protected |
|
| 3391 | - * @return void |
|
| 3392 | - */ |
|
| 3393 | - protected function _resend_registration() |
|
| 3394 | - { |
|
| 3395 | - $this->_process_resend_registration(); |
|
| 3396 | - $query_args = isset($this->_req_data['redirect_to']) |
|
| 3397 | - ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID']) |
|
| 3398 | - : array('action' => 'default'); |
|
| 3399 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 3400 | - } |
|
| 3401 | - |
|
| 3402 | - /** |
|
| 3403 | - * Creates a registration report, but accepts the name of a method to use for preparing the query parameters |
|
| 3404 | - * to use when selecting registrations |
|
| 3405 | - * |
|
| 3406 | - * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing |
|
| 3407 | - * the query parameters from the request |
|
| 3408 | - * @return void ends the request with a redirect or download |
|
| 3409 | - */ |
|
| 3410 | - public function _registrations_report_base($method_name_for_getting_query_params) |
|
| 3411 | - { |
|
| 3412 | - if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3413 | - wp_redirect( |
|
| 3414 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 3415 | - array( |
|
| 3416 | - 'page' => 'espresso_batch', |
|
| 3417 | - 'batch' => 'file', |
|
| 3418 | - 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 3419 | - 'filters' => urlencode( |
|
| 3420 | - serialize( |
|
| 3421 | - call_user_func( |
|
| 3422 | - array($this, $method_name_for_getting_query_params), |
|
| 3423 | - EEH_Array::is_set( |
|
| 3424 | - $this->_req_data, |
|
| 3425 | - 'filters', |
|
| 3426 | - array() |
|
| 3427 | - ) |
|
| 3428 | - ) |
|
| 3429 | - ) |
|
| 3430 | - ), |
|
| 3431 | - 'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false), |
|
| 3432 | - 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'), |
|
| 3433 | - 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 3434 | - ) |
|
| 3435 | - ) |
|
| 3436 | - ); |
|
| 3437 | - } else { |
|
| 3438 | - $new_request_args = array( |
|
| 3439 | - 'export' => 'report', |
|
| 3440 | - 'action' => 'registrations_report_for_event', |
|
| 3441 | - 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 3442 | - ); |
|
| 3443 | - $this->_req_data = array_merge($this->_req_data, $new_request_args); |
|
| 3444 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3445 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3446 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
| 3447 | - $EE_Export->export(); |
|
| 3448 | - } |
|
| 3449 | - } |
|
| 3450 | - } |
|
| 3451 | - |
|
| 3452 | - |
|
| 3453 | - /** |
|
| 3454 | - * Creates a registration report using only query parameters in the request |
|
| 3455 | - * |
|
| 3456 | - * @return void |
|
| 3457 | - */ |
|
| 3458 | - public function _registrations_report() |
|
| 3459 | - { |
|
| 3460 | - $this->_registrations_report_base('_get_registration_query_parameters'); |
|
| 3461 | - } |
|
| 3462 | - |
|
| 3463 | - |
|
| 3464 | - public function _contact_list_export() |
|
| 3465 | - { |
|
| 3466 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3467 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3468 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
| 3469 | - $EE_Export->export_attendees(); |
|
| 3470 | - } |
|
| 3471 | - } |
|
| 3472 | - |
|
| 3473 | - |
|
| 3474 | - public function _contact_list_report() |
|
| 3475 | - { |
|
| 3476 | - if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3477 | - wp_redirect( |
|
| 3478 | - EE_Admin_Page::add_query_args_and_nonce( |
|
| 3479 | - array( |
|
| 3480 | - 'page' => 'espresso_batch', |
|
| 3481 | - 'batch' => 'file', |
|
| 3482 | - 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'), |
|
| 3483 | - 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 3484 | - ) |
|
| 3485 | - ) |
|
| 3486 | - ); |
|
| 3487 | - } else { |
|
| 3488 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3489 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3490 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
| 3491 | - $EE_Export->report_attendees(); |
|
| 3492 | - } |
|
| 3493 | - } |
|
| 3494 | - } |
|
| 3495 | - |
|
| 3496 | - |
|
| 3497 | - |
|
| 3498 | - |
|
| 3499 | - |
|
| 3500 | - /*************************************** ATTENDEE DETAILS ***************************************/ |
|
| 3501 | - /** |
|
| 3502 | - * This duplicates the attendee object for the given incoming registration id and attendee_id. |
|
| 3503 | - * |
|
| 3504 | - * @return void |
|
| 3505 | - * @throws EE_Error |
|
| 3506 | - * @throws InvalidArgumentException |
|
| 3507 | - * @throws InvalidDataTypeException |
|
| 3508 | - * @throws InvalidInterfaceException |
|
| 3509 | - */ |
|
| 3510 | - protected function _duplicate_attendee() |
|
| 3511 | - { |
|
| 3512 | - $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default'; |
|
| 3513 | - // verify we have necessary info |
|
| 3514 | - if (empty($this->_req_data['_REG_ID'])) { |
|
| 3515 | - EE_Error::add_error( |
|
| 3516 | - esc_html__( |
|
| 3517 | - 'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )', |
|
| 3518 | - 'event_espresso' |
|
| 3519 | - ), |
|
| 3520 | - __FILE__, |
|
| 3521 | - __LINE__, |
|
| 3522 | - __FUNCTION__ |
|
| 3523 | - ); |
|
| 3524 | - $query_args = array('action' => $action); |
|
| 3525 | - $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 3526 | - } |
|
| 3527 | - // okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration. |
|
| 3528 | - $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']); |
|
| 3529 | - $attendee = $registration->attendee(); |
|
| 3530 | - // remove relation of existing attendee on registration |
|
| 3531 | - $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 3532 | - // new attendee |
|
| 3533 | - $new_attendee = clone $attendee; |
|
| 3534 | - $new_attendee->set('ATT_ID', 0); |
|
| 3535 | - $new_attendee->save(); |
|
| 3536 | - // add new attendee to reg |
|
| 3537 | - $registration->_add_relation_to($new_attendee, 'Attendee'); |
|
| 3538 | - EE_Error::add_success( |
|
| 3539 | - esc_html__( |
|
| 3540 | - 'New Contact record created. Now make any edits you wish to make for this contact.', |
|
| 3541 | - 'event_espresso' |
|
| 3542 | - ) |
|
| 3543 | - ); |
|
| 3544 | - // redirect to edit page for attendee |
|
| 3545 | - $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee'); |
|
| 3546 | - $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 3547 | - } |
|
| 3548 | - |
|
| 3549 | - |
|
| 3550 | - /** |
|
| 3551 | - * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook. |
|
| 3552 | - * |
|
| 3553 | - * @param int $post_id |
|
| 3554 | - * @param WP_POST $post |
|
| 3555 | - * @throws DomainException |
|
| 3556 | - * @throws EE_Error |
|
| 3557 | - * @throws InvalidArgumentException |
|
| 3558 | - * @throws InvalidDataTypeException |
|
| 3559 | - * @throws InvalidInterfaceException |
|
| 3560 | - * @throws LogicException |
|
| 3561 | - * @throws InvalidFormSubmissionException |
|
| 3562 | - */ |
|
| 3563 | - protected function _insert_update_cpt_item($post_id, $post) |
|
| 3564 | - { |
|
| 3565 | - $success = true; |
|
| 3566 | - $attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees' |
|
| 3567 | - ? EEM_Attendee::instance()->get_one_by_ID($post_id) |
|
| 3568 | - : null; |
|
| 3569 | - // for attendee updates |
|
| 3570 | - if ($attendee instanceof EE_Attendee) { |
|
| 3571 | - // note we should only be UPDATING attendees at this point. |
|
| 3572 | - $updated_fields = array( |
|
| 3573 | - 'ATT_fname' => $this->_req_data['ATT_fname'], |
|
| 3574 | - 'ATT_lname' => $this->_req_data['ATT_lname'], |
|
| 3575 | - 'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'], |
|
| 3576 | - 'ATT_address' => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '', |
|
| 3577 | - 'ATT_address2' => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '', |
|
| 3578 | - 'ATT_city' => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '', |
|
| 3579 | - 'STA_ID' => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '', |
|
| 3580 | - 'CNT_ISO' => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '', |
|
| 3581 | - 'ATT_zip' => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '', |
|
| 3582 | - ); |
|
| 3583 | - foreach ($updated_fields as $field => $value) { |
|
| 3584 | - $attendee->set($field, $value); |
|
| 3585 | - } |
|
| 3586 | - |
|
| 3587 | - // process contact details metabox form handler (which will also save the attendee) |
|
| 3588 | - $contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee); |
|
| 3589 | - $success = $contact_details_form->process($this->_req_data); |
|
| 3590 | - |
|
| 3591 | - $attendee_update_callbacks = apply_filters( |
|
| 3592 | - 'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update', |
|
| 3593 | - array() |
|
| 3594 | - ); |
|
| 3595 | - foreach ($attendee_update_callbacks as $a_callback) { |
|
| 3596 | - if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) { |
|
| 3597 | - throw new EE_Error( |
|
| 3598 | - sprintf( |
|
| 3599 | - esc_html__( |
|
| 3600 | - 'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback. Please check the spelling.', |
|
| 3601 | - 'event_espresso' |
|
| 3602 | - ), |
|
| 3603 | - $a_callback |
|
| 3604 | - ) |
|
| 3605 | - ); |
|
| 3606 | - } |
|
| 3607 | - } |
|
| 3608 | - } |
|
| 3609 | - |
|
| 3610 | - if ($success === false) { |
|
| 3611 | - EE_Error::add_error( |
|
| 3612 | - esc_html__( |
|
| 3613 | - 'Something went wrong with updating the meta table data for the registration.', |
|
| 3614 | - 'event_espresso' |
|
| 3615 | - ), |
|
| 3616 | - __FILE__, |
|
| 3617 | - __FUNCTION__, |
|
| 3618 | - __LINE__ |
|
| 3619 | - ); |
|
| 3620 | - } |
|
| 3621 | - } |
|
| 3622 | - |
|
| 3623 | - |
|
| 3624 | - public function trash_cpt_item($post_id) |
|
| 3625 | - { |
|
| 3626 | - } |
|
| 3627 | - |
|
| 3628 | - |
|
| 3629 | - public function delete_cpt_item($post_id) |
|
| 3630 | - { |
|
| 3631 | - } |
|
| 3632 | - |
|
| 3633 | - |
|
| 3634 | - public function restore_cpt_item($post_id) |
|
| 3635 | - { |
|
| 3636 | - } |
|
| 3637 | - |
|
| 3638 | - |
|
| 3639 | - protected function _restore_cpt_item($post_id, $revision_id) |
|
| 3640 | - { |
|
| 3641 | - } |
|
| 3642 | - |
|
| 3643 | - |
|
| 3644 | - public function attendee_editor_metaboxes() |
|
| 3645 | - { |
|
| 3646 | - $this->verify_cpt_object(); |
|
| 3647 | - remove_meta_box( |
|
| 3648 | - 'postexcerpt', |
|
| 3649 | - esc_html__('Excerpt', 'event_espresso'), |
|
| 3650 | - 'post_excerpt_meta_box', |
|
| 3651 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3652 | - 'normal', |
|
| 3653 | - 'core' |
|
| 3654 | - ); |
|
| 3655 | - remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core'); |
|
| 3656 | - if (post_type_supports('espresso_attendees', 'excerpt')) { |
|
| 3657 | - add_meta_box( |
|
| 3658 | - 'postexcerpt', |
|
| 3659 | - esc_html__('Short Biography', 'event_espresso'), |
|
| 3660 | - 'post_excerpt_meta_box', |
|
| 3661 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3662 | - 'normal' |
|
| 3663 | - ); |
|
| 3664 | - } |
|
| 3665 | - if (post_type_supports('espresso_attendees', 'comments')) { |
|
| 3666 | - add_meta_box( |
|
| 3667 | - 'commentsdiv', |
|
| 3668 | - esc_html__('Notes on the Contact', 'event_espresso'), |
|
| 3669 | - 'post_comment_meta_box', |
|
| 3670 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3671 | - 'normal', |
|
| 3672 | - 'core' |
|
| 3673 | - ); |
|
| 3674 | - } |
|
| 3675 | - add_meta_box( |
|
| 3676 | - 'attendee_contact_info', |
|
| 3677 | - esc_html__('Contact Info', 'event_espresso'), |
|
| 3678 | - array($this, 'attendee_contact_info'), |
|
| 3679 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3680 | - 'side', |
|
| 3681 | - 'core' |
|
| 3682 | - ); |
|
| 3683 | - add_meta_box( |
|
| 3684 | - 'attendee_details_address', |
|
| 3685 | - esc_html__('Address Details', 'event_espresso'), |
|
| 3686 | - array($this, 'attendee_address_details'), |
|
| 3687 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3688 | - 'normal', |
|
| 3689 | - 'core' |
|
| 3690 | - ); |
|
| 3691 | - add_meta_box( |
|
| 3692 | - 'attendee_registrations', |
|
| 3693 | - esc_html__('Registrations for this Contact', 'event_espresso'), |
|
| 3694 | - array($this, 'attendee_registrations_meta_box'), |
|
| 3695 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3696 | - 'normal', |
|
| 3697 | - 'high' |
|
| 3698 | - ); |
|
| 3699 | - } |
|
| 3700 | - |
|
| 3701 | - |
|
| 3702 | - /** |
|
| 3703 | - * Metabox for attendee contact info |
|
| 3704 | - * |
|
| 3705 | - * @param WP_Post $post wp post object |
|
| 3706 | - * @return string attendee contact info ( and form ) |
|
| 3707 | - * @throws EE_Error |
|
| 3708 | - * @throws InvalidArgumentException |
|
| 3709 | - * @throws InvalidDataTypeException |
|
| 3710 | - * @throws InvalidInterfaceException |
|
| 3711 | - * @throws LogicException |
|
| 3712 | - * @throws DomainException |
|
| 3713 | - */ |
|
| 3714 | - public function attendee_contact_info($post) |
|
| 3715 | - { |
|
| 3716 | - // get attendee object ( should already have it ) |
|
| 3717 | - $form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj); |
|
| 3718 | - $form->enqueueStylesAndScripts(); |
|
| 3719 | - echo $form->display(); |
|
| 3720 | - } |
|
| 3721 | - |
|
| 3722 | - |
|
| 3723 | - /** |
|
| 3724 | - * Return form handler for the contact details metabox |
|
| 3725 | - * |
|
| 3726 | - * @param EE_Attendee $attendee |
|
| 3727 | - * @return AttendeeContactDetailsMetaboxFormHandler |
|
| 3728 | - * @throws DomainException |
|
| 3729 | - * @throws InvalidArgumentException |
|
| 3730 | - * @throws InvalidDataTypeException |
|
| 3731 | - * @throws InvalidInterfaceException |
|
| 3732 | - */ |
|
| 3733 | - protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee) |
|
| 3734 | - { |
|
| 3735 | - return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance()); |
|
| 3736 | - } |
|
| 3737 | - |
|
| 3738 | - |
|
| 3739 | - /** |
|
| 3740 | - * Metabox for attendee details |
|
| 3741 | - * |
|
| 3742 | - * @param WP_Post $post wp post object |
|
| 3743 | - * @throws DomainException |
|
| 3744 | - */ |
|
| 3745 | - public function attendee_address_details($post) |
|
| 3746 | - { |
|
| 3747 | - // get attendee object (should already have it) |
|
| 3748 | - $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 3749 | - $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input( |
|
| 3750 | - new EE_Question_Form_Input( |
|
| 3751 | - EE_Question::new_instance( |
|
| 3752 | - array( |
|
| 3753 | - 'QST_ID' => 0, |
|
| 3754 | - 'QST_display_text' => esc_html__('State/Province', 'event_espresso'), |
|
| 3755 | - 'QST_system' => 'admin-state', |
|
| 3756 | - ) |
|
| 3757 | - ), |
|
| 3758 | - EE_Answer::new_instance( |
|
| 3759 | - array( |
|
| 3760 | - 'ANS_ID' => 0, |
|
| 3761 | - 'ANS_value' => $this->_cpt_model_obj->state_ID(), |
|
| 3762 | - ) |
|
| 3763 | - ), |
|
| 3764 | - array( |
|
| 3765 | - 'input_id' => 'STA_ID', |
|
| 3766 | - 'input_name' => 'STA_ID', |
|
| 3767 | - 'input_prefix' => '', |
|
| 3768 | - 'append_qstn_id' => false, |
|
| 3769 | - ) |
|
| 3770 | - ) |
|
| 3771 | - ); |
|
| 3772 | - $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input( |
|
| 3773 | - new EE_Question_Form_Input( |
|
| 3774 | - EE_Question::new_instance( |
|
| 3775 | - array( |
|
| 3776 | - 'QST_ID' => 0, |
|
| 3777 | - 'QST_display_text' => esc_html__('Country', 'event_espresso'), |
|
| 3778 | - 'QST_system' => 'admin-country', |
|
| 3779 | - ) |
|
| 3780 | - ), |
|
| 3781 | - EE_Answer::new_instance( |
|
| 3782 | - array( |
|
| 3783 | - 'ANS_ID' => 0, |
|
| 3784 | - 'ANS_value' => $this->_cpt_model_obj->country_ID(), |
|
| 3785 | - ) |
|
| 3786 | - ), |
|
| 3787 | - array( |
|
| 3788 | - 'input_id' => 'CNT_ISO', |
|
| 3789 | - 'input_name' => 'CNT_ISO', |
|
| 3790 | - 'input_prefix' => '', |
|
| 3791 | - 'append_qstn_id' => false, |
|
| 3792 | - ) |
|
| 3793 | - ) |
|
| 3794 | - ); |
|
| 3795 | - $template = |
|
| 3796 | - REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php'; |
|
| 3797 | - EEH_Template::display_template($template, $this->_template_args); |
|
| 3798 | - } |
|
| 3799 | - |
|
| 3800 | - |
|
| 3801 | - /** |
|
| 3802 | - * _attendee_details |
|
| 3803 | - * |
|
| 3804 | - * @access protected |
|
| 3805 | - * @param $post |
|
| 3806 | - * @return void |
|
| 3807 | - * @throws DomainException |
|
| 3808 | - * @throws EE_Error |
|
| 3809 | - */ |
|
| 3810 | - public function attendee_registrations_meta_box($post) |
|
| 3811 | - { |
|
| 3812 | - $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 3813 | - $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration'); |
|
| 3814 | - $template = |
|
| 3815 | - REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php'; |
|
| 3816 | - EEH_Template::display_template($template, $this->_template_args); |
|
| 3817 | - } |
|
| 3818 | - |
|
| 3819 | - |
|
| 3820 | - /** |
|
| 3821 | - * add in the form fields for the attendee edit |
|
| 3822 | - * |
|
| 3823 | - * @param WP_Post $post wp post object |
|
| 3824 | - * @return string html for new form. |
|
| 3825 | - * @throws DomainException |
|
| 3826 | - */ |
|
| 3827 | - public function after_title_form_fields($post) |
|
| 3828 | - { |
|
| 3829 | - if ($post->post_type == 'espresso_attendees') { |
|
| 3830 | - $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php'; |
|
| 3831 | - $template_args['attendee'] = $this->_cpt_model_obj; |
|
| 3832 | - EEH_Template::display_template($template, $template_args); |
|
| 3833 | - } |
|
| 3834 | - } |
|
| 3835 | - |
|
| 3836 | - |
|
| 3837 | - /** |
|
| 3838 | - * _trash_or_restore_attendee |
|
| 3839 | - * |
|
| 3840 | - * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE) |
|
| 3841 | - * @return void |
|
| 3842 | - * @throws EE_Error |
|
| 3843 | - * @throws InvalidArgumentException |
|
| 3844 | - * @throws InvalidDataTypeException |
|
| 3845 | - * @throws InvalidInterfaceException |
|
| 3846 | - * @access protected |
|
| 3847 | - */ |
|
| 3848 | - protected function _trash_or_restore_attendees($trash = true) |
|
| 3849 | - { |
|
| 3850 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 3851 | - $ATT_MDL = EEM_Attendee::instance(); |
|
| 3852 | - $success = 1; |
|
| 3853 | - // Checkboxes |
|
| 3854 | - if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 3855 | - // if array has more than one element than success message should be plural |
|
| 3856 | - $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
| 3857 | - // cycle thru checkboxes |
|
| 3858 | - while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 3859 | - $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID) |
|
| 3860 | - : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID); |
|
| 3861 | - if (! $updated) { |
|
| 3862 | - $success = 0; |
|
| 3863 | - } |
|
| 3864 | - } |
|
| 3865 | - } else { |
|
| 3866 | - // grab single id and delete |
|
| 3867 | - $ATT_ID = absint($this->_req_data['ATT_ID']); |
|
| 3868 | - // get attendee |
|
| 3869 | - $att = $ATT_MDL->get_one_by_ID($ATT_ID); |
|
| 3870 | - $updated = $trash ? $att->set_status('trash') : $att->set_status('publish'); |
|
| 3871 | - $updated = $att->save(); |
|
| 3872 | - if (! $updated) { |
|
| 3873 | - $success = 0; |
|
| 3874 | - } |
|
| 3875 | - } |
|
| 3876 | - $what = $success > 1 |
|
| 3877 | - ? esc_html__('Contacts', 'event_espresso') |
|
| 3878 | - : esc_html__('Contact', 'event_espresso'); |
|
| 3879 | - $action_desc = $trash |
|
| 3880 | - ? esc_html__('moved to the trash', 'event_espresso') |
|
| 3881 | - : esc_html__('restored', 'event_espresso'); |
|
| 3882 | - $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list')); |
|
| 3883 | - } |
|
| 3033 | + } |
|
| 3034 | + $template_args = array( |
|
| 3035 | + 'title' => '', |
|
| 3036 | + 'content' => '', |
|
| 3037 | + 'step_button_text' => '', |
|
| 3038 | + 'show_notification_toggle' => false, |
|
| 3039 | + ); |
|
| 3040 | + // to indicate we're processing a new registration |
|
| 3041 | + $hidden_fields = array( |
|
| 3042 | + 'processing_registration' => array( |
|
| 3043 | + 'type' => 'hidden', |
|
| 3044 | + 'value' => 0, |
|
| 3045 | + ), |
|
| 3046 | + 'event_id' => array( |
|
| 3047 | + 'type' => 'hidden', |
|
| 3048 | + 'value' => $this->_reg_event->ID(), |
|
| 3049 | + ), |
|
| 3050 | + ); |
|
| 3051 | + // if the cart is empty then we know we're at step one so we'll display ticket selector |
|
| 3052 | + $cart = EE_Registry::instance()->SSN->cart(); |
|
| 3053 | + $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 3054 | + switch ($step) { |
|
| 3055 | + case 'ticket': |
|
| 3056 | + $hidden_fields['processing_registration']['value'] = 1; |
|
| 3057 | + $template_args['title'] = esc_html__( |
|
| 3058 | + 'Step One: Select the Ticket for this registration', |
|
| 3059 | + 'event_espresso' |
|
| 3060 | + ); |
|
| 3061 | + $template_args['content'] = |
|
| 3062 | + EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event); |
|
| 3063 | + $template_args['step_button_text'] = esc_html__( |
|
| 3064 | + 'Add Tickets and Continue to Registrant Details', |
|
| 3065 | + 'event_espresso' |
|
| 3066 | + ); |
|
| 3067 | + $template_args['show_notification_toggle'] = false; |
|
| 3068 | + break; |
|
| 3069 | + case 'questions': |
|
| 3070 | + $hidden_fields['processing_registration']['value'] = 2; |
|
| 3071 | + $template_args['title'] = esc_html__( |
|
| 3072 | + 'Step Two: Add Registrant Details for this Registration', |
|
| 3073 | + 'event_espresso' |
|
| 3074 | + ); |
|
| 3075 | + // in theory we should be able to run EED_SPCO at this point because the cart should have been setup |
|
| 3076 | + // properly by the first process_reg_step run. |
|
| 3077 | + $template_args['content'] = |
|
| 3078 | + EED_Single_Page_Checkout::registration_checkout_for_admin(); |
|
| 3079 | + $template_args['step_button_text'] = esc_html__( |
|
| 3080 | + 'Save Registration and Continue to Details', |
|
| 3081 | + 'event_espresso' |
|
| 3082 | + ); |
|
| 3083 | + $template_args['show_notification_toggle'] = true; |
|
| 3084 | + break; |
|
| 3085 | + } |
|
| 3086 | + // we come back to the process_registration_step route. |
|
| 3087 | + $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields); |
|
| 3088 | + return EEH_Template::display_template( |
|
| 3089 | + REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php', |
|
| 3090 | + $template_args, |
|
| 3091 | + true |
|
| 3092 | + ); |
|
| 3093 | + } |
|
| 3094 | + |
|
| 3095 | + |
|
| 3096 | + /** |
|
| 3097 | + * set_reg_event |
|
| 3098 | + * |
|
| 3099 | + * @access private |
|
| 3100 | + * @return bool |
|
| 3101 | + * @throws EE_Error |
|
| 3102 | + * @throws InvalidArgumentException |
|
| 3103 | + * @throws InvalidDataTypeException |
|
| 3104 | + * @throws InvalidInterfaceException |
|
| 3105 | + */ |
|
| 3106 | + private function _set_reg_event() |
|
| 3107 | + { |
|
| 3108 | + if (is_object($this->_reg_event)) { |
|
| 3109 | + return true; |
|
| 3110 | + } |
|
| 3111 | + $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
| 3112 | + if (! $EVT_ID) { |
|
| 3113 | + return false; |
|
| 3114 | + } |
|
| 3115 | + $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 3116 | + return true; |
|
| 3117 | + } |
|
| 3118 | + |
|
| 3119 | + |
|
| 3120 | + /** |
|
| 3121 | + * process_reg_step |
|
| 3122 | + * |
|
| 3123 | + * @access public |
|
| 3124 | + * @return string |
|
| 3125 | + * @throws DomainException |
|
| 3126 | + * @throws EE_Error |
|
| 3127 | + * @throws InvalidArgumentException |
|
| 3128 | + * @throws InvalidDataTypeException |
|
| 3129 | + * @throws InvalidInterfaceException |
|
| 3130 | + * @throws ReflectionException |
|
| 3131 | + * @throws RuntimeException |
|
| 3132 | + */ |
|
| 3133 | + public function process_reg_step() |
|
| 3134 | + { |
|
| 3135 | + EE_System::do_not_cache(); |
|
| 3136 | + $this->_set_reg_event(); |
|
| 3137 | + EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 3138 | + EE_Registry::instance()->REQ->set('uts', time()); |
|
| 3139 | + // what step are we on? |
|
| 3140 | + $cart = EE_Registry::instance()->SSN->cart(); |
|
| 3141 | + $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 3142 | + // if doing ajax then we need to verify the nonce |
|
| 3143 | + if (defined('DOING_AJAX')) { |
|
| 3144 | + $nonce = isset($this->_req_data[ $this->_req_nonce ]) |
|
| 3145 | + ? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : ''; |
|
| 3146 | + $this->_verify_nonce($nonce, $this->_req_nonce); |
|
| 3147 | + } |
|
| 3148 | + switch ($step) { |
|
| 3149 | + case 'ticket': |
|
| 3150 | + // process ticket selection |
|
| 3151 | + $success = EED_Ticket_Selector::instance()->process_ticket_selections(); |
|
| 3152 | + if ($success) { |
|
| 3153 | + EE_Error::add_success( |
|
| 3154 | + esc_html__( |
|
| 3155 | + 'Tickets Selected. Now complete the registration.', |
|
| 3156 | + 'event_espresso' |
|
| 3157 | + ) |
|
| 3158 | + ); |
|
| 3159 | + } else { |
|
| 3160 | + $query_args['step_error'] = $this->_req_data['step_error'] = true; |
|
| 3161 | + } |
|
| 3162 | + if (defined('DOING_AJAX')) { |
|
| 3163 | + $this->new_registration(); // display next step |
|
| 3164 | + } else { |
|
| 3165 | + $query_args = array( |
|
| 3166 | + 'action' => 'new_registration', |
|
| 3167 | + 'processing_registration' => 1, |
|
| 3168 | + 'event_id' => $this->_reg_event->ID(), |
|
| 3169 | + 'uts' => time(), |
|
| 3170 | + ); |
|
| 3171 | + $this->_redirect_after_action( |
|
| 3172 | + false, |
|
| 3173 | + '', |
|
| 3174 | + '', |
|
| 3175 | + $query_args, |
|
| 3176 | + true |
|
| 3177 | + ); |
|
| 3178 | + } |
|
| 3179 | + break; |
|
| 3180 | + case 'questions': |
|
| 3181 | + if (! isset( |
|
| 3182 | + $this->_req_data['txn_reg_status_change'], |
|
| 3183 | + $this->_req_data['txn_reg_status_change']['send_notifications'] |
|
| 3184 | + ) |
|
| 3185 | + ) { |
|
| 3186 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15); |
|
| 3187 | + } |
|
| 3188 | + // process registration |
|
| 3189 | + $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin(); |
|
| 3190 | + if ($cart instanceof EE_Cart) { |
|
| 3191 | + $grand_total = $cart->get_cart_grand_total(); |
|
| 3192 | + if ($grand_total instanceof EE_Line_Item) { |
|
| 3193 | + $grand_total->save_this_and_descendants_to_txn(); |
|
| 3194 | + } |
|
| 3195 | + } |
|
| 3196 | + if (! $transaction instanceof EE_Transaction) { |
|
| 3197 | + $query_args = array( |
|
| 3198 | + 'action' => 'new_registration', |
|
| 3199 | + 'processing_registration' => 2, |
|
| 3200 | + 'event_id' => $this->_reg_event->ID(), |
|
| 3201 | + 'uts' => time(), |
|
| 3202 | + ); |
|
| 3203 | + if (defined('DOING_AJAX')) { |
|
| 3204 | + // display registration form again because there are errors (maybe validation?) |
|
| 3205 | + $this->new_registration(); |
|
| 3206 | + return; |
|
| 3207 | + } else { |
|
| 3208 | + $this->_redirect_after_action( |
|
| 3209 | + false, |
|
| 3210 | + '', |
|
| 3211 | + '', |
|
| 3212 | + $query_args, |
|
| 3213 | + true |
|
| 3214 | + ); |
|
| 3215 | + return; |
|
| 3216 | + } |
|
| 3217 | + } |
|
| 3218 | + // maybe update status, and make sure to save transaction if not done already |
|
| 3219 | + if (! $transaction->update_status_based_on_total_paid()) { |
|
| 3220 | + $transaction->save(); |
|
| 3221 | + } |
|
| 3222 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 3223 | + $this->_req_data = array(); |
|
| 3224 | + $query_args = array( |
|
| 3225 | + 'action' => 'redirect_to_txn', |
|
| 3226 | + 'TXN_ID' => $transaction->ID(), |
|
| 3227 | + 'EVT_ID' => $this->_reg_event->ID(), |
|
| 3228 | + 'event_name' => urlencode($this->_reg_event->name()), |
|
| 3229 | + 'redirect_from' => 'new_registration', |
|
| 3230 | + ); |
|
| 3231 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 3232 | + break; |
|
| 3233 | + } |
|
| 3234 | + // what are you looking here for? Should be nothing to do at this point. |
|
| 3235 | + } |
|
| 3236 | + |
|
| 3237 | + |
|
| 3238 | + /** |
|
| 3239 | + * redirect_to_txn |
|
| 3240 | + * |
|
| 3241 | + * @access public |
|
| 3242 | + * @return void |
|
| 3243 | + * @throws EE_Error |
|
| 3244 | + * @throws InvalidArgumentException |
|
| 3245 | + * @throws InvalidDataTypeException |
|
| 3246 | + * @throws InvalidInterfaceException |
|
| 3247 | + */ |
|
| 3248 | + public function redirect_to_txn() |
|
| 3249 | + { |
|
| 3250 | + EE_System::do_not_cache(); |
|
| 3251 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 3252 | + $query_args = array( |
|
| 3253 | + 'action' => 'view_transaction', |
|
| 3254 | + 'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0, |
|
| 3255 | + 'page' => 'espresso_transactions', |
|
| 3256 | + ); |
|
| 3257 | + if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) { |
|
| 3258 | + $query_args['EVT_ID'] = $this->_req_data['EVT_ID']; |
|
| 3259 | + $query_args['event_name'] = urlencode($this->_req_data['event_name']); |
|
| 3260 | + $query_args['redirect_from'] = $this->_req_data['redirect_from']; |
|
| 3261 | + } |
|
| 3262 | + EE_Error::add_success( |
|
| 3263 | + esc_html__( |
|
| 3264 | + 'Registration Created. Please review the transaction and add any payments as necessary', |
|
| 3265 | + 'event_espresso' |
|
| 3266 | + ) |
|
| 3267 | + ); |
|
| 3268 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 3269 | + } |
|
| 3270 | + |
|
| 3271 | + |
|
| 3272 | + /** |
|
| 3273 | + * generates HTML for the Attendee Contact List |
|
| 3274 | + * |
|
| 3275 | + * @access protected |
|
| 3276 | + * @return void |
|
| 3277 | + */ |
|
| 3278 | + protected function _attendee_contact_list_table() |
|
| 3279 | + { |
|
| 3280 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 3281 | + $this->_search_btn_label = esc_html__('Contacts', 'event_espresso'); |
|
| 3282 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 3283 | + } |
|
| 3284 | + |
|
| 3285 | + |
|
| 3286 | + /** |
|
| 3287 | + * get_attendees |
|
| 3288 | + * |
|
| 3289 | + * @param $per_page |
|
| 3290 | + * @param bool $count whether to return count or data. |
|
| 3291 | + * @param bool $trash |
|
| 3292 | + * @return array |
|
| 3293 | + * @throws EE_Error |
|
| 3294 | + * @throws InvalidArgumentException |
|
| 3295 | + * @throws InvalidDataTypeException |
|
| 3296 | + * @throws InvalidInterfaceException |
|
| 3297 | + * @access public |
|
| 3298 | + */ |
|
| 3299 | + public function get_attendees($per_page, $count = false, $trash = false) |
|
| 3300 | + { |
|
| 3301 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 3302 | + require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php'); |
|
| 3303 | + $ATT_MDL = EEM_Attendee::instance(); |
|
| 3304 | + $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
| 3305 | + switch ($this->_req_data['orderby']) { |
|
| 3306 | + case 'ATT_ID': |
|
| 3307 | + $orderby = 'ATT_ID'; |
|
| 3308 | + break; |
|
| 3309 | + case 'ATT_fname': |
|
| 3310 | + $orderby = 'ATT_fname'; |
|
| 3311 | + break; |
|
| 3312 | + case 'ATT_email': |
|
| 3313 | + $orderby = 'ATT_email'; |
|
| 3314 | + break; |
|
| 3315 | + case 'ATT_city': |
|
| 3316 | + $orderby = 'ATT_city'; |
|
| 3317 | + break; |
|
| 3318 | + case 'STA_ID': |
|
| 3319 | + $orderby = 'STA_ID'; |
|
| 3320 | + break; |
|
| 3321 | + case 'CNT_ID': |
|
| 3322 | + $orderby = 'CNT_ID'; |
|
| 3323 | + break; |
|
| 3324 | + case 'Registration_Count': |
|
| 3325 | + $orderby = 'Registration_Count'; |
|
| 3326 | + break; |
|
| 3327 | + default: |
|
| 3328 | + $orderby = 'ATT_lname'; |
|
| 3329 | + } |
|
| 3330 | + $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) |
|
| 3331 | + ? $this->_req_data['order'] |
|
| 3332 | + : 'ASC'; |
|
| 3333 | + $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) |
|
| 3334 | + ? $this->_req_data['paged'] |
|
| 3335 | + : 1; |
|
| 3336 | + $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10; |
|
| 3337 | + $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) |
|
| 3338 | + ? $this->_req_data['perpage'] |
|
| 3339 | + : $per_page; |
|
| 3340 | + $_where = array(); |
|
| 3341 | + if (! empty($this->_req_data['s'])) { |
|
| 3342 | + $sstr = '%' . $this->_req_data['s'] . '%'; |
|
| 3343 | + $_where['OR'] = array( |
|
| 3344 | + 'Registration.Event.EVT_name' => array('LIKE', $sstr), |
|
| 3345 | + 'Registration.Event.EVT_desc' => array('LIKE', $sstr), |
|
| 3346 | + 'Registration.Event.EVT_short_desc' => array('LIKE', $sstr), |
|
| 3347 | + 'ATT_fname' => array('LIKE', $sstr), |
|
| 3348 | + 'ATT_lname' => array('LIKE', $sstr), |
|
| 3349 | + 'ATT_short_bio' => array('LIKE', $sstr), |
|
| 3350 | + 'ATT_email' => array('LIKE', $sstr), |
|
| 3351 | + 'ATT_address' => array('LIKE', $sstr), |
|
| 3352 | + 'ATT_address2' => array('LIKE', $sstr), |
|
| 3353 | + 'ATT_city' => array('LIKE', $sstr), |
|
| 3354 | + 'Country.CNT_name' => array('LIKE', $sstr), |
|
| 3355 | + 'State.STA_name' => array('LIKE', $sstr), |
|
| 3356 | + 'ATT_phone' => array('LIKE', $sstr), |
|
| 3357 | + 'Registration.REG_final_price' => array('LIKE', $sstr), |
|
| 3358 | + 'Registration.REG_code' => array('LIKE', $sstr), |
|
| 3359 | + 'Registration.REG_group_size' => array('LIKE', $sstr), |
|
| 3360 | + ); |
|
| 3361 | + } |
|
| 3362 | + $offset = ($current_page - 1) * $per_page; |
|
| 3363 | + $limit = $count ? null : array($offset, $per_page); |
|
| 3364 | + $query_args = array( |
|
| 3365 | + $_where, |
|
| 3366 | + 'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')), |
|
| 3367 | + 'limit' => $limit, |
|
| 3368 | + ); |
|
| 3369 | + if (! $count) { |
|
| 3370 | + $query_args['order_by'] = array($orderby => $sort); |
|
| 3371 | + } |
|
| 3372 | + if ($trash) { |
|
| 3373 | + $query_args[0]['status'] = array('!=', 'publish'); |
|
| 3374 | + $all_attendees = $count |
|
| 3375 | + ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
| 3376 | + : $ATT_MDL->get_all($query_args); |
|
| 3377 | + } else { |
|
| 3378 | + $query_args[0]['status'] = array('IN', array('publish')); |
|
| 3379 | + $all_attendees = $count |
|
| 3380 | + ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
| 3381 | + : $ATT_MDL->get_all($query_args); |
|
| 3382 | + } |
|
| 3383 | + return $all_attendees; |
|
| 3384 | + } |
|
| 3385 | + |
|
| 3386 | + |
|
| 3387 | + /** |
|
| 3388 | + * This is just taking care of resending the registration confirmation |
|
| 3389 | + * |
|
| 3390 | + * @access protected |
|
| 3391 | + * @return void |
|
| 3392 | + */ |
|
| 3393 | + protected function _resend_registration() |
|
| 3394 | + { |
|
| 3395 | + $this->_process_resend_registration(); |
|
| 3396 | + $query_args = isset($this->_req_data['redirect_to']) |
|
| 3397 | + ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID']) |
|
| 3398 | + : array('action' => 'default'); |
|
| 3399 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 3400 | + } |
|
| 3401 | + |
|
| 3402 | + /** |
|
| 3403 | + * Creates a registration report, but accepts the name of a method to use for preparing the query parameters |
|
| 3404 | + * to use when selecting registrations |
|
| 3405 | + * |
|
| 3406 | + * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing |
|
| 3407 | + * the query parameters from the request |
|
| 3408 | + * @return void ends the request with a redirect or download |
|
| 3409 | + */ |
|
| 3410 | + public function _registrations_report_base($method_name_for_getting_query_params) |
|
| 3411 | + { |
|
| 3412 | + if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3413 | + wp_redirect( |
|
| 3414 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 3415 | + array( |
|
| 3416 | + 'page' => 'espresso_batch', |
|
| 3417 | + 'batch' => 'file', |
|
| 3418 | + 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 3419 | + 'filters' => urlencode( |
|
| 3420 | + serialize( |
|
| 3421 | + call_user_func( |
|
| 3422 | + array($this, $method_name_for_getting_query_params), |
|
| 3423 | + EEH_Array::is_set( |
|
| 3424 | + $this->_req_data, |
|
| 3425 | + 'filters', |
|
| 3426 | + array() |
|
| 3427 | + ) |
|
| 3428 | + ) |
|
| 3429 | + ) |
|
| 3430 | + ), |
|
| 3431 | + 'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false), |
|
| 3432 | + 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'), |
|
| 3433 | + 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 3434 | + ) |
|
| 3435 | + ) |
|
| 3436 | + ); |
|
| 3437 | + } else { |
|
| 3438 | + $new_request_args = array( |
|
| 3439 | + 'export' => 'report', |
|
| 3440 | + 'action' => 'registrations_report_for_event', |
|
| 3441 | + 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 3442 | + ); |
|
| 3443 | + $this->_req_data = array_merge($this->_req_data, $new_request_args); |
|
| 3444 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3445 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3446 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
| 3447 | + $EE_Export->export(); |
|
| 3448 | + } |
|
| 3449 | + } |
|
| 3450 | + } |
|
| 3451 | + |
|
| 3452 | + |
|
| 3453 | + /** |
|
| 3454 | + * Creates a registration report using only query parameters in the request |
|
| 3455 | + * |
|
| 3456 | + * @return void |
|
| 3457 | + */ |
|
| 3458 | + public function _registrations_report() |
|
| 3459 | + { |
|
| 3460 | + $this->_registrations_report_base('_get_registration_query_parameters'); |
|
| 3461 | + } |
|
| 3462 | + |
|
| 3463 | + |
|
| 3464 | + public function _contact_list_export() |
|
| 3465 | + { |
|
| 3466 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3467 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3468 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
| 3469 | + $EE_Export->export_attendees(); |
|
| 3470 | + } |
|
| 3471 | + } |
|
| 3472 | + |
|
| 3473 | + |
|
| 3474 | + public function _contact_list_report() |
|
| 3475 | + { |
|
| 3476 | + if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3477 | + wp_redirect( |
|
| 3478 | + EE_Admin_Page::add_query_args_and_nonce( |
|
| 3479 | + array( |
|
| 3480 | + 'page' => 'espresso_batch', |
|
| 3481 | + 'batch' => 'file', |
|
| 3482 | + 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'), |
|
| 3483 | + 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 3484 | + ) |
|
| 3485 | + ) |
|
| 3486 | + ); |
|
| 3487 | + } else { |
|
| 3488 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3489 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3490 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
| 3491 | + $EE_Export->report_attendees(); |
|
| 3492 | + } |
|
| 3493 | + } |
|
| 3494 | + } |
|
| 3495 | + |
|
| 3496 | + |
|
| 3497 | + |
|
| 3498 | + |
|
| 3499 | + |
|
| 3500 | + /*************************************** ATTENDEE DETAILS ***************************************/ |
|
| 3501 | + /** |
|
| 3502 | + * This duplicates the attendee object for the given incoming registration id and attendee_id. |
|
| 3503 | + * |
|
| 3504 | + * @return void |
|
| 3505 | + * @throws EE_Error |
|
| 3506 | + * @throws InvalidArgumentException |
|
| 3507 | + * @throws InvalidDataTypeException |
|
| 3508 | + * @throws InvalidInterfaceException |
|
| 3509 | + */ |
|
| 3510 | + protected function _duplicate_attendee() |
|
| 3511 | + { |
|
| 3512 | + $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default'; |
|
| 3513 | + // verify we have necessary info |
|
| 3514 | + if (empty($this->_req_data['_REG_ID'])) { |
|
| 3515 | + EE_Error::add_error( |
|
| 3516 | + esc_html__( |
|
| 3517 | + 'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )', |
|
| 3518 | + 'event_espresso' |
|
| 3519 | + ), |
|
| 3520 | + __FILE__, |
|
| 3521 | + __LINE__, |
|
| 3522 | + __FUNCTION__ |
|
| 3523 | + ); |
|
| 3524 | + $query_args = array('action' => $action); |
|
| 3525 | + $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 3526 | + } |
|
| 3527 | + // okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration. |
|
| 3528 | + $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']); |
|
| 3529 | + $attendee = $registration->attendee(); |
|
| 3530 | + // remove relation of existing attendee on registration |
|
| 3531 | + $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 3532 | + // new attendee |
|
| 3533 | + $new_attendee = clone $attendee; |
|
| 3534 | + $new_attendee->set('ATT_ID', 0); |
|
| 3535 | + $new_attendee->save(); |
|
| 3536 | + // add new attendee to reg |
|
| 3537 | + $registration->_add_relation_to($new_attendee, 'Attendee'); |
|
| 3538 | + EE_Error::add_success( |
|
| 3539 | + esc_html__( |
|
| 3540 | + 'New Contact record created. Now make any edits you wish to make for this contact.', |
|
| 3541 | + 'event_espresso' |
|
| 3542 | + ) |
|
| 3543 | + ); |
|
| 3544 | + // redirect to edit page for attendee |
|
| 3545 | + $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee'); |
|
| 3546 | + $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 3547 | + } |
|
| 3548 | + |
|
| 3549 | + |
|
| 3550 | + /** |
|
| 3551 | + * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook. |
|
| 3552 | + * |
|
| 3553 | + * @param int $post_id |
|
| 3554 | + * @param WP_POST $post |
|
| 3555 | + * @throws DomainException |
|
| 3556 | + * @throws EE_Error |
|
| 3557 | + * @throws InvalidArgumentException |
|
| 3558 | + * @throws InvalidDataTypeException |
|
| 3559 | + * @throws InvalidInterfaceException |
|
| 3560 | + * @throws LogicException |
|
| 3561 | + * @throws InvalidFormSubmissionException |
|
| 3562 | + */ |
|
| 3563 | + protected function _insert_update_cpt_item($post_id, $post) |
|
| 3564 | + { |
|
| 3565 | + $success = true; |
|
| 3566 | + $attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees' |
|
| 3567 | + ? EEM_Attendee::instance()->get_one_by_ID($post_id) |
|
| 3568 | + : null; |
|
| 3569 | + // for attendee updates |
|
| 3570 | + if ($attendee instanceof EE_Attendee) { |
|
| 3571 | + // note we should only be UPDATING attendees at this point. |
|
| 3572 | + $updated_fields = array( |
|
| 3573 | + 'ATT_fname' => $this->_req_data['ATT_fname'], |
|
| 3574 | + 'ATT_lname' => $this->_req_data['ATT_lname'], |
|
| 3575 | + 'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'], |
|
| 3576 | + 'ATT_address' => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '', |
|
| 3577 | + 'ATT_address2' => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '', |
|
| 3578 | + 'ATT_city' => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '', |
|
| 3579 | + 'STA_ID' => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '', |
|
| 3580 | + 'CNT_ISO' => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '', |
|
| 3581 | + 'ATT_zip' => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '', |
|
| 3582 | + ); |
|
| 3583 | + foreach ($updated_fields as $field => $value) { |
|
| 3584 | + $attendee->set($field, $value); |
|
| 3585 | + } |
|
| 3586 | + |
|
| 3587 | + // process contact details metabox form handler (which will also save the attendee) |
|
| 3588 | + $contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee); |
|
| 3589 | + $success = $contact_details_form->process($this->_req_data); |
|
| 3590 | + |
|
| 3591 | + $attendee_update_callbacks = apply_filters( |
|
| 3592 | + 'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update', |
|
| 3593 | + array() |
|
| 3594 | + ); |
|
| 3595 | + foreach ($attendee_update_callbacks as $a_callback) { |
|
| 3596 | + if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) { |
|
| 3597 | + throw new EE_Error( |
|
| 3598 | + sprintf( |
|
| 3599 | + esc_html__( |
|
| 3600 | + 'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback. Please check the spelling.', |
|
| 3601 | + 'event_espresso' |
|
| 3602 | + ), |
|
| 3603 | + $a_callback |
|
| 3604 | + ) |
|
| 3605 | + ); |
|
| 3606 | + } |
|
| 3607 | + } |
|
| 3608 | + } |
|
| 3609 | + |
|
| 3610 | + if ($success === false) { |
|
| 3611 | + EE_Error::add_error( |
|
| 3612 | + esc_html__( |
|
| 3613 | + 'Something went wrong with updating the meta table data for the registration.', |
|
| 3614 | + 'event_espresso' |
|
| 3615 | + ), |
|
| 3616 | + __FILE__, |
|
| 3617 | + __FUNCTION__, |
|
| 3618 | + __LINE__ |
|
| 3619 | + ); |
|
| 3620 | + } |
|
| 3621 | + } |
|
| 3622 | + |
|
| 3623 | + |
|
| 3624 | + public function trash_cpt_item($post_id) |
|
| 3625 | + { |
|
| 3626 | + } |
|
| 3627 | + |
|
| 3628 | + |
|
| 3629 | + public function delete_cpt_item($post_id) |
|
| 3630 | + { |
|
| 3631 | + } |
|
| 3632 | + |
|
| 3633 | + |
|
| 3634 | + public function restore_cpt_item($post_id) |
|
| 3635 | + { |
|
| 3636 | + } |
|
| 3637 | + |
|
| 3638 | + |
|
| 3639 | + protected function _restore_cpt_item($post_id, $revision_id) |
|
| 3640 | + { |
|
| 3641 | + } |
|
| 3642 | + |
|
| 3643 | + |
|
| 3644 | + public function attendee_editor_metaboxes() |
|
| 3645 | + { |
|
| 3646 | + $this->verify_cpt_object(); |
|
| 3647 | + remove_meta_box( |
|
| 3648 | + 'postexcerpt', |
|
| 3649 | + esc_html__('Excerpt', 'event_espresso'), |
|
| 3650 | + 'post_excerpt_meta_box', |
|
| 3651 | + $this->_cpt_routes[ $this->_req_action ], |
|
| 3652 | + 'normal', |
|
| 3653 | + 'core' |
|
| 3654 | + ); |
|
| 3655 | + remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core'); |
|
| 3656 | + if (post_type_supports('espresso_attendees', 'excerpt')) { |
|
| 3657 | + add_meta_box( |
|
| 3658 | + 'postexcerpt', |
|
| 3659 | + esc_html__('Short Biography', 'event_espresso'), |
|
| 3660 | + 'post_excerpt_meta_box', |
|
| 3661 | + $this->_cpt_routes[ $this->_req_action ], |
|
| 3662 | + 'normal' |
|
| 3663 | + ); |
|
| 3664 | + } |
|
| 3665 | + if (post_type_supports('espresso_attendees', 'comments')) { |
|
| 3666 | + add_meta_box( |
|
| 3667 | + 'commentsdiv', |
|
| 3668 | + esc_html__('Notes on the Contact', 'event_espresso'), |
|
| 3669 | + 'post_comment_meta_box', |
|
| 3670 | + $this->_cpt_routes[ $this->_req_action ], |
|
| 3671 | + 'normal', |
|
| 3672 | + 'core' |
|
| 3673 | + ); |
|
| 3674 | + } |
|
| 3675 | + add_meta_box( |
|
| 3676 | + 'attendee_contact_info', |
|
| 3677 | + esc_html__('Contact Info', 'event_espresso'), |
|
| 3678 | + array($this, 'attendee_contact_info'), |
|
| 3679 | + $this->_cpt_routes[ $this->_req_action ], |
|
| 3680 | + 'side', |
|
| 3681 | + 'core' |
|
| 3682 | + ); |
|
| 3683 | + add_meta_box( |
|
| 3684 | + 'attendee_details_address', |
|
| 3685 | + esc_html__('Address Details', 'event_espresso'), |
|
| 3686 | + array($this, 'attendee_address_details'), |
|
| 3687 | + $this->_cpt_routes[ $this->_req_action ], |
|
| 3688 | + 'normal', |
|
| 3689 | + 'core' |
|
| 3690 | + ); |
|
| 3691 | + add_meta_box( |
|
| 3692 | + 'attendee_registrations', |
|
| 3693 | + esc_html__('Registrations for this Contact', 'event_espresso'), |
|
| 3694 | + array($this, 'attendee_registrations_meta_box'), |
|
| 3695 | + $this->_cpt_routes[ $this->_req_action ], |
|
| 3696 | + 'normal', |
|
| 3697 | + 'high' |
|
| 3698 | + ); |
|
| 3699 | + } |
|
| 3700 | + |
|
| 3701 | + |
|
| 3702 | + /** |
|
| 3703 | + * Metabox for attendee contact info |
|
| 3704 | + * |
|
| 3705 | + * @param WP_Post $post wp post object |
|
| 3706 | + * @return string attendee contact info ( and form ) |
|
| 3707 | + * @throws EE_Error |
|
| 3708 | + * @throws InvalidArgumentException |
|
| 3709 | + * @throws InvalidDataTypeException |
|
| 3710 | + * @throws InvalidInterfaceException |
|
| 3711 | + * @throws LogicException |
|
| 3712 | + * @throws DomainException |
|
| 3713 | + */ |
|
| 3714 | + public function attendee_contact_info($post) |
|
| 3715 | + { |
|
| 3716 | + // get attendee object ( should already have it ) |
|
| 3717 | + $form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj); |
|
| 3718 | + $form->enqueueStylesAndScripts(); |
|
| 3719 | + echo $form->display(); |
|
| 3720 | + } |
|
| 3721 | + |
|
| 3722 | + |
|
| 3723 | + /** |
|
| 3724 | + * Return form handler for the contact details metabox |
|
| 3725 | + * |
|
| 3726 | + * @param EE_Attendee $attendee |
|
| 3727 | + * @return AttendeeContactDetailsMetaboxFormHandler |
|
| 3728 | + * @throws DomainException |
|
| 3729 | + * @throws InvalidArgumentException |
|
| 3730 | + * @throws InvalidDataTypeException |
|
| 3731 | + * @throws InvalidInterfaceException |
|
| 3732 | + */ |
|
| 3733 | + protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee) |
|
| 3734 | + { |
|
| 3735 | + return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance()); |
|
| 3736 | + } |
|
| 3737 | + |
|
| 3738 | + |
|
| 3739 | + /** |
|
| 3740 | + * Metabox for attendee details |
|
| 3741 | + * |
|
| 3742 | + * @param WP_Post $post wp post object |
|
| 3743 | + * @throws DomainException |
|
| 3744 | + */ |
|
| 3745 | + public function attendee_address_details($post) |
|
| 3746 | + { |
|
| 3747 | + // get attendee object (should already have it) |
|
| 3748 | + $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 3749 | + $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input( |
|
| 3750 | + new EE_Question_Form_Input( |
|
| 3751 | + EE_Question::new_instance( |
|
| 3752 | + array( |
|
| 3753 | + 'QST_ID' => 0, |
|
| 3754 | + 'QST_display_text' => esc_html__('State/Province', 'event_espresso'), |
|
| 3755 | + 'QST_system' => 'admin-state', |
|
| 3756 | + ) |
|
| 3757 | + ), |
|
| 3758 | + EE_Answer::new_instance( |
|
| 3759 | + array( |
|
| 3760 | + 'ANS_ID' => 0, |
|
| 3761 | + 'ANS_value' => $this->_cpt_model_obj->state_ID(), |
|
| 3762 | + ) |
|
| 3763 | + ), |
|
| 3764 | + array( |
|
| 3765 | + 'input_id' => 'STA_ID', |
|
| 3766 | + 'input_name' => 'STA_ID', |
|
| 3767 | + 'input_prefix' => '', |
|
| 3768 | + 'append_qstn_id' => false, |
|
| 3769 | + ) |
|
| 3770 | + ) |
|
| 3771 | + ); |
|
| 3772 | + $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input( |
|
| 3773 | + new EE_Question_Form_Input( |
|
| 3774 | + EE_Question::new_instance( |
|
| 3775 | + array( |
|
| 3776 | + 'QST_ID' => 0, |
|
| 3777 | + 'QST_display_text' => esc_html__('Country', 'event_espresso'), |
|
| 3778 | + 'QST_system' => 'admin-country', |
|
| 3779 | + ) |
|
| 3780 | + ), |
|
| 3781 | + EE_Answer::new_instance( |
|
| 3782 | + array( |
|
| 3783 | + 'ANS_ID' => 0, |
|
| 3784 | + 'ANS_value' => $this->_cpt_model_obj->country_ID(), |
|
| 3785 | + ) |
|
| 3786 | + ), |
|
| 3787 | + array( |
|
| 3788 | + 'input_id' => 'CNT_ISO', |
|
| 3789 | + 'input_name' => 'CNT_ISO', |
|
| 3790 | + 'input_prefix' => '', |
|
| 3791 | + 'append_qstn_id' => false, |
|
| 3792 | + ) |
|
| 3793 | + ) |
|
| 3794 | + ); |
|
| 3795 | + $template = |
|
| 3796 | + REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php'; |
|
| 3797 | + EEH_Template::display_template($template, $this->_template_args); |
|
| 3798 | + } |
|
| 3799 | + |
|
| 3800 | + |
|
| 3801 | + /** |
|
| 3802 | + * _attendee_details |
|
| 3803 | + * |
|
| 3804 | + * @access protected |
|
| 3805 | + * @param $post |
|
| 3806 | + * @return void |
|
| 3807 | + * @throws DomainException |
|
| 3808 | + * @throws EE_Error |
|
| 3809 | + */ |
|
| 3810 | + public function attendee_registrations_meta_box($post) |
|
| 3811 | + { |
|
| 3812 | + $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 3813 | + $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration'); |
|
| 3814 | + $template = |
|
| 3815 | + REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php'; |
|
| 3816 | + EEH_Template::display_template($template, $this->_template_args); |
|
| 3817 | + } |
|
| 3818 | + |
|
| 3819 | + |
|
| 3820 | + /** |
|
| 3821 | + * add in the form fields for the attendee edit |
|
| 3822 | + * |
|
| 3823 | + * @param WP_Post $post wp post object |
|
| 3824 | + * @return string html for new form. |
|
| 3825 | + * @throws DomainException |
|
| 3826 | + */ |
|
| 3827 | + public function after_title_form_fields($post) |
|
| 3828 | + { |
|
| 3829 | + if ($post->post_type == 'espresso_attendees') { |
|
| 3830 | + $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php'; |
|
| 3831 | + $template_args['attendee'] = $this->_cpt_model_obj; |
|
| 3832 | + EEH_Template::display_template($template, $template_args); |
|
| 3833 | + } |
|
| 3834 | + } |
|
| 3835 | + |
|
| 3836 | + |
|
| 3837 | + /** |
|
| 3838 | + * _trash_or_restore_attendee |
|
| 3839 | + * |
|
| 3840 | + * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE) |
|
| 3841 | + * @return void |
|
| 3842 | + * @throws EE_Error |
|
| 3843 | + * @throws InvalidArgumentException |
|
| 3844 | + * @throws InvalidDataTypeException |
|
| 3845 | + * @throws InvalidInterfaceException |
|
| 3846 | + * @access protected |
|
| 3847 | + */ |
|
| 3848 | + protected function _trash_or_restore_attendees($trash = true) |
|
| 3849 | + { |
|
| 3850 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 3851 | + $ATT_MDL = EEM_Attendee::instance(); |
|
| 3852 | + $success = 1; |
|
| 3853 | + // Checkboxes |
|
| 3854 | + if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 3855 | + // if array has more than one element than success message should be plural |
|
| 3856 | + $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
| 3857 | + // cycle thru checkboxes |
|
| 3858 | + while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 3859 | + $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID) |
|
| 3860 | + : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID); |
|
| 3861 | + if (! $updated) { |
|
| 3862 | + $success = 0; |
|
| 3863 | + } |
|
| 3864 | + } |
|
| 3865 | + } else { |
|
| 3866 | + // grab single id and delete |
|
| 3867 | + $ATT_ID = absint($this->_req_data['ATT_ID']); |
|
| 3868 | + // get attendee |
|
| 3869 | + $att = $ATT_MDL->get_one_by_ID($ATT_ID); |
|
| 3870 | + $updated = $trash ? $att->set_status('trash') : $att->set_status('publish'); |
|
| 3871 | + $updated = $att->save(); |
|
| 3872 | + if (! $updated) { |
|
| 3873 | + $success = 0; |
|
| 3874 | + } |
|
| 3875 | + } |
|
| 3876 | + $what = $success > 1 |
|
| 3877 | + ? esc_html__('Contacts', 'event_espresso') |
|
| 3878 | + : esc_html__('Contact', 'event_espresso'); |
|
| 3879 | + $action_desc = $trash |
|
| 3880 | + ? esc_html__('moved to the trash', 'event_espresso') |
|
| 3881 | + : esc_html__('restored', 'event_espresso'); |
|
| 3882 | + $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list')); |
|
| 3883 | + } |
|
| 3884 | 3884 | } |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | // when adding a new registration... |
| 66 | 66 | if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') { |
| 67 | 67 | EE_System::do_not_cache(); |
| 68 | - if (! isset($this->_req_data['processing_registration']) |
|
| 68 | + if ( ! isset($this->_req_data['processing_registration']) |
|
| 69 | 69 | || absint($this->_req_data['processing_registration']) !== 1 |
| 70 | 70 | ) { |
| 71 | 71 | // and it's NOT the attendee information reg step |
@@ -658,7 +658,7 @@ discard block |
||
| 658 | 658 | // style |
| 659 | 659 | wp_register_style( |
| 660 | 660 | 'espresso_reg', |
| 661 | - REG_ASSETS_URL . 'espresso_registrations_admin.css', |
|
| 661 | + REG_ASSETS_URL.'espresso_registrations_admin.css', |
|
| 662 | 662 | array('ee-admin-css'), |
| 663 | 663 | EVENT_ESPRESSO_VERSION |
| 664 | 664 | ); |
@@ -666,7 +666,7 @@ discard block |
||
| 666 | 666 | // script |
| 667 | 667 | wp_register_script( |
| 668 | 668 | 'espresso_reg', |
| 669 | - REG_ASSETS_URL . 'espresso_registrations_admin.js', |
|
| 669 | + REG_ASSETS_URL.'espresso_registrations_admin.js', |
|
| 670 | 670 | array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), |
| 671 | 671 | EVENT_ESPRESSO_VERSION, |
| 672 | 672 | true |
@@ -704,7 +704,7 @@ discard block |
||
| 704 | 704 | wp_dequeue_style('espresso_reg'); |
| 705 | 705 | wp_register_style( |
| 706 | 706 | 'espresso_att', |
| 707 | - REG_ASSETS_URL . 'espresso_attendees_admin.css', |
|
| 707 | + REG_ASSETS_URL.'espresso_attendees_admin.css', |
|
| 708 | 708 | array('ee-admin-css'), |
| 709 | 709 | EVENT_ESPRESSO_VERSION |
| 710 | 710 | ); |
@@ -716,7 +716,7 @@ discard block |
||
| 716 | 716 | { |
| 717 | 717 | wp_register_script( |
| 718 | 718 | 'ee-spco-for-admin', |
| 719 | - REG_ASSETS_URL . 'spco_for_admin.js', |
|
| 719 | + REG_ASSETS_URL.'spco_for_admin.js', |
|
| 720 | 720 | array('underscore', 'jquery'), |
| 721 | 721 | EVENT_ESPRESSO_VERSION, |
| 722 | 722 | true |
@@ -950,7 +950,7 @@ discard block |
||
| 950 | 950 | } |
| 951 | 951 | $sc_items = array( |
| 952 | 952 | 'approved_status' => array( |
| 953 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 953 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved, |
|
| 954 | 954 | 'desc' => EEH_Template::pretty_status( |
| 955 | 955 | EEM_Registration::status_id_approved, |
| 956 | 956 | false, |
@@ -958,7 +958,7 @@ discard block |
||
| 958 | 958 | ), |
| 959 | 959 | ), |
| 960 | 960 | 'pending_status' => array( |
| 961 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 961 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment, |
|
| 962 | 962 | 'desc' => EEH_Template::pretty_status( |
| 963 | 963 | EEM_Registration::status_id_pending_payment, |
| 964 | 964 | false, |
@@ -966,7 +966,7 @@ discard block |
||
| 966 | 966 | ), |
| 967 | 967 | ), |
| 968 | 968 | 'wait_list' => array( |
| 969 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 969 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list, |
|
| 970 | 970 | 'desc' => EEH_Template::pretty_status( |
| 971 | 971 | EEM_Registration::status_id_wait_list, |
| 972 | 972 | false, |
@@ -974,7 +974,7 @@ discard block |
||
| 974 | 974 | ), |
| 975 | 975 | ), |
| 976 | 976 | 'incomplete_status' => array( |
| 977 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete, |
|
| 977 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_incomplete, |
|
| 978 | 978 | 'desc' => EEH_Template::pretty_status( |
| 979 | 979 | EEM_Registration::status_id_incomplete, |
| 980 | 980 | false, |
@@ -982,7 +982,7 @@ discard block |
||
| 982 | 982 | ), |
| 983 | 983 | ), |
| 984 | 984 | 'not_approved' => array( |
| 985 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 985 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved, |
|
| 986 | 986 | 'desc' => EEH_Template::pretty_status( |
| 987 | 987 | EEM_Registration::status_id_not_approved, |
| 988 | 988 | false, |
@@ -990,7 +990,7 @@ discard block |
||
| 990 | 990 | ), |
| 991 | 991 | ), |
| 992 | 992 | 'declined_status' => array( |
| 993 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 993 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined, |
|
| 994 | 994 | 'desc' => EEH_Template::pretty_status( |
| 995 | 995 | EEM_Registration::status_id_declined, |
| 996 | 996 | false, |
@@ -998,7 +998,7 @@ discard block |
||
| 998 | 998 | ), |
| 999 | 999 | ), |
| 1000 | 1000 | 'cancelled_status' => array( |
| 1001 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 1001 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled, |
|
| 1002 | 1002 | 'desc' => EEH_Template::pretty_status( |
| 1003 | 1003 | EEM_Registration::status_id_cancelled, |
| 1004 | 1004 | false, |
@@ -1033,13 +1033,13 @@ discard block |
||
| 1033 | 1033 | 'event_espresso' |
| 1034 | 1034 | ), |
| 1035 | 1035 | '<h3 style="line-height:1.5em;">', |
| 1036 | - '<a href="' . EE_Admin_Page::add_query_args_and_nonce( |
|
| 1036 | + '<a href="'.EE_Admin_Page::add_query_args_and_nonce( |
|
| 1037 | 1037 | array( |
| 1038 | 1038 | 'action' => 'edit_attendee', |
| 1039 | 1039 | 'post' => $ATT_ID, |
| 1040 | 1040 | ), |
| 1041 | 1041 | REG_ADMIN_URL |
| 1042 | - ) . '">' . $attendee->full_name() . '</a>', |
|
| 1042 | + ).'">'.$attendee->full_name().'</a>', |
|
| 1043 | 1043 | '</h3>' |
| 1044 | 1044 | ); |
| 1045 | 1045 | } |
@@ -1050,7 +1050,7 @@ discard block |
||
| 1050 | 1050 | 'espresso_registrations_new_registration', |
| 1051 | 1051 | $EVT_ID |
| 1052 | 1052 | )) { |
| 1053 | - $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
| 1053 | + $this->_admin_page_title .= ' '.$this->get_action_link_or_button( |
|
| 1054 | 1054 | 'new_registration', |
| 1055 | 1055 | 'add-registrant', |
| 1056 | 1056 | array('event_id' => $EVT_ID), |
@@ -1090,7 +1090,7 @@ discard block |
||
| 1090 | 1090 | $this->_template_args['admin_page_header'] .= ' <span class="drk-grey-text">'; |
| 1091 | 1091 | $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>'; |
| 1092 | 1092 | $this->_template_args['admin_page_header'] .= $datetime->name(); |
| 1093 | - $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )'; |
|
| 1093 | + $this->_template_args['admin_page_header'] .= ' ( '.$datetime->start_date().' )'; |
|
| 1094 | 1094 | $this->_template_args['admin_page_header'] .= '</span></h3>'; |
| 1095 | 1095 | } |
| 1096 | 1096 | } |
@@ -1116,7 +1116,7 @@ discard block |
||
| 1116 | 1116 | return true; |
| 1117 | 1117 | } |
| 1118 | 1118 | $REG = EEM_Registration::instance(); |
| 1119 | - $REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 1119 | + $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 1120 | 1120 | if ($this->_registration = $REG->get_one_by_ID($REG_ID)) { |
| 1121 | 1121 | return true; |
| 1122 | 1122 | } else { |
@@ -1200,7 +1200,7 @@ discard block |
||
| 1200 | 1200 | 'caps' => EEM_Registration::caps_read_admin, |
| 1201 | 1201 | 'default_where_conditions' => 'this_model_only', |
| 1202 | 1202 | ); |
| 1203 | - if (! $count) { |
|
| 1203 | + if ( ! $count) { |
|
| 1204 | 1204 | $query_params = array_merge( |
| 1205 | 1205 | $query_params, |
| 1206 | 1206 | $this->_get_orderby_for_registrations_query(), |
@@ -1221,7 +1221,7 @@ discard block |
||
| 1221 | 1221 | protected function addAttendeeIdToWhereConditions(array $request) |
| 1222 | 1222 | { |
| 1223 | 1223 | $where = array(); |
| 1224 | - if (! empty($request['ATT_ID'])) { |
|
| 1224 | + if ( ! empty($request['ATT_ID'])) { |
|
| 1225 | 1225 | $where['ATT_ID'] = absint($request['ATT_ID']); |
| 1226 | 1226 | } |
| 1227 | 1227 | return $where; |
@@ -1237,7 +1237,7 @@ discard block |
||
| 1237 | 1237 | protected function _add_event_id_to_where_conditions(array $request) |
| 1238 | 1238 | { |
| 1239 | 1239 | $where = array(); |
| 1240 | - if (! empty($request['event_id'])) { |
|
| 1240 | + if ( ! empty($request['event_id'])) { |
|
| 1241 | 1241 | $where['EVT_ID'] = absint($request['event_id']); |
| 1242 | 1242 | } |
| 1243 | 1243 | return $where; |
@@ -1253,7 +1253,7 @@ discard block |
||
| 1253 | 1253 | protected function _add_category_id_to_where_conditions(array $request) |
| 1254 | 1254 | { |
| 1255 | 1255 | $where = array(); |
| 1256 | - if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) { |
|
| 1256 | + if ( ! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) { |
|
| 1257 | 1257 | $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']); |
| 1258 | 1258 | } |
| 1259 | 1259 | return $where; |
@@ -1269,10 +1269,10 @@ discard block |
||
| 1269 | 1269 | protected function _add_datetime_id_to_where_conditions(array $request) |
| 1270 | 1270 | { |
| 1271 | 1271 | $where = array(); |
| 1272 | - if (! empty($request['datetime_id'])) { |
|
| 1272 | + if ( ! empty($request['datetime_id'])) { |
|
| 1273 | 1273 | $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']); |
| 1274 | 1274 | } |
| 1275 | - if (! empty($request['DTT_ID'])) { |
|
| 1275 | + if ( ! empty($request['DTT_ID'])) { |
|
| 1276 | 1276 | $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']); |
| 1277 | 1277 | } |
| 1278 | 1278 | return $where; |
@@ -1298,7 +1298,7 @@ discard block |
||
| 1298 | 1298 | * If not filtering by specified status, then we show all registrations excluding incomplete registrations |
| 1299 | 1299 | * UNLESS viewing trashed registrations. |
| 1300 | 1300 | */ |
| 1301 | - if (! empty($registration_status)) { |
|
| 1301 | + if ( ! empty($registration_status)) { |
|
| 1302 | 1302 | $where['STS_ID'] = $registration_status; |
| 1303 | 1303 | } else { |
| 1304 | 1304 | // make sure we exclude incomplete registrations, but only if not trashed. |
@@ -1341,12 +1341,12 @@ discard block |
||
| 1341 | 1341 | array( |
| 1342 | 1342 | EEM_Registration::instance()->convert_datetime_for_query( |
| 1343 | 1343 | 'REG_date', |
| 1344 | - $now . ' 00:00:00', |
|
| 1344 | + $now.' 00:00:00', |
|
| 1345 | 1345 | 'Y-m-d H:i:s' |
| 1346 | 1346 | ), |
| 1347 | 1347 | EEM_Registration::instance()->convert_datetime_for_query( |
| 1348 | 1348 | 'REG_date', |
| 1349 | - $now . ' 23:59:59', |
|
| 1349 | + $now.' 23:59:59', |
|
| 1350 | 1350 | 'Y-m-d H:i:s' |
| 1351 | 1351 | ), |
| 1352 | 1352 | ), |
@@ -1359,12 +1359,12 @@ discard block |
||
| 1359 | 1359 | array( |
| 1360 | 1360 | EEM_Registration::instance()->convert_datetime_for_query( |
| 1361 | 1361 | 'REG_date', |
| 1362 | - $current_year_and_month . '-01 00:00:00', |
|
| 1362 | + $current_year_and_month.'-01 00:00:00', |
|
| 1363 | 1363 | 'Y-m-d H:i:s' |
| 1364 | 1364 | ), |
| 1365 | 1365 | EEM_Registration::instance()->convert_datetime_for_query( |
| 1366 | 1366 | 'REG_date', |
| 1367 | - $current_year_and_month . '-' . $days_this_month . ' 23:59:59', |
|
| 1367 | + $current_year_and_month.'-'.$days_this_month.' 23:59:59', |
|
| 1368 | 1368 | 'Y-m-d H:i:s' |
| 1369 | 1369 | ), |
| 1370 | 1370 | ), |
@@ -1379,18 +1379,18 @@ discard block |
||
| 1379 | 1379 | : ''; |
| 1380 | 1380 | // if there is not a month or year then we can't go further |
| 1381 | 1381 | if ($month_requested && $year_requested) { |
| 1382 | - $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01')); |
|
| 1382 | + $days_in_month = date('t', strtotime($year_requested.'-'.$month_requested.'-'.'01')); |
|
| 1383 | 1383 | $where['REG_date'] = array( |
| 1384 | 1384 | 'BETWEEN', |
| 1385 | 1385 | array( |
| 1386 | 1386 | EEM_Registration::instance()->convert_datetime_for_query( |
| 1387 | 1387 | 'REG_date', |
| 1388 | - $year_requested . '-' . $month_requested . '-01 00:00:00', |
|
| 1388 | + $year_requested.'-'.$month_requested.'-01 00:00:00', |
|
| 1389 | 1389 | 'Y-m-d H:i:s' |
| 1390 | 1390 | ), |
| 1391 | 1391 | EEM_Registration::instance()->convert_datetime_for_query( |
| 1392 | 1392 | 'REG_date', |
| 1393 | - $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59', |
|
| 1393 | + $year_requested.'-'.$month_requested.'-'.$days_in_month.' 23:59:59', |
|
| 1394 | 1394 | 'Y-m-d H:i:s' |
| 1395 | 1395 | ), |
| 1396 | 1396 | ), |
@@ -1410,8 +1410,8 @@ discard block |
||
| 1410 | 1410 | protected function _add_search_to_where_conditions(array $request) |
| 1411 | 1411 | { |
| 1412 | 1412 | $where = array(); |
| 1413 | - if (! empty($request['s'])) { |
|
| 1414 | - $search_string = '%' . sanitize_text_field($request['s']) . '%'; |
|
| 1413 | + if ( ! empty($request['s'])) { |
|
| 1414 | + $search_string = '%'.sanitize_text_field($request['s']).'%'; |
|
| 1415 | 1415 | $where['OR*search_conditions'] = array( |
| 1416 | 1416 | 'Event.EVT_name' => array('LIKE', $search_string), |
| 1417 | 1417 | 'Event.EVT_desc' => array('LIKE', $search_string), |
@@ -1647,7 +1647,7 @@ discard block |
||
| 1647 | 1647 | ) |
| 1648 | 1648 | : ''; |
| 1649 | 1649 | // grab header |
| 1650 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php'; |
|
| 1650 | + $template_path = REG_TEMPLATE_PATH.'reg_admin_details_header.template.php'; |
|
| 1651 | 1651 | $this->_template_args['REG_ID'] = $this->_registration->ID(); |
| 1652 | 1652 | $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
| 1653 | 1653 | $template_path, |
@@ -1784,7 +1784,7 @@ discard block |
||
| 1784 | 1784 | EEH_HTML::strong( |
| 1785 | 1785 | $this->_registration->pretty_status(), |
| 1786 | 1786 | '', |
| 1787 | - 'status-' . $this->_registration->status_ID(), |
|
| 1787 | + 'status-'.$this->_registration->status_ID(), |
|
| 1788 | 1788 | 'line-height: 1em; font-size: 1.5em; font-weight: bold;' |
| 1789 | 1789 | ) |
| 1790 | 1790 | ) |
@@ -1839,14 +1839,14 @@ discard block |
||
| 1839 | 1839 | protected function _get_reg_statuses() |
| 1840 | 1840 | { |
| 1841 | 1841 | $reg_status_array = EEM_Registration::instance()->reg_status_array(); |
| 1842 | - unset($reg_status_array[ EEM_Registration::status_id_incomplete ]); |
|
| 1842 | + unset($reg_status_array[EEM_Registration::status_id_incomplete]); |
|
| 1843 | 1843 | // get current reg status |
| 1844 | 1844 | $current_status = $this->_registration->status_ID(); |
| 1845 | 1845 | // is registration for free event? This will determine whether to display the pending payment option |
| 1846 | 1846 | if ($current_status !== EEM_Registration::status_id_pending_payment |
| 1847 | 1847 | && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00) |
| 1848 | 1848 | ) { |
| 1849 | - unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]); |
|
| 1849 | + unset($reg_status_array[EEM_Registration::status_id_pending_payment]); |
|
| 1850 | 1850 | } |
| 1851 | 1851 | return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence'); |
| 1852 | 1852 | } |
@@ -1938,7 +1938,7 @@ discard block |
||
| 1938 | 1938 | $success = false; |
| 1939 | 1939 | // typecast $REG_IDs |
| 1940 | 1940 | $REG_IDs = (array) $REG_IDs; |
| 1941 | - if (! empty($REG_IDs)) { |
|
| 1941 | + if ( ! empty($REG_IDs)) { |
|
| 1942 | 1942 | $success = true; |
| 1943 | 1943 | // set default status if none is passed |
| 1944 | 1944 | $status = $status ? $status : EEM_Registration::status_id_pending_payment; |
@@ -2086,7 +2086,7 @@ discard block |
||
| 2086 | 2086 | $action, |
| 2087 | 2087 | $notify |
| 2088 | 2088 | ); |
| 2089 | - $method = $action . '_registration'; |
|
| 2089 | + $method = $action.'_registration'; |
|
| 2090 | 2090 | if (method_exists($this, $method)) { |
| 2091 | 2091 | $this->$method($notify); |
| 2092 | 2092 | } |
@@ -2317,7 +2317,7 @@ discard block |
||
| 2317 | 2317 | $this->_template_args['REG_ID'] = $this->_registration->ID(); |
| 2318 | 2318 | $this->_template_args['event_id'] = $this->_registration->event_ID(); |
| 2319 | 2319 | $template_path = |
| 2320 | - REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
| 2320 | + REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
| 2321 | 2321 | echo EEH_Template::display_template($template_path, $this->_template_args, true); |
| 2322 | 2322 | } |
| 2323 | 2323 | |
@@ -2350,7 +2350,7 @@ discard block |
||
| 2350 | 2350 | $this->_template_args['reg_questions_form_action'] = 'edit_registration'; |
| 2351 | 2351 | $this->_template_args['REG_ID'] = $this->_registration->ID(); |
| 2352 | 2352 | $template_path = |
| 2353 | - REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 2353 | + REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 2354 | 2354 | echo EEH_Template::display_template($template_path, $this->_template_args, true); |
| 2355 | 2355 | } |
| 2356 | 2356 | } |
@@ -2367,7 +2367,7 @@ discard block |
||
| 2367 | 2367 | public function form_before_question_group($output) |
| 2368 | 2368 | { |
| 2369 | 2369 | EE_Error::doing_it_wrong( |
| 2370 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2370 | + __CLASS__.'::'.__FUNCTION__, |
|
| 2371 | 2371 | esc_html__( |
| 2372 | 2372 | 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
| 2373 | 2373 | 'event_espresso' |
@@ -2392,7 +2392,7 @@ discard block |
||
| 2392 | 2392 | public function form_after_question_group($output) |
| 2393 | 2393 | { |
| 2394 | 2394 | EE_Error::doing_it_wrong( |
| 2395 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2395 | + __CLASS__.'::'.__FUNCTION__, |
|
| 2396 | 2396 | esc_html__( |
| 2397 | 2397 | 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
| 2398 | 2398 | 'event_espresso' |
@@ -2430,7 +2430,7 @@ discard block |
||
| 2430 | 2430 | public function form_form_field_label_wrap($label) |
| 2431 | 2431 | { |
| 2432 | 2432 | EE_Error::doing_it_wrong( |
| 2433 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2433 | + __CLASS__.'::'.__FUNCTION__, |
|
| 2434 | 2434 | esc_html__( |
| 2435 | 2435 | 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
| 2436 | 2436 | 'event_espresso' |
@@ -2440,7 +2440,7 @@ discard block |
||
| 2440 | 2440 | return ' |
| 2441 | 2441 | <tr> |
| 2442 | 2442 | <th> |
| 2443 | - ' . $label . ' |
|
| 2443 | + ' . $label.' |
|
| 2444 | 2444 | </th>'; |
| 2445 | 2445 | } |
| 2446 | 2446 | |
@@ -2456,7 +2456,7 @@ discard block |
||
| 2456 | 2456 | public function form_form_field_input__wrap($input) |
| 2457 | 2457 | { |
| 2458 | 2458 | EE_Error::doing_it_wrong( |
| 2459 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 2459 | + __CLASS__.'::'.__FUNCTION__, |
|
| 2460 | 2460 | esc_html__( |
| 2461 | 2461 | 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
| 2462 | 2462 | 'event_espresso' |
@@ -2465,7 +2465,7 @@ discard block |
||
| 2465 | 2465 | ); |
| 2466 | 2466 | return ' |
| 2467 | 2467 | <td class="reg-admin-attendee-questions-input-td disabled-input"> |
| 2468 | - ' . $input . ' |
|
| 2468 | + ' . $input.' |
|
| 2469 | 2469 | </td> |
| 2470 | 2470 | </tr>'; |
| 2471 | 2471 | } |
@@ -2509,8 +2509,8 @@ discard block |
||
| 2509 | 2509 | */ |
| 2510 | 2510 | protected function _get_reg_custom_questions_form($REG_ID) |
| 2511 | 2511 | { |
| 2512 | - if (! $this->_reg_custom_questions_form) { |
|
| 2513 | - require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php'); |
|
| 2512 | + if ( ! $this->_reg_custom_questions_form) { |
|
| 2513 | + require_once(REG_ADMIN.'form_sections'.DS.'EE_Registration_Custom_Questions_Form.form.php'); |
|
| 2514 | 2514 | $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form( |
| 2515 | 2515 | EEM_Registration::instance()->get_one_by_ID($REG_ID) |
| 2516 | 2516 | ); |
@@ -2533,7 +2533,7 @@ discard block |
||
| 2533 | 2533 | */ |
| 2534 | 2534 | private function _save_reg_custom_questions_form($REG_ID = false) |
| 2535 | 2535 | { |
| 2536 | - if (! $REG_ID) { |
|
| 2536 | + if ( ! $REG_ID) { |
|
| 2537 | 2537 | EE_Error::add_error( |
| 2538 | 2538 | esc_html__( |
| 2539 | 2539 | 'An error occurred. No registration ID was received.', |
@@ -2624,30 +2624,30 @@ discard block |
||
| 2624 | 2624 | ? $registration->attendee() |
| 2625 | 2625 | : EEM_Attendee::instance() |
| 2626 | 2626 | ->create_default_object(); |
| 2627 | - $this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID(); |
|
| 2628 | - $this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname(); |
|
| 2629 | - $this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname(); |
|
| 2630 | - $this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email(); |
|
| 2631 | - $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price(); |
|
| 2632 | - $this->_template_args['attendees'][ $att_nmbr ]['address'] = implode( |
|
| 2627 | + $this->_template_args['attendees'][$att_nmbr]['STS_ID'] = $registration->status_ID(); |
|
| 2628 | + $this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname(); |
|
| 2629 | + $this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname(); |
|
| 2630 | + $this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email(); |
|
| 2631 | + $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price(); |
|
| 2632 | + $this->_template_args['attendees'][$att_nmbr]['address'] = implode( |
|
| 2633 | 2633 | ', ', |
| 2634 | 2634 | $attendee->full_address_as_array() |
| 2635 | 2635 | ); |
| 2636 | - $this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce( |
|
| 2636 | + $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce( |
|
| 2637 | 2637 | array( |
| 2638 | 2638 | 'action' => 'edit_attendee', |
| 2639 | 2639 | 'post' => $attendee->ID(), |
| 2640 | 2640 | ), |
| 2641 | 2641 | REG_ADMIN_URL |
| 2642 | 2642 | ); |
| 2643 | - $this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event |
|
| 2643 | + $this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj() instanceof EE_Event |
|
| 2644 | 2644 | ? $registration->event_obj()->name() |
| 2645 | 2645 | : ''; |
| 2646 | 2646 | $att_nmbr++; |
| 2647 | 2647 | } |
| 2648 | 2648 | $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
| 2649 | 2649 | } |
| 2650 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php'; |
|
| 2650 | + $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_attendees.template.php'; |
|
| 2651 | 2651 | echo EEH_Template::display_template($template_path, $this->_template_args, true); |
| 2652 | 2652 | } |
| 2653 | 2653 | |
@@ -2671,11 +2671,11 @@ discard block |
||
| 2671 | 2671 | // now let's determine if this is not the primary registration. If it isn't then we set the |
| 2672 | 2672 | // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the |
| 2673 | 2673 | // primary registration object (that way we know if we need to show create button or not) |
| 2674 | - if (! $this->_registration->is_primary_registrant()) { |
|
| 2674 | + if ( ! $this->_registration->is_primary_registrant()) { |
|
| 2675 | 2675 | $primary_registration = $this->_registration->get_primary_registration(); |
| 2676 | 2676 | $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() |
| 2677 | 2677 | : null; |
| 2678 | - if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
| 2678 | + if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
| 2679 | 2679 | // in here? This means the displayed registration is not the primary registrant but ALREADY HAS its own |
| 2680 | 2680 | // custom attendee object so let's not worry about the primary reg. |
| 2681 | 2681 | $primary_registration = null; |
@@ -2709,7 +2709,7 @@ discard block |
||
| 2709 | 2709 | ) : ''; |
| 2710 | 2710 | $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso'); |
| 2711 | 2711 | $this->_template_args['att_check'] = $att_check; |
| 2712 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php'; |
|
| 2712 | + $template_path = REG_TEMPLATE_PATH.'reg_admin_details_side_meta_box_registrant.template.php'; |
|
| 2713 | 2713 | echo EEH_Template::display_template($template_path, $this->_template_args, true); |
| 2714 | 2714 | } |
| 2715 | 2715 | |
@@ -2747,7 +2747,7 @@ discard block |
||
| 2747 | 2747 | $success = 0; |
| 2748 | 2748 | $overwrite_msgs = false; |
| 2749 | 2749 | // Checkboxes |
| 2750 | - if (! is_array($this->_req_data['_REG_ID'])) { |
|
| 2750 | + if ( ! is_array($this->_req_data['_REG_ID'])) { |
|
| 2751 | 2751 | $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']); |
| 2752 | 2752 | } |
| 2753 | 2753 | $reg_count = count($this->_req_data['_REG_ID']); |
@@ -2756,7 +2756,7 @@ discard block |
||
| 2756 | 2756 | /** @var EE_Registration $REG */ |
| 2757 | 2757 | $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
| 2758 | 2758 | $payments = $REG->registration_payments(); |
| 2759 | - if (! empty($payments)) { |
|
| 2759 | + if ( ! empty($payments)) { |
|
| 2760 | 2760 | $name = $REG->attendee() instanceof EE_Attendee |
| 2761 | 2761 | ? $REG->attendee()->full_name() |
| 2762 | 2762 | : esc_html__('Unknown Attendee', 'event_espresso'); |
@@ -2817,17 +2817,17 @@ discard block |
||
| 2817 | 2817 | $REG_MDL = EEM_Registration::instance(); |
| 2818 | 2818 | $success = 1; |
| 2819 | 2819 | // Checkboxes |
| 2820 | - if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
| 2820 | + if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
| 2821 | 2821 | // if array has more than one element than success message should be plural |
| 2822 | 2822 | $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1; |
| 2823 | 2823 | // cycle thru checkboxes |
| 2824 | 2824 | while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) { |
| 2825 | 2825 | $REG = $REG_MDL->get_one_by_ID($REG_ID); |
| 2826 | - if (! $REG instanceof EE_Registration) { |
|
| 2826 | + if ( ! $REG instanceof EE_Registration) { |
|
| 2827 | 2827 | continue; |
| 2828 | 2828 | } |
| 2829 | 2829 | $deleted = $this->_delete_registration($REG); |
| 2830 | - if (! $deleted) { |
|
| 2830 | + if ( ! $deleted) { |
|
| 2831 | 2831 | $success = 0; |
| 2832 | 2832 | } |
| 2833 | 2833 | } |
@@ -2836,7 +2836,7 @@ discard block |
||
| 2836 | 2836 | $REG_ID = $this->_req_data['_REG_ID']; |
| 2837 | 2837 | $REG = $REG_MDL->get_one_by_ID($REG_ID); |
| 2838 | 2838 | $deleted = $this->_delete_registration($REG); |
| 2839 | - if (! $deleted) { |
|
| 2839 | + if ( ! $deleted) { |
|
| 2840 | 2840 | $success = 0; |
| 2841 | 2841 | } |
| 2842 | 2842 | } |
@@ -2870,11 +2870,11 @@ discard block |
||
| 2870 | 2870 | $REGS = $TXN->get_many_related('Registration'); |
| 2871 | 2871 | $all_trashed = true; |
| 2872 | 2872 | foreach ($REGS as $registration) { |
| 2873 | - if (! $registration->get('REG_deleted')) { |
|
| 2873 | + if ( ! $registration->get('REG_deleted')) { |
|
| 2874 | 2874 | $all_trashed = false; |
| 2875 | 2875 | } |
| 2876 | 2876 | } |
| 2877 | - if (! $all_trashed) { |
|
| 2877 | + if ( ! $all_trashed) { |
|
| 2878 | 2878 | EE_Error::add_error( |
| 2879 | 2879 | esc_html__( |
| 2880 | 2880 | 'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well. These registrations will be permanently deleted in the same action.', |
@@ -2933,7 +2933,7 @@ discard block |
||
| 2933 | 2933 | */ |
| 2934 | 2934 | public function new_registration() |
| 2935 | 2935 | { |
| 2936 | - if (! $this->_set_reg_event()) { |
|
| 2936 | + if ( ! $this->_set_reg_event()) { |
|
| 2937 | 2937 | throw new EE_Error( |
| 2938 | 2938 | esc_html__( |
| 2939 | 2939 | 'Unable to continue with registering because there is no Event ID in the request', |
@@ -2943,8 +2943,8 @@ discard block |
||
| 2943 | 2943 | } |
| 2944 | 2944 | EE_Registry::instance()->REQ->set_espresso_page(true); |
| 2945 | 2945 | // gotta start with a clean slate if we're not coming here via ajax |
| 2946 | - if (! defined('DOING_AJAX') |
|
| 2947 | - && (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
| 2946 | + if ( ! defined('DOING_AJAX') |
|
| 2947 | + && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
| 2948 | 2948 | ) { |
| 2949 | 2949 | EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
| 2950 | 2950 | } |
@@ -2977,7 +2977,7 @@ discard block |
||
| 2977 | 2977 | } |
| 2978 | 2978 | // grab header |
| 2979 | 2979 | $template_path = |
| 2980 | - REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php'; |
|
| 2980 | + REG_TEMPLATE_PATH.'reg_admin_register_new_attendee.template.php'; |
|
| 2981 | 2981 | $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
| 2982 | 2982 | $template_path, |
| 2983 | 2983 | $this->_template_args, |
@@ -3018,7 +3018,7 @@ discard block |
||
| 3018 | 3018 | '</b>' |
| 3019 | 3019 | ); |
| 3020 | 3020 | return ' |
| 3021 | - <div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div> |
|
| 3021 | + <div id="ee-add-reg-back-button-dv"><p>' . $warning_msg.'</p></div> |
|
| 3022 | 3022 | <script > |
| 3023 | 3023 | // WHOAH !!! it appears that someone is using the back button from the Transaction admin page |
| 3024 | 3024 | // after just adding a new registration... we gotta try to put a stop to that !!! |
@@ -3086,7 +3086,7 @@ discard block |
||
| 3086 | 3086 | // we come back to the process_registration_step route. |
| 3087 | 3087 | $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields); |
| 3088 | 3088 | return EEH_Template::display_template( |
| 3089 | - REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php', |
|
| 3089 | + REG_TEMPLATE_PATH.'reg_admin_register_new_attendee_step_content.template.php', |
|
| 3090 | 3090 | $template_args, |
| 3091 | 3091 | true |
| 3092 | 3092 | ); |
@@ -3108,8 +3108,8 @@ discard block |
||
| 3108 | 3108 | if (is_object($this->_reg_event)) { |
| 3109 | 3109 | return true; |
| 3110 | 3110 | } |
| 3111 | - $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
| 3112 | - if (! $EVT_ID) { |
|
| 3111 | + $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
| 3112 | + if ( ! $EVT_ID) { |
|
| 3113 | 3113 | return false; |
| 3114 | 3114 | } |
| 3115 | 3115 | $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
@@ -3141,8 +3141,8 @@ discard block |
||
| 3141 | 3141 | $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
| 3142 | 3142 | // if doing ajax then we need to verify the nonce |
| 3143 | 3143 | if (defined('DOING_AJAX')) { |
| 3144 | - $nonce = isset($this->_req_data[ $this->_req_nonce ]) |
|
| 3145 | - ? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : ''; |
|
| 3144 | + $nonce = isset($this->_req_data[$this->_req_nonce]) |
|
| 3145 | + ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : ''; |
|
| 3146 | 3146 | $this->_verify_nonce($nonce, $this->_req_nonce); |
| 3147 | 3147 | } |
| 3148 | 3148 | switch ($step) { |
@@ -3178,7 +3178,7 @@ discard block |
||
| 3178 | 3178 | } |
| 3179 | 3179 | break; |
| 3180 | 3180 | case 'questions': |
| 3181 | - if (! isset( |
|
| 3181 | + if ( ! isset( |
|
| 3182 | 3182 | $this->_req_data['txn_reg_status_change'], |
| 3183 | 3183 | $this->_req_data['txn_reg_status_change']['send_notifications'] |
| 3184 | 3184 | ) |
@@ -3193,7 +3193,7 @@ discard block |
||
| 3193 | 3193 | $grand_total->save_this_and_descendants_to_txn(); |
| 3194 | 3194 | } |
| 3195 | 3195 | } |
| 3196 | - if (! $transaction instanceof EE_Transaction) { |
|
| 3196 | + if ( ! $transaction instanceof EE_Transaction) { |
|
| 3197 | 3197 | $query_args = array( |
| 3198 | 3198 | 'action' => 'new_registration', |
| 3199 | 3199 | 'processing_registration' => 2, |
@@ -3216,7 +3216,7 @@ discard block |
||
| 3216 | 3216 | } |
| 3217 | 3217 | } |
| 3218 | 3218 | // maybe update status, and make sure to save transaction if not done already |
| 3219 | - if (! $transaction->update_status_based_on_total_paid()) { |
|
| 3219 | + if ( ! $transaction->update_status_based_on_total_paid()) { |
|
| 3220 | 3220 | $transaction->save(); |
| 3221 | 3221 | } |
| 3222 | 3222 | EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
@@ -3299,7 +3299,7 @@ discard block |
||
| 3299 | 3299 | public function get_attendees($per_page, $count = false, $trash = false) |
| 3300 | 3300 | { |
| 3301 | 3301 | do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
| 3302 | - require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php'); |
|
| 3302 | + require_once(REG_ADMIN.'EE_Attendee_Contact_List_Table.class.php'); |
|
| 3303 | 3303 | $ATT_MDL = EEM_Attendee::instance(); |
| 3304 | 3304 | $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
| 3305 | 3305 | switch ($this->_req_data['orderby']) { |
@@ -3338,8 +3338,8 @@ discard block |
||
| 3338 | 3338 | ? $this->_req_data['perpage'] |
| 3339 | 3339 | : $per_page; |
| 3340 | 3340 | $_where = array(); |
| 3341 | - if (! empty($this->_req_data['s'])) { |
|
| 3342 | - $sstr = '%' . $this->_req_data['s'] . '%'; |
|
| 3341 | + if ( ! empty($this->_req_data['s'])) { |
|
| 3342 | + $sstr = '%'.$this->_req_data['s'].'%'; |
|
| 3343 | 3343 | $_where['OR'] = array( |
| 3344 | 3344 | 'Registration.Event.EVT_name' => array('LIKE', $sstr), |
| 3345 | 3345 | 'Registration.Event.EVT_desc' => array('LIKE', $sstr), |
@@ -3366,7 +3366,7 @@ discard block |
||
| 3366 | 3366 | 'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')), |
| 3367 | 3367 | 'limit' => $limit, |
| 3368 | 3368 | ); |
| 3369 | - if (! $count) { |
|
| 3369 | + if ( ! $count) { |
|
| 3370 | 3370 | $query_args['order_by'] = array($orderby => $sort); |
| 3371 | 3371 | } |
| 3372 | 3372 | if ($trash) { |
@@ -3409,7 +3409,7 @@ discard block |
||
| 3409 | 3409 | */ |
| 3410 | 3410 | public function _registrations_report_base($method_name_for_getting_query_params) |
| 3411 | 3411 | { |
| 3412 | - if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3412 | + if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3413 | 3413 | wp_redirect( |
| 3414 | 3414 | EE_Admin_Page::add_query_args_and_nonce( |
| 3415 | 3415 | array( |
@@ -3441,8 +3441,8 @@ discard block |
||
| 3441 | 3441 | 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
| 3442 | 3442 | ); |
| 3443 | 3443 | $this->_req_data = array_merge($this->_req_data, $new_request_args); |
| 3444 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3445 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3444 | + if (is_readable(EE_CLASSES.'EE_Export.class.php')) { |
|
| 3445 | + require_once(EE_CLASSES.'EE_Export.class.php'); |
|
| 3446 | 3446 | $EE_Export = EE_Export::instance($this->_req_data); |
| 3447 | 3447 | $EE_Export->export(); |
| 3448 | 3448 | } |
@@ -3463,8 +3463,8 @@ discard block |
||
| 3463 | 3463 | |
| 3464 | 3464 | public function _contact_list_export() |
| 3465 | 3465 | { |
| 3466 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3467 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3466 | + if (is_readable(EE_CLASSES.'EE_Export.class.php')) { |
|
| 3467 | + require_once(EE_CLASSES.'EE_Export.class.php'); |
|
| 3468 | 3468 | $EE_Export = EE_Export::instance($this->_req_data); |
| 3469 | 3469 | $EE_Export->export_attendees(); |
| 3470 | 3470 | } |
@@ -3473,7 +3473,7 @@ discard block |
||
| 3473 | 3473 | |
| 3474 | 3474 | public function _contact_list_report() |
| 3475 | 3475 | { |
| 3476 | - if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3476 | + if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 3477 | 3477 | wp_redirect( |
| 3478 | 3478 | EE_Admin_Page::add_query_args_and_nonce( |
| 3479 | 3479 | array( |
@@ -3485,8 +3485,8 @@ discard block |
||
| 3485 | 3485 | ) |
| 3486 | 3486 | ); |
| 3487 | 3487 | } else { |
| 3488 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 3489 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 3488 | + if (is_readable(EE_CLASSES.'EE_Export.class.php')) { |
|
| 3489 | + require_once(EE_CLASSES.'EE_Export.class.php'); |
|
| 3490 | 3490 | $EE_Export = EE_Export::instance($this->_req_data); |
| 3491 | 3491 | $EE_Export->report_attendees(); |
| 3492 | 3492 | } |
@@ -3572,7 +3572,7 @@ discard block |
||
| 3572 | 3572 | $updated_fields = array( |
| 3573 | 3573 | 'ATT_fname' => $this->_req_data['ATT_fname'], |
| 3574 | 3574 | 'ATT_lname' => $this->_req_data['ATT_lname'], |
| 3575 | - 'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'], |
|
| 3575 | + 'ATT_full_name' => $this->_req_data['ATT_fname'].' '.$this->_req_data['ATT_lname'], |
|
| 3576 | 3576 | 'ATT_address' => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '', |
| 3577 | 3577 | 'ATT_address2' => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '', |
| 3578 | 3578 | 'ATT_city' => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '', |
@@ -3648,17 +3648,17 @@ discard block |
||
| 3648 | 3648 | 'postexcerpt', |
| 3649 | 3649 | esc_html__('Excerpt', 'event_espresso'), |
| 3650 | 3650 | 'post_excerpt_meta_box', |
| 3651 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3651 | + $this->_cpt_routes[$this->_req_action], |
|
| 3652 | 3652 | 'normal', |
| 3653 | 3653 | 'core' |
| 3654 | 3654 | ); |
| 3655 | - remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core'); |
|
| 3655 | + remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core'); |
|
| 3656 | 3656 | if (post_type_supports('espresso_attendees', 'excerpt')) { |
| 3657 | 3657 | add_meta_box( |
| 3658 | 3658 | 'postexcerpt', |
| 3659 | 3659 | esc_html__('Short Biography', 'event_espresso'), |
| 3660 | 3660 | 'post_excerpt_meta_box', |
| 3661 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3661 | + $this->_cpt_routes[$this->_req_action], |
|
| 3662 | 3662 | 'normal' |
| 3663 | 3663 | ); |
| 3664 | 3664 | } |
@@ -3667,7 +3667,7 @@ discard block |
||
| 3667 | 3667 | 'commentsdiv', |
| 3668 | 3668 | esc_html__('Notes on the Contact', 'event_espresso'), |
| 3669 | 3669 | 'post_comment_meta_box', |
| 3670 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3670 | + $this->_cpt_routes[$this->_req_action], |
|
| 3671 | 3671 | 'normal', |
| 3672 | 3672 | 'core' |
| 3673 | 3673 | ); |
@@ -3676,7 +3676,7 @@ discard block |
||
| 3676 | 3676 | 'attendee_contact_info', |
| 3677 | 3677 | esc_html__('Contact Info', 'event_espresso'), |
| 3678 | 3678 | array($this, 'attendee_contact_info'), |
| 3679 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3679 | + $this->_cpt_routes[$this->_req_action], |
|
| 3680 | 3680 | 'side', |
| 3681 | 3681 | 'core' |
| 3682 | 3682 | ); |
@@ -3684,7 +3684,7 @@ discard block |
||
| 3684 | 3684 | 'attendee_details_address', |
| 3685 | 3685 | esc_html__('Address Details', 'event_espresso'), |
| 3686 | 3686 | array($this, 'attendee_address_details'), |
| 3687 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3687 | + $this->_cpt_routes[$this->_req_action], |
|
| 3688 | 3688 | 'normal', |
| 3689 | 3689 | 'core' |
| 3690 | 3690 | ); |
@@ -3692,7 +3692,7 @@ discard block |
||
| 3692 | 3692 | 'attendee_registrations', |
| 3693 | 3693 | esc_html__('Registrations for this Contact', 'event_espresso'), |
| 3694 | 3694 | array($this, 'attendee_registrations_meta_box'), |
| 3695 | - $this->_cpt_routes[ $this->_req_action ], |
|
| 3695 | + $this->_cpt_routes[$this->_req_action], |
|
| 3696 | 3696 | 'normal', |
| 3697 | 3697 | 'high' |
| 3698 | 3698 | ); |
@@ -3793,7 +3793,7 @@ discard block |
||
| 3793 | 3793 | ) |
| 3794 | 3794 | ); |
| 3795 | 3795 | $template = |
| 3796 | - REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php'; |
|
| 3796 | + REG_TEMPLATE_PATH.'attendee_address_details_metabox_content.template.php'; |
|
| 3797 | 3797 | EEH_Template::display_template($template, $this->_template_args); |
| 3798 | 3798 | } |
| 3799 | 3799 | |
@@ -3812,7 +3812,7 @@ discard block |
||
| 3812 | 3812 | $this->_template_args['attendee'] = $this->_cpt_model_obj; |
| 3813 | 3813 | $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration'); |
| 3814 | 3814 | $template = |
| 3815 | - REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php'; |
|
| 3815 | + REG_TEMPLATE_PATH.'attendee_registrations_main_meta_box.template.php'; |
|
| 3816 | 3816 | EEH_Template::display_template($template, $this->_template_args); |
| 3817 | 3817 | } |
| 3818 | 3818 | |
@@ -3827,7 +3827,7 @@ discard block |
||
| 3827 | 3827 | public function after_title_form_fields($post) |
| 3828 | 3828 | { |
| 3829 | 3829 | if ($post->post_type == 'espresso_attendees') { |
| 3830 | - $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php'; |
|
| 3830 | + $template = REG_TEMPLATE_PATH.'attendee_details_after_title_form_fields.template.php'; |
|
| 3831 | 3831 | $template_args['attendee'] = $this->_cpt_model_obj; |
| 3832 | 3832 | EEH_Template::display_template($template, $template_args); |
| 3833 | 3833 | } |
@@ -3851,14 +3851,14 @@ discard block |
||
| 3851 | 3851 | $ATT_MDL = EEM_Attendee::instance(); |
| 3852 | 3852 | $success = 1; |
| 3853 | 3853 | // Checkboxes |
| 3854 | - if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 3854 | + if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 3855 | 3855 | // if array has more than one element than success message should be plural |
| 3856 | 3856 | $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
| 3857 | 3857 | // cycle thru checkboxes |
| 3858 | 3858 | while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) { |
| 3859 | 3859 | $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID) |
| 3860 | 3860 | : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID); |
| 3861 | - if (! $updated) { |
|
| 3861 | + if ( ! $updated) { |
|
| 3862 | 3862 | $success = 0; |
| 3863 | 3863 | } |
| 3864 | 3864 | } |
@@ -3869,7 +3869,7 @@ discard block |
||
| 3869 | 3869 | $att = $ATT_MDL->get_one_by_ID($ATT_ID); |
| 3870 | 3870 | $updated = $trash ? $att->set_status('trash') : $att->set_status('publish'); |
| 3871 | 3871 | $updated = $att->save(); |
| 3872 | - if (! $updated) { |
|
| 3872 | + if ( ! $updated) { |
|
| 3873 | 3873 | $success = 0; |
| 3874 | 3874 | } |
| 3875 | 3875 | } |