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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<?php
namespace AutomateWoo\Actions\Subscriptions;
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Action to remove a shipping method from a subscription.
*
* @since 5.4.0
*/
class RemoveShipping extends AddShipping {
/**
* Flag to define whether to include an "All shipping methods" option in the shipping
* method select field for this action.
*
* @var bool
*/
protected $include_all_shipping_method = true;
/**
* Flag to define whether the instance of this action requires a name input field to
* be displayed on the action's admin UI.
*
* @var bool
*/
protected $load_name_field = false;
/**
* Flag to define whether the instance of this action requires a price input field to
* be displayed on the action's admin UI.
*
* @var bool
*/
protected $load_cost_field = false;
/**
* Explain to store admin what this action does via a unique title and description.
*/
public function load_admin_details() {
parent::load_admin_details();
$this->title = __( 'Remove Shipping', 'automatewoo' );
$this->description = __( 'Remove a shipping line item or items from a subscription, if any line items match the chosen shipping method. This is useful for bulk editing subscriptions, or to change the shipping charged to a subscriber at different stages of their subscription\'s lifecycle. Please note: all line items for the chosen shipping method will be removed.', 'automatewoo' );
}
/**
* Add a given shipping as a line item to a given subscription.
*
* @param array $shipping_data Shipping line item data. Same data as the return value of @see $this->get_object_for_edit().
* @param \WC_Subscription $subscription Instance of subscription to add the shipping to.
*
* @return bool True if the subscription was edited, false if no change was made.
*/
protected function edit_subscription( $shipping_data, $subscription ) {
$edited = false;
foreach ( $subscription->get_shipping_methods() as $line_item ) {
// Same approach used in Abstract_WC_Order::has_shipping_method() to check for method
if (
0 === strpos( $line_item->get_method_id(), $shipping_data['shipping_method_id'] )
|| $this->all_shipping_method_option_key === $shipping_data['shipping_method_id']
) {
$edited = true;
$subscription->remove_item( $line_item->get_id() );
}
}
if ( $edited ) {
$subscription->save();
$subscription->calculate_totals();
}
return $edited;
}
/**
* Create a note recording the shipping method ID and workflow name to add after removing shipping.
*
* Helpful for tracing the history of this action by viewing the subscription's notes.
*
* @param array $shipping_data Shipping line item data. Same data as the return value of @see $this->get_object_for_edit().
* @return string
*/
protected function get_note( $shipping_data ) {
/* translators: %1$s: workflow title, %2$s shipping method ID, %3$d workflow ID */
return sprintf( __( '%1$s workflow run: removed shipping method from subscription. (Shipping Method ID: %2$s; Workflow ID: %3$d)', 'automatewoo' ), $this->workflow->get_title(), $shipping_data['shipping_method_id'], $this->workflow->get_id() );
}
}
|