AyeCode /
invoicing
@@ -15,125 +15,125 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class WPInv_Subscription extends GetPaid_Data { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Which data store to load. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 23 | - protected $data_store_name = 'subscription'; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * This is the name of this object type. |
|
| 27 | - * |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $object_type = 'subscription'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Item Data array. This is the core item data exposed in APIs. |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - protected $data = array( |
|
| 39 | - 'customer_id' => 0, |
|
| 40 | - 'frequency' => 1, |
|
| 41 | - 'period' => 'D', |
|
| 42 | - 'initial_amount' => null, |
|
| 43 | - 'recurring_amount' => null, |
|
| 44 | - 'bill_times' => 0, |
|
| 45 | - 'transaction_id' => '', |
|
| 46 | - 'parent_payment_id' => null, |
|
| 47 | - 'product_id' => 0, |
|
| 48 | - 'created' => '0000-00-00 00:00:00', |
|
| 49 | - 'expiration' => '0000-00-00 00:00:00', |
|
| 50 | - 'trial_period' => '', |
|
| 51 | - 'status' => 'pending', |
|
| 52 | - 'profile_id' => '', |
|
| 53 | - 'gateway' => '', |
|
| 54 | - 'customer' => '', |
|
| 55 | - ); |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Stores the status transition information. |
|
| 59 | - * |
|
| 60 | - * @since 1.0.19 |
|
| 61 | - * @var bool |
|
| 62 | - */ |
|
| 63 | - protected $status_transition = false; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Get the subscription if ID is passed, otherwise the subscription is new and empty. |
|
| 67 | - * |
|
| 68 | - * @param int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read. |
|
| 69 | - * @param bool $deprecated |
|
| 70 | - */ |
|
| 71 | - function __construct( $subscription = 0, $deprecated = false ) { |
|
| 72 | - |
|
| 73 | - parent::__construct( $subscription ); |
|
| 74 | - |
|
| 75 | - if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) { |
|
| 76 | - $this->set_id( $subscription ); |
|
| 77 | - } elseif ( $subscription instanceof self ) { |
|
| 78 | - $this->set_id( $subscription->get_id() ); |
|
| 79 | - } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) { |
|
| 80 | - $this->set_id( $subscription_id ); |
|
| 81 | - } elseif ( ! empty( $subscription->id ) ) { |
|
| 82 | - $this->set_id( $subscription->id ); |
|
| 83 | - } else { |
|
| 84 | - $this->set_object_read( true ); |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - // Load the datastore. |
|
| 88 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 89 | - |
|
| 90 | - if ( $this->get_id() > 0 ) { |
|
| 91 | - $this->data_store->read( $this ); |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * Given an invoice id, profile id, transaction id, it returns the subscription's id. |
|
| 98 | - * |
|
| 99 | - * |
|
| 100 | - * @static |
|
| 101 | - * @param string $value |
|
| 102 | - * @param string $field Either invoice_id, transaction_id or profile_id. |
|
| 103 | - * @since 1.0.19 |
|
| 104 | - * @return int |
|
| 105 | - */ |
|
| 106 | - public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) { |
|
| 18 | + /** |
|
| 19 | + * Which data store to load. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | + protected $data_store_name = 'subscription'; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * This is the name of this object type. |
|
| 27 | + * |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $object_type = 'subscription'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Item Data array. This is the core item data exposed in APIs. |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + protected $data = array( |
|
| 39 | + 'customer_id' => 0, |
|
| 40 | + 'frequency' => 1, |
|
| 41 | + 'period' => 'D', |
|
| 42 | + 'initial_amount' => null, |
|
| 43 | + 'recurring_amount' => null, |
|
| 44 | + 'bill_times' => 0, |
|
| 45 | + 'transaction_id' => '', |
|
| 46 | + 'parent_payment_id' => null, |
|
| 47 | + 'product_id' => 0, |
|
| 48 | + 'created' => '0000-00-00 00:00:00', |
|
| 49 | + 'expiration' => '0000-00-00 00:00:00', |
|
| 50 | + 'trial_period' => '', |
|
| 51 | + 'status' => 'pending', |
|
| 52 | + 'profile_id' => '', |
|
| 53 | + 'gateway' => '', |
|
| 54 | + 'customer' => '', |
|
| 55 | + ); |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Stores the status transition information. |
|
| 59 | + * |
|
| 60 | + * @since 1.0.19 |
|
| 61 | + * @var bool |
|
| 62 | + */ |
|
| 63 | + protected $status_transition = false; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Get the subscription if ID is passed, otherwise the subscription is new and empty. |
|
| 67 | + * |
|
| 68 | + * @param int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read. |
|
| 69 | + * @param bool $deprecated |
|
| 70 | + */ |
|
| 71 | + function __construct( $subscription = 0, $deprecated = false ) { |
|
| 72 | + |
|
| 73 | + parent::__construct( $subscription ); |
|
| 74 | + |
|
| 75 | + if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) { |
|
| 76 | + $this->set_id( $subscription ); |
|
| 77 | + } elseif ( $subscription instanceof self ) { |
|
| 78 | + $this->set_id( $subscription->get_id() ); |
|
| 79 | + } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) { |
|
| 80 | + $this->set_id( $subscription_id ); |
|
| 81 | + } elseif ( ! empty( $subscription->id ) ) { |
|
| 82 | + $this->set_id( $subscription->id ); |
|
| 83 | + } else { |
|
| 84 | + $this->set_object_read( true ); |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + // Load the datastore. |
|
| 88 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 89 | + |
|
| 90 | + if ( $this->get_id() > 0 ) { |
|
| 91 | + $this->data_store->read( $this ); |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * Given an invoice id, profile id, transaction id, it returns the subscription's id. |
|
| 98 | + * |
|
| 99 | + * |
|
| 100 | + * @static |
|
| 101 | + * @param string $value |
|
| 102 | + * @param string $field Either invoice_id, transaction_id or profile_id. |
|
| 103 | + * @since 1.0.19 |
|
| 104 | + * @return int |
|
| 105 | + */ |
|
| 106 | + public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) { |
|
| 107 | 107 | global $wpdb; |
| 108 | 108 | |
| 109 | - // Trim the value. |
|
| 110 | - $value = trim( $value ); |
|
| 109 | + // Trim the value. |
|
| 110 | + $value = trim( $value ); |
|
| 111 | 111 | |
| 112 | - if ( empty( $value ) ) { |
|
| 113 | - return 0; |
|
| 114 | - } |
|
| 112 | + if ( empty( $value ) ) { |
|
| 113 | + return 0; |
|
| 114 | + } |
|
| 115 | 115 | |
| 116 | - if ( 'invoice_id' == $field ) { |
|
| 117 | - $field = 'parent_payment_id'; |
|
| 118 | - } |
|
| 116 | + if ( 'invoice_id' == $field ) { |
|
| 117 | + $field = 'parent_payment_id'; |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | 120 | // Valid fields. |
| 121 | 121 | $fields = array( |
| 122 | - 'parent_payment_id', |
|
| 123 | - 'transaction_id', |
|
| 124 | - 'profile_id', |
|
| 125 | - ); |
|
| 126 | - |
|
| 127 | - // Ensure a field has been passed. |
|
| 128 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 129 | - return 0; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - // Maybe retrieve from the cache. |
|
| 133 | - $subscription_id = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 134 | - if ( ! empty( $subscription_id ) ) { |
|
| 135 | - return $subscription_id; |
|
| 136 | - } |
|
| 122 | + 'parent_payment_id', |
|
| 123 | + 'transaction_id', |
|
| 124 | + 'profile_id', |
|
| 125 | + ); |
|
| 126 | + |
|
| 127 | + // Ensure a field has been passed. |
|
| 128 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 129 | + return 0; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + // Maybe retrieve from the cache. |
|
| 133 | + $subscription_id = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 134 | + if ( ! empty( $subscription_id ) ) { |
|
| 135 | + return $subscription_id; |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | 138 | // Fetch from the db. |
| 139 | 139 | $table = $wpdb->prefix . 'wpinv_subscriptions'; |
@@ -141,34 +141,34 @@ discard block |
||
| 141 | 141 | $wpdb->prepare( "SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
| 142 | 142 | ); |
| 143 | 143 | |
| 144 | - if ( empty( $subscription_id ) ) { |
|
| 145 | - return 0; |
|
| 146 | - } |
|
| 144 | + if ( empty( $subscription_id ) ) { |
|
| 145 | + return 0; |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - // Update the cache with our data. |
|
| 149 | - wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 148 | + // Update the cache with our data. |
|
| 149 | + wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 150 | 150 | |
| 151 | - return $subscription_id; |
|
| 152 | - } |
|
| 151 | + return $subscription_id; |
|
| 152 | + } |
|
| 153 | 153 | |
| 154 | - /** |
|
| 154 | + /** |
|
| 155 | 155 | * Clears the subscription's cache. |
| 156 | 156 | */ |
| 157 | 157 | public function clear_cache() { |
| 158 | - wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' ); |
|
| 159 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 160 | - wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 161 | - wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' ); |
|
| 162 | - } |
|
| 158 | + wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' ); |
|
| 159 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 160 | + wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 161 | + wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' ); |
|
| 162 | + } |
|
| 163 | 163 | |
| 164 | - /** |
|
| 164 | + /** |
|
| 165 | 165 | * Checks if a subscription key is set. |
| 166 | 166 | */ |
| 167 | 167 | public function _isset( $key ) { |
| 168 | 168 | return isset( $this->data[ $key ] ) || method_exists( $this, "get_$key" ); |
| 169 | - } |
|
| 169 | + } |
|
| 170 | 170 | |
| 171 | - /* |
|
| 171 | + /* |
|
| 172 | 172 | |-------------------------------------------------------------------------- |
| 173 | 173 | | CRUD methods |
| 174 | 174 | |-------------------------------------------------------------------------- |
@@ -177,544 +177,544 @@ discard block |
||
| 177 | 177 | | |
| 178 | 178 | */ |
| 179 | 179 | |
| 180 | - /* |
|
| 180 | + /* |
|
| 181 | 181 | |-------------------------------------------------------------------------- |
| 182 | 182 | | Getters |
| 183 | 183 | |-------------------------------------------------------------------------- |
| 184 | 184 | */ |
| 185 | 185 | |
| 186 | - /** |
|
| 187 | - * Get customer id. |
|
| 188 | - * |
|
| 189 | - * @since 1.0.19 |
|
| 190 | - * @param string $context View or edit context. |
|
| 191 | - * @return int |
|
| 192 | - */ |
|
| 193 | - public function get_customer_id( $context = 'view' ) { |
|
| 194 | - return (int) $this->get_prop( 'customer_id', $context ); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * Get customer information. |
|
| 199 | - * |
|
| 200 | - * @since 1.0.19 |
|
| 201 | - * @param string $context View or edit context. |
|
| 202 | - * @return WP_User|false WP_User object on success, false on failure. |
|
| 203 | - */ |
|
| 204 | - public function get_customer( $context = 'view' ) { |
|
| 205 | - return get_userdata( $this->get_customer_id( $context ) ); |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * Get parent invoice id. |
|
| 210 | - * |
|
| 211 | - * @since 1.0.19 |
|
| 212 | - * @param string $context View or edit context. |
|
| 213 | - * @return int |
|
| 214 | - */ |
|
| 215 | - public function get_parent_invoice_id( $context = 'view' ) { |
|
| 216 | - return (int) $this->get_prop( 'parent_payment_id', $context ); |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * Alias for self::get_parent_invoice_id(). |
|
| 221 | - * |
|
| 222 | - * @since 1.0.19 |
|
| 223 | - * @param string $context View or edit context. |
|
| 224 | - * @return int |
|
| 225 | - */ |
|
| 186 | + /** |
|
| 187 | + * Get customer id. |
|
| 188 | + * |
|
| 189 | + * @since 1.0.19 |
|
| 190 | + * @param string $context View or edit context. |
|
| 191 | + * @return int |
|
| 192 | + */ |
|
| 193 | + public function get_customer_id( $context = 'view' ) { |
|
| 194 | + return (int) $this->get_prop( 'customer_id', $context ); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * Get customer information. |
|
| 199 | + * |
|
| 200 | + * @since 1.0.19 |
|
| 201 | + * @param string $context View or edit context. |
|
| 202 | + * @return WP_User|false WP_User object on success, false on failure. |
|
| 203 | + */ |
|
| 204 | + public function get_customer( $context = 'view' ) { |
|
| 205 | + return get_userdata( $this->get_customer_id( $context ) ); |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * Get parent invoice id. |
|
| 210 | + * |
|
| 211 | + * @since 1.0.19 |
|
| 212 | + * @param string $context View or edit context. |
|
| 213 | + * @return int |
|
| 214 | + */ |
|
| 215 | + public function get_parent_invoice_id( $context = 'view' ) { |
|
| 216 | + return (int) $this->get_prop( 'parent_payment_id', $context ); |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * Alias for self::get_parent_invoice_id(). |
|
| 221 | + * |
|
| 222 | + * @since 1.0.19 |
|
| 223 | + * @param string $context View or edit context. |
|
| 224 | + * @return int |
|
| 225 | + */ |
|
| 226 | 226 | public function get_parent_payment_id( $context = 'view' ) { |
| 227 | 227 | return $this->get_parent_invoice_id( $context ); |
| 228 | - } |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + /** |
|
| 231 | + * Alias for self::get_parent_invoice_id(). |
|
| 232 | + * |
|
| 233 | + * @since 1.0.0 |
|
| 234 | + * @return int |
|
| 235 | + */ |
|
| 236 | + public function get_original_payment_id( $context = 'view' ) { |
|
| 237 | + return $this->get_parent_invoice_id( $context ); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * Get parent invoice. |
|
| 242 | + * |
|
| 243 | + * @since 1.0.19 |
|
| 244 | + * @param string $context View or edit context. |
|
| 245 | + * @return WPInv_Invoice |
|
| 246 | + */ |
|
| 247 | + public function get_parent_invoice( $context = 'view' ) { |
|
| 248 | + return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) ); |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + /** |
|
| 252 | + * Alias for self::get_parent_invoice(). |
|
| 253 | + * |
|
| 254 | + * @since 1.0.19 |
|
| 255 | + * @param string $context View or edit context. |
|
| 256 | + * @return WPInv_Invoice |
|
| 257 | + */ |
|
| 258 | + public function get_parent_payment( $context = 'view' ) { |
|
| 259 | + return $this->get_parent_invoice( $context ); |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + /** |
|
| 263 | + * Get subscription's product id. |
|
| 264 | + * |
|
| 265 | + * @since 1.0.19 |
|
| 266 | + * @param string $context View or edit context. |
|
| 267 | + * @return int |
|
| 268 | + */ |
|
| 269 | + public function get_product_id( $context = 'view' ) { |
|
| 270 | + return (int) $this->get_prop( 'product_id', $context ); |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + /** |
|
| 274 | + * Get the subscription product. |
|
| 275 | + * |
|
| 276 | + * @since 1.0.19 |
|
| 277 | + * @param string $context View or edit context. |
|
| 278 | + * @return WPInv_Item |
|
| 279 | + */ |
|
| 280 | + public function get_product( $context = 'view' ) { |
|
| 281 | + return new WPInv_Item( $this->get_product_id( $context ) ); |
|
| 282 | + } |
|
| 283 | + |
|
| 284 | + /** |
|
| 285 | + * Get parent invoice's gateway. |
|
| 286 | + * |
|
| 287 | + * Here for backwards compatibility. |
|
| 288 | + * |
|
| 289 | + * @since 1.0.19 |
|
| 290 | + * @param string $context View or edit context. |
|
| 291 | + * @return string |
|
| 292 | + */ |
|
| 293 | + public function get_gateway( $context = 'view' ) { |
|
| 294 | + return $this->get_parent_invoice( $context )->get_gateway(); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Get the period of a renewal. |
|
| 299 | + * |
|
| 300 | + * @since 1.0.19 |
|
| 301 | + * @param string $context View or edit context. |
|
| 302 | + * @return string |
|
| 303 | + */ |
|
| 304 | + public function get_period( $context = 'view' ) { |
|
| 305 | + return $this->get_prop( 'period', $context ); |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * Get number of periods each renewal is valid for. |
|
| 310 | + * |
|
| 311 | + * @since 1.0.19 |
|
| 312 | + * @param string $context View or edit context. |
|
| 313 | + * @return int |
|
| 314 | + */ |
|
| 315 | + public function get_frequency( $context = 'view' ) { |
|
| 316 | + return (int) $this->get_prop( 'frequency', $context ); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + /** |
|
| 320 | + * Get the initial amount for the subscription. |
|
| 321 | + * |
|
| 322 | + * @since 1.0.19 |
|
| 323 | + * @param string $context View or edit context. |
|
| 324 | + * @return float |
|
| 325 | + */ |
|
| 326 | + public function get_initial_amount( $context = 'view' ) { |
|
| 327 | + return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) ); |
|
| 328 | + } |
|
| 329 | + |
|
| 330 | + /** |
|
| 331 | + * Get the recurring amount for the subscription. |
|
| 332 | + * |
|
| 333 | + * @since 1.0.19 |
|
| 334 | + * @param string $context View or edit context. |
|
| 335 | + * @return float |
|
| 336 | + */ |
|
| 337 | + public function get_recurring_amount( $context = 'view' ) { |
|
| 338 | + return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) ); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + /** |
|
| 342 | + * Get number of times that this subscription can be renewed. |
|
| 343 | + * |
|
| 344 | + * @since 1.0.19 |
|
| 345 | + * @param string $context View or edit context. |
|
| 346 | + * @return int |
|
| 347 | + */ |
|
| 348 | + public function get_bill_times( $context = 'view' ) { |
|
| 349 | + return (int) $this->get_prop( 'bill_times', $context ); |
|
| 350 | + } |
|
| 351 | + |
|
| 352 | + /** |
|
| 353 | + * Get transaction id of this subscription's parent invoice. |
|
| 354 | + * |
|
| 355 | + * @since 1.0.19 |
|
| 356 | + * @param string $context View or edit context. |
|
| 357 | + * @return string |
|
| 358 | + */ |
|
| 359 | + public function get_transaction_id( $context = 'view' ) { |
|
| 360 | + return $this->get_prop( 'transaction_id', $context ); |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + /** |
|
| 364 | + * Get the date that the subscription was created. |
|
| 365 | + * |
|
| 366 | + * @since 1.0.19 |
|
| 367 | + * @param string $context View or edit context. |
|
| 368 | + * @return string |
|
| 369 | + */ |
|
| 370 | + public function get_created( $context = 'view' ) { |
|
| 371 | + return $this->get_prop( 'created', $context ); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + /** |
|
| 375 | + * Alias for self::get_created(). |
|
| 376 | + * |
|
| 377 | + * @since 1.0.19 |
|
| 378 | + * @param string $context View or edit context. |
|
| 379 | + * @return string |
|
| 380 | + */ |
|
| 381 | + public function get_date_created( $context = 'view' ) { |
|
| 382 | + return $this->get_created( $context ); |
|
| 383 | + } |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * Retrieves the creation date in a timestamp |
|
| 387 | + * |
|
| 388 | + * @since 1.0.0 |
|
| 389 | + * @return int |
|
| 390 | + */ |
|
| 391 | + public function get_time_created() { |
|
| 392 | + $created = $this->get_date_created(); |
|
| 393 | + return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) ); |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + /** |
|
| 397 | + * Get GMT date when the subscription was created. |
|
| 398 | + * |
|
| 399 | + * @since 1.0.19 |
|
| 400 | + * @param string $context View or edit context. |
|
| 401 | + * @return string |
|
| 402 | + */ |
|
| 403 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 404 | + $date = $this->get_date_created( $context ); |
|
| 405 | + |
|
| 406 | + if ( $date ) { |
|
| 407 | + $date = get_gmt_from_date( $date ); |
|
| 408 | + } |
|
| 409 | + return $date; |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + /** |
|
| 413 | + * Get the date that the subscription will renew. |
|
| 414 | + * |
|
| 415 | + * @since 1.0.19 |
|
| 416 | + * @param string $context View or edit context. |
|
| 417 | + * @return string |
|
| 418 | + */ |
|
| 419 | + public function get_next_renewal_date( $context = 'view' ) { |
|
| 420 | + return $this->get_prop( 'expiration', $context ); |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * Alias for self::get_next_renewal_date(). |
|
| 425 | + * |
|
| 426 | + * @since 1.0.19 |
|
| 427 | + * @param string $context View or edit context. |
|
| 428 | + * @return string |
|
| 429 | + */ |
|
| 430 | + public function get_expiration( $context = 'view' ) { |
|
| 431 | + return $this->get_next_renewal_date( $context ); |
|
| 432 | + } |
|
| 433 | + |
|
| 434 | + /** |
|
| 435 | + * Retrieves the expiration date in a timestamp |
|
| 436 | + * |
|
| 437 | + * @since 1.0.0 |
|
| 438 | + * @return int |
|
| 439 | + */ |
|
| 440 | + public function get_expiration_time() { |
|
| 441 | + $expiration = $this->get_expiration(); |
|
| 442 | + |
|
| 443 | + if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) { |
|
| 444 | + return current_time( 'timestamp' ); |
|
| 445 | + } |
|
| 446 | + |
|
| 447 | + $expiration = strtotime( $expiration, current_time( 'timestamp' ) ); |
|
| 448 | + return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration; |
|
| 449 | + } |
|
| 450 | + |
|
| 451 | + /** |
|
| 452 | + * Get GMT date when the subscription will renew. |
|
| 453 | + * |
|
| 454 | + * @since 1.0.19 |
|
| 455 | + * @param string $context View or edit context. |
|
| 456 | + * @return string |
|
| 457 | + */ |
|
| 458 | + public function get_next_renewal_date_gmt( $context = 'view' ) { |
|
| 459 | + $date = $this->get_next_renewal_date( $context ); |
|
| 460 | + |
|
| 461 | + if ( $date ) { |
|
| 462 | + $date = get_gmt_from_date( $date ); |
|
| 463 | + } |
|
| 464 | + return $date; |
|
| 465 | + } |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * Get the subscription's trial period. |
|
| 469 | + * |
|
| 470 | + * @since 1.0.19 |
|
| 471 | + * @param string $context View or edit context. |
|
| 472 | + * @return string |
|
| 473 | + */ |
|
| 474 | + public function get_trial_period( $context = 'view' ) { |
|
| 475 | + return $this->get_prop( 'trial_period', $context ); |
|
| 476 | + } |
|
| 477 | + |
|
| 478 | + /** |
|
| 479 | + * Get the subscription's status. |
|
| 480 | + * |
|
| 481 | + * @since 1.0.19 |
|
| 482 | + * @param string $context View or edit context. |
|
| 483 | + * @return string |
|
| 484 | + */ |
|
| 485 | + public function get_status( $context = 'view' ) { |
|
| 486 | + return $this->get_prop( 'status', $context ); |
|
| 487 | + } |
|
| 488 | + |
|
| 489 | + /** |
|
| 490 | + * Get the subscription's profile id. |
|
| 491 | + * |
|
| 492 | + * @since 1.0.19 |
|
| 493 | + * @param string $context View or edit context. |
|
| 494 | + * @return string |
|
| 495 | + */ |
|
| 496 | + public function get_profile_id( $context = 'view' ) { |
|
| 497 | + return $this->get_prop( 'profile_id', $context ); |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + /* |
|
| 501 | + |-------------------------------------------------------------------------- |
|
| 502 | + | Setters |
|
| 503 | + |-------------------------------------------------------------------------- |
|
| 504 | + */ |
|
| 505 | + |
|
| 506 | + /** |
|
| 507 | + * Set customer id. |
|
| 508 | + * |
|
| 509 | + * @since 1.0.19 |
|
| 510 | + * @param int $value The customer's id. |
|
| 511 | + */ |
|
| 512 | + public function set_customer_id( $value ) { |
|
| 513 | + $this->set_prop( 'customer_id', (int) $value ); |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + /** |
|
| 517 | + * Set parent invoice id. |
|
| 518 | + * |
|
| 519 | + * @since 1.0.19 |
|
| 520 | + * @param int $value The parent invoice id. |
|
| 521 | + */ |
|
| 522 | + public function set_parent_invoice_id( $value ) { |
|
| 523 | + $this->set_prop( 'parent_payment_id', (int) $value ); |
|
| 524 | + } |
|
| 525 | + |
|
| 526 | + /** |
|
| 527 | + * Alias for self::set_parent_invoice_id(). |
|
| 528 | + * |
|
| 529 | + * @since 1.0.19 |
|
| 530 | + * @param int $value The parent invoice id. |
|
| 531 | + */ |
|
| 532 | + public function set_parent_payment_id( $value ) { |
|
| 533 | + $this->set_parent_invoice_id( $value ); |
|
| 534 | + } |
|
| 535 | + |
|
| 536 | + /** |
|
| 537 | + * Alias for self::set_parent_invoice_id(). |
|
| 538 | + * |
|
| 539 | + * @since 1.0.19 |
|
| 540 | + * @param int $value The parent invoice id. |
|
| 541 | + */ |
|
| 542 | + public function set_original_payment_id( $value ) { |
|
| 543 | + $this->set_parent_invoice_id( $value ); |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * Set subscription's product id. |
|
| 548 | + * |
|
| 549 | + * @since 1.0.19 |
|
| 550 | + * @param int $value The subscription product id. |
|
| 551 | + */ |
|
| 552 | + public function set_product_id( $value ) { |
|
| 553 | + $this->set_prop( 'product_id', (int) $value ); |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + /** |
|
| 557 | + * Set the period of a renewal. |
|
| 558 | + * |
|
| 559 | + * @since 1.0.19 |
|
| 560 | + * @param string $value The renewal period. |
|
| 561 | + */ |
|
| 562 | + public function set_period( $value ) { |
|
| 563 | + $this->set_prop( 'period', $value ); |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Set number of periods each renewal is valid for. |
|
| 568 | + * |
|
| 569 | + * @since 1.0.19 |
|
| 570 | + * @param int $value The subscription frequency. |
|
| 571 | + */ |
|
| 572 | + public function set_frequency( $value ) { |
|
| 573 | + $value = empty( $value ) ? 1 : (int) $value; |
|
| 574 | + $this->set_prop( 'frequency', absint( $value ) ); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * Set the initial amount for the subscription. |
|
| 579 | + * |
|
| 580 | + * @since 1.0.19 |
|
| 581 | + * @param float $value The initial subcription amount. |
|
| 582 | + */ |
|
| 583 | + public function set_initial_amount( $value ) { |
|
| 584 | + $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) ); |
|
| 585 | + } |
|
| 586 | + |
|
| 587 | + /** |
|
| 588 | + * Set the recurring amount for the subscription. |
|
| 589 | + * |
|
| 590 | + * @since 1.0.19 |
|
| 591 | + * @param float $value The recurring subcription amount. |
|
| 592 | + */ |
|
| 593 | + public function set_recurring_amount( $value ) { |
|
| 594 | + $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) ); |
|
| 595 | + } |
|
| 596 | + |
|
| 597 | + /** |
|
| 598 | + * Set number of times that this subscription can be renewed. |
|
| 599 | + * |
|
| 600 | + * @since 1.0.19 |
|
| 601 | + * @param int $value Bill times. |
|
| 602 | + */ |
|
| 603 | + public function set_bill_times( $value ) { |
|
| 604 | + $this->set_prop( 'bill_times', (int) $value ); |
|
| 605 | + } |
|
| 606 | + |
|
| 607 | + /** |
|
| 608 | + * Get transaction id of this subscription's parent invoice. |
|
| 609 | + * |
|
| 610 | + * @since 1.0.19 |
|
| 611 | + * @param string $value Bill times. |
|
| 612 | + */ |
|
| 613 | + public function set_transaction_id( $value ) { |
|
| 614 | + $this->set_prop( 'transaction_id', sanitize_text_field( $value ) ); |
|
| 615 | + } |
|
| 616 | + |
|
| 617 | + /** |
|
| 618 | + * Set date when this subscription started. |
|
| 619 | + * |
|
| 620 | + * @since 1.0.19 |
|
| 621 | + * @param string $value strtotime compliant date. |
|
| 622 | + */ |
|
| 623 | + public function set_created( $value ) { |
|
| 624 | + $date = strtotime( $value ); |
|
| 625 | + |
|
| 626 | + if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 627 | + $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) ); |
|
| 628 | + return; |
|
| 629 | + } |
|
| 630 | + |
|
| 631 | + $this->set_prop( 'created', '' ); |
|
| 229 | 632 | |
| 230 | - /** |
|
| 231 | - * Alias for self::get_parent_invoice_id(). |
|
| 633 | + } |
|
| 634 | + |
|
| 635 | + /** |
|
| 636 | + * Alias for self::set_created(). |
|
| 232 | 637 | * |
| 233 | - * @since 1.0.0 |
|
| 234 | - * @return int |
|
| 638 | + * @since 1.0.19 |
|
| 639 | + * @param string $value strtotime compliant date. |
|
| 235 | 640 | */ |
| 236 | - public function get_original_payment_id( $context = 'view' ) { |
|
| 237 | - return $this->get_parent_invoice_id( $context ); |
|
| 641 | + public function set_date_created( $value ) { |
|
| 642 | + $this->set_created( $value ); |
|
| 238 | 643 | } |
| 239 | 644 | |
| 240 | - /** |
|
| 241 | - * Get parent invoice. |
|
| 242 | - * |
|
| 243 | - * @since 1.0.19 |
|
| 244 | - * @param string $context View or edit context. |
|
| 245 | - * @return WPInv_Invoice |
|
| 246 | - */ |
|
| 247 | - public function get_parent_invoice( $context = 'view' ) { |
|
| 248 | - return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) ); |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - /** |
|
| 252 | - * Alias for self::get_parent_invoice(). |
|
| 253 | - * |
|
| 254 | - * @since 1.0.19 |
|
| 255 | - * @param string $context View or edit context. |
|
| 256 | - * @return WPInv_Invoice |
|
| 257 | - */ |
|
| 258 | - public function get_parent_payment( $context = 'view' ) { |
|
| 259 | - return $this->get_parent_invoice( $context ); |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - /** |
|
| 263 | - * Get subscription's product id. |
|
| 264 | - * |
|
| 265 | - * @since 1.0.19 |
|
| 266 | - * @param string $context View or edit context. |
|
| 267 | - * @return int |
|
| 268 | - */ |
|
| 269 | - public function get_product_id( $context = 'view' ) { |
|
| 270 | - return (int) $this->get_prop( 'product_id', $context ); |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - /** |
|
| 274 | - * Get the subscription product. |
|
| 275 | - * |
|
| 276 | - * @since 1.0.19 |
|
| 277 | - * @param string $context View or edit context. |
|
| 278 | - * @return WPInv_Item |
|
| 279 | - */ |
|
| 280 | - public function get_product( $context = 'view' ) { |
|
| 281 | - return new WPInv_Item( $this->get_product_id( $context ) ); |
|
| 282 | - } |
|
| 283 | - |
|
| 284 | - /** |
|
| 285 | - * Get parent invoice's gateway. |
|
| 286 | - * |
|
| 287 | - * Here for backwards compatibility. |
|
| 288 | - * |
|
| 289 | - * @since 1.0.19 |
|
| 290 | - * @param string $context View or edit context. |
|
| 291 | - * @return string |
|
| 292 | - */ |
|
| 293 | - public function get_gateway( $context = 'view' ) { |
|
| 294 | - return $this->get_parent_invoice( $context )->get_gateway(); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Get the period of a renewal. |
|
| 299 | - * |
|
| 300 | - * @since 1.0.19 |
|
| 301 | - * @param string $context View or edit context. |
|
| 302 | - * @return string |
|
| 303 | - */ |
|
| 304 | - public function get_period( $context = 'view' ) { |
|
| 305 | - return $this->get_prop( 'period', $context ); |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * Get number of periods each renewal is valid for. |
|
| 310 | - * |
|
| 311 | - * @since 1.0.19 |
|
| 312 | - * @param string $context View or edit context. |
|
| 313 | - * @return int |
|
| 314 | - */ |
|
| 315 | - public function get_frequency( $context = 'view' ) { |
|
| 316 | - return (int) $this->get_prop( 'frequency', $context ); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - /** |
|
| 320 | - * Get the initial amount for the subscription. |
|
| 321 | - * |
|
| 322 | - * @since 1.0.19 |
|
| 323 | - * @param string $context View or edit context. |
|
| 324 | - * @return float |
|
| 325 | - */ |
|
| 326 | - public function get_initial_amount( $context = 'view' ) { |
|
| 327 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) ); |
|
| 328 | - } |
|
| 329 | - |
|
| 330 | - /** |
|
| 331 | - * Get the recurring amount for the subscription. |
|
| 332 | - * |
|
| 333 | - * @since 1.0.19 |
|
| 334 | - * @param string $context View or edit context. |
|
| 335 | - * @return float |
|
| 336 | - */ |
|
| 337 | - public function get_recurring_amount( $context = 'view' ) { |
|
| 338 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) ); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - /** |
|
| 342 | - * Get number of times that this subscription can be renewed. |
|
| 343 | - * |
|
| 344 | - * @since 1.0.19 |
|
| 345 | - * @param string $context View or edit context. |
|
| 346 | - * @return int |
|
| 347 | - */ |
|
| 348 | - public function get_bill_times( $context = 'view' ) { |
|
| 349 | - return (int) $this->get_prop( 'bill_times', $context ); |
|
| 350 | - } |
|
| 351 | - |
|
| 352 | - /** |
|
| 353 | - * Get transaction id of this subscription's parent invoice. |
|
| 354 | - * |
|
| 355 | - * @since 1.0.19 |
|
| 356 | - * @param string $context View or edit context. |
|
| 357 | - * @return string |
|
| 358 | - */ |
|
| 359 | - public function get_transaction_id( $context = 'view' ) { |
|
| 360 | - return $this->get_prop( 'transaction_id', $context ); |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - /** |
|
| 364 | - * Get the date that the subscription was created. |
|
| 365 | - * |
|
| 366 | - * @since 1.0.19 |
|
| 367 | - * @param string $context View or edit context. |
|
| 368 | - * @return string |
|
| 369 | - */ |
|
| 370 | - public function get_created( $context = 'view' ) { |
|
| 371 | - return $this->get_prop( 'created', $context ); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - /** |
|
| 375 | - * Alias for self::get_created(). |
|
| 376 | - * |
|
| 377 | - * @since 1.0.19 |
|
| 378 | - * @param string $context View or edit context. |
|
| 379 | - * @return string |
|
| 380 | - */ |
|
| 381 | - public function get_date_created( $context = 'view' ) { |
|
| 382 | - return $this->get_created( $context ); |
|
| 383 | - } |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * Retrieves the creation date in a timestamp |
|
| 387 | - * |
|
| 388 | - * @since 1.0.0 |
|
| 389 | - * @return int |
|
| 390 | - */ |
|
| 391 | - public function get_time_created() { |
|
| 392 | - $created = $this->get_date_created(); |
|
| 393 | - return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) ); |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - /** |
|
| 397 | - * Get GMT date when the subscription was created. |
|
| 398 | - * |
|
| 399 | - * @since 1.0.19 |
|
| 400 | - * @param string $context View or edit context. |
|
| 401 | - * @return string |
|
| 402 | - */ |
|
| 403 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 404 | - $date = $this->get_date_created( $context ); |
|
| 645 | + /** |
|
| 646 | + * Set the date that the subscription will renew. |
|
| 647 | + * |
|
| 648 | + * @since 1.0.19 |
|
| 649 | + * @param string $value strtotime compliant date. |
|
| 650 | + */ |
|
| 651 | + public function set_next_renewal_date( $value ) { |
|
| 652 | + $date = strtotime( $value ); |
|
| 405 | 653 | |
| 406 | - if ( $date ) { |
|
| 407 | - $date = get_gmt_from_date( $date ); |
|
| 654 | + if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 655 | + $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) ); |
|
| 656 | + return; |
|
| 408 | 657 | } |
| 409 | - return $date; |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - /** |
|
| 413 | - * Get the date that the subscription will renew. |
|
| 414 | - * |
|
| 415 | - * @since 1.0.19 |
|
| 416 | - * @param string $context View or edit context. |
|
| 417 | - * @return string |
|
| 418 | - */ |
|
| 419 | - public function get_next_renewal_date( $context = 'view' ) { |
|
| 420 | - return $this->get_prop( 'expiration', $context ); |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * Alias for self::get_next_renewal_date(). |
|
| 425 | - * |
|
| 426 | - * @since 1.0.19 |
|
| 427 | - * @param string $context View or edit context. |
|
| 428 | - * @return string |
|
| 429 | - */ |
|
| 430 | - public function get_expiration( $context = 'view' ) { |
|
| 431 | - return $this->get_next_renewal_date( $context ); |
|
| 432 | - } |
|
| 433 | - |
|
| 434 | - /** |
|
| 435 | - * Retrieves the expiration date in a timestamp |
|
| 436 | - * |
|
| 437 | - * @since 1.0.0 |
|
| 438 | - * @return int |
|
| 439 | - */ |
|
| 440 | - public function get_expiration_time() { |
|
| 441 | - $expiration = $this->get_expiration(); |
|
| 442 | - |
|
| 443 | - if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) { |
|
| 444 | - return current_time( 'timestamp' ); |
|
| 445 | - } |
|
| 446 | - |
|
| 447 | - $expiration = strtotime( $expiration, current_time( 'timestamp' ) ); |
|
| 448 | - return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration; |
|
| 449 | - } |
|
| 450 | - |
|
| 451 | - /** |
|
| 452 | - * Get GMT date when the subscription will renew. |
|
| 453 | - * |
|
| 454 | - * @since 1.0.19 |
|
| 455 | - * @param string $context View or edit context. |
|
| 456 | - * @return string |
|
| 457 | - */ |
|
| 458 | - public function get_next_renewal_date_gmt( $context = 'view' ) { |
|
| 459 | - $date = $this->get_next_renewal_date( $context ); |
|
| 460 | 658 | |
| 461 | - if ( $date ) { |
|
| 462 | - $date = get_gmt_from_date( $date ); |
|
| 463 | - } |
|
| 464 | - return $date; |
|
| 465 | - } |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * Get the subscription's trial period. |
|
| 469 | - * |
|
| 470 | - * @since 1.0.19 |
|
| 471 | - * @param string $context View or edit context. |
|
| 472 | - * @return string |
|
| 473 | - */ |
|
| 474 | - public function get_trial_period( $context = 'view' ) { |
|
| 475 | - return $this->get_prop( 'trial_period', $context ); |
|
| 476 | - } |
|
| 477 | - |
|
| 478 | - /** |
|
| 479 | - * Get the subscription's status. |
|
| 480 | - * |
|
| 481 | - * @since 1.0.19 |
|
| 482 | - * @param string $context View or edit context. |
|
| 483 | - * @return string |
|
| 484 | - */ |
|
| 485 | - public function get_status( $context = 'view' ) { |
|
| 486 | - return $this->get_prop( 'status', $context ); |
|
| 487 | - } |
|
| 488 | - |
|
| 489 | - /** |
|
| 490 | - * Get the subscription's profile id. |
|
| 491 | - * |
|
| 492 | - * @since 1.0.19 |
|
| 493 | - * @param string $context View or edit context. |
|
| 494 | - * @return string |
|
| 495 | - */ |
|
| 496 | - public function get_profile_id( $context = 'view' ) { |
|
| 497 | - return $this->get_prop( 'profile_id', $context ); |
|
| 498 | - } |
|
| 499 | - |
|
| 500 | - /* |
|
| 501 | - |-------------------------------------------------------------------------- |
|
| 502 | - | Setters |
|
| 503 | - |-------------------------------------------------------------------------- |
|
| 504 | - */ |
|
| 659 | + $this->set_prop( 'expiration', '' ); |
|
| 505 | 660 | |
| 506 | - /** |
|
| 507 | - * Set customer id. |
|
| 508 | - * |
|
| 509 | - * @since 1.0.19 |
|
| 510 | - * @param int $value The customer's id. |
|
| 511 | - */ |
|
| 512 | - public function set_customer_id( $value ) { |
|
| 513 | - $this->set_prop( 'customer_id', (int) $value ); |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - /** |
|
| 517 | - * Set parent invoice id. |
|
| 518 | - * |
|
| 519 | - * @since 1.0.19 |
|
| 520 | - * @param int $value The parent invoice id. |
|
| 521 | - */ |
|
| 522 | - public function set_parent_invoice_id( $value ) { |
|
| 523 | - $this->set_prop( 'parent_payment_id', (int) $value ); |
|
| 524 | - } |
|
| 525 | - |
|
| 526 | - /** |
|
| 527 | - * Alias for self::set_parent_invoice_id(). |
|
| 528 | - * |
|
| 529 | - * @since 1.0.19 |
|
| 530 | - * @param int $value The parent invoice id. |
|
| 531 | - */ |
|
| 532 | - public function set_parent_payment_id( $value ) { |
|
| 533 | - $this->set_parent_invoice_id( $value ); |
|
| 534 | - } |
|
| 661 | + } |
|
| 535 | 662 | |
| 536 | - /** |
|
| 537 | - * Alias for self::set_parent_invoice_id(). |
|
| 663 | + /** |
|
| 664 | + * Alias for self::set_next_renewal_date(). |
|
| 538 | 665 | * |
| 539 | 666 | * @since 1.0.19 |
| 540 | - * @param int $value The parent invoice id. |
|
| 667 | + * @param string $value strtotime compliant date. |
|
| 541 | 668 | */ |
| 542 | - public function set_original_payment_id( $value ) { |
|
| 543 | - $this->set_parent_invoice_id( $value ); |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * Set subscription's product id. |
|
| 548 | - * |
|
| 549 | - * @since 1.0.19 |
|
| 550 | - * @param int $value The subscription product id. |
|
| 551 | - */ |
|
| 552 | - public function set_product_id( $value ) { |
|
| 553 | - $this->set_prop( 'product_id', (int) $value ); |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - /** |
|
| 557 | - * Set the period of a renewal. |
|
| 558 | - * |
|
| 559 | - * @since 1.0.19 |
|
| 560 | - * @param string $value The renewal period. |
|
| 561 | - */ |
|
| 562 | - public function set_period( $value ) { |
|
| 563 | - $this->set_prop( 'period', $value ); |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Set number of periods each renewal is valid for. |
|
| 568 | - * |
|
| 569 | - * @since 1.0.19 |
|
| 570 | - * @param int $value The subscription frequency. |
|
| 571 | - */ |
|
| 572 | - public function set_frequency( $value ) { |
|
| 573 | - $value = empty( $value ) ? 1 : (int) $value; |
|
| 574 | - $this->set_prop( 'frequency', absint( $value ) ); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * Set the initial amount for the subscription. |
|
| 579 | - * |
|
| 580 | - * @since 1.0.19 |
|
| 581 | - * @param float $value The initial subcription amount. |
|
| 582 | - */ |
|
| 583 | - public function set_initial_amount( $value ) { |
|
| 584 | - $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) ); |
|
| 585 | - } |
|
| 586 | - |
|
| 587 | - /** |
|
| 588 | - * Set the recurring amount for the subscription. |
|
| 589 | - * |
|
| 590 | - * @since 1.0.19 |
|
| 591 | - * @param float $value The recurring subcription amount. |
|
| 592 | - */ |
|
| 593 | - public function set_recurring_amount( $value ) { |
|
| 594 | - $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) ); |
|
| 595 | - } |
|
| 596 | - |
|
| 597 | - /** |
|
| 598 | - * Set number of times that this subscription can be renewed. |
|
| 599 | - * |
|
| 600 | - * @since 1.0.19 |
|
| 601 | - * @param int $value Bill times. |
|
| 602 | - */ |
|
| 603 | - public function set_bill_times( $value ) { |
|
| 604 | - $this->set_prop( 'bill_times', (int) $value ); |
|
| 605 | - } |
|
| 606 | - |
|
| 607 | - /** |
|
| 608 | - * Get transaction id of this subscription's parent invoice. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.19 |
|
| 611 | - * @param string $value Bill times. |
|
| 612 | - */ |
|
| 613 | - public function set_transaction_id( $value ) { |
|
| 614 | - $this->set_prop( 'transaction_id', sanitize_text_field( $value ) ); |
|
| 615 | - } |
|
| 616 | - |
|
| 617 | - /** |
|
| 618 | - * Set date when this subscription started. |
|
| 619 | - * |
|
| 620 | - * @since 1.0.19 |
|
| 621 | - * @param string $value strtotime compliant date. |
|
| 622 | - */ |
|
| 623 | - public function set_created( $value ) { |
|
| 624 | - $date = strtotime( $value ); |
|
| 669 | + public function set_expiration( $value ) { |
|
| 670 | + $this->set_next_renewal_date( $value ); |
|
| 671 | + } |
|
| 625 | 672 | |
| 626 | - if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 627 | - $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) ); |
|
| 673 | + /** |
|
| 674 | + * Set the subscription's trial period. |
|
| 675 | + * |
|
| 676 | + * @since 1.0.19 |
|
| 677 | + * @param string $value trial period e.g 1 year. |
|
| 678 | + */ |
|
| 679 | + public function set_trial_period( $value ) { |
|
| 680 | + $this->set_prop( 'trial_period', $value ); |
|
| 681 | + } |
|
| 682 | + |
|
| 683 | + /** |
|
| 684 | + * Set the subscription's status. |
|
| 685 | + * |
|
| 686 | + * @since 1.0.19 |
|
| 687 | + * @param string $new_status New subscription status. |
|
| 688 | + */ |
|
| 689 | + public function set_status( $new_status ) { |
|
| 690 | + |
|
| 691 | + // Abort if this is not a valid status; |
|
| 692 | + if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) { |
|
| 628 | 693 | return; |
| 629 | 694 | } |
| 630 | 695 | |
| 631 | - $this->set_prop( 'created', '' ); |
|
| 632 | - |
|
| 633 | - } |
|
| 696 | + $old_status = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status(); |
|
| 697 | + if ( true === $this->object_read && $old_status !== $new_status ) { |
|
| 698 | + $this->status_transition = array( |
|
| 699 | + 'from' => $old_status, |
|
| 700 | + 'to' => $new_status, |
|
| 701 | + ); |
|
| 702 | + } |
|
| 634 | 703 | |
| 635 | - /** |
|
| 636 | - * Alias for self::set_created(). |
|
| 637 | - * |
|
| 638 | - * @since 1.0.19 |
|
| 639 | - * @param string $value strtotime compliant date. |
|
| 640 | - */ |
|
| 641 | - public function set_date_created( $value ) { |
|
| 642 | - $this->set_created( $value ); |
|
| 704 | + $this->set_prop( 'status', $new_status ); |
|
| 643 | 705 | } |
| 644 | 706 | |
| 645 | - /** |
|
| 646 | - * Set the date that the subscription will renew. |
|
| 647 | - * |
|
| 648 | - * @since 1.0.19 |
|
| 649 | - * @param string $value strtotime compliant date. |
|
| 650 | - */ |
|
| 651 | - public function set_next_renewal_date( $value ) { |
|
| 652 | - $date = strtotime( $value ); |
|
| 707 | + /** |
|
| 708 | + * Set the subscription's (remote) profile id. |
|
| 709 | + * |
|
| 710 | + * @since 1.0.19 |
|
| 711 | + * @param string $value the remote profile id. |
|
| 712 | + */ |
|
| 713 | + public function set_profile_id( $value ) { |
|
| 714 | + $this->set_prop( 'profile_id', sanitize_text_field( $value ) ); |
|
| 715 | + } |
|
| 653 | 716 | |
| 654 | - if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 655 | - $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) ); |
|
| 656 | - return; |
|
| 657 | - } |
|
| 658 | - |
|
| 659 | - $this->set_prop( 'expiration', '' ); |
|
| 660 | - |
|
| 661 | - } |
|
| 662 | - |
|
| 663 | - /** |
|
| 664 | - * Alias for self::set_next_renewal_date(). |
|
| 665 | - * |
|
| 666 | - * @since 1.0.19 |
|
| 667 | - * @param string $value strtotime compliant date. |
|
| 668 | - */ |
|
| 669 | - public function set_expiration( $value ) { |
|
| 670 | - $this->set_next_renewal_date( $value ); |
|
| 671 | - } |
|
| 672 | - |
|
| 673 | - /** |
|
| 674 | - * Set the subscription's trial period. |
|
| 675 | - * |
|
| 676 | - * @since 1.0.19 |
|
| 677 | - * @param string $value trial period e.g 1 year. |
|
| 678 | - */ |
|
| 679 | - public function set_trial_period( $value ) { |
|
| 680 | - $this->set_prop( 'trial_period', $value ); |
|
| 681 | - } |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Set the subscription's status. |
|
| 685 | - * |
|
| 686 | - * @since 1.0.19 |
|
| 687 | - * @param string $new_status New subscription status. |
|
| 688 | - */ |
|
| 689 | - public function set_status( $new_status ) { |
|
| 690 | - |
|
| 691 | - // Abort if this is not a valid status; |
|
| 692 | - if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) { |
|
| 693 | - return; |
|
| 694 | - } |
|
| 695 | - |
|
| 696 | - $old_status = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status(); |
|
| 697 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
| 698 | - $this->status_transition = array( |
|
| 699 | - 'from' => $old_status, |
|
| 700 | - 'to' => $new_status, |
|
| 701 | - ); |
|
| 702 | - } |
|
| 703 | - |
|
| 704 | - $this->set_prop( 'status', $new_status ); |
|
| 705 | - } |
|
| 706 | - |
|
| 707 | - /** |
|
| 708 | - * Set the subscription's (remote) profile id. |
|
| 709 | - * |
|
| 710 | - * @since 1.0.19 |
|
| 711 | - * @param string $value the remote profile id. |
|
| 712 | - */ |
|
| 713 | - public function set_profile_id( $value ) { |
|
| 714 | - $this->set_prop( 'profile_id', sanitize_text_field( $value ) ); |
|
| 715 | - } |
|
| 716 | - |
|
| 717 | - /* |
|
| 717 | + /* |
|
| 718 | 718 | |-------------------------------------------------------------------------- |
| 719 | 719 | | Boolean methods |
| 720 | 720 | |-------------------------------------------------------------------------- |
@@ -723,55 +723,55 @@ discard block |
||
| 723 | 723 | | |
| 724 | 724 | */ |
| 725 | 725 | |
| 726 | - /** |
|
| 726 | + /** |
|
| 727 | 727 | * Checks if the subscription has a given status. |
| 728 | - * |
|
| 729 | - * @param string|array String or array of strings to check for. |
|
| 730 | - * @return bool |
|
| 728 | + * |
|
| 729 | + * @param string|array String or array of strings to check for. |
|
| 730 | + * @return bool |
|
| 731 | 731 | */ |
| 732 | 732 | public function has_status( $status ) { |
| 733 | 733 | return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) ); |
| 734 | - } |
|
| 734 | + } |
|
| 735 | 735 | |
| 736 | - /** |
|
| 736 | + /** |
|
| 737 | 737 | * Checks if the subscription has a trial period. |
| 738 | - * |
|
| 739 | - * @return bool |
|
| 738 | + * |
|
| 739 | + * @return bool |
|
| 740 | 740 | */ |
| 741 | 741 | public function has_trial_period() { |
| 742 | - $period = $this->get_trial_period(); |
|
| 742 | + $period = $this->get_trial_period(); |
|
| 743 | 743 | return ! empty( $period ); |
| 744 | - } |
|
| 745 | - |
|
| 746 | - /** |
|
| 747 | - * Is the subscription active? |
|
| 748 | - * |
|
| 749 | - * @return bool |
|
| 750 | - */ |
|
| 751 | - public function is_active() { |
|
| 752 | - return $this->has_status( 'active trialling' ) && ! $this->is_expired(); |
|
| 753 | - } |
|
| 754 | - |
|
| 755 | - /** |
|
| 756 | - * Is the subscription expired? |
|
| 757 | - * |
|
| 758 | - * @return bool |
|
| 759 | - */ |
|
| 760 | - public function is_expired() { |
|
| 761 | - return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'timestamp' ) ); |
|
| 762 | - } |
|
| 763 | - |
|
| 764 | - /** |
|
| 765 | - * Is this the last renewals? |
|
| 766 | - * |
|
| 767 | - * @return bool |
|
| 768 | - */ |
|
| 769 | - public function is_last_renewal() { |
|
| 770 | - $max_bills = $this->get_bill_times(); |
|
| 771 | - return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed(); |
|
| 772 | - } |
|
| 773 | - |
|
| 774 | - /* |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + /** |
|
| 747 | + * Is the subscription active? |
|
| 748 | + * |
|
| 749 | + * @return bool |
|
| 750 | + */ |
|
| 751 | + public function is_active() { |
|
| 752 | + return $this->has_status( 'active trialling' ) && ! $this->is_expired(); |
|
| 753 | + } |
|
| 754 | + |
|
| 755 | + /** |
|
| 756 | + * Is the subscription expired? |
|
| 757 | + * |
|
| 758 | + * @return bool |
|
| 759 | + */ |
|
| 760 | + public function is_expired() { |
|
| 761 | + return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'timestamp' ) ); |
|
| 762 | + } |
|
| 763 | + |
|
| 764 | + /** |
|
| 765 | + * Is this the last renewals? |
|
| 766 | + * |
|
| 767 | + * @return bool |
|
| 768 | + */ |
|
| 769 | + public function is_last_renewal() { |
|
| 770 | + $max_bills = $this->get_bill_times(); |
|
| 771 | + return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed(); |
|
| 772 | + } |
|
| 773 | + |
|
| 774 | + /* |
|
| 775 | 775 | |-------------------------------------------------------------------------- |
| 776 | 776 | | Additional methods |
| 777 | 777 | |-------------------------------------------------------------------------- |
@@ -780,27 +780,27 @@ discard block |
||
| 780 | 780 | | |
| 781 | 781 | */ |
| 782 | 782 | |
| 783 | - /** |
|
| 784 | - * Backwards compatibilty. |
|
| 785 | - */ |
|
| 786 | - public function create( $data = array() ) { |
|
| 783 | + /** |
|
| 784 | + * Backwards compatibilty. |
|
| 785 | + */ |
|
| 786 | + public function create( $data = array() ) { |
|
| 787 | 787 | |
| 788 | - // Set the properties. |
|
| 789 | - if ( is_array( $data ) ) { |
|
| 790 | - $this->set_props( $data ); |
|
| 791 | - } |
|
| 788 | + // Set the properties. |
|
| 789 | + if ( is_array( $data ) ) { |
|
| 790 | + $this->set_props( $data ); |
|
| 791 | + } |
|
| 792 | 792 | |
| 793 | - // Save the item. |
|
| 794 | - return $this->save(); |
|
| 793 | + // Save the item. |
|
| 794 | + return $this->save(); |
|
| 795 | 795 | |
| 796 | - } |
|
| 796 | + } |
|
| 797 | 797 | |
| 798 | - /** |
|
| 799 | - * Backwards compatibilty. |
|
| 800 | - */ |
|
| 801 | - public function update( $args = array() ) { |
|
| 802 | - return $this->create( $args ); |
|
| 803 | - } |
|
| 798 | + /** |
|
| 799 | + * Backwards compatibilty. |
|
| 800 | + */ |
|
| 801 | + public function update( $args = array() ) { |
|
| 802 | + return $this->create( $args ); |
|
| 803 | + } |
|
| 804 | 804 | |
| 805 | 805 | /** |
| 806 | 806 | * Retrieve renewal payments for a subscription |
@@ -810,22 +810,22 @@ discard block |
||
| 810 | 810 | */ |
| 811 | 811 | public function get_child_payments( $hide_pending = true ) { |
| 812 | 812 | |
| 813 | - $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' ); |
|
| 813 | + $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' ); |
|
| 814 | 814 | |
| 815 | - if ( ! $hide_pending ) { |
|
| 816 | - $statuses = array_keys( wpinv_get_invoice_statuses() ); |
|
| 817 | - } |
|
| 815 | + if ( ! $hide_pending ) { |
|
| 816 | + $statuses = array_keys( wpinv_get_invoice_statuses() ); |
|
| 817 | + } |
|
| 818 | 818 | |
| 819 | 819 | return get_posts( |
| 820 | - array( |
|
| 821 | - 'post_parent' => $this->get_parent_payment_id(), |
|
| 822 | - 'numberposts' => -1, |
|
| 823 | - 'post_status' => $statuses, |
|
| 824 | - 'orderby' => 'ID', |
|
| 825 | - 'order' => 'ASC', |
|
| 826 | - 'post_type' => 'wpi_invoice', |
|
| 827 | - ) |
|
| 828 | - ); |
|
| 820 | + array( |
|
| 821 | + 'post_parent' => $this->get_parent_payment_id(), |
|
| 822 | + 'numberposts' => -1, |
|
| 823 | + 'post_status' => $statuses, |
|
| 824 | + 'orderby' => 'ID', |
|
| 825 | + 'order' => 'ASC', |
|
| 826 | + 'post_type' => 'wpi_invoice', |
|
| 827 | + ) |
|
| 828 | + ); |
|
| 829 | 829 | } |
| 830 | 830 | |
| 831 | 831 | /** |
@@ -835,7 +835,7 @@ discard block |
||
| 835 | 835 | * @return int |
| 836 | 836 | */ |
| 837 | 837 | public function get_total_payments() { |
| 838 | - return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() ); |
|
| 838 | + return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() ); |
|
| 839 | 839 | } |
| 840 | 840 | |
| 841 | 841 | /** |
@@ -859,187 +859,187 @@ discard block |
||
| 859 | 859 | * |
| 860 | 860 | * @since 2.4 |
| 861 | 861 | * @param array $args Array of values for the payment, including amount and transaction ID |
| 862 | - * @param WPInv_Invoice $invoice If adding an existing invoice. |
|
| 862 | + * @param WPInv_Invoice $invoice If adding an existing invoice. |
|
| 863 | 863 | * @return bool |
| 864 | 864 | */ |
| 865 | 865 | public function add_payment( $args = array(), $invoice = false ) { |
| 866 | 866 | |
| 867 | - // Process each payment once. |
|
| 867 | + // Process each payment once. |
|
| 868 | 868 | if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) { |
| 869 | 869 | return false; |
| 870 | 870 | } |
| 871 | 871 | |
| 872 | - // Are we creating a new invoice? |
|
| 873 | - if ( empty( $invoice ) ) { |
|
| 874 | - $invoice = $this->create_payment( false ); |
|
| 872 | + // Are we creating a new invoice? |
|
| 873 | + if ( empty( $invoice ) ) { |
|
| 874 | + $invoice = $this->create_payment( false ); |
|
| 875 | 875 | |
| 876 | - if ( empty( $invoice ) ) { |
|
| 877 | - return false; |
|
| 878 | - } |
|
| 879 | - } |
|
| 876 | + if ( empty( $invoice ) ) { |
|
| 877 | + return false; |
|
| 878 | + } |
|
| 879 | + } |
|
| 880 | 880 | |
| 881 | - // Maybe set a transaction id. |
|
| 882 | - if ( ! empty( $args['transaction_id'] ) ) { |
|
| 883 | - $invoice->set_transaction_id( $args['transaction_id'] ); |
|
| 884 | - } |
|
| 881 | + // Maybe set a transaction id. |
|
| 882 | + if ( ! empty( $args['transaction_id'] ) ) { |
|
| 883 | + $invoice->set_transaction_id( $args['transaction_id'] ); |
|
| 884 | + } |
|
| 885 | 885 | |
| 886 | - // Set the completed date. |
|
| 887 | - $invoice->set_completed_date( current_time( 'mysql' ) ); |
|
| 886 | + // Set the completed date. |
|
| 887 | + $invoice->set_completed_date( current_time( 'mysql' ) ); |
|
| 888 | 888 | |
| 889 | - // And the gateway. |
|
| 890 | - if ( ! empty( $args['gateway'] ) ) { |
|
| 891 | - $invoice->set_gateway( $args['gateway'] ); |
|
| 892 | - } |
|
| 889 | + // And the gateway. |
|
| 890 | + if ( ! empty( $args['gateway'] ) ) { |
|
| 891 | + $invoice->set_gateway( $args['gateway'] ); |
|
| 892 | + } |
|
| 893 | 893 | |
| 894 | - $invoice->set_status( 'wpi-renewal' ); |
|
| 895 | - $invoice->save(); |
|
| 894 | + $invoice->set_status( 'wpi-renewal' ); |
|
| 895 | + $invoice->save(); |
|
| 896 | 896 | |
| 897 | - if ( ! $invoice->exists() ) { |
|
| 898 | - return false; |
|
| 899 | - } |
|
| 897 | + if ( ! $invoice->exists() ) { |
|
| 898 | + return false; |
|
| 899 | + } |
|
| 900 | 900 | |
| 901 | - do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this ); |
|
| 902 | - do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this ); |
|
| 901 | + do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this ); |
|
| 902 | + do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this ); |
|
| 903 | 903 | do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() ); |
| 904 | 904 | |
| 905 | 905 | update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id ); |
| 906 | 906 | |
| 907 | 907 | return $invoice->get_id(); |
| 908 | - } |
|
| 908 | + } |
|
| 909 | 909 | |
| 910 | - /** |
|
| 910 | + /** |
|
| 911 | 911 | * Creates a new invoice and returns it. |
| 912 | 912 | * |
| 913 | 913 | * @since 1.0.19 |
| 914 | - * @param bool $save Whether we should save the invoice. |
|
| 914 | + * @param bool $save Whether we should save the invoice. |
|
| 915 | 915 | * @return WPInv_Invoice|bool |
| 916 | 916 | */ |
| 917 | 917 | public function create_payment( $save = true ) { |
| 918 | 918 | |
| 919 | - $parent_invoice = $this->get_parent_payment(); |
|
| 920 | - |
|
| 921 | - if ( ! $parent_invoice->exists() ) { |
|
| 922 | - return false; |
|
| 923 | - } |
|
| 924 | - |
|
| 925 | - // Duplicate the parent invoice. |
|
| 926 | - $invoice = getpaid_duplicate_invoice( $parent_invoice ); |
|
| 927 | - $invoice->set_parent_id( $parent_invoice->get_id() ); |
|
| 928 | - $invoice->set_subscription_id( $this->get_id() ); |
|
| 929 | - $invoice->set_remote_subscription_id( $this->get_profile_id() ); |
|
| 930 | - |
|
| 931 | - // Set invoice items. |
|
| 932 | - $subscription_group = getpaid_get_invoice_subscription_group( $parent_invoice->get_id(), $this->get_id() ); |
|
| 933 | - $allowed_items = empty( $subscription_group ) ? array( $this->get_product_id() ) : array_keys( $subscription_group['items'] ); |
|
| 934 | - $invoice_items = array(); |
|
| 935 | - |
|
| 936 | - foreach ( $invoice->get_items() as $item ) { |
|
| 937 | - if ( in_array( $item->get_id(), $allowed_items ) ) { |
|
| 938 | - $invoice_items[] = $item; |
|
| 939 | - } |
|
| 940 | - } |
|
| 941 | - |
|
| 942 | - $invoice->set_items( $invoice_items ); |
|
| 943 | - |
|
| 944 | - if ( ! empty( $subscription_group['fees'] ) ) { |
|
| 945 | - $invoice->set_fees( $subscription_group['fees'] ); |
|
| 946 | - } |
|
| 947 | - |
|
| 948 | - // Maybe recalculate discount (Pre-GetPaid Fix). |
|
| 949 | - $discount = new WPInv_Discount( $invoice->get_discount_code() ); |
|
| 950 | - if ( $discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount() ) { |
|
| 951 | - $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) ); |
|
| 952 | - } |
|
| 953 | - |
|
| 954 | - $invoice->recalculate_total(); |
|
| 955 | - $invoice->set_status( 'wpi-pending' ); |
|
| 956 | - |
|
| 957 | - if ( ! $save ) { |
|
| 958 | - return $invoice; |
|
| 959 | - } |
|
| 960 | - |
|
| 961 | - $invoice->save(); |
|
| 962 | - |
|
| 963 | - return $invoice->exists() ? $invoice : false; |
|
| 964 | - } |
|
| 965 | - |
|
| 966 | - /** |
|
| 967 | - * Renews or completes a subscription |
|
| 968 | - * |
|
| 969 | - * @since 1.0.0 |
|
| 970 | - * @return int The subscription's id |
|
| 971 | - */ |
|
| 972 | - public function renew( $calculate_from = null ) { |
|
| 973 | - |
|
| 974 | - // Complete subscription if applicable |
|
| 975 | - if ( $this->is_last_renewal() ) { |
|
| 976 | - return $this->complete(); |
|
| 977 | - } |
|
| 978 | - |
|
| 979 | - // Calculate new expiration |
|
| 980 | - $frequency = $this->get_frequency(); |
|
| 981 | - $period = $this->get_period(); |
|
| 982 | - $calculate_from = empty( $calculate_from ) ? $this->get_expiration_time() : $calculate_from; |
|
| 983 | - $new_expiration = strtotime( "+ $frequency $period", $calculate_from ); |
|
| 984 | - |
|
| 985 | - $this->set_expiration( date( 'Y-m-d H:i:s', $new_expiration ) ); |
|
| 986 | - $this->set_status( 'active' ); |
|
| 987 | - $this->save(); |
|
| 988 | - |
|
| 989 | - do_action( 'getpaid_subscription_renewed', $this ); |
|
| 990 | - |
|
| 991 | - return $this->get_id(); |
|
| 992 | - } |
|
| 993 | - |
|
| 994 | - /** |
|
| 995 | - * Marks a subscription as completed |
|
| 996 | - * |
|
| 997 | - * Subscription is completed when the number of payments matches the billing_times field |
|
| 998 | - * |
|
| 999 | - * @since 1.0.0 |
|
| 1000 | - * @return int|bool Subscription id or false if the subscription is cancelled. |
|
| 1001 | - */ |
|
| 1002 | - public function complete() { |
|
| 1003 | - |
|
| 1004 | - // Only mark a subscription as complete if it's not already cancelled. |
|
| 1005 | - if ( $this->has_status( 'cancelled' ) ) { |
|
| 1006 | - return false; |
|
| 1007 | - } |
|
| 1008 | - |
|
| 1009 | - $this->set_status( 'completed' ); |
|
| 1010 | - return $this->save(); |
|
| 1011 | - |
|
| 1012 | - } |
|
| 1013 | - |
|
| 1014 | - /** |
|
| 1015 | - * Marks a subscription as expired |
|
| 1016 | - * |
|
| 1017 | - * @since 1.0.0 |
|
| 1018 | - * @param bool $check_expiration |
|
| 1019 | - * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future. |
|
| 1020 | - */ |
|
| 1021 | - public function expire( $check_expiration = false ) { |
|
| 1022 | - |
|
| 1023 | - if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) { |
|
| 1024 | - // Do not mark as expired since real expiration date is in the future |
|
| 1025 | - return false; |
|
| 1026 | - } |
|
| 1027 | - |
|
| 1028 | - $this->set_status( 'expired' ); |
|
| 1029 | - return $this->save(); |
|
| 1030 | - |
|
| 1031 | - } |
|
| 1032 | - |
|
| 1033 | - /** |
|
| 1034 | - * Marks a subscription as failing |
|
| 1035 | - * |
|
| 1036 | - * @since 2.4.2 |
|
| 1037 | - * @return int Subscription id. |
|
| 1038 | - */ |
|
| 1039 | - public function failing() { |
|
| 1040 | - $this->set_status( 'failing' ); |
|
| 1041 | - return $this->save(); |
|
| 1042 | - } |
|
| 919 | + $parent_invoice = $this->get_parent_payment(); |
|
| 920 | + |
|
| 921 | + if ( ! $parent_invoice->exists() ) { |
|
| 922 | + return false; |
|
| 923 | + } |
|
| 924 | + |
|
| 925 | + // Duplicate the parent invoice. |
|
| 926 | + $invoice = getpaid_duplicate_invoice( $parent_invoice ); |
|
| 927 | + $invoice->set_parent_id( $parent_invoice->get_id() ); |
|
| 928 | + $invoice->set_subscription_id( $this->get_id() ); |
|
| 929 | + $invoice->set_remote_subscription_id( $this->get_profile_id() ); |
|
| 930 | + |
|
| 931 | + // Set invoice items. |
|
| 932 | + $subscription_group = getpaid_get_invoice_subscription_group( $parent_invoice->get_id(), $this->get_id() ); |
|
| 933 | + $allowed_items = empty( $subscription_group ) ? array( $this->get_product_id() ) : array_keys( $subscription_group['items'] ); |
|
| 934 | + $invoice_items = array(); |
|
| 935 | + |
|
| 936 | + foreach ( $invoice->get_items() as $item ) { |
|
| 937 | + if ( in_array( $item->get_id(), $allowed_items ) ) { |
|
| 938 | + $invoice_items[] = $item; |
|
| 939 | + } |
|
| 940 | + } |
|
| 941 | + |
|
| 942 | + $invoice->set_items( $invoice_items ); |
|
| 943 | + |
|
| 944 | + if ( ! empty( $subscription_group['fees'] ) ) { |
|
| 945 | + $invoice->set_fees( $subscription_group['fees'] ); |
|
| 946 | + } |
|
| 947 | + |
|
| 948 | + // Maybe recalculate discount (Pre-GetPaid Fix). |
|
| 949 | + $discount = new WPInv_Discount( $invoice->get_discount_code() ); |
|
| 950 | + if ( $discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount() ) { |
|
| 951 | + $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) ); |
|
| 952 | + } |
|
| 953 | + |
|
| 954 | + $invoice->recalculate_total(); |
|
| 955 | + $invoice->set_status( 'wpi-pending' ); |
|
| 956 | + |
|
| 957 | + if ( ! $save ) { |
|
| 958 | + return $invoice; |
|
| 959 | + } |
|
| 960 | + |
|
| 961 | + $invoice->save(); |
|
| 962 | + |
|
| 963 | + return $invoice->exists() ? $invoice : false; |
|
| 964 | + } |
|
| 965 | + |
|
| 966 | + /** |
|
| 967 | + * Renews or completes a subscription |
|
| 968 | + * |
|
| 969 | + * @since 1.0.0 |
|
| 970 | + * @return int The subscription's id |
|
| 971 | + */ |
|
| 972 | + public function renew( $calculate_from = null ) { |
|
| 973 | + |
|
| 974 | + // Complete subscription if applicable |
|
| 975 | + if ( $this->is_last_renewal() ) { |
|
| 976 | + return $this->complete(); |
|
| 977 | + } |
|
| 978 | + |
|
| 979 | + // Calculate new expiration |
|
| 980 | + $frequency = $this->get_frequency(); |
|
| 981 | + $period = $this->get_period(); |
|
| 982 | + $calculate_from = empty( $calculate_from ) ? $this->get_expiration_time() : $calculate_from; |
|
| 983 | + $new_expiration = strtotime( "+ $frequency $period", $calculate_from ); |
|
| 984 | + |
|
| 985 | + $this->set_expiration( date( 'Y-m-d H:i:s', $new_expiration ) ); |
|
| 986 | + $this->set_status( 'active' ); |
|
| 987 | + $this->save(); |
|
| 988 | + |
|
| 989 | + do_action( 'getpaid_subscription_renewed', $this ); |
|
| 990 | + |
|
| 991 | + return $this->get_id(); |
|
| 992 | + } |
|
| 993 | + |
|
| 994 | + /** |
|
| 995 | + * Marks a subscription as completed |
|
| 996 | + * |
|
| 997 | + * Subscription is completed when the number of payments matches the billing_times field |
|
| 998 | + * |
|
| 999 | + * @since 1.0.0 |
|
| 1000 | + * @return int|bool Subscription id or false if the subscription is cancelled. |
|
| 1001 | + */ |
|
| 1002 | + public function complete() { |
|
| 1003 | + |
|
| 1004 | + // Only mark a subscription as complete if it's not already cancelled. |
|
| 1005 | + if ( $this->has_status( 'cancelled' ) ) { |
|
| 1006 | + return false; |
|
| 1007 | + } |
|
| 1008 | + |
|
| 1009 | + $this->set_status( 'completed' ); |
|
| 1010 | + return $this->save(); |
|
| 1011 | + |
|
| 1012 | + } |
|
| 1013 | + |
|
| 1014 | + /** |
|
| 1015 | + * Marks a subscription as expired |
|
| 1016 | + * |
|
| 1017 | + * @since 1.0.0 |
|
| 1018 | + * @param bool $check_expiration |
|
| 1019 | + * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future. |
|
| 1020 | + */ |
|
| 1021 | + public function expire( $check_expiration = false ) { |
|
| 1022 | + |
|
| 1023 | + if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) { |
|
| 1024 | + // Do not mark as expired since real expiration date is in the future |
|
| 1025 | + return false; |
|
| 1026 | + } |
|
| 1027 | + |
|
| 1028 | + $this->set_status( 'expired' ); |
|
| 1029 | + return $this->save(); |
|
| 1030 | + |
|
| 1031 | + } |
|
| 1032 | + |
|
| 1033 | + /** |
|
| 1034 | + * Marks a subscription as failing |
|
| 1035 | + * |
|
| 1036 | + * @since 2.4.2 |
|
| 1037 | + * @return int Subscription id. |
|
| 1038 | + */ |
|
| 1039 | + public function failing() { |
|
| 1040 | + $this->set_status( 'failing' ); |
|
| 1041 | + return $this->save(); |
|
| 1042 | + } |
|
| 1043 | 1043 | |
| 1044 | 1044 | /** |
| 1045 | 1045 | * Marks a subscription as cancelled |
@@ -1048,19 +1048,19 @@ discard block |
||
| 1048 | 1048 | * @return int Subscription id. |
| 1049 | 1049 | */ |
| 1050 | 1050 | public function cancel() { |
| 1051 | - $this->set_status( 'cancelled' ); |
|
| 1052 | - return $this->save(); |
|
| 1051 | + $this->set_status( 'cancelled' ); |
|
| 1052 | + return $this->save(); |
|
| 1053 | 1053 | } |
| 1054 | 1054 | |
| 1055 | - /** |
|
| 1056 | - * Determines if a subscription can be cancelled both locally and with a payment processor. |
|
| 1057 | - * |
|
| 1058 | - * @since 1.0.0 |
|
| 1059 | - * @return bool |
|
| 1060 | - */ |
|
| 1061 | - public function can_cancel() { |
|
| 1062 | - return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this ); |
|
| 1063 | - } |
|
| 1055 | + /** |
|
| 1056 | + * Determines if a subscription can be cancelled both locally and with a payment processor. |
|
| 1057 | + * |
|
| 1058 | + * @since 1.0.0 |
|
| 1059 | + * @return bool |
|
| 1060 | + */ |
|
| 1061 | + public function can_cancel() { |
|
| 1062 | + return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this ); |
|
| 1063 | + } |
|
| 1064 | 1064 | |
| 1065 | 1065 | /** |
| 1066 | 1066 | * Returns an array of subscription statuses that can be cancelled |
@@ -1073,109 +1073,109 @@ discard block |
||
| 1073 | 1073 | return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) ); |
| 1074 | 1074 | } |
| 1075 | 1075 | |
| 1076 | - /** |
|
| 1077 | - * Retrieves the URL to cancel subscription |
|
| 1078 | - * |
|
| 1079 | - * @since 1.0.0 |
|
| 1080 | - * @return string |
|
| 1081 | - */ |
|
| 1082 | - public function get_cancel_url() { |
|
| 1083 | - $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() ); |
|
| 1084 | - return apply_filters( 'wpinv_subscription_cancel_url', $url, $this ); |
|
| 1085 | - } |
|
| 1086 | - |
|
| 1087 | - /** |
|
| 1088 | - * Retrieves the URL to view a subscription |
|
| 1089 | - * |
|
| 1090 | - * @since 1.0.19 |
|
| 1091 | - * @return string |
|
| 1092 | - */ |
|
| 1093 | - public function get_view_url() { |
|
| 1094 | - |
|
| 1095 | - $url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
| 1096 | - $url = add_query_arg( 'subscription', $this->get_id(), $url ); |
|
| 1097 | - |
|
| 1098 | - return apply_filters( 'getpaid_get_subscription_view_url', $url, $this ); |
|
| 1099 | - } |
|
| 1100 | - |
|
| 1101 | - /** |
|
| 1102 | - * Determines if subscription can be manually renewed |
|
| 1103 | - * |
|
| 1104 | - * This method is filtered by payment gateways in order to return true on subscriptions |
|
| 1105 | - * that can be renewed manually |
|
| 1106 | - * |
|
| 1107 | - * @since 2.5 |
|
| 1108 | - * @return bool |
|
| 1109 | - */ |
|
| 1110 | - public function can_renew() { |
|
| 1111 | - return apply_filters( 'wpinv_subscription_can_renew', true, $this ); |
|
| 1112 | - } |
|
| 1113 | - |
|
| 1114 | - /** |
|
| 1115 | - * Retrieves the URL to renew a subscription |
|
| 1116 | - * |
|
| 1117 | - * @since 2.5 |
|
| 1118 | - * @return string |
|
| 1119 | - */ |
|
| 1120 | - public function get_renew_url() { |
|
| 1121 | - $url = wp_nonce_url( |
|
| 1076 | + /** |
|
| 1077 | + * Retrieves the URL to cancel subscription |
|
| 1078 | + * |
|
| 1079 | + * @since 1.0.0 |
|
| 1080 | + * @return string |
|
| 1081 | + */ |
|
| 1082 | + public function get_cancel_url() { |
|
| 1083 | + $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() ); |
|
| 1084 | + return apply_filters( 'wpinv_subscription_cancel_url', $url, $this ); |
|
| 1085 | + } |
|
| 1086 | + |
|
| 1087 | + /** |
|
| 1088 | + * Retrieves the URL to view a subscription |
|
| 1089 | + * |
|
| 1090 | + * @since 1.0.19 |
|
| 1091 | + * @return string |
|
| 1092 | + */ |
|
| 1093 | + public function get_view_url() { |
|
| 1094 | + |
|
| 1095 | + $url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
| 1096 | + $url = add_query_arg( 'subscription', $this->get_id(), $url ); |
|
| 1097 | + |
|
| 1098 | + return apply_filters( 'getpaid_get_subscription_view_url', $url, $this ); |
|
| 1099 | + } |
|
| 1100 | + |
|
| 1101 | + /** |
|
| 1102 | + * Determines if subscription can be manually renewed |
|
| 1103 | + * |
|
| 1104 | + * This method is filtered by payment gateways in order to return true on subscriptions |
|
| 1105 | + * that can be renewed manually |
|
| 1106 | + * |
|
| 1107 | + * @since 2.5 |
|
| 1108 | + * @return bool |
|
| 1109 | + */ |
|
| 1110 | + public function can_renew() { |
|
| 1111 | + return apply_filters( 'wpinv_subscription_can_renew', true, $this ); |
|
| 1112 | + } |
|
| 1113 | + |
|
| 1114 | + /** |
|
| 1115 | + * Retrieves the URL to renew a subscription |
|
| 1116 | + * |
|
| 1117 | + * @since 2.5 |
|
| 1118 | + * @return string |
|
| 1119 | + */ |
|
| 1120 | + public function get_renew_url() { |
|
| 1121 | + $url = wp_nonce_url( |
|
| 1122 | 1122 | add_query_arg( |
| 1123 | 1123 | array( |
| 1124 | - 'getpaid-action' => 'renew_subscription', |
|
| 1125 | - 'sub_id' => $this->get_id, |
|
| 1124 | + 'getpaid-action' => 'renew_subscription', |
|
| 1125 | + 'sub_id' => $this->get_id, |
|
| 1126 | 1126 | ) |
| 1127 | 1127 | ), |
| 1128 | 1128 | 'getpaid-nonce' |
| 1129 | 1129 | ); |
| 1130 | - return apply_filters( 'wpinv_subscription_renew_url', $url, $this ); |
|
| 1131 | - } |
|
| 1132 | - |
|
| 1133 | - /** |
|
| 1134 | - * Determines if subscription can have their payment method updated |
|
| 1135 | - * |
|
| 1136 | - * @since 1.0.0 |
|
| 1137 | - * @return bool |
|
| 1138 | - */ |
|
| 1139 | - public function can_update() { |
|
| 1140 | - return apply_filters( 'wpinv_subscription_can_update', false, $this ); |
|
| 1141 | - } |
|
| 1142 | - |
|
| 1143 | - /** |
|
| 1144 | - * Retrieves the URL to update subscription |
|
| 1145 | - * |
|
| 1146 | - * @since 1.0.0 |
|
| 1147 | - * @return string |
|
| 1148 | - */ |
|
| 1149 | - public function get_update_url() { |
|
| 1150 | - $url = add_query_arg( |
|
| 1130 | + return apply_filters( 'wpinv_subscription_renew_url', $url, $this ); |
|
| 1131 | + } |
|
| 1132 | + |
|
| 1133 | + /** |
|
| 1134 | + * Determines if subscription can have their payment method updated |
|
| 1135 | + * |
|
| 1136 | + * @since 1.0.0 |
|
| 1137 | + * @return bool |
|
| 1138 | + */ |
|
| 1139 | + public function can_update() { |
|
| 1140 | + return apply_filters( 'wpinv_subscription_can_update', false, $this ); |
|
| 1141 | + } |
|
| 1142 | + |
|
| 1143 | + /** |
|
| 1144 | + * Retrieves the URL to update subscription |
|
| 1145 | + * |
|
| 1146 | + * @since 1.0.0 |
|
| 1147 | + * @return string |
|
| 1148 | + */ |
|
| 1149 | + public function get_update_url() { |
|
| 1150 | + $url = add_query_arg( |
|
| 1151 | 1151 | array( |
| 1152 | - 'action' => 'update', |
|
| 1153 | - 'subscription_id' => $this->get_id(), |
|
| 1152 | + 'action' => 'update', |
|
| 1153 | + 'subscription_id' => $this->get_id(), |
|
| 1154 | 1154 | ) |
| 1155 | 1155 | ); |
| 1156 | - return apply_filters( 'wpinv_subscription_update_url', $url, $this ); |
|
| 1157 | - } |
|
| 1158 | - |
|
| 1159 | - /** |
|
| 1160 | - * Retrieves the subscription status label |
|
| 1161 | - * |
|
| 1162 | - * @since 1.0.0 |
|
| 1163 | - * @return string |
|
| 1164 | - */ |
|
| 1165 | - public function get_status_label() { |
|
| 1166 | - return getpaid_get_subscription_status_label( $this->get_status() ); |
|
| 1167 | - } |
|
| 1168 | - |
|
| 1169 | - /** |
|
| 1170 | - * Retrieves the subscription status class |
|
| 1171 | - * |
|
| 1172 | - * @since 1.0.19 |
|
| 1173 | - * @return string |
|
| 1174 | - */ |
|
| 1175 | - public function get_status_class() { |
|
| 1176 | - $statuses = getpaid_get_subscription_status_classes(); |
|
| 1177 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
| 1178 | - } |
|
| 1156 | + return apply_filters( 'wpinv_subscription_update_url', $url, $this ); |
|
| 1157 | + } |
|
| 1158 | + |
|
| 1159 | + /** |
|
| 1160 | + * Retrieves the subscription status label |
|
| 1161 | + * |
|
| 1162 | + * @since 1.0.0 |
|
| 1163 | + * @return string |
|
| 1164 | + */ |
|
| 1165 | + public function get_status_label() { |
|
| 1166 | + return getpaid_get_subscription_status_label( $this->get_status() ); |
|
| 1167 | + } |
|
| 1168 | + |
|
| 1169 | + /** |
|
| 1170 | + * Retrieves the subscription status class |
|
| 1171 | + * |
|
| 1172 | + * @since 1.0.19 |
|
| 1173 | + * @return string |
|
| 1174 | + */ |
|
| 1175 | + public function get_status_class() { |
|
| 1176 | + $statuses = getpaid_get_subscription_status_classes(); |
|
| 1177 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
| 1178 | + } |
|
| 1179 | 1179 | |
| 1180 | 1180 | /** |
| 1181 | 1181 | * Retrieves the subscription status label |
@@ -1185,11 +1185,11 @@ discard block |
||
| 1185 | 1185 | */ |
| 1186 | 1186 | public function get_status_label_html() { |
| 1187 | 1187 | |
| 1188 | - $status_label = sanitize_text_field( $this->get_status_label() ); |
|
| 1189 | - $class = esc_attr( $this->get_status_class() ); |
|
| 1190 | - $status = sanitize_html_class( $this->get_status() ); |
|
| 1188 | + $status_label = sanitize_text_field( $this->get_status_label() ); |
|
| 1189 | + $class = esc_attr( $this->get_status_class() ); |
|
| 1190 | + $status = sanitize_html_class( $this->get_status() ); |
|
| 1191 | 1191 | |
| 1192 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
| 1192 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
| 1193 | 1193 | } |
| 1194 | 1194 | |
| 1195 | 1195 | /** |
@@ -1200,75 +1200,75 @@ discard block |
||
| 1200 | 1200 | * @return bool |
| 1201 | 1201 | */ |
| 1202 | 1202 | public function payment_exists( $txn_id = '' ) { |
| 1203 | - $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' ); |
|
| 1203 | + $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' ); |
|
| 1204 | 1204 | return ! empty( $invoice_id ); |
| 1205 | - } |
|
| 1206 | - |
|
| 1207 | - /** |
|
| 1208 | - * Handle the status transition. |
|
| 1209 | - */ |
|
| 1210 | - protected function status_transition() { |
|
| 1211 | - $status_transition = $this->status_transition; |
|
| 1212 | - |
|
| 1213 | - // Reset status transition variable. |
|
| 1214 | - $this->status_transition = false; |
|
| 1215 | - |
|
| 1216 | - if ( $status_transition ) { |
|
| 1217 | - try { |
|
| 1218 | - |
|
| 1219 | - // Fire a hook for the status change. |
|
| 1220 | - do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition ); |
|
| 1221 | - do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition ); |
|
| 1222 | - |
|
| 1223 | - if ( ! empty( $status_transition['from'] ) ) { |
|
| 1224 | - |
|
| 1225 | - /* translators: 1: old subscription status 2: new subscription status */ |
|
| 1226 | - $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1227 | - |
|
| 1228 | - // Note the transition occurred. |
|
| 1229 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1230 | - |
|
| 1231 | - // Fire another hook. |
|
| 1232 | - do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this ); |
|
| 1233 | - do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 1234 | - |
|
| 1235 | - } else { |
|
| 1236 | - /* translators: %s: new invoice status */ |
|
| 1237 | - $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1238 | - |
|
| 1239 | - // Note the transition occurred. |
|
| 1240 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1241 | - |
|
| 1242 | - } |
|
| 1243 | - } catch ( Exception $e ) { |
|
| 1244 | - $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 1245 | - } |
|
| 1246 | - } |
|
| 1247 | - |
|
| 1248 | - } |
|
| 1249 | - |
|
| 1250 | - /** |
|
| 1251 | - * Save data to the database. |
|
| 1252 | - * |
|
| 1253 | - * @since 1.0.19 |
|
| 1254 | - * @return int subscription ID |
|
| 1255 | - */ |
|
| 1256 | - public function save() { |
|
| 1257 | - parent::save(); |
|
| 1258 | - $this->status_transition(); |
|
| 1259 | - return $this->get_id(); |
|
| 1260 | - } |
|
| 1261 | - |
|
| 1262 | - /** |
|
| 1263 | - * Activates a subscription. |
|
| 1264 | - * |
|
| 1265 | - * @since 1.0.19 |
|
| 1266 | - * @return int subscription ID |
|
| 1267 | - */ |
|
| 1268 | - public function activate() { |
|
| 1269 | - $status = 'trialling' === $this->get_status() ? 'trialling' : 'active'; |
|
| 1270 | - $this->set_status( $status ); |
|
| 1271 | - return $this->save(); |
|
| 1272 | - } |
|
| 1205 | + } |
|
| 1206 | + |
|
| 1207 | + /** |
|
| 1208 | + * Handle the status transition. |
|
| 1209 | + */ |
|
| 1210 | + protected function status_transition() { |
|
| 1211 | + $status_transition = $this->status_transition; |
|
| 1212 | + |
|
| 1213 | + // Reset status transition variable. |
|
| 1214 | + $this->status_transition = false; |
|
| 1215 | + |
|
| 1216 | + if ( $status_transition ) { |
|
| 1217 | + try { |
|
| 1218 | + |
|
| 1219 | + // Fire a hook for the status change. |
|
| 1220 | + do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition ); |
|
| 1221 | + do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition ); |
|
| 1222 | + |
|
| 1223 | + if ( ! empty( $status_transition['from'] ) ) { |
|
| 1224 | + |
|
| 1225 | + /* translators: 1: old subscription status 2: new subscription status */ |
|
| 1226 | + $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1227 | + |
|
| 1228 | + // Note the transition occurred. |
|
| 1229 | + $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1230 | + |
|
| 1231 | + // Fire another hook. |
|
| 1232 | + do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this ); |
|
| 1233 | + do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 1234 | + |
|
| 1235 | + } else { |
|
| 1236 | + /* translators: %s: new invoice status */ |
|
| 1237 | + $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1238 | + |
|
| 1239 | + // Note the transition occurred. |
|
| 1240 | + $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1241 | + |
|
| 1242 | + } |
|
| 1243 | + } catch ( Exception $e ) { |
|
| 1244 | + $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 1245 | + } |
|
| 1246 | + } |
|
| 1247 | + |
|
| 1248 | + } |
|
| 1249 | + |
|
| 1250 | + /** |
|
| 1251 | + * Save data to the database. |
|
| 1252 | + * |
|
| 1253 | + * @since 1.0.19 |
|
| 1254 | + * @return int subscription ID |
|
| 1255 | + */ |
|
| 1256 | + public function save() { |
|
| 1257 | + parent::save(); |
|
| 1258 | + $this->status_transition(); |
|
| 1259 | + return $this->get_id(); |
|
| 1260 | + } |
|
| 1261 | + |
|
| 1262 | + /** |
|
| 1263 | + * Activates a subscription. |
|
| 1264 | + * |
|
| 1265 | + * @since 1.0.19 |
|
| 1266 | + * @return int subscription ID |
|
| 1267 | + */ |
|
| 1268 | + public function activate() { |
|
| 1269 | + $status = 'trialling' === $this->get_status() ? 'trialling' : 'active'; |
|
| 1270 | + $this->set_status( $status ); |
|
| 1271 | + return $this->save(); |
|
| 1272 | + } |
|
| 1273 | 1273 | |
| 1274 | 1274 | } |
@@ -6,7 +6,7 @@ discard block |
||
| 6 | 6 | * @package Invoicing |
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | -defined( 'ABSPATH' ) || exit; |
|
| 9 | +defined('ABSPATH') || exit; |
|
| 10 | 10 | |
| 11 | 11 | /** |
| 12 | 12 | * The Subscription Class |
@@ -68,27 +68,27 @@ discard block |
||
| 68 | 68 | * @param int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read. |
| 69 | 69 | * @param bool $deprecated |
| 70 | 70 | */ |
| 71 | - function __construct( $subscription = 0, $deprecated = false ) { |
|
| 71 | + function __construct($subscription = 0, $deprecated = false) { |
|
| 72 | 72 | |
| 73 | - parent::__construct( $subscription ); |
|
| 73 | + parent::__construct($subscription); |
|
| 74 | 74 | |
| 75 | - if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) { |
|
| 76 | - $this->set_id( $subscription ); |
|
| 77 | - } elseif ( $subscription instanceof self ) { |
|
| 78 | - $this->set_id( $subscription->get_id() ); |
|
| 79 | - } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) { |
|
| 80 | - $this->set_id( $subscription_id ); |
|
| 81 | - } elseif ( ! empty( $subscription->id ) ) { |
|
| 82 | - $this->set_id( $subscription->id ); |
|
| 75 | + if (!$deprecated && !empty($subscription) && is_numeric($subscription)) { |
|
| 76 | + $this->set_id($subscription); |
|
| 77 | + } elseif ($subscription instanceof self) { |
|
| 78 | + $this->set_id($subscription->get_id()); |
|
| 79 | + } elseif ($deprecated && $subscription_id = self::get_subscription_id_by_field($subscription, 'profile_id')) { |
|
| 80 | + $this->set_id($subscription_id); |
|
| 81 | + } elseif (!empty($subscription->id)) { |
|
| 82 | + $this->set_id($subscription->id); |
|
| 83 | 83 | } else { |
| 84 | - $this->set_object_read( true ); |
|
| 84 | + $this->set_object_read(true); |
|
| 85 | 85 | } |
| 86 | 86 | |
| 87 | 87 | // Load the datastore. |
| 88 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 88 | + $this->data_store = GetPaid_Data_Store::load($this->data_store_name); |
|
| 89 | 89 | |
| 90 | - if ( $this->get_id() > 0 ) { |
|
| 91 | - $this->data_store->read( $this ); |
|
| 90 | + if ($this->get_id() > 0) { |
|
| 91 | + $this->data_store->read($this); |
|
| 92 | 92 | } |
| 93 | 93 | |
| 94 | 94 | } |
@@ -103,17 +103,17 @@ discard block |
||
| 103 | 103 | * @since 1.0.19 |
| 104 | 104 | * @return int |
| 105 | 105 | */ |
| 106 | - public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) { |
|
| 106 | + public static function get_subscription_id_by_field($value, $field = 'profile_id') { |
|
| 107 | 107 | global $wpdb; |
| 108 | 108 | |
| 109 | 109 | // Trim the value. |
| 110 | - $value = trim( $value ); |
|
| 110 | + $value = trim($value); |
|
| 111 | 111 | |
| 112 | - if ( empty( $value ) ) { |
|
| 112 | + if (empty($value)) { |
|
| 113 | 113 | return 0; |
| 114 | 114 | } |
| 115 | 115 | |
| 116 | - if ( 'invoice_id' == $field ) { |
|
| 116 | + if ('invoice_id' == $field) { |
|
| 117 | 117 | $field = 'parent_payment_id'; |
| 118 | 118 | } |
| 119 | 119 | |
@@ -125,28 +125,28 @@ discard block |
||
| 125 | 125 | ); |
| 126 | 126 | |
| 127 | 127 | // Ensure a field has been passed. |
| 128 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 128 | + if (empty($field) || !in_array($field, $fields)) { |
|
| 129 | 129 | return 0; |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | 132 | // Maybe retrieve from the cache. |
| 133 | - $subscription_id = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 134 | - if ( ! empty( $subscription_id ) ) { |
|
| 133 | + $subscription_id = wp_cache_get($value, "getpaid_subscription_{$field}s_to_subscription_ids"); |
|
| 134 | + if (!empty($subscription_id)) { |
|
| 135 | 135 | return $subscription_id; |
| 136 | 136 | } |
| 137 | 137 | |
| 138 | 138 | // Fetch from the db. |
| 139 | 139 | $table = $wpdb->prefix . 'wpinv_subscriptions'; |
| 140 | 140 | $subscription_id = (int) $wpdb->get_var( |
| 141 | - $wpdb->prepare( "SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
|
| 141 | + $wpdb->prepare("SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value) |
|
| 142 | 142 | ); |
| 143 | 143 | |
| 144 | - if ( empty( $subscription_id ) ) { |
|
| 144 | + if (empty($subscription_id)) { |
|
| 145 | 145 | return 0; |
| 146 | 146 | } |
| 147 | 147 | |
| 148 | 148 | // Update the cache with our data. |
| 149 | - wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 149 | + wp_cache_set($value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids"); |
|
| 150 | 150 | |
| 151 | 151 | return $subscription_id; |
| 152 | 152 | } |
@@ -155,17 +155,17 @@ discard block |
||
| 155 | 155 | * Clears the subscription's cache. |
| 156 | 156 | */ |
| 157 | 157 | public function clear_cache() { |
| 158 | - wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' ); |
|
| 159 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 160 | - wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 161 | - wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' ); |
|
| 158 | + wp_cache_delete($this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids'); |
|
| 159 | + wp_cache_delete($this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids'); |
|
| 160 | + wp_cache_delete($this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids'); |
|
| 161 | + wp_cache_delete($this->get_id(), 'getpaid_subscriptions'); |
|
| 162 | 162 | } |
| 163 | 163 | |
| 164 | 164 | /** |
| 165 | 165 | * Checks if a subscription key is set. |
| 166 | 166 | */ |
| 167 | - public function _isset( $key ) { |
|
| 168 | - return isset( $this->data[ $key ] ) || method_exists( $this, "get_$key" ); |
|
| 167 | + public function _isset($key) { |
|
| 168 | + return isset($this->data[$key]) || method_exists($this, "get_$key"); |
|
| 169 | 169 | } |
| 170 | 170 | |
| 171 | 171 | /* |
@@ -190,8 +190,8 @@ discard block |
||
| 190 | 190 | * @param string $context View or edit context. |
| 191 | 191 | * @return int |
| 192 | 192 | */ |
| 193 | - public function get_customer_id( $context = 'view' ) { |
|
| 194 | - return (int) $this->get_prop( 'customer_id', $context ); |
|
| 193 | + public function get_customer_id($context = 'view') { |
|
| 194 | + return (int) $this->get_prop('customer_id', $context); |
|
| 195 | 195 | } |
| 196 | 196 | |
| 197 | 197 | /** |
@@ -201,8 +201,8 @@ discard block |
||
| 201 | 201 | * @param string $context View or edit context. |
| 202 | 202 | * @return WP_User|false WP_User object on success, false on failure. |
| 203 | 203 | */ |
| 204 | - public function get_customer( $context = 'view' ) { |
|
| 205 | - return get_userdata( $this->get_customer_id( $context ) ); |
|
| 204 | + public function get_customer($context = 'view') { |
|
| 205 | + return get_userdata($this->get_customer_id($context)); |
|
| 206 | 206 | } |
| 207 | 207 | |
| 208 | 208 | /** |
@@ -212,8 +212,8 @@ discard block |
||
| 212 | 212 | * @param string $context View or edit context. |
| 213 | 213 | * @return int |
| 214 | 214 | */ |
| 215 | - public function get_parent_invoice_id( $context = 'view' ) { |
|
| 216 | - return (int) $this->get_prop( 'parent_payment_id', $context ); |
|
| 215 | + public function get_parent_invoice_id($context = 'view') { |
|
| 216 | + return (int) $this->get_prop('parent_payment_id', $context); |
|
| 217 | 217 | } |
| 218 | 218 | |
| 219 | 219 | /** |
@@ -223,8 +223,8 @@ discard block |
||
| 223 | 223 | * @param string $context View or edit context. |
| 224 | 224 | * @return int |
| 225 | 225 | */ |
| 226 | - public function get_parent_payment_id( $context = 'view' ) { |
|
| 227 | - return $this->get_parent_invoice_id( $context ); |
|
| 226 | + public function get_parent_payment_id($context = 'view') { |
|
| 227 | + return $this->get_parent_invoice_id($context); |
|
| 228 | 228 | } |
| 229 | 229 | |
| 230 | 230 | /** |
@@ -233,8 +233,8 @@ discard block |
||
| 233 | 233 | * @since 1.0.0 |
| 234 | 234 | * @return int |
| 235 | 235 | */ |
| 236 | - public function get_original_payment_id( $context = 'view' ) { |
|
| 237 | - return $this->get_parent_invoice_id( $context ); |
|
| 236 | + public function get_original_payment_id($context = 'view') { |
|
| 237 | + return $this->get_parent_invoice_id($context); |
|
| 238 | 238 | } |
| 239 | 239 | |
| 240 | 240 | /** |
@@ -244,8 +244,8 @@ discard block |
||
| 244 | 244 | * @param string $context View or edit context. |
| 245 | 245 | * @return WPInv_Invoice |
| 246 | 246 | */ |
| 247 | - public function get_parent_invoice( $context = 'view' ) { |
|
| 248 | - return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) ); |
|
| 247 | + public function get_parent_invoice($context = 'view') { |
|
| 248 | + return new WPInv_Invoice($this->get_parent_invoice_id($context)); |
|
| 249 | 249 | } |
| 250 | 250 | |
| 251 | 251 | /** |
@@ -255,8 +255,8 @@ discard block |
||
| 255 | 255 | * @param string $context View or edit context. |
| 256 | 256 | * @return WPInv_Invoice |
| 257 | 257 | */ |
| 258 | - public function get_parent_payment( $context = 'view' ) { |
|
| 259 | - return $this->get_parent_invoice( $context ); |
|
| 258 | + public function get_parent_payment($context = 'view') { |
|
| 259 | + return $this->get_parent_invoice($context); |
|
| 260 | 260 | } |
| 261 | 261 | |
| 262 | 262 | /** |
@@ -266,8 +266,8 @@ discard block |
||
| 266 | 266 | * @param string $context View or edit context. |
| 267 | 267 | * @return int |
| 268 | 268 | */ |
| 269 | - public function get_product_id( $context = 'view' ) { |
|
| 270 | - return (int) $this->get_prop( 'product_id', $context ); |
|
| 269 | + public function get_product_id($context = 'view') { |
|
| 270 | + return (int) $this->get_prop('product_id', $context); |
|
| 271 | 271 | } |
| 272 | 272 | |
| 273 | 273 | /** |
@@ -277,8 +277,8 @@ discard block |
||
| 277 | 277 | * @param string $context View or edit context. |
| 278 | 278 | * @return WPInv_Item |
| 279 | 279 | */ |
| 280 | - public function get_product( $context = 'view' ) { |
|
| 281 | - return new WPInv_Item( $this->get_product_id( $context ) ); |
|
| 280 | + public function get_product($context = 'view') { |
|
| 281 | + return new WPInv_Item($this->get_product_id($context)); |
|
| 282 | 282 | } |
| 283 | 283 | |
| 284 | 284 | /** |
@@ -290,8 +290,8 @@ discard block |
||
| 290 | 290 | * @param string $context View or edit context. |
| 291 | 291 | * @return string |
| 292 | 292 | */ |
| 293 | - public function get_gateway( $context = 'view' ) { |
|
| 294 | - return $this->get_parent_invoice( $context )->get_gateway(); |
|
| 293 | + public function get_gateway($context = 'view') { |
|
| 294 | + return $this->get_parent_invoice($context)->get_gateway(); |
|
| 295 | 295 | } |
| 296 | 296 | |
| 297 | 297 | /** |
@@ -301,8 +301,8 @@ discard block |
||
| 301 | 301 | * @param string $context View or edit context. |
| 302 | 302 | * @return string |
| 303 | 303 | */ |
| 304 | - public function get_period( $context = 'view' ) { |
|
| 305 | - return $this->get_prop( 'period', $context ); |
|
| 304 | + public function get_period($context = 'view') { |
|
| 305 | + return $this->get_prop('period', $context); |
|
| 306 | 306 | } |
| 307 | 307 | |
| 308 | 308 | /** |
@@ -312,8 +312,8 @@ discard block |
||
| 312 | 312 | * @param string $context View or edit context. |
| 313 | 313 | * @return int |
| 314 | 314 | */ |
| 315 | - public function get_frequency( $context = 'view' ) { |
|
| 316 | - return (int) $this->get_prop( 'frequency', $context ); |
|
| 315 | + public function get_frequency($context = 'view') { |
|
| 316 | + return (int) $this->get_prop('frequency', $context); |
|
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | /** |
@@ -323,8 +323,8 @@ discard block |
||
| 323 | 323 | * @param string $context View or edit context. |
| 324 | 324 | * @return float |
| 325 | 325 | */ |
| 326 | - public function get_initial_amount( $context = 'view' ) { |
|
| 327 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) ); |
|
| 326 | + public function get_initial_amount($context = 'view') { |
|
| 327 | + return (float) wpinv_sanitize_amount($this->get_prop('initial_amount', $context)); |
|
| 328 | 328 | } |
| 329 | 329 | |
| 330 | 330 | /** |
@@ -334,8 +334,8 @@ discard block |
||
| 334 | 334 | * @param string $context View or edit context. |
| 335 | 335 | * @return float |
| 336 | 336 | */ |
| 337 | - public function get_recurring_amount( $context = 'view' ) { |
|
| 338 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) ); |
|
| 337 | + public function get_recurring_amount($context = 'view') { |
|
| 338 | + return (float) wpinv_sanitize_amount($this->get_prop('recurring_amount', $context)); |
|
| 339 | 339 | } |
| 340 | 340 | |
| 341 | 341 | /** |
@@ -345,8 +345,8 @@ discard block |
||
| 345 | 345 | * @param string $context View or edit context. |
| 346 | 346 | * @return int |
| 347 | 347 | */ |
| 348 | - public function get_bill_times( $context = 'view' ) { |
|
| 349 | - return (int) $this->get_prop( 'bill_times', $context ); |
|
| 348 | + public function get_bill_times($context = 'view') { |
|
| 349 | + return (int) $this->get_prop('bill_times', $context); |
|
| 350 | 350 | } |
| 351 | 351 | |
| 352 | 352 | /** |
@@ -356,8 +356,8 @@ discard block |
||
| 356 | 356 | * @param string $context View or edit context. |
| 357 | 357 | * @return string |
| 358 | 358 | */ |
| 359 | - public function get_transaction_id( $context = 'view' ) { |
|
| 360 | - return $this->get_prop( 'transaction_id', $context ); |
|
| 359 | + public function get_transaction_id($context = 'view') { |
|
| 360 | + return $this->get_prop('transaction_id', $context); |
|
| 361 | 361 | } |
| 362 | 362 | |
| 363 | 363 | /** |
@@ -367,8 +367,8 @@ discard block |
||
| 367 | 367 | * @param string $context View or edit context. |
| 368 | 368 | * @return string |
| 369 | 369 | */ |
| 370 | - public function get_created( $context = 'view' ) { |
|
| 371 | - return $this->get_prop( 'created', $context ); |
|
| 370 | + public function get_created($context = 'view') { |
|
| 371 | + return $this->get_prop('created', $context); |
|
| 372 | 372 | } |
| 373 | 373 | |
| 374 | 374 | /** |
@@ -378,8 +378,8 @@ discard block |
||
| 378 | 378 | * @param string $context View or edit context. |
| 379 | 379 | * @return string |
| 380 | 380 | */ |
| 381 | - public function get_date_created( $context = 'view' ) { |
|
| 382 | - return $this->get_created( $context ); |
|
| 381 | + public function get_date_created($context = 'view') { |
|
| 382 | + return $this->get_created($context); |
|
| 383 | 383 | } |
| 384 | 384 | |
| 385 | 385 | /** |
@@ -390,7 +390,7 @@ discard block |
||
| 390 | 390 | */ |
| 391 | 391 | public function get_time_created() { |
| 392 | 392 | $created = $this->get_date_created(); |
| 393 | - return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) ); |
|
| 393 | + return empty($created) ? current_time('timestamp') : strtotime($created, current_time('timestamp')); |
|
| 394 | 394 | } |
| 395 | 395 | |
| 396 | 396 | /** |
@@ -400,11 +400,11 @@ discard block |
||
| 400 | 400 | * @param string $context View or edit context. |
| 401 | 401 | * @return string |
| 402 | 402 | */ |
| 403 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 404 | - $date = $this->get_date_created( $context ); |
|
| 403 | + public function get_date_created_gmt($context = 'view') { |
|
| 404 | + $date = $this->get_date_created($context); |
|
| 405 | 405 | |
| 406 | - if ( $date ) { |
|
| 407 | - $date = get_gmt_from_date( $date ); |
|
| 406 | + if ($date) { |
|
| 407 | + $date = get_gmt_from_date($date); |
|
| 408 | 408 | } |
| 409 | 409 | return $date; |
| 410 | 410 | } |
@@ -416,8 +416,8 @@ discard block |
||
| 416 | 416 | * @param string $context View or edit context. |
| 417 | 417 | * @return string |
| 418 | 418 | */ |
| 419 | - public function get_next_renewal_date( $context = 'view' ) { |
|
| 420 | - return $this->get_prop( 'expiration', $context ); |
|
| 419 | + public function get_next_renewal_date($context = 'view') { |
|
| 420 | + return $this->get_prop('expiration', $context); |
|
| 421 | 421 | } |
| 422 | 422 | |
| 423 | 423 | /** |
@@ -427,8 +427,8 @@ discard block |
||
| 427 | 427 | * @param string $context View or edit context. |
| 428 | 428 | * @return string |
| 429 | 429 | */ |
| 430 | - public function get_expiration( $context = 'view' ) { |
|
| 431 | - return $this->get_next_renewal_date( $context ); |
|
| 430 | + public function get_expiration($context = 'view') { |
|
| 431 | + return $this->get_next_renewal_date($context); |
|
| 432 | 432 | } |
| 433 | 433 | |
| 434 | 434 | /** |
@@ -440,12 +440,12 @@ discard block |
||
| 440 | 440 | public function get_expiration_time() { |
| 441 | 441 | $expiration = $this->get_expiration(); |
| 442 | 442 | |
| 443 | - if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) { |
|
| 444 | - return current_time( 'timestamp' ); |
|
| 443 | + if (empty($expiration) || '0000-00-00 00:00:00' == $expiration) { |
|
| 444 | + return current_time('timestamp'); |
|
| 445 | 445 | } |
| 446 | 446 | |
| 447 | - $expiration = strtotime( $expiration, current_time( 'timestamp' ) ); |
|
| 448 | - return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration; |
|
| 447 | + $expiration = strtotime($expiration, current_time('timestamp')); |
|
| 448 | + return $expiration < current_time('timestamp') ? current_time('timestamp') : $expiration; |
|
| 449 | 449 | } |
| 450 | 450 | |
| 451 | 451 | /** |
@@ -455,11 +455,11 @@ discard block |
||
| 455 | 455 | * @param string $context View or edit context. |
| 456 | 456 | * @return string |
| 457 | 457 | */ |
| 458 | - public function get_next_renewal_date_gmt( $context = 'view' ) { |
|
| 459 | - $date = $this->get_next_renewal_date( $context ); |
|
| 458 | + public function get_next_renewal_date_gmt($context = 'view') { |
|
| 459 | + $date = $this->get_next_renewal_date($context); |
|
| 460 | 460 | |
| 461 | - if ( $date ) { |
|
| 462 | - $date = get_gmt_from_date( $date ); |
|
| 461 | + if ($date) { |
|
| 462 | + $date = get_gmt_from_date($date); |
|
| 463 | 463 | } |
| 464 | 464 | return $date; |
| 465 | 465 | } |
@@ -471,8 +471,8 @@ discard block |
||
| 471 | 471 | * @param string $context View or edit context. |
| 472 | 472 | * @return string |
| 473 | 473 | */ |
| 474 | - public function get_trial_period( $context = 'view' ) { |
|
| 475 | - return $this->get_prop( 'trial_period', $context ); |
|
| 474 | + public function get_trial_period($context = 'view') { |
|
| 475 | + return $this->get_prop('trial_period', $context); |
|
| 476 | 476 | } |
| 477 | 477 | |
| 478 | 478 | /** |
@@ -482,8 +482,8 @@ discard block |
||
| 482 | 482 | * @param string $context View or edit context. |
| 483 | 483 | * @return string |
| 484 | 484 | */ |
| 485 | - public function get_status( $context = 'view' ) { |
|
| 486 | - return $this->get_prop( 'status', $context ); |
|
| 485 | + public function get_status($context = 'view') { |
|
| 486 | + return $this->get_prop('status', $context); |
|
| 487 | 487 | } |
| 488 | 488 | |
| 489 | 489 | /** |
@@ -493,8 +493,8 @@ discard block |
||
| 493 | 493 | * @param string $context View or edit context. |
| 494 | 494 | * @return string |
| 495 | 495 | */ |
| 496 | - public function get_profile_id( $context = 'view' ) { |
|
| 497 | - return $this->get_prop( 'profile_id', $context ); |
|
| 496 | + public function get_profile_id($context = 'view') { |
|
| 497 | + return $this->get_prop('profile_id', $context); |
|
| 498 | 498 | } |
| 499 | 499 | |
| 500 | 500 | /* |
@@ -509,8 +509,8 @@ discard block |
||
| 509 | 509 | * @since 1.0.19 |
| 510 | 510 | * @param int $value The customer's id. |
| 511 | 511 | */ |
| 512 | - public function set_customer_id( $value ) { |
|
| 513 | - $this->set_prop( 'customer_id', (int) $value ); |
|
| 512 | + public function set_customer_id($value) { |
|
| 513 | + $this->set_prop('customer_id', (int) $value); |
|
| 514 | 514 | } |
| 515 | 515 | |
| 516 | 516 | /** |
@@ -519,8 +519,8 @@ discard block |
||
| 519 | 519 | * @since 1.0.19 |
| 520 | 520 | * @param int $value The parent invoice id. |
| 521 | 521 | */ |
| 522 | - public function set_parent_invoice_id( $value ) { |
|
| 523 | - $this->set_prop( 'parent_payment_id', (int) $value ); |
|
| 522 | + public function set_parent_invoice_id($value) { |
|
| 523 | + $this->set_prop('parent_payment_id', (int) $value); |
|
| 524 | 524 | } |
| 525 | 525 | |
| 526 | 526 | /** |
@@ -529,8 +529,8 @@ discard block |
||
| 529 | 529 | * @since 1.0.19 |
| 530 | 530 | * @param int $value The parent invoice id. |
| 531 | 531 | */ |
| 532 | - public function set_parent_payment_id( $value ) { |
|
| 533 | - $this->set_parent_invoice_id( $value ); |
|
| 532 | + public function set_parent_payment_id($value) { |
|
| 533 | + $this->set_parent_invoice_id($value); |
|
| 534 | 534 | } |
| 535 | 535 | |
| 536 | 536 | /** |
@@ -539,8 +539,8 @@ discard block |
||
| 539 | 539 | * @since 1.0.19 |
| 540 | 540 | * @param int $value The parent invoice id. |
| 541 | 541 | */ |
| 542 | - public function set_original_payment_id( $value ) { |
|
| 543 | - $this->set_parent_invoice_id( $value ); |
|
| 542 | + public function set_original_payment_id($value) { |
|
| 543 | + $this->set_parent_invoice_id($value); |
|
| 544 | 544 | } |
| 545 | 545 | |
| 546 | 546 | /** |
@@ -549,8 +549,8 @@ discard block |
||
| 549 | 549 | * @since 1.0.19 |
| 550 | 550 | * @param int $value The subscription product id. |
| 551 | 551 | */ |
| 552 | - public function set_product_id( $value ) { |
|
| 553 | - $this->set_prop( 'product_id', (int) $value ); |
|
| 552 | + public function set_product_id($value) { |
|
| 553 | + $this->set_prop('product_id', (int) $value); |
|
| 554 | 554 | } |
| 555 | 555 | |
| 556 | 556 | /** |
@@ -559,8 +559,8 @@ discard block |
||
| 559 | 559 | * @since 1.0.19 |
| 560 | 560 | * @param string $value The renewal period. |
| 561 | 561 | */ |
| 562 | - public function set_period( $value ) { |
|
| 563 | - $this->set_prop( 'period', $value ); |
|
| 562 | + public function set_period($value) { |
|
| 563 | + $this->set_prop('period', $value); |
|
| 564 | 564 | } |
| 565 | 565 | |
| 566 | 566 | /** |
@@ -569,9 +569,9 @@ discard block |
||
| 569 | 569 | * @since 1.0.19 |
| 570 | 570 | * @param int $value The subscription frequency. |
| 571 | 571 | */ |
| 572 | - public function set_frequency( $value ) { |
|
| 573 | - $value = empty( $value ) ? 1 : (int) $value; |
|
| 574 | - $this->set_prop( 'frequency', absint( $value ) ); |
|
| 572 | + public function set_frequency($value) { |
|
| 573 | + $value = empty($value) ? 1 : (int) $value; |
|
| 574 | + $this->set_prop('frequency', absint($value)); |
|
| 575 | 575 | } |
| 576 | 576 | |
| 577 | 577 | /** |
@@ -580,8 +580,8 @@ discard block |
||
| 580 | 580 | * @since 1.0.19 |
| 581 | 581 | * @param float $value The initial subcription amount. |
| 582 | 582 | */ |
| 583 | - public function set_initial_amount( $value ) { |
|
| 584 | - $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) ); |
|
| 583 | + public function set_initial_amount($value) { |
|
| 584 | + $this->set_prop('initial_amount', wpinv_sanitize_amount($value)); |
|
| 585 | 585 | } |
| 586 | 586 | |
| 587 | 587 | /** |
@@ -590,8 +590,8 @@ discard block |
||
| 590 | 590 | * @since 1.0.19 |
| 591 | 591 | * @param float $value The recurring subcription amount. |
| 592 | 592 | */ |
| 593 | - public function set_recurring_amount( $value ) { |
|
| 594 | - $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) ); |
|
| 593 | + public function set_recurring_amount($value) { |
|
| 594 | + $this->set_prop('recurring_amount', wpinv_sanitize_amount($value)); |
|
| 595 | 595 | } |
| 596 | 596 | |
| 597 | 597 | /** |
@@ -600,8 +600,8 @@ discard block |
||
| 600 | 600 | * @since 1.0.19 |
| 601 | 601 | * @param int $value Bill times. |
| 602 | 602 | */ |
| 603 | - public function set_bill_times( $value ) { |
|
| 604 | - $this->set_prop( 'bill_times', (int) $value ); |
|
| 603 | + public function set_bill_times($value) { |
|
| 604 | + $this->set_prop('bill_times', (int) $value); |
|
| 605 | 605 | } |
| 606 | 606 | |
| 607 | 607 | /** |
@@ -610,8 +610,8 @@ discard block |
||
| 610 | 610 | * @since 1.0.19 |
| 611 | 611 | * @param string $value Bill times. |
| 612 | 612 | */ |
| 613 | - public function set_transaction_id( $value ) { |
|
| 614 | - $this->set_prop( 'transaction_id', sanitize_text_field( $value ) ); |
|
| 613 | + public function set_transaction_id($value) { |
|
| 614 | + $this->set_prop('transaction_id', sanitize_text_field($value)); |
|
| 615 | 615 | } |
| 616 | 616 | |
| 617 | 617 | /** |
@@ -620,15 +620,15 @@ discard block |
||
| 620 | 620 | * @since 1.0.19 |
| 621 | 621 | * @param string $value strtotime compliant date. |
| 622 | 622 | */ |
| 623 | - public function set_created( $value ) { |
|
| 624 | - $date = strtotime( $value ); |
|
| 623 | + public function set_created($value) { |
|
| 624 | + $date = strtotime($value); |
|
| 625 | 625 | |
| 626 | - if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 627 | - $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) ); |
|
| 626 | + if ($date && $value !== '0000-00-00 00:00:00') { |
|
| 627 | + $this->set_prop('created', date('Y-m-d H:i:s', $date)); |
|
| 628 | 628 | return; |
| 629 | 629 | } |
| 630 | 630 | |
| 631 | - $this->set_prop( 'created', '' ); |
|
| 631 | + $this->set_prop('created', ''); |
|
| 632 | 632 | |
| 633 | 633 | } |
| 634 | 634 | |
@@ -638,8 +638,8 @@ discard block |
||
| 638 | 638 | * @since 1.0.19 |
| 639 | 639 | * @param string $value strtotime compliant date. |
| 640 | 640 | */ |
| 641 | - public function set_date_created( $value ) { |
|
| 642 | - $this->set_created( $value ); |
|
| 641 | + public function set_date_created($value) { |
|
| 642 | + $this->set_created($value); |
|
| 643 | 643 | } |
| 644 | 644 | |
| 645 | 645 | /** |
@@ -648,15 +648,15 @@ discard block |
||
| 648 | 648 | * @since 1.0.19 |
| 649 | 649 | * @param string $value strtotime compliant date. |
| 650 | 650 | */ |
| 651 | - public function set_next_renewal_date( $value ) { |
|
| 652 | - $date = strtotime( $value ); |
|
| 651 | + public function set_next_renewal_date($value) { |
|
| 652 | + $date = strtotime($value); |
|
| 653 | 653 | |
| 654 | - if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 655 | - $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) ); |
|
| 654 | + if ($date && $value !== '0000-00-00 00:00:00') { |
|
| 655 | + $this->set_prop('expiration', date('Y-m-d H:i:s', $date)); |
|
| 656 | 656 | return; |
| 657 | 657 | } |
| 658 | 658 | |
| 659 | - $this->set_prop( 'expiration', '' ); |
|
| 659 | + $this->set_prop('expiration', ''); |
|
| 660 | 660 | |
| 661 | 661 | } |
| 662 | 662 | |
@@ -666,8 +666,8 @@ discard block |
||
| 666 | 666 | * @since 1.0.19 |
| 667 | 667 | * @param string $value strtotime compliant date. |
| 668 | 668 | */ |
| 669 | - public function set_expiration( $value ) { |
|
| 670 | - $this->set_next_renewal_date( $value ); |
|
| 669 | + public function set_expiration($value) { |
|
| 670 | + $this->set_next_renewal_date($value); |
|
| 671 | 671 | } |
| 672 | 672 | |
| 673 | 673 | /** |
@@ -676,8 +676,8 @@ discard block |
||
| 676 | 676 | * @since 1.0.19 |
| 677 | 677 | * @param string $value trial period e.g 1 year. |
| 678 | 678 | */ |
| 679 | - public function set_trial_period( $value ) { |
|
| 680 | - $this->set_prop( 'trial_period', $value ); |
|
| 679 | + public function set_trial_period($value) { |
|
| 680 | + $this->set_prop('trial_period', $value); |
|
| 681 | 681 | } |
| 682 | 682 | |
| 683 | 683 | /** |
@@ -686,22 +686,22 @@ discard block |
||
| 686 | 686 | * @since 1.0.19 |
| 687 | 687 | * @param string $new_status New subscription status. |
| 688 | 688 | */ |
| 689 | - public function set_status( $new_status ) { |
|
| 689 | + public function set_status($new_status) { |
|
| 690 | 690 | |
| 691 | 691 | // Abort if this is not a valid status; |
| 692 | - if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) { |
|
| 692 | + if (!array_key_exists($new_status, getpaid_get_subscription_statuses())) { |
|
| 693 | 693 | return; |
| 694 | 694 | } |
| 695 | 695 | |
| 696 | - $old_status = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status(); |
|
| 697 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
| 696 | + $old_status = !empty($this->status_transition['from']) ? $this->status_transition['from'] : $this->get_status(); |
|
| 697 | + if (true === $this->object_read && $old_status !== $new_status) { |
|
| 698 | 698 | $this->status_transition = array( |
| 699 | 699 | 'from' => $old_status, |
| 700 | 700 | 'to' => $new_status, |
| 701 | 701 | ); |
| 702 | 702 | } |
| 703 | 703 | |
| 704 | - $this->set_prop( 'status', $new_status ); |
|
| 704 | + $this->set_prop('status', $new_status); |
|
| 705 | 705 | } |
| 706 | 706 | |
| 707 | 707 | /** |
@@ -710,8 +710,8 @@ discard block |
||
| 710 | 710 | * @since 1.0.19 |
| 711 | 711 | * @param string $value the remote profile id. |
| 712 | 712 | */ |
| 713 | - public function set_profile_id( $value ) { |
|
| 714 | - $this->set_prop( 'profile_id', sanitize_text_field( $value ) ); |
|
| 713 | + public function set_profile_id($value) { |
|
| 714 | + $this->set_prop('profile_id', sanitize_text_field($value)); |
|
| 715 | 715 | } |
| 716 | 716 | |
| 717 | 717 | /* |
@@ -729,8 +729,8 @@ discard block |
||
| 729 | 729 | * @param string|array String or array of strings to check for. |
| 730 | 730 | * @return bool |
| 731 | 731 | */ |
| 732 | - public function has_status( $status ) { |
|
| 733 | - return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) ); |
|
| 732 | + public function has_status($status) { |
|
| 733 | + return in_array($this->get_status(), wpinv_clean(wpinv_parse_list($status))); |
|
| 734 | 734 | } |
| 735 | 735 | |
| 736 | 736 | /** |
@@ -740,7 +740,7 @@ discard block |
||
| 740 | 740 | */ |
| 741 | 741 | public function has_trial_period() { |
| 742 | 742 | $period = $this->get_trial_period(); |
| 743 | - return ! empty( $period ); |
|
| 743 | + return !empty($period); |
|
| 744 | 744 | } |
| 745 | 745 | |
| 746 | 746 | /** |
@@ -749,7 +749,7 @@ discard block |
||
| 749 | 749 | * @return bool |
| 750 | 750 | */ |
| 751 | 751 | public function is_active() { |
| 752 | - return $this->has_status( 'active trialling' ) && ! $this->is_expired(); |
|
| 752 | + return $this->has_status('active trialling') && !$this->is_expired(); |
|
| 753 | 753 | } |
| 754 | 754 | |
| 755 | 755 | /** |
@@ -758,7 +758,7 @@ discard block |
||
| 758 | 758 | * @return bool |
| 759 | 759 | */ |
| 760 | 760 | public function is_expired() { |
| 761 | - return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'timestamp' ) ); |
|
| 761 | + return $this->has_status('expired') || ($this->has_status('active cancelled trialling') && $this->get_expiration_time() < current_time('timestamp')); |
|
| 762 | 762 | } |
| 763 | 763 | |
| 764 | 764 | /** |
@@ -768,7 +768,7 @@ discard block |
||
| 768 | 768 | */ |
| 769 | 769 | public function is_last_renewal() { |
| 770 | 770 | $max_bills = $this->get_bill_times(); |
| 771 | - return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed(); |
|
| 771 | + return !empty($max_bills) && $max_bills <= $this->get_times_billed(); |
|
| 772 | 772 | } |
| 773 | 773 | |
| 774 | 774 | /* |
@@ -783,11 +783,11 @@ discard block |
||
| 783 | 783 | /** |
| 784 | 784 | * Backwards compatibilty. |
| 785 | 785 | */ |
| 786 | - public function create( $data = array() ) { |
|
| 786 | + public function create($data = array()) { |
|
| 787 | 787 | |
| 788 | 788 | // Set the properties. |
| 789 | - if ( is_array( $data ) ) { |
|
| 790 | - $this->set_props( $data ); |
|
| 789 | + if (is_array($data)) { |
|
| 790 | + $this->set_props($data); |
|
| 791 | 791 | } |
| 792 | 792 | |
| 793 | 793 | // Save the item. |
@@ -798,8 +798,8 @@ discard block |
||
| 798 | 798 | /** |
| 799 | 799 | * Backwards compatibilty. |
| 800 | 800 | */ |
| 801 | - public function update( $args = array() ) { |
|
| 802 | - return $this->create( $args ); |
|
| 801 | + public function update($args = array()) { |
|
| 802 | + return $this->create($args); |
|
| 803 | 803 | } |
| 804 | 804 | |
| 805 | 805 | /** |
@@ -808,12 +808,12 @@ discard block |
||
| 808 | 808 | * @since 1.0.0 |
| 809 | 809 | * @return WP_Post[] |
| 810 | 810 | */ |
| 811 | - public function get_child_payments( $hide_pending = true ) { |
|
| 811 | + public function get_child_payments($hide_pending = true) { |
|
| 812 | 812 | |
| 813 | - $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' ); |
|
| 813 | + $statuses = array('publish', 'wpi-processing', 'wpi-renewal'); |
|
| 814 | 814 | |
| 815 | - if ( ! $hide_pending ) { |
|
| 816 | - $statuses = array_keys( wpinv_get_invoice_statuses() ); |
|
| 815 | + if (!$hide_pending) { |
|
| 816 | + $statuses = array_keys(wpinv_get_invoice_statuses()); |
|
| 817 | 817 | } |
| 818 | 818 | |
| 819 | 819 | return get_posts( |
@@ -835,7 +835,7 @@ discard block |
||
| 835 | 835 | * @return int |
| 836 | 836 | */ |
| 837 | 837 | public function get_total_payments() { |
| 838 | - return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() ); |
|
| 838 | + return getpaid_count_subscription_invoices($this->get_parent_invoice_id(), $this->get_id()); |
|
| 839 | 839 | } |
| 840 | 840 | |
| 841 | 841 | /** |
@@ -847,7 +847,7 @@ discard block |
||
| 847 | 847 | public function get_times_billed() { |
| 848 | 848 | $times_billed = $this->get_total_payments(); |
| 849 | 849 | |
| 850 | - if ( (float) $this->get_initial_amount() == 0 && $times_billed > 0 ) { |
|
| 850 | + if ((float) $this->get_initial_amount() == 0 && $times_billed > 0) { |
|
| 851 | 851 | $times_billed--; |
| 852 | 852 | } |
| 853 | 853 | |
@@ -862,47 +862,47 @@ discard block |
||
| 862 | 862 | * @param WPInv_Invoice $invoice If adding an existing invoice. |
| 863 | 863 | * @return bool |
| 864 | 864 | */ |
| 865 | - public function add_payment( $args = array(), $invoice = false ) { |
|
| 865 | + public function add_payment($args = array(), $invoice = false) { |
|
| 866 | 866 | |
| 867 | 867 | // Process each payment once. |
| 868 | - if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) { |
|
| 868 | + if (!empty($args['transaction_id']) && $this->payment_exists($args['transaction_id'])) { |
|
| 869 | 869 | return false; |
| 870 | 870 | } |
| 871 | 871 | |
| 872 | 872 | // Are we creating a new invoice? |
| 873 | - if ( empty( $invoice ) ) { |
|
| 874 | - $invoice = $this->create_payment( false ); |
|
| 873 | + if (empty($invoice)) { |
|
| 874 | + $invoice = $this->create_payment(false); |
|
| 875 | 875 | |
| 876 | - if ( empty( $invoice ) ) { |
|
| 876 | + if (empty($invoice)) { |
|
| 877 | 877 | return false; |
| 878 | 878 | } |
| 879 | 879 | } |
| 880 | 880 | |
| 881 | 881 | // Maybe set a transaction id. |
| 882 | - if ( ! empty( $args['transaction_id'] ) ) { |
|
| 883 | - $invoice->set_transaction_id( $args['transaction_id'] ); |
|
| 882 | + if (!empty($args['transaction_id'])) { |
|
| 883 | + $invoice->set_transaction_id($args['transaction_id']); |
|
| 884 | 884 | } |
| 885 | 885 | |
| 886 | 886 | // Set the completed date. |
| 887 | - $invoice->set_completed_date( current_time( 'mysql' ) ); |
|
| 887 | + $invoice->set_completed_date(current_time('mysql')); |
|
| 888 | 888 | |
| 889 | 889 | // And the gateway. |
| 890 | - if ( ! empty( $args['gateway'] ) ) { |
|
| 891 | - $invoice->set_gateway( $args['gateway'] ); |
|
| 890 | + if (!empty($args['gateway'])) { |
|
| 891 | + $invoice->set_gateway($args['gateway']); |
|
| 892 | 892 | } |
| 893 | 893 | |
| 894 | - $invoice->set_status( 'wpi-renewal' ); |
|
| 894 | + $invoice->set_status('wpi-renewal'); |
|
| 895 | 895 | $invoice->save(); |
| 896 | 896 | |
| 897 | - if ( ! $invoice->exists() ) { |
|
| 897 | + if (!$invoice->exists()) { |
|
| 898 | 898 | return false; |
| 899 | 899 | } |
| 900 | 900 | |
| 901 | - do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this ); |
|
| 902 | - do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this ); |
|
| 903 | - do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() ); |
|
| 901 | + do_action('getpaid_after_create_subscription_renewal_invoice', $invoice, $this); |
|
| 902 | + do_action('wpinv_recurring_add_subscription_payment', $invoice, $this); |
|
| 903 | + do_action('wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id()); |
|
| 904 | 904 | |
| 905 | - update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id ); |
|
| 905 | + update_post_meta($invoice->get_id(), '_wpinv_subscription_id', $this->id); |
|
| 906 | 906 | |
| 907 | 907 | return $invoice->get_id(); |
| 908 | 908 | } |
@@ -914,47 +914,47 @@ discard block |
||
| 914 | 914 | * @param bool $save Whether we should save the invoice. |
| 915 | 915 | * @return WPInv_Invoice|bool |
| 916 | 916 | */ |
| 917 | - public function create_payment( $save = true ) { |
|
| 917 | + public function create_payment($save = true) { |
|
| 918 | 918 | |
| 919 | 919 | $parent_invoice = $this->get_parent_payment(); |
| 920 | 920 | |
| 921 | - if ( ! $parent_invoice->exists() ) { |
|
| 921 | + if (!$parent_invoice->exists()) { |
|
| 922 | 922 | return false; |
| 923 | 923 | } |
| 924 | 924 | |
| 925 | 925 | // Duplicate the parent invoice. |
| 926 | - $invoice = getpaid_duplicate_invoice( $parent_invoice ); |
|
| 927 | - $invoice->set_parent_id( $parent_invoice->get_id() ); |
|
| 928 | - $invoice->set_subscription_id( $this->get_id() ); |
|
| 929 | - $invoice->set_remote_subscription_id( $this->get_profile_id() ); |
|
| 926 | + $invoice = getpaid_duplicate_invoice($parent_invoice); |
|
| 927 | + $invoice->set_parent_id($parent_invoice->get_id()); |
|
| 928 | + $invoice->set_subscription_id($this->get_id()); |
|
| 929 | + $invoice->set_remote_subscription_id($this->get_profile_id()); |
|
| 930 | 930 | |
| 931 | 931 | // Set invoice items. |
| 932 | - $subscription_group = getpaid_get_invoice_subscription_group( $parent_invoice->get_id(), $this->get_id() ); |
|
| 933 | - $allowed_items = empty( $subscription_group ) ? array( $this->get_product_id() ) : array_keys( $subscription_group['items'] ); |
|
| 932 | + $subscription_group = getpaid_get_invoice_subscription_group($parent_invoice->get_id(), $this->get_id()); |
|
| 933 | + $allowed_items = empty($subscription_group) ? array($this->get_product_id()) : array_keys($subscription_group['items']); |
|
| 934 | 934 | $invoice_items = array(); |
| 935 | 935 | |
| 936 | - foreach ( $invoice->get_items() as $item ) { |
|
| 937 | - if ( in_array( $item->get_id(), $allowed_items ) ) { |
|
| 936 | + foreach ($invoice->get_items() as $item) { |
|
| 937 | + if (in_array($item->get_id(), $allowed_items)) { |
|
| 938 | 938 | $invoice_items[] = $item; |
| 939 | 939 | } |
| 940 | 940 | } |
| 941 | 941 | |
| 942 | - $invoice->set_items( $invoice_items ); |
|
| 942 | + $invoice->set_items($invoice_items); |
|
| 943 | 943 | |
| 944 | - if ( ! empty( $subscription_group['fees'] ) ) { |
|
| 945 | - $invoice->set_fees( $subscription_group['fees'] ); |
|
| 944 | + if (!empty($subscription_group['fees'])) { |
|
| 945 | + $invoice->set_fees($subscription_group['fees']); |
|
| 946 | 946 | } |
| 947 | 947 | |
| 948 | 948 | // Maybe recalculate discount (Pre-GetPaid Fix). |
| 949 | - $discount = new WPInv_Discount( $invoice->get_discount_code() ); |
|
| 950 | - if ( $discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount() ) { |
|
| 951 | - $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) ); |
|
| 949 | + $discount = new WPInv_Discount($invoice->get_discount_code()); |
|
| 950 | + if ($discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount()) { |
|
| 951 | + $invoice->add_discount(getpaid_calculate_invoice_discount($invoice, $discount)); |
|
| 952 | 952 | } |
| 953 | 953 | |
| 954 | 954 | $invoice->recalculate_total(); |
| 955 | - $invoice->set_status( 'wpi-pending' ); |
|
| 955 | + $invoice->set_status('wpi-pending'); |
|
| 956 | 956 | |
| 957 | - if ( ! $save ) { |
|
| 957 | + if (!$save) { |
|
| 958 | 958 | return $invoice; |
| 959 | 959 | } |
| 960 | 960 | |
@@ -969,24 +969,24 @@ discard block |
||
| 969 | 969 | * @since 1.0.0 |
| 970 | 970 | * @return int The subscription's id |
| 971 | 971 | */ |
| 972 | - public function renew( $calculate_from = null ) { |
|
| 972 | + public function renew($calculate_from = null) { |
|
| 973 | 973 | |
| 974 | 974 | // Complete subscription if applicable |
| 975 | - if ( $this->is_last_renewal() ) { |
|
| 975 | + if ($this->is_last_renewal()) { |
|
| 976 | 976 | return $this->complete(); |
| 977 | 977 | } |
| 978 | 978 | |
| 979 | 979 | // Calculate new expiration |
| 980 | 980 | $frequency = $this->get_frequency(); |
| 981 | 981 | $period = $this->get_period(); |
| 982 | - $calculate_from = empty( $calculate_from ) ? $this->get_expiration_time() : $calculate_from; |
|
| 983 | - $new_expiration = strtotime( "+ $frequency $period", $calculate_from ); |
|
| 982 | + $calculate_from = empty($calculate_from) ? $this->get_expiration_time() : $calculate_from; |
|
| 983 | + $new_expiration = strtotime("+ $frequency $period", $calculate_from); |
|
| 984 | 984 | |
| 985 | - $this->set_expiration( date( 'Y-m-d H:i:s', $new_expiration ) ); |
|
| 986 | - $this->set_status( 'active' ); |
|
| 985 | + $this->set_expiration(date('Y-m-d H:i:s', $new_expiration)); |
|
| 986 | + $this->set_status('active'); |
|
| 987 | 987 | $this->save(); |
| 988 | 988 | |
| 989 | - do_action( 'getpaid_subscription_renewed', $this ); |
|
| 989 | + do_action('getpaid_subscription_renewed', $this); |
|
| 990 | 990 | |
| 991 | 991 | return $this->get_id(); |
| 992 | 992 | } |
@@ -1002,11 +1002,11 @@ discard block |
||
| 1002 | 1002 | public function complete() { |
| 1003 | 1003 | |
| 1004 | 1004 | // Only mark a subscription as complete if it's not already cancelled. |
| 1005 | - if ( $this->has_status( 'cancelled' ) ) { |
|
| 1005 | + if ($this->has_status('cancelled')) { |
|
| 1006 | 1006 | return false; |
| 1007 | 1007 | } |
| 1008 | 1008 | |
| 1009 | - $this->set_status( 'completed' ); |
|
| 1009 | + $this->set_status('completed'); |
|
| 1010 | 1010 | return $this->save(); |
| 1011 | 1011 | |
| 1012 | 1012 | } |
@@ -1018,14 +1018,14 @@ discard block |
||
| 1018 | 1018 | * @param bool $check_expiration |
| 1019 | 1019 | * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future. |
| 1020 | 1020 | */ |
| 1021 | - public function expire( $check_expiration = false ) { |
|
| 1021 | + public function expire($check_expiration = false) { |
|
| 1022 | 1022 | |
| 1023 | - if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) { |
|
| 1023 | + if ($check_expiration && $this->get_expiration_time() > current_time('timestamp')) { |
|
| 1024 | 1024 | // Do not mark as expired since real expiration date is in the future |
| 1025 | 1025 | return false; |
| 1026 | 1026 | } |
| 1027 | 1027 | |
| 1028 | - $this->set_status( 'expired' ); |
|
| 1028 | + $this->set_status('expired'); |
|
| 1029 | 1029 | return $this->save(); |
| 1030 | 1030 | |
| 1031 | 1031 | } |
@@ -1037,7 +1037,7 @@ discard block |
||
| 1037 | 1037 | * @return int Subscription id. |
| 1038 | 1038 | */ |
| 1039 | 1039 | public function failing() { |
| 1040 | - $this->set_status( 'failing' ); |
|
| 1040 | + $this->set_status('failing'); |
|
| 1041 | 1041 | return $this->save(); |
| 1042 | 1042 | } |
| 1043 | 1043 | |
@@ -1048,7 +1048,7 @@ discard block |
||
| 1048 | 1048 | * @return int Subscription id. |
| 1049 | 1049 | */ |
| 1050 | 1050 | public function cancel() { |
| 1051 | - $this->set_status( 'cancelled' ); |
|
| 1051 | + $this->set_status('cancelled'); |
|
| 1052 | 1052 | return $this->save(); |
| 1053 | 1053 | } |
| 1054 | 1054 | |
@@ -1059,7 +1059,7 @@ discard block |
||
| 1059 | 1059 | * @return bool |
| 1060 | 1060 | */ |
| 1061 | 1061 | public function can_cancel() { |
| 1062 | - return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this ); |
|
| 1062 | + return apply_filters('wpinv_subscription_can_cancel', $this->has_status($this->get_cancellable_statuses()), $this); |
|
| 1063 | 1063 | } |
| 1064 | 1064 | |
| 1065 | 1065 | /** |
@@ -1070,7 +1070,7 @@ discard block |
||
| 1070 | 1070 | * @return array |
| 1071 | 1071 | */ |
| 1072 | 1072 | public function get_cancellable_statuses() { |
| 1073 | - return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) ); |
|
| 1073 | + return apply_filters('wpinv_recurring_cancellable_statuses', array('active', 'trialling', 'failing')); |
|
| 1074 | 1074 | } |
| 1075 | 1075 | |
| 1076 | 1076 | /** |
@@ -1080,8 +1080,8 @@ discard block |
||
| 1080 | 1080 | * @return string |
| 1081 | 1081 | */ |
| 1082 | 1082 | public function get_cancel_url() { |
| 1083 | - $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() ); |
|
| 1084 | - return apply_filters( 'wpinv_subscription_cancel_url', $url, $this ); |
|
| 1083 | + $url = getpaid_get_authenticated_action_url('subscription_cancel', $this->get_view_url()); |
|
| 1084 | + return apply_filters('wpinv_subscription_cancel_url', $url, $this); |
|
| 1085 | 1085 | } |
| 1086 | 1086 | |
| 1087 | 1087 | /** |
@@ -1092,10 +1092,10 @@ discard block |
||
| 1092 | 1092 | */ |
| 1093 | 1093 | public function get_view_url() { |
| 1094 | 1094 | |
| 1095 | - $url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
| 1096 | - $url = add_query_arg( 'subscription', $this->get_id(), $url ); |
|
| 1095 | + $url = getpaid_get_tab_url('gp-subscriptions', get_permalink((int) wpinv_get_option('invoice_subscription_page'))); |
|
| 1096 | + $url = add_query_arg('subscription', $this->get_id(), $url); |
|
| 1097 | 1097 | |
| 1098 | - return apply_filters( 'getpaid_get_subscription_view_url', $url, $this ); |
|
| 1098 | + return apply_filters('getpaid_get_subscription_view_url', $url, $this); |
|
| 1099 | 1099 | } |
| 1100 | 1100 | |
| 1101 | 1101 | /** |
@@ -1108,7 +1108,7 @@ discard block |
||
| 1108 | 1108 | * @return bool |
| 1109 | 1109 | */ |
| 1110 | 1110 | public function can_renew() { |
| 1111 | - return apply_filters( 'wpinv_subscription_can_renew', true, $this ); |
|
| 1111 | + return apply_filters('wpinv_subscription_can_renew', true, $this); |
|
| 1112 | 1112 | } |
| 1113 | 1113 | |
| 1114 | 1114 | /** |
@@ -1127,7 +1127,7 @@ discard block |
||
| 1127 | 1127 | ), |
| 1128 | 1128 | 'getpaid-nonce' |
| 1129 | 1129 | ); |
| 1130 | - return apply_filters( 'wpinv_subscription_renew_url', $url, $this ); |
|
| 1130 | + return apply_filters('wpinv_subscription_renew_url', $url, $this); |
|
| 1131 | 1131 | } |
| 1132 | 1132 | |
| 1133 | 1133 | /** |
@@ -1137,7 +1137,7 @@ discard block |
||
| 1137 | 1137 | * @return bool |
| 1138 | 1138 | */ |
| 1139 | 1139 | public function can_update() { |
| 1140 | - return apply_filters( 'wpinv_subscription_can_update', false, $this ); |
|
| 1140 | + return apply_filters('wpinv_subscription_can_update', false, $this); |
|
| 1141 | 1141 | } |
| 1142 | 1142 | |
| 1143 | 1143 | /** |
@@ -1153,7 +1153,7 @@ discard block |
||
| 1153 | 1153 | 'subscription_id' => $this->get_id(), |
| 1154 | 1154 | ) |
| 1155 | 1155 | ); |
| 1156 | - return apply_filters( 'wpinv_subscription_update_url', $url, $this ); |
|
| 1156 | + return apply_filters('wpinv_subscription_update_url', $url, $this); |
|
| 1157 | 1157 | } |
| 1158 | 1158 | |
| 1159 | 1159 | /** |
@@ -1163,7 +1163,7 @@ discard block |
||
| 1163 | 1163 | * @return string |
| 1164 | 1164 | */ |
| 1165 | 1165 | public function get_status_label() { |
| 1166 | - return getpaid_get_subscription_status_label( $this->get_status() ); |
|
| 1166 | + return getpaid_get_subscription_status_label($this->get_status()); |
|
| 1167 | 1167 | } |
| 1168 | 1168 | |
| 1169 | 1169 | /** |
@@ -1174,7 +1174,7 @@ discard block |
||
| 1174 | 1174 | */ |
| 1175 | 1175 | public function get_status_class() { |
| 1176 | 1176 | $statuses = getpaid_get_subscription_status_classes(); |
| 1177 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
| 1177 | + return isset($statuses[$this->get_status()]) ? $statuses[$this->get_status()] : 'badge-dark'; |
|
| 1178 | 1178 | } |
| 1179 | 1179 | |
| 1180 | 1180 | /** |
@@ -1185,9 +1185,9 @@ discard block |
||
| 1185 | 1185 | */ |
| 1186 | 1186 | public function get_status_label_html() { |
| 1187 | 1187 | |
| 1188 | - $status_label = sanitize_text_field( $this->get_status_label() ); |
|
| 1189 | - $class = esc_attr( $this->get_status_class() ); |
|
| 1190 | - $status = sanitize_html_class( $this->get_status() ); |
|
| 1188 | + $status_label = sanitize_text_field($this->get_status_label()); |
|
| 1189 | + $class = esc_attr($this->get_status_class()); |
|
| 1190 | + $status = sanitize_html_class($this->get_status()); |
|
| 1191 | 1191 | |
| 1192 | 1192 | return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
| 1193 | 1193 | } |
@@ -1199,9 +1199,9 @@ discard block |
||
| 1199 | 1199 | * @param string $txn_id The transaction ID from the merchant processor |
| 1200 | 1200 | * @return bool |
| 1201 | 1201 | */ |
| 1202 | - public function payment_exists( $txn_id = '' ) { |
|
| 1203 | - $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' ); |
|
| 1204 | - return ! empty( $invoice_id ); |
|
| 1202 | + public function payment_exists($txn_id = '') { |
|
| 1203 | + $invoice_id = WPInv_Invoice::get_invoice_id_by_field($txn_id, 'transaction_id'); |
|
| 1204 | + return !empty($invoice_id); |
|
| 1205 | 1205 | } |
| 1206 | 1206 | |
| 1207 | 1207 | /** |
@@ -1213,35 +1213,35 @@ discard block |
||
| 1213 | 1213 | // Reset status transition variable. |
| 1214 | 1214 | $this->status_transition = false; |
| 1215 | 1215 | |
| 1216 | - if ( $status_transition ) { |
|
| 1216 | + if ($status_transition) { |
|
| 1217 | 1217 | try { |
| 1218 | 1218 | |
| 1219 | 1219 | // Fire a hook for the status change. |
| 1220 | - do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition ); |
|
| 1221 | - do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition ); |
|
| 1220 | + do_action('wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition); |
|
| 1221 | + do_action('getpaid_subscription_' . $status_transition['to'], $this, $status_transition); |
|
| 1222 | 1222 | |
| 1223 | - if ( ! empty( $status_transition['from'] ) ) { |
|
| 1223 | + if (!empty($status_transition['from'])) { |
|
| 1224 | 1224 | |
| 1225 | 1225 | /* translators: 1: old subscription status 2: new subscription status */ |
| 1226 | - $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1226 | + $transition_note = sprintf(__('Subscription status changed from %1$s to %2$s.', 'invoicing'), getpaid_get_subscription_status_label($status_transition['from']), getpaid_get_subscription_status_label($status_transition['to'])); |
|
| 1227 | 1227 | |
| 1228 | 1228 | // Note the transition occurred. |
| 1229 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1229 | + $this->get_parent_payment()->add_note($transition_note, false, false, true); |
|
| 1230 | 1230 | |
| 1231 | 1231 | // Fire another hook. |
| 1232 | - do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this ); |
|
| 1233 | - do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 1232 | + do_action('getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this); |
|
| 1233 | + do_action('getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to']); |
|
| 1234 | 1234 | |
| 1235 | 1235 | } else { |
| 1236 | 1236 | /* translators: %s: new invoice status */ |
| 1237 | - $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1237 | + $transition_note = sprintf(__('Subscription status set to %s.', 'invoicing'), getpaid_get_subscription_status_label($status_transition['to'])); |
|
| 1238 | 1238 | |
| 1239 | 1239 | // Note the transition occurred. |
| 1240 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1240 | + $this->get_parent_payment()->add_note($transition_note, false, false, true); |
|
| 1241 | 1241 | |
| 1242 | 1242 | } |
| 1243 | - } catch ( Exception $e ) { |
|
| 1244 | - $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 1243 | + } catch (Exception $e) { |
|
| 1244 | + $this->get_parent_payment()->add_note(__('Error during subscription status transition.', 'invoicing') . ' ' . $e->getMessage()); |
|
| 1245 | 1245 | } |
| 1246 | 1246 | } |
| 1247 | 1247 | |
@@ -1267,7 +1267,7 @@ discard block |
||
| 1267 | 1267 | */ |
| 1268 | 1268 | public function activate() { |
| 1269 | 1269 | $status = 'trialling' === $this->get_status() ? 'trialling' : 'active'; |
| 1270 | - $this->set_status( $status ); |
|
| 1270 | + $this->set_status($status); |
|
| 1271 | 1271 | return $this->save(); |
| 1272 | 1272 | } |
| 1273 | 1273 | |
