blocked_period.php
3 months ago
booked_period.php
3 months ago
booking_request.php
3 months ago
booking_resource.php
3 months ago
booking_slot.php
3 months ago
filter.php
3 months ago
process_action.php
1 month ago
process_event.php
1 month ago
role.php
2 weeks ago
router.php
3 months ago
step.php
3 months ago
stripe_connect_customer.php
3 months ago
time_period.php
3 months ago
user.php
3 months ago
work_period.php
3 months ago
process_event.php
647 lines
| 1 | <?php |
| 2 | /* |
| 3 | * Copyright (c) 2022 LatePoint LLC. All rights reserved. |
| 4 | */ |
| 5 | |
| 6 | namespace LatePoint\Misc; |
| 7 | |
| 8 | class ProcessEvent { |
| 9 | public string $type = 'booking_created'; // booking_created, booking_updated, booking_start, booking_end, transaction_created, customer_created |
| 10 | public array $trigger_conditions = []; |
| 11 | public array $time_offset = []; |
| 12 | |
| 13 | function __construct( $args = [] ) { |
| 14 | $allowed_props = self::allowed_props(); |
| 15 | foreach ( $args as $key => $arg ) { |
| 16 | if ( in_array( $key, $allowed_props ) ) { |
| 17 | $this->$key = $arg; |
| 18 | } |
| 19 | } |
| 20 | } |
| 21 | |
| 22 | |
| 23 | public function set_from_params( $event_params ) { |
| 24 | $this->type = $event_params['type']; |
| 25 | $this->trigger_conditions = ( $event_params['conditional'] == LATEPOINT_VALUE_ON ) ? $event_params['trigger_conditions'] : []; |
| 26 | $this->time_offset = ( $event_params['has_time_offset'] == LATEPOINT_VALUE_ON ) ? $event_params['time_offset'] : []; |
| 27 | } |
| 28 | |
| 29 | public function get_available_data_sources( array $trigger_conditions = [] ): array { |
| 30 | $data_sources = []; |
| 31 | switch ( $this->type ) { |
| 32 | case 'payment_request_created': |
| 33 | $payment_requests = new \OsPaymentRequestModel(); |
| 34 | $payment_requests = $payment_requests->order_by( 'id desc' )->set_limit( 100 )->get_results_as_models(); |
| 35 | $payment_requests_for_select = []; |
| 36 | foreach ( $payment_requests as $payment_request ) { |
| 37 | $name = 'Order ID:' . $payment_request->order_id . ', Invoice ID: ' . $payment_request->invoice_id . ' [' . \OsMoneyHelper::format_price( $payment_request->charge_amount, true, false ) . ' : ' . $payment_request->id . ']'; |
| 38 | $payment_requests_for_select[] = [ |
| 39 | 'value' => $payment_request->id, |
| 40 | 'label' => esc_html( $name ), |
| 41 | ]; |
| 42 | } |
| 43 | |
| 44 | $data_sources[] = [ |
| 45 | 'name' => 'payment_request_id', |
| 46 | 'values' => $payment_requests_for_select, |
| 47 | 'label' => __( 'Choose a payment request for this test run:', 'latepoint' ), |
| 48 | 'model' => 'payment_request', |
| 49 | ]; |
| 50 | break; |
| 51 | case 'order_created': |
| 52 | $orders_for_select = \OsOrdersHelper::get_orders_for_select(); |
| 53 | $data_sources[] = [ |
| 54 | 'name' => 'order_id', |
| 55 | 'values' => $orders_for_select, |
| 56 | 'label' => __( 'Choose an order for this test run:', 'latepoint' ), |
| 57 | 'model' => 'order', |
| 58 | ]; |
| 59 | break; |
| 60 | case 'order_updated': |
| 61 | $orders_for_select = \OsOrdersHelper::get_orders_for_select(); |
| 62 | $data_sources[] = [ |
| 63 | 'name' => 'new_order_id', |
| 64 | 'values' => $orders_for_select, |
| 65 | 'label' => __( 'Choose old order to be used for this test run:', 'latepoint' ), |
| 66 | 'model' => 'order', |
| 67 | ]; |
| 68 | $data_sources[] = [ |
| 69 | 'name' => 'old_order_id', |
| 70 | 'values' => $orders_for_select, |
| 71 | 'label' => __( 'Choose new order to be used for this test run:', 'latepoint' ), |
| 72 | 'model' => 'order', |
| 73 | ]; |
| 74 | break; |
| 75 | case 'booking_created': |
| 76 | case 'booking_start': |
| 77 | case 'booking_end': |
| 78 | $bookings_for_select = \OsBookingHelper::get_bookings_for_select(); |
| 79 | $data_sources[] = [ |
| 80 | 'name' => 'booking_id', |
| 81 | 'values' => $bookings_for_select, |
| 82 | 'label' => __( 'Choose a booking for this test run:', 'latepoint' ), |
| 83 | 'model' => 'booking', |
| 84 | ]; |
| 85 | break; |
| 86 | case 'booking_updated': |
| 87 | $bookings_for_select = \OsBookingHelper::get_bookings_for_select(); |
| 88 | $data_sources[] = [ |
| 89 | 'name' => 'new_booking_id', |
| 90 | 'values' => $bookings_for_select, |
| 91 | 'label' => __( 'Choose old booking to be used for this test run:', 'latepoint' ), |
| 92 | 'model' => 'booking', |
| 93 | ]; |
| 94 | $data_sources[] = [ |
| 95 | 'name' => 'old_booking_id', |
| 96 | 'values' => $bookings_for_select, |
| 97 | 'label' => __( 'Choose new booking to be used for this test run:', 'latepoint' ), |
| 98 | 'model' => 'booking', |
| 99 | ]; |
| 100 | break; |
| 101 | case 'transaction_created': |
| 102 | $transactions = \OsPaymentsHelper::get_transactions_for_select(); |
| 103 | $data_sources[] = [ |
| 104 | 'name' => 'transaction_id', |
| 105 | 'values' => $transactions, |
| 106 | 'label' => __( 'Choose a transaction for this test run:', 'latepoint' ), |
| 107 | 'model' => 'transaction', |
| 108 | ]; |
| 109 | break; |
| 110 | case 'customer_created': |
| 111 | $customers = \OsCustomerHelper::get_customers_for_select(); |
| 112 | $data_sources[] = [ |
| 113 | 'name' => 'customer_id', |
| 114 | 'values' => $customers, |
| 115 | 'label' => __( 'Choose a customer for this test run:', 'latepoint' ), |
| 116 | 'model' => 'customer', |
| 117 | ]; |
| 118 | break; |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * Returns an array of process event data sources |
| 123 | * |
| 124 | * @since 4.7.0 |
| 125 | * @hook latepoint_process_event_data_sources |
| 126 | * |
| 127 | * @param {array} $data_sources Current array of process event data sources |
| 128 | * @param {ProcessEvent} $event The ProcessEvent object for which to generate data sources |
| 129 | * |
| 130 | * @returns {array} Filtered array of process event data sources |
| 131 | */ |
| 132 | return apply_filters( 'latepoint_process_event_data_sources', $data_sources, $this ); |
| 133 | } |
| 134 | |
| 135 | public function trigger_conditions_form_html() { |
| 136 | $html = ''; |
| 137 | if ( $this->trigger_conditions ) { |
| 138 | foreach ( $this->trigger_conditions as $trigger_condition ) { |
| 139 | $html .= $this->generate_trigger_condition_form_html( $trigger_condition ); |
| 140 | } |
| 141 | } else { |
| 142 | $html .= $this->generate_trigger_condition_form_html(); |
| 143 | } |
| 144 | return $html; |
| 145 | } |
| 146 | |
| 147 | public static function get_object_from_property( string $property ): string { |
| 148 | return explode( '__', $property )[0] ?? ''; |
| 149 | } |
| 150 | |
| 151 | public static function get_object_attribute_from_property( string $property ): string { |
| 152 | return explode( '__', $property )[1] ?? ''; |
| 153 | } |
| 154 | |
| 155 | public static function get_model_by_code( string $property_object_name ): \OsModel { |
| 156 | $model = new \OsBookingModel(); |
| 157 | switch ( $property_object_name ) { |
| 158 | case 'order': |
| 159 | case 'old_order': |
| 160 | $model = new \OsOrderModel(); |
| 161 | break; |
| 162 | case 'booking': |
| 163 | case 'old_booking': |
| 164 | $model = new \OsBookingModel(); |
| 165 | break; |
| 166 | case 'transaction': |
| 167 | $model = new \OsTransactionModel(); |
| 168 | break; |
| 169 | case 'customer': |
| 170 | $model = new \OsCustomerModel(); |
| 171 | break; |
| 172 | case 'agent': |
| 173 | $model = new \OsAgentModel(); |
| 174 | break; |
| 175 | case 'service': |
| 176 | $model = new \OsServiceModel(); |
| 177 | break; |
| 178 | case 'payment_request': |
| 179 | $model = new \OsPaymentRequestModel(); |
| 180 | break; |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * Returns an instance of <code>OsModel</code>, based on the supplied object code |
| 185 | * |
| 186 | * @since 4.7.0 |
| 187 | * @hook latepoint_process_event_model |
| 188 | * |
| 189 | * @param {OsModel} $model Current model |
| 190 | * @param {string} $property_object_name The object code used to determine the resultant model |
| 191 | * |
| 192 | * @returns {OsModel} Instance of <code>OsModel</code> based on the supplied object code |
| 193 | */ |
| 194 | return apply_filters( 'latepoint_process_event_model', $model, $property_object_name ); |
| 195 | } |
| 196 | |
| 197 | public static function get_properties_for_object_code( string $property_object, bool $prepare_for_select = false ): array { |
| 198 | $model = self::get_model_by_code( $property_object ); |
| 199 | $properties = $model->get_properties_to_query(); |
| 200 | if ( $prepare_for_select ) { |
| 201 | $properties_for_select = []; |
| 202 | // glue property name and object code together so they are identifiable in a select box |
| 203 | foreach ( $properties as $property_code => $property_label ) { |
| 204 | $property_full_code = $property_object . '__' . $property_code; |
| 205 | $operators = self::trigger_condition_operators_for_property( $property_full_code ); |
| 206 | if ( ! empty( $operators ) ) { |
| 207 | $properties_for_select[] = [ |
| 208 | 'value' => $property_full_code, |
| 209 | 'label' => $property_label, |
| 210 | ]; |
| 211 | } |
| 212 | } |
| 213 | return $properties_for_select; |
| 214 | } else { |
| 215 | return $properties; |
| 216 | } |
| 217 | } |
| 218 | |
| 219 | public static function get_available_trigger_condition_objects_for_event_type( string $event_type ): array { |
| 220 | $objects = []; |
| 221 | switch ( $event_type ) { |
| 222 | case 'booking_created': |
| 223 | case 'booking_start': |
| 224 | case 'booking_end': |
| 225 | $objects[] = [ |
| 226 | 'code' => 'booking', |
| 227 | 'model' => 'OsBookingModel', |
| 228 | 'label' => __( 'Booking', 'latepoint' ), |
| 229 | 'properties' => [], |
| 230 | ]; |
| 231 | break; |
| 232 | case 'booking_updated': |
| 233 | $objects[] = [ |
| 234 | 'code' => 'old_booking', |
| 235 | 'model' => 'OsBookingModel', |
| 236 | 'label' => __( 'Old Booking', 'latepoint' ), |
| 237 | 'properties' => [], |
| 238 | ]; |
| 239 | $objects[] = [ |
| 240 | 'code' => 'booking', |
| 241 | 'model' => 'OsBookingModel', |
| 242 | 'label' => __( 'New Booking', 'latepoint' ), |
| 243 | 'properties' => [], |
| 244 | ]; |
| 245 | break; |
| 246 | case 'order_updated': |
| 247 | $objects[] = [ |
| 248 | 'code' => 'old_order', |
| 249 | 'model' => 'OsOrderModel', |
| 250 | 'label' => __( 'Old Order', 'latepoint' ), |
| 251 | 'properties' => [], |
| 252 | ]; |
| 253 | $objects[] = [ |
| 254 | 'code' => 'order', |
| 255 | 'model' => 'OsOrderModel', |
| 256 | 'label' => __( 'New Order', 'latepoint' ), |
| 257 | 'properties' => [], |
| 258 | ]; |
| 259 | break; |
| 260 | case 'order_created': |
| 261 | $objects[] = [ |
| 262 | 'code' => 'order', |
| 263 | 'model' => 'OsOrderModel', |
| 264 | 'label' => __( 'Order', 'latepoint' ), |
| 265 | 'properties' => [], |
| 266 | ]; |
| 267 | break; |
| 268 | case 'transaction_created': |
| 269 | $objects[] = [ |
| 270 | 'code' => 'transaction', |
| 271 | 'model' => 'OsTransactionModel', |
| 272 | 'label' => __( 'Transaction', 'latepoint' ), |
| 273 | 'properties' => [], |
| 274 | ]; |
| 275 | break; |
| 276 | case 'customer_created': |
| 277 | // $objects[] = ['code' => 'customer', 'model' => 'OsCustomerModel', 'label' => __('Customer', 'latepoint'), 'properties' => []]; |
| 278 | break; |
| 279 | case 'agent_created': |
| 280 | $objects[] = [ |
| 281 | 'code' => 'agent', |
| 282 | 'model' => 'OsAgentModel', |
| 283 | 'label' => __( 'Agent', 'latepoint' ), |
| 284 | 'properties' => [], |
| 285 | ]; |
| 286 | break; |
| 287 | case 'service_created': |
| 288 | $objects[] = [ |
| 289 | 'code' => 'service', |
| 290 | 'model' => 'OsServiceModel', |
| 291 | 'label' => __( 'Service', 'latepoint' ), |
| 292 | 'properties' => [], |
| 293 | ]; |
| 294 | break; |
| 295 | } |
| 296 | |
| 297 | /** |
| 298 | * Returns an array of condition objects, based on the supplied event type |
| 299 | * |
| 300 | * @since 4.7.0 |
| 301 | * @hook latepoint_process_event_condition_objects |
| 302 | * |
| 303 | * @param {array} $objects Current array of condition objects |
| 304 | * @param {string} $event_type The event type for which to generate condition objects |
| 305 | * |
| 306 | * @returns {array} Filtered array of available condition objects |
| 307 | */ |
| 308 | return apply_filters( 'latepoint_process_event_condition_objects', $objects, $event_type ); |
| 309 | } |
| 310 | |
| 311 | public function generate_trigger_condition_form_html( $trigger_condition = false ) { |
| 312 | $objects = self::get_available_trigger_condition_objects_for_event_type( $this->type ); |
| 313 | $objects_for_select = []; |
| 314 | foreach ( $objects as $object ) { |
| 315 | $objects_for_select[] = [ |
| 316 | 'value' => $object['code'], |
| 317 | 'label' => $object['label'], |
| 318 | ]; |
| 319 | } |
| 320 | |
| 321 | // new condition |
| 322 | if ( ! $trigger_condition ) { |
| 323 | $selected_object_code = $objects_for_select[0]['value']; |
| 324 | $properties_for_select = self::get_properties_for_object_code( $selected_object_code, true ); |
| 325 | $operators_for_select = self::trigger_condition_operators_for_property( $properties_for_select[0]['value'] ); |
| 326 | $trigger_condition = [ |
| 327 | 'id' => self::generate_trigger_condition_id(), |
| 328 | 'property' => $properties_for_select[0]['value'] ?? '', |
| 329 | 'operator' => $operators_for_select[0]['value'] ?? 'equal', |
| 330 | 'value' => false, |
| 331 | ]; |
| 332 | } else { |
| 333 | $operators_for_select = self::trigger_condition_operators_for_property( $trigger_condition['property'] ); |
| 334 | $selected_object_code = $trigger_condition['property'] ? explode( '__', $trigger_condition['property'] )[0] : $objects_for_select[0]['value']; |
| 335 | $properties_for_select = self::get_properties_for_object_code( $selected_object_code, true ); |
| 336 | $operators_for_select = self::trigger_condition_operators_for_property( $trigger_condition['property'] ); |
| 337 | } |
| 338 | // if we only have 1 object available - no need to output the select box for it |
| 339 | if ( count( $objects_for_select ) > 1 ) { |
| 340 | $object_selector_html = \OsFormHelper::select_field( |
| 341 | 'process[event][trigger_conditions][' . $trigger_condition['id'] . '][object]', |
| 342 | false, |
| 343 | $objects_for_select, |
| 344 | $selected_object_code, |
| 345 | [ |
| 346 | 'class' => 'process-condition-object-selector', |
| 347 | 'data-change-target' => 'process-condition-properties-w', |
| 348 | 'data-condition-id' => $trigger_condition['id'], |
| 349 | 'data-route' => \OsRouterHelper::build_route_name( 'processes', 'available_properties_for_object_code' ), |
| 350 | ] |
| 351 | ); |
| 352 | } else { |
| 353 | $object_selector_html = ''; |
| 354 | } |
| 355 | $html = '<div class="pe-condition" data-condition-id="' . $trigger_condition['id'] . '">' . |
| 356 | '<button class="pe-remove-condition"><i class="latepoint-icon latepoint-icon-cross"></i></button>' . |
| 357 | $object_selector_html . |
| 358 | \OsFormHelper::select_field( |
| 359 | 'process[event][trigger_conditions][' . $trigger_condition['id'] . '][property]', |
| 360 | false, |
| 361 | $properties_for_select, |
| 362 | $trigger_condition['property'], |
| 363 | [ |
| 364 | 'class' => 'process-condition-property-selector', |
| 365 | 'data-route' => \OsRouterHelper::build_route_name( 'processes', 'available_operators_for_trigger_condition_property' ), |
| 366 | ], |
| 367 | [ 'class' => 'process-condition-properties-w' ] |
| 368 | ) . |
| 369 | \OsFormHelper::select_field( |
| 370 | 'process[event][trigger_conditions][' . $trigger_condition['id'] . '][operator]', |
| 371 | false, |
| 372 | $operators_for_select, |
| 373 | $trigger_condition['operator'], |
| 374 | [ |
| 375 | 'class' => 'process-condition-operator-selector', |
| 376 | 'data-route' => \OsRouterHelper::build_route_name( 'processes', 'available_values_for_trigger_condition_property' ), |
| 377 | ], |
| 378 | [ 'class' => 'process-condition-operators-w' ] |
| 379 | ) . |
| 380 | self::value_field_html_for_trigger_condition( |
| 381 | $trigger_condition['property'], |
| 382 | $trigger_condition['value'] ?: '', |
| 383 | $trigger_condition['id'], |
| 384 | $trigger_condition['operator'] ?? '' |
| 385 | ) . |
| 386 | '<div data-os-action="' . \OsRouterHelper::build_route_name( 'processes', 'new_trigger_condition' ) . '" |
| 387 | data-os-pass-response="yes" |
| 388 | data-os-pass-this="yes" |
| 389 | data-os-before-after="none" |
| 390 | data-os-params="' . \OsUtilHelper::build_os_params( [ 'event_type' => $this->type ] ) . '" |
| 391 | data-os-after-call="latepoint_add_process_condition"><button class="latepoint-btn-outline latepoint-btn"><i class="latepoint-icon latepoint-icon-plus2"></i><span>' . __( 'AND', 'latepoint' ) . '</span></button></div>' . |
| 392 | '</div>'; |
| 393 | return $html; |
| 394 | } |
| 395 | |
| 396 | /** |
| 397 | * Renders the value-input HTML for a single trigger condition. Numeric |
| 398 | * properties get a bordered number input; other properties get the |
| 399 | * existing multi-select dropdown populated from |
| 400 | * OsProcessesHelper::values_for_trigger_condition_property(). |
| 401 | * |
| 402 | * Used inline by generate_trigger_condition_form_html() and from the |
| 403 | * processes__available_values_for_trigger_condition_property AJAX endpoint. |
| 404 | */ |
| 405 | public static function value_field_html_for_trigger_condition( string $property, string $value, string $trigger_condition_id, string $operator = '' ): string { |
| 406 | $name = 'process[event][trigger_conditions][' . $trigger_condition_id . '][value]'; |
| 407 | |
| 408 | if ( self::is_numeric_trigger_condition_property( $property ) ) { |
| 409 | return \OsFormHelper::number_field( |
| 410 | $name, |
| 411 | '', |
| 412 | $value, |
| 413 | 0, |
| 414 | null, |
| 415 | [ |
| 416 | 'step' => '1', |
| 417 | 'theme' => 'bordered', |
| 418 | 'placeholder' => __( 'Count', 'latepoint' ), |
| 419 | ], |
| 420 | [ |
| 421 | 'class' => 'process-condition-values-w', |
| 422 | ] |
| 423 | ); |
| 424 | } |
| 425 | |
| 426 | return \OsFormHelper::multi_select_field( |
| 427 | $name, |
| 428 | '', |
| 429 | \OsProcessesHelper::values_for_trigger_condition_property( $property ), |
| 430 | $value ? explode( ',', $value ) : [], |
| 431 | [], |
| 432 | [ |
| 433 | 'class' => 'process-condition-values-w', |
| 434 | 'style' => in_array( $operator, [ 'changed', 'not_changed' ] ) ? 'display: none;' : '', |
| 435 | ] |
| 436 | ); |
| 437 | } |
| 438 | |
| 439 | /** |
| 440 | * Returns true when the given condition property holds a numeric value |
| 441 | * (free-form integer input, comparable with greater/less-than operators) |
| 442 | * rather than a fixed set of options (status keys, agent IDs, etc.). |
| 443 | * |
| 444 | * Used by trigger_condition_operators_for_property() to expose numeric |
| 445 | * operators and by value_field_html_for_trigger_condition() to render a |
| 446 | * <input type="number"> instead of the default multi-select dropdown. |
| 447 | */ |
| 448 | public static function is_numeric_trigger_condition_property( string $property ): bool { |
| 449 | if ( ! $property ) { |
| 450 | return false; |
| 451 | } |
| 452 | $numeric_properties = [ |
| 453 | 'booking__order_item_counts', |
| 454 | 'order__order_item_counts', |
| 455 | ]; |
| 456 | |
| 457 | /** |
| 458 | * Filter the list of trigger condition properties that should be treated as numeric. |
| 459 | * |
| 460 | * @since 5.x |
| 461 | * @hook latepoint_process_event_numeric_trigger_condition_properties |
| 462 | * |
| 463 | * @param {string[]} $numeric_properties Array of property codes in object__attribute format |
| 464 | * |
| 465 | * @returns {string[]} Filtered list of numeric property codes |
| 466 | */ |
| 467 | $numeric_properties = apply_filters( 'latepoint_process_event_numeric_trigger_condition_properties', $numeric_properties ); |
| 468 | |
| 469 | return in_array( $property, $numeric_properties, true ); |
| 470 | } |
| 471 | |
| 472 | public static function trigger_condition_operators_for_property( string $property = '' ) { |
| 473 | $property_object = $property ? explode( '__', $property )[0] : 'booking'; |
| 474 | $property_attribute = $property ? explode( '__', $property )[1] : ''; |
| 475 | $operators = []; |
| 476 | |
| 477 | switch ( $property_object ) { |
| 478 | case 'old_order': |
| 479 | case 'old_booking': |
| 480 | // TODO time range operators instead of removing these opearators completely |
| 481 | if ( $property_attribute != 'start_datetime_utc' ) { |
| 482 | $operators['equal'] = __( 'was equal to', 'latepoint' ); |
| 483 | $operators['not_equal'] = __( 'was not equal to', 'latepoint' ); |
| 484 | } |
| 485 | $operators['changed'] = __( 'has changed', 'latepoint' ); |
| 486 | $operators['not_changed'] = __( 'has not changed', 'latepoint' ); |
| 487 | break; |
| 488 | case 'order': |
| 489 | case 'booking': |
| 490 | case 'customer': |
| 491 | case 'agent': |
| 492 | case 'service': |
| 493 | case 'transaction': |
| 494 | if ( self::is_numeric_trigger_condition_property( $property ) ) { |
| 495 | $operators['equal'] = __( 'is equal to', 'latepoint' ); |
| 496 | $operators['not_equal'] = __( 'is not equal to', 'latepoint' ); |
| 497 | $operators['greater_than'] = __( 'is greater than', 'latepoint' ); |
| 498 | $operators['less_than'] = __( 'is less than', 'latepoint' ); |
| 499 | $operators['greater_or_equal'] = __( 'is greater than or equal to', 'latepoint' ); |
| 500 | $operators['less_or_equal'] = __( 'is less than or equal to', 'latepoint' ); |
| 501 | } elseif ( $property_attribute != 'start_datetime_utc' ) { |
| 502 | // TODO time range operators instead of removing these opearators completely |
| 503 | $operators['equal'] = __( 'is equal to', 'latepoint' ); |
| 504 | $operators['not_equal'] = __( 'is not equal to', 'latepoint' ); |
| 505 | } |
| 506 | break; |
| 507 | } |
| 508 | |
| 509 | /** |
| 510 | * Returns an array of operators available for a selected condition property |
| 511 | * |
| 512 | * @since 4.7.0 |
| 513 | * @hook latepoint_process_event_trigger_condition_properties |
| 514 | * |
| 515 | * @param {array} $operators Array of operators |
| 516 | * @param {string} $property Property in a format of object_code__object_property (e.g. old_booking__agent_id) |
| 517 | * @param {string} $property_object Object name |
| 518 | * @param {string} $property_attribute Property of an object |
| 519 | * |
| 520 | * @returns {array} The array of available operators |
| 521 | * |
| 522 | */ |
| 523 | return apply_filters( 'latepoint_process_event_trigger_condition_operators', $operators, $property, $property_object, $property_attribute ); |
| 524 | } |
| 525 | |
| 526 | public static function trigger_condition_properties_for_type( $event_type ) { |
| 527 | $properties = []; |
| 528 | switch ( $event_type ) { |
| 529 | case 'order_created': |
| 530 | $properties = [ |
| 531 | 'order__status' => __( 'Order Status', 'latepoint' ), |
| 532 | 'order__fulfillment_status' => __( 'Fulfillment Service', 'latepoint' ), |
| 533 | 'order__payment_status' => __( 'Payment Status', 'latepoint' ), |
| 534 | ]; |
| 535 | break; |
| 536 | case 'order_updated': |
| 537 | $properties = [ |
| 538 | 'old__order__status' => __( 'Previous Order Status', 'latepoint' ), |
| 539 | 'old__order__fulfillment_status' => __( 'Previous Fulfillment Service', 'latepoint' ), |
| 540 | 'old__order__payment_status' => __( 'Previous Payment Status', 'latepoint' ), |
| 541 | 'order__status' => __( 'Order Status', 'latepoint' ), |
| 542 | 'order__fulfillment_status' => __( 'Fulfillment Service', 'latepoint' ), |
| 543 | 'order__payment_status' => __( 'Payment Status', 'latepoint' ), |
| 544 | ]; |
| 545 | break; |
| 546 | case 'booking_created': |
| 547 | $properties = [ |
| 548 | 'booking__status' => __( 'Booking Status', 'latepoint' ), |
| 549 | 'booking__service_id' => __( 'Service', 'latepoint' ), |
| 550 | 'booking__agent_id' => __( 'Agent', 'latepoint' ), |
| 551 | 'booking__order_item_counts' => __( 'Order Item Counts', 'latepoint' ), |
| 552 | ]; |
| 553 | break; |
| 554 | case 'booking_updated': |
| 555 | $properties = [ |
| 556 | 'old__booking__status' => __( 'Previous Booking Status', 'latepoint' ), |
| 557 | 'old__booking__service_id' => __( 'Previous Service', 'latepoint' ), |
| 558 | 'old__booking__agent_id' => __( 'Previous Agent', 'latepoint' ), |
| 559 | 'old__booking__start_datetime_utc' => __( 'Start Time', 'latepoint' ), |
| 560 | 'booking__status' => __( 'Booking Status', 'latepoint' ), |
| 561 | 'booking__service_id' => __( 'Service', 'latepoint' ), |
| 562 | 'booking__agent_id' => __( 'Agent', 'latepoint' ), |
| 563 | ]; |
| 564 | break; |
| 565 | case 'transaction_created': |
| 566 | $properties = [ |
| 567 | 'transaction__payment_method' => __( 'Payment Method', 'latepoint' ), |
| 568 | ]; |
| 569 | break; |
| 570 | } |
| 571 | |
| 572 | return apply_filters( 'latepoint_process_event_trigger_condition_properties', $properties, $event_type ); |
| 573 | } |
| 574 | |
| 575 | public static function get_event_types() { |
| 576 | $event_types = [ |
| 577 | 'order_created', |
| 578 | 'order_updated', |
| 579 | 'booking_created', |
| 580 | 'booking_updated', |
| 581 | 'booking_start', |
| 582 | 'booking_end', |
| 583 | 'customer_created', |
| 584 | 'transaction_created', |
| 585 | 'payment_request_created', |
| 586 | ]; |
| 587 | |
| 588 | /** |
| 589 | * Returns an array of event types that trigger automation process |
| 590 | * |
| 591 | * @since 4.7.0 |
| 592 | * @hook latepoint_process_event_types |
| 593 | * |
| 594 | * @param {array} $event_types Array of event types |
| 595 | * |
| 596 | * @returns {array} The array of event types that trigger automation process |
| 597 | */ |
| 598 | return apply_filters( 'latepoint_process_event_types', $event_types ); |
| 599 | } |
| 600 | |
| 601 | |
| 602 | public static function get_event_name_for_type( $type ) { |
| 603 | $names = [ |
| 604 | 'order_created' => __( 'Order Created', 'latepoint' ), |
| 605 | 'order_updated' => __( 'Order Updated', 'latepoint' ), |
| 606 | 'booking_created' => __( 'Booking Created', 'latepoint' ), |
| 607 | 'booking_updated' => __( 'Booking Updated', 'latepoint' ), |
| 608 | 'booking_start' => __( 'Booking Started', 'latepoint' ), |
| 609 | 'booking_end' => __( 'Booking Ended', 'latepoint' ), |
| 610 | 'customer_created' => __( 'Customer Created', 'latepoint' ), |
| 611 | 'transaction_created' => __( 'Transaction Created', 'latepoint' ), |
| 612 | 'payment_request_created' => __( 'Payment Request Created', 'latepoint' ), |
| 613 | ]; |
| 614 | |
| 615 | /** |
| 616 | * Returns an array of process event types mapped to their displayable names |
| 617 | * |
| 618 | * @since 4.7.0 |
| 619 | * @hook latepoint_process_event_names |
| 620 | * |
| 621 | * @param {array} $names Array of event types/names to filter |
| 622 | * |
| 623 | * @returns {array} Filtered array of event types/names |
| 624 | */ |
| 625 | $names = apply_filters( 'latepoint_process_event_names', $names ); |
| 626 | |
| 627 | return $names[ $type ] ?? $type; |
| 628 | } |
| 629 | |
| 630 | public static function get_event_types_for_select() { |
| 631 | $types = self::get_event_types(); |
| 632 | $types_for_select = []; |
| 633 | foreach ( $types as $type ) { |
| 634 | $types_for_select[ $type ] = self::get_event_name_for_type( $type ); |
| 635 | } |
| 636 | return $types_for_select; |
| 637 | } |
| 638 | |
| 639 | public static function generate_trigger_condition_id(): string { |
| 640 | return 'pec_' . \OsUtilHelper::random_text( 'alnum', 6 ); |
| 641 | } |
| 642 | |
| 643 | public static function allowed_props(): array { |
| 644 | return [ 'id', 'type', 'trigger_conditions', 'time_offset' ]; |
| 645 | } |
| 646 | } |
| 647 |