1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<?php

namespace AutomateWoo\Async_Events;

use AutomateWoo\Clean;
use AutomateWoo\Orders\StatusTransition;

defined( 'ABSPATH' ) || exit;

/**
 * Event to fire when an order is first paid, supports payments by invoice, cheque, bank etc
 *
 * @since 4.8.0
 */
class Order_Paid extends Abstract_Async_Event {

    /**
     * Set any events that this event is dependant on.
     *
     * @var array
     */
    protected $event_dependencies = [ 'order_status_changed' ];

    /**
     * Init order paid event helper.
     */
    public function init() {
        add_action( 'automatewoo/order/status_changed_async', [ $this, 'handle_async_order_status_changed' ], 10, 3 );
    }

    /**
     * Get the async event hook name.
     *
     * @since 5.2.0
     *
     * @return string
     */
    public function get_hook_name(): string {
        return 'automatewoo/order/paid_async';
    }

    /**
     * Determines whether the status change means the order is now paid.
     *
     * If the order is paid an action is triggered. This action can only run once for each order.
     *
     * @param int    $order_id
     * @param string $old_status
     * @param string $new_status
     */
    public function handle_async_order_status_changed( $order_id, $old_status, $new_status ) {
        $transition = new StatusTransition( $old_status, $new_status );
        if ( ! $transition->is_becoming_paid() ) {
            return;
        }

        $order = wc_get_order( Clean::id( $order_id ) );

        if ( ! $order || $order->get_meta( '_aw_is_paid' ) ) {
            return;
        }

        $order->update_meta_data( '_aw_is_paid', true );
        $order->save();

        do_action( $this->get_hook_name(), $order->get_id() );

        // This hook is also asynchronous, avoid using due to possible confusion
        do_action( 'automatewoo/order/paid', $order );
    }
}