woothemes /
woocommerce
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like WC_Coupon often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use WC_Coupon, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | class WC_Coupon extends WC_Legacy_Coupon { |
||
| 20 | |||
| 21 | /** |
||
| 22 | * Data array, with defaults. |
||
| 23 | * @since 2.7.0 |
||
| 24 | * @var array |
||
| 25 | */ |
||
| 26 | protected $_data = array( |
||
| 27 | 'id' => 0, |
||
| 28 | 'code' => '', |
||
| 29 | 'amount' => 0, |
||
| 30 | 'date_created' => '', |
||
| 31 | 'date_modified' => '', |
||
| 32 | 'discount_type' => 'fixed_cart', |
||
| 33 | 'description' => '', |
||
| 34 | 'date_expires' => '', |
||
| 35 | 'usage_count' => 0, |
||
| 36 | 'individual_use' => false, |
||
| 37 | 'product_ids' => array(), |
||
| 38 | 'excluded_product_ids' => array(), |
||
| 39 | 'usage_limit' => 0, |
||
| 40 | 'usage_limit_per_user' => 0, |
||
| 41 | 'limit_usage_to_x_items' => 0, |
||
| 42 | 'free_shipping' => false, |
||
| 43 | 'product_categories' => array(), |
||
| 44 | 'excluded_product_categories' => array(), |
||
| 45 | 'exclude_sale_items' => false, |
||
| 46 | 'minimum_amount' => '', |
||
| 47 | 'maximum_amount' => '', |
||
| 48 | 'email_restrictions' => array(), |
||
| 49 | 'used_by' => '', |
||
| 50 | ); |
||
| 51 | |||
| 52 | // Coupon message codes |
||
| 53 | const E_WC_COUPON_INVALID_FILTERED = 100; |
||
| 54 | const E_WC_COUPON_INVALID_REMOVED = 101; |
||
| 55 | const E_WC_COUPON_NOT_YOURS_REMOVED = 102; |
||
| 56 | const E_WC_COUPON_ALREADY_APPLIED = 103; |
||
| 57 | const E_WC_COUPON_ALREADY_APPLIED_INDIV_USE_ONLY = 104; |
||
| 58 | const E_WC_COUPON_NOT_EXIST = 105; |
||
| 59 | const E_WC_COUPON_USAGE_LIMIT_REACHED = 106; |
||
| 60 | const E_WC_COUPON_EXPIRED = 107; |
||
| 61 | const E_WC_COUPON_MIN_SPEND_LIMIT_NOT_MET = 108; |
||
| 62 | const E_WC_COUPON_NOT_APPLICABLE = 109; |
||
| 63 | const E_WC_COUPON_NOT_VALID_SALE_ITEMS = 110; |
||
| 64 | const E_WC_COUPON_PLEASE_ENTER = 111; |
||
| 65 | const E_WC_COUPON_MAX_SPEND_LIMIT_MET = 112; |
||
| 66 | const E_WC_COUPON_EXCLUDED_PRODUCTS = 113; |
||
| 67 | const E_WC_COUPON_EXCLUDED_CATEGORIES = 114; |
||
| 68 | const WC_COUPON_SUCCESS = 200; |
||
| 69 | const WC_COUPON_REMOVED = 201; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Internal meta type used to store coupon data. |
||
| 73 | * @since 2.7.0 |
||
| 74 | * @var string |
||
| 75 | */ |
||
| 76 | protected $_meta_type = 'post'; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Data stored in meta keys, but not considered "meta" for a coupon. |
||
| 80 | * @since 2.7.0 |
||
| 81 | * @var array |
||
| 82 | */ |
||
| 83 | protected $_internal_meta_keys = array( |
||
| 84 | 'discount_type', 'coupon_amount', 'expiry_date', 'usage_count', |
||
| 85 | 'individual_use', 'product_ids', 'exclude_product_ids', 'usage_limit', |
||
| 86 | 'usage_limit_per_user', 'limit_usage_to_x_items', 'free_shipping', |
||
| 87 | 'product_categories', 'exclude_product_categories', 'exclude_sale_items', |
||
| 88 | 'minimum_amount', 'maximum_amount', 'customer_email', '_used_by', |
||
| 89 | '_edit_lock', '_edit_last', |
||
| 90 | ); |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Coupon constructor. Loads coupon data. |
||
| 94 | * @param mixed $data Coupon data, object, ID or code. |
||
| 95 | */ |
||
| 96 | public function __construct( $data = '' ) { |
||
| 97 | parent::__construct( $data ); |
||
| 98 | |||
| 99 | if ( $data instanceof WC_Coupon ) { |
||
| 100 | $this->read( absint( $data->get_id() ) ); |
||
| 101 | } elseif ( $coupon = apply_filters( 'woocommerce_get_shop_coupon_data', false, $data ) ) { |
||
| 102 | _doing_it_wrong( 'woocommerce_get_shop_coupon_data', 'Reading a manual coupon via woocommerce_get_shop_coupon_data has been deprecated. Please sent an instance of WC_Coupon instead.', '2.7' ); |
||
| 103 | $this->read_manual_coupon( $data, $coupon ); |
||
| 104 | } elseif ( is_numeric( $data ) && 'shop_coupon' === get_post_type( $data ) ) { |
||
| 105 | $this->read( $data ); |
||
| 106 | } elseif ( ! empty( $data ) ) { |
||
| 107 | $this->set_code( $data ); |
||
| 108 | $this->read( wc_get_coupon_id_by_code( $data ) ); |
||
| 109 | } |
||
| 110 | } |
||
| 111 | |||
| 112 | /** |
||
| 113 | * Checks the coupon type. |
||
| 114 | * @param string $type Array or string of types |
||
| 115 | * @return bool |
||
| 116 | */ |
||
| 117 | public function is_type( $type ) { |
||
| 118 | return ( $this->get_discount_type() == $type || ( is_array( $type ) && in_array( $this->get_discount_type(), $type ) ) ); |
||
| 119 | } |
||
| 120 | |||
| 121 | /* |
||
| 122 | |-------------------------------------------------------------------------- |
||
| 123 | | Getters |
||
| 124 | |-------------------------------------------------------------------------- |
||
| 125 | | |
||
| 126 | | Methods for getting data from the coupon object. |
||
| 127 | | |
||
| 128 | */ |
||
| 129 | |||
| 130 | /** |
||
| 131 | * Get coupon ID. |
||
| 132 | * @since 2.7.0 |
||
| 133 | * @return integer |
||
| 134 | */ |
||
| 135 | public function get_id() { |
||
| 136 | return $this->_data['id']; |
||
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Get coupon code. |
||
| 141 | * @since 2.7.0 |
||
| 142 | * @return string |
||
| 143 | */ |
||
| 144 | public function get_code() { |
||
| 145 | return $this->_data['code']; |
||
| 146 | } |
||
| 147 | |||
| 148 | /** |
||
| 149 | * Get coupon description. |
||
| 150 | * @since 2.7.0 |
||
| 151 | * @return string |
||
| 152 | */ |
||
| 153 | public function get_description() { |
||
| 154 | return $this->_data['description']; |
||
| 155 | } |
||
| 156 | |||
| 157 | /** |
||
| 158 | * Get discount type. |
||
| 159 | * @since 2.7.0 |
||
| 160 | * @return string |
||
| 161 | */ |
||
| 162 | public function get_discount_type() { |
||
| 163 | return $this->_data['discount_type']; |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Get coupon code. |
||
| 168 | * @since 2.7.0 |
||
| 169 | * @return float |
||
| 170 | */ |
||
| 171 | public function get_amount() { |
||
| 172 | return wc_format_decimal( $this->_data['amount'] ); |
||
| 173 | } |
||
| 174 | |||
| 175 | /** |
||
| 176 | * Get coupon expiration date. |
||
| 177 | * @since 2.7.0 |
||
| 178 | * @return int |
||
| 179 | */ |
||
| 180 | public function get_date_expires() { |
||
| 181 | return $this->_data['date_expires']; |
||
| 182 | } |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Get date_created |
||
| 186 | * @since 2.7.0 |
||
| 187 | * @return int |
||
| 188 | */ |
||
| 189 | public function get_date_created() { |
||
| 190 | return $this->_data['date_created']; |
||
| 191 | } |
||
| 192 | |||
| 193 | /** |
||
| 194 | * Get date_modified |
||
| 195 | * @since 2.7.0 |
||
| 196 | * @return int |
||
| 197 | */ |
||
| 198 | public function get_date_modified() { |
||
| 199 | return $this->_data['date_modified']; |
||
| 200 | } |
||
| 201 | |||
| 202 | /** |
||
| 203 | * Get coupon usage count. |
||
| 204 | * @since 2.7.0 |
||
| 205 | * @return integer |
||
| 206 | */ |
||
| 207 | public function get_usage_count() { |
||
| 208 | return $this->_data['usage_count']; |
||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Get the "indvidual use" checkbox status. |
||
| 213 | * @since 2.7.0 |
||
| 214 | * @return bool |
||
| 215 | */ |
||
| 216 | public function get_individual_use() { |
||
| 217 | return $this->_data['individual_use']; |
||
| 218 | } |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Get product IDs this coupon can apply to. |
||
| 222 | * @since 2.7.0 |
||
| 223 | * @return array |
||
| 224 | */ |
||
| 225 | public function get_product_ids() { |
||
| 226 | return $this->_data['product_ids']; |
||
| 227 | } |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Get product IDs that this coupon should not apply to. |
||
| 231 | * @since 2.7.0 |
||
| 232 | * @return array |
||
| 233 | */ |
||
| 234 | public function get_excluded_product_ids() { |
||
| 235 | return $this->_data['excluded_product_ids']; |
||
| 236 | } |
||
| 237 | |||
| 238 | /** |
||
| 239 | * Get coupon usage limit. |
||
| 240 | * @since 2.7.0 |
||
| 241 | * @return integer |
||
| 242 | */ |
||
| 243 | public function get_usage_limit() { |
||
| 244 | return $this->_data['usage_limit']; |
||
| 245 | } |
||
| 246 | |||
| 247 | /** |
||
| 248 | * Get coupon usage limit per customer (for a single customer) |
||
| 249 | * @since 2.7.0 |
||
| 250 | * @return integer |
||
| 251 | */ |
||
| 252 | public function get_usage_limit_per_user() { |
||
| 253 | return $this->_data['usage_limit_per_user']; |
||
| 254 | } |
||
| 255 | |||
| 256 | /** |
||
| 257 | * Usage limited to certain amount of items |
||
| 258 | * @since 2.7.0 |
||
| 259 | * @return integer |
||
| 260 | */ |
||
| 261 | public function get_limit_usage_to_x_items() { |
||
| 262 | return $this->_data['limit_usage_to_x_items']; |
||
| 263 | } |
||
| 264 | |||
| 265 | /** |
||
| 266 | * If this coupon grants free shipping or not. |
||
| 267 | * @since 2.7.0 |
||
| 268 | * @return bool |
||
| 269 | */ |
||
| 270 | public function get_free_shipping() { |
||
| 271 | return $this->_data['free_shipping']; |
||
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * Get product categories this coupon can apply to. |
||
| 276 | * @since 2.7.0 |
||
| 277 | * @return array |
||
| 278 | */ |
||
| 279 | public function get_product_categories() { |
||
| 280 | return $this->_data['product_categories']; |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Get product categories this coupon cannot not apply to. |
||
| 285 | * @since 2.7.0 |
||
| 286 | * @return array |
||
| 287 | */ |
||
| 288 | public function get_excluded_product_categories() { |
||
| 289 | return $this->_data['excluded_product_categories']; |
||
| 290 | } |
||
| 291 | |||
| 292 | /** |
||
| 293 | * If this coupon should exclude items on sale. |
||
| 294 | * @since 2.7.0 |
||
| 295 | * @return bool |
||
| 296 | */ |
||
| 297 | public function get_exclude_sale_items() { |
||
| 298 | return $this->_data['exclude_sale_items']; |
||
| 299 | } |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Get minium spend amount. |
||
| 303 | * @since 2.7.0 |
||
| 304 | * @return float |
||
| 305 | */ |
||
| 306 | public function get_minimum_amount() { |
||
| 307 | return wc_format_decimal( $this->_data['minimum_amount'] ); |
||
| 308 | } |
||
| 309 | /** |
||
| 310 | * Get maximum spend amount. |
||
| 311 | * @since 2.7.0 |
||
| 312 | * @return float |
||
| 313 | */ |
||
| 314 | public function get_maximum_amount() { |
||
| 315 | return wc_format_decimal( $this->_data['maximum_amount'] ); |
||
| 316 | } |
||
| 317 | |||
| 318 | /** |
||
| 319 | * Get emails to check customer usage restrictions. |
||
| 320 | * @since 2.7.0 |
||
| 321 | * @return array |
||
| 322 | */ |
||
| 323 | public function get_email_restrictions() { |
||
| 324 | return $this->_data['email_restrictions']; |
||
| 325 | } |
||
| 326 | |||
| 327 | /** |
||
| 328 | * Get records of all users who have used the current coupon. |
||
| 329 | * |
||
| 330 | * @return array |
||
| 331 | */ |
||
| 332 | public function get_used_by() { |
||
| 333 | return $this->_data['used_by']; |
||
| 334 | } |
||
| 335 | |||
| 336 | /** |
||
| 337 | * Get discount amount for a cart item. |
||
| 338 | * |
||
| 339 | * @param float $discounting_amount Amount the coupon is being applied to |
||
| 340 | * @param array|null $cart_item Cart item being discounted if applicable |
||
| 341 | * @param boolean $single True if discounting a single qty item, false if its the line |
||
| 342 | * @return float Amount this coupon has discounted |
||
| 343 | */ |
||
| 344 | public function get_discount_amount( $discounting_amount, $cart_item = null, $single = false ) { |
||
| 345 | $discount = 0; |
||
| 346 | $cart_item_qty = is_null( $cart_item ) ? 1 : $cart_item['quantity']; |
||
| 347 | |||
| 348 | if ( $this->is_type( array( 'percent_product', 'percent' ) ) ) { |
||
|
|
|||
| 349 | $discount = $this->get_amount() * ( $discounting_amount / 100 ); |
||
| 350 | } elseif ( $this->is_type( 'fixed_cart' ) && ! is_null( $cart_item ) && WC()->cart->subtotal_ex_tax ) { |
||
| 351 | /** |
||
| 352 | * This is the most complex discount - we need to divide the discount between rows based on their price in. |
||
| 353 | * proportion to the subtotal. This is so rows with different tax rates get a fair discount, and so rows. |
||
| 354 | * with no price (free) don't get discounted. |
||
| 355 | * |
||
| 356 | * Get item discount by dividing item cost by subtotal to get a %. |
||
| 357 | * |
||
| 358 | * Uses price inc tax if prices include tax to work around https://github.com/woothemes/woocommerce/issues/7669 and https://github.com/woothemes/woocommerce/issues/8074. |
||
| 359 | */ |
||
| 360 | if ( wc_prices_include_tax() ) { |
||
| 361 | $discount_percent = ( $cart_item['data']->get_price_including_tax() * $cart_item_qty ) / WC()->cart->subtotal; |
||
| 362 | } else { |
||
| 363 | $discount_percent = ( $cart_item['data']->get_price_excluding_tax() * $cart_item_qty ) / WC()->cart->subtotal_ex_tax; |
||
| 364 | } |
||
| 365 | $discount = ( $this->get_amount() * $discount_percent ) / $cart_item_qty; |
||
| 366 | |||
| 367 | } elseif ( $this->is_type( 'fixed_product' ) ) { |
||
| 368 | $discount = min( $this->get_amount(), $discounting_amount ); |
||
| 369 | $discount = $single ? $discount : $discount * $cart_item_qty; |
||
| 370 | } |
||
| 371 | |||
| 372 | $discount = min( $discount, $discounting_amount ); |
||
| 373 | |||
| 374 | // Handle the limit_usage_to_x_items option |
||
| 375 | if ( $this->is_type( array( 'percent_product', 'fixed_product' ) ) ) { |
||
| 376 | if ( $discounting_amount ) { |
||
| 377 | if ( '' === $this->get_limit_usage_to_x_items() ) { |
||
| 378 | $limit_usage_qty = $cart_item_qty; |
||
| 379 | } else { |
||
| 380 | $limit_usage_qty = min( $this->get_limit_usage_to_x_items(), $cart_item_qty ); |
||
| 381 | $this->set_limit_usage_to_x_items( max( 0, $this->get_limit_usage_to_x_items() - $limit_usage_qty ) ); |
||
| 382 | } |
||
| 383 | if ( $single ) { |
||
| 384 | $discount = ( $discount * $limit_usage_qty ) / $cart_item_qty; |
||
| 385 | } else { |
||
| 386 | $discount = ( $discount / $cart_item_qty ) * $limit_usage_qty; |
||
| 387 | } |
||
| 388 | } |
||
| 389 | } |
||
| 390 | |||
| 391 | $discount = round( $discount, wc_get_rounding_precision() ); |
||
| 392 | |||
| 393 | return apply_filters( 'woocommerce_coupon_get_discount_amount', $discount, $discounting_amount, $cart_item, $single, $this ); |
||
| 394 | } |
||
| 395 | |||
| 396 | /* |
||
| 397 | |-------------------------------------------------------------------------- |
||
| 398 | | Setters |
||
| 399 | |-------------------------------------------------------------------------- |
||
| 400 | | |
||
| 401 | | Functions for setting coupon data. These should not update anything in the |
||
| 402 | | database itself and should only change what is stored in the class |
||
| 403 | | object. |
||
| 404 | | |
||
| 405 | */ |
||
| 406 | |||
| 407 | /** |
||
| 408 | * Set ID |
||
| 409 | * @param int $value |
||
| 410 | * @throws WC_Data_Exception |
||
| 411 | */ |
||
| 412 | public function set_id( $value ) { |
||
| 413 | $this->_data['id'] = absint( $value ); |
||
| 414 | } |
||
| 415 | |||
| 416 | /** |
||
| 417 | * Set coupon code. |
||
| 418 | * @since 2.7.0 |
||
| 419 | * @param string $code |
||
| 420 | * @throws WC_Data_Exception |
||
| 421 | */ |
||
| 422 | public function set_code( $code ) { |
||
| 423 | $this->_data['code'] = apply_filters( 'woocommerce_coupon_code', $code ); |
||
| 424 | } |
||
| 425 | |||
| 426 | /** |
||
| 427 | * Set coupon description. |
||
| 428 | * @since 2.7.0 |
||
| 429 | * @param string $description |
||
| 430 | * @throws WC_Data_Exception |
||
| 431 | */ |
||
| 432 | public function set_description( $description ) { |
||
| 435 | |||
| 436 | /** |
||
| 437 | * Set discount type. |
||
| 438 | * @since 2.7.0 |
||
| 439 | * @param string $discount_type |
||
| 440 | * @throws WC_Data_Exception |
||
| 441 | */ |
||
| 442 | public function set_discount_type( $discount_type ) { |
||
| 443 | if ( ! in_array( $discount_type, array_keys( wc_get_coupon_types() ) ) ) { |
||
| 444 | $this->error( 'coupon_invalid_discount_type', __( 'Invalid discount type', 'woocommerce' ) ); |
||
| 445 | } |
||
| 446 | $this->_data['discount_type'] = $discount_type; |
||
| 447 | } |
||
| 448 | |||
| 449 | /** |
||
| 450 | * Set amount. |
||
| 451 | * @since 2.7.0 |
||
| 452 | * @param float $amount |
||
| 453 | * @throws WC_Data_Exception |
||
| 454 | */ |
||
| 455 | public function set_amount( $amount ) { |
||
| 456 | $this->_data['amount'] = wc_format_decimal( $amount ); |
||
| 457 | } |
||
| 458 | |||
| 459 | /** |
||
| 460 | * Set expiration date. |
||
| 461 | * @since 2.7.0 |
||
| 462 | * @param string $timestamp Timestamp |
||
| 463 | * @throws WC_Data_Exception |
||
| 464 | */ |
||
| 465 | public function set_date_expires( $timestamp ) { |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Set date_created |
||
| 471 | * @since 2.7.0 |
||
| 472 | * @param string $timestamp Timestamp |
||
| 473 | * @throws WC_Data_Exception |
||
| 474 | */ |
||
| 475 | public function set_date_created( $timestamp ) { |
||
| 478 | |||
| 479 | /** |
||
| 480 | * Set date_modified |
||
| 481 | * @since 2.7.0 |
||
| 482 | * @param string $timestamp |
||
| 483 | * @throws WC_Data_Exception |
||
| 484 | */ |
||
| 485 | public function set_date_modified( $timestamp ) { |
||
| 488 | |||
| 489 | /** |
||
| 490 | * Set how many times this coupon has been used. |
||
| 491 | * @since 2.7.0 |
||
| 492 | * @param int $usage_count |
||
| 493 | * @throws WC_Data_Exception |
||
| 494 | */ |
||
| 495 | public function set_usage_count( $usage_count ) { |
||
| 498 | |||
| 499 | /** |
||
| 500 | * Set if this coupon can only be used once. |
||
| 501 | * @since 2.7.0 |
||
| 502 | * @param bool $is_individual_use |
||
| 503 | * @throws WC_Data_Exception |
||
| 504 | */ |
||
| 505 | public function set_individual_use( $is_individual_use ) { |
||
| 508 | |||
| 509 | /** |
||
| 510 | * Set the product IDs this coupon can be used with. |
||
| 511 | * @since 2.7.0 |
||
| 512 | * @param array $product_ids |
||
| 513 | * @throws WC_Data_Exception |
||
| 514 | */ |
||
| 515 | public function set_product_ids( $product_ids ) { |
||
| 518 | |||
| 519 | /** |
||
| 520 | * Set the product IDs this coupon cannot be used with. |
||
| 521 | * @since 2.7.0 |
||
| 522 | * @param array $excluded_product_ids |
||
| 523 | * @throws WC_Data_Exception |
||
| 524 | */ |
||
| 525 | public function set_excluded_product_ids( $excluded_product_ids ) { |
||
| 528 | |||
| 529 | /** |
||
| 530 | * Set the amount of times this coupon can be used. |
||
| 531 | * @since 2.7.0 |
||
| 532 | * @param int $usage_limit |
||
| 533 | * @throws WC_Data_Exception |
||
| 534 | */ |
||
| 535 | public function set_usage_limit( $usage_limit ) { |
||
| 538 | |||
| 539 | /** |
||
| 540 | * Set the amount of times this coupon can be used per user. |
||
| 541 | * @since 2.7.0 |
||
| 542 | * @param int $usage_limit |
||
| 543 | * @throws WC_Data_Exception |
||
| 544 | */ |
||
| 545 | public function set_usage_limit_per_user( $usage_limit ) { |
||
| 548 | |||
| 549 | /** |
||
| 550 | * Set usage limit to x number of items. |
||
| 551 | * @since 2.7.0 |
||
| 552 | * @param int $limit_usage_to_x_items |
||
| 553 | * @throws WC_Data_Exception |
||
| 554 | */ |
||
| 555 | public function set_limit_usage_to_x_items( $limit_usage_to_x_items ) { |
||
| 558 | |||
| 559 | /** |
||
| 560 | * Set if this coupon enables free shipping or not. |
||
| 561 | * @since 2.7.0 |
||
| 562 | * @param bool $free_shipping |
||
| 563 | * @throws WC_Data_Exception |
||
| 564 | */ |
||
| 565 | public function set_free_shipping( $free_shipping ) { |
||
| 568 | |||
| 569 | /** |
||
| 570 | * Set the product category IDs this coupon can be used with. |
||
| 571 | * @since 2.7.0 |
||
| 572 | * @param array $product_categories |
||
| 573 | * @throws WC_Data_Exception |
||
| 574 | */ |
||
| 575 | public function set_product_categories( $product_categories ) { |
||
| 578 | |||
| 579 | /** |
||
| 580 | * Set the product category IDs this coupon cannot be used with. |
||
| 581 | * @since 2.7.0 |
||
| 582 | * @param array $excluded_product_categories |
||
| 583 | * @throws WC_Data_Exception |
||
| 584 | */ |
||
| 585 | public function set_excluded_product_categories( $excluded_product_categories ) { |
||
| 588 | |||
| 589 | /** |
||
| 590 | * Set if this coupon should excluded sale items or not. |
||
| 591 | * @since 2.7.0 |
||
| 592 | * @param bool $exclude_sale_items |
||
| 593 | * @throws WC_Data_Exception |
||
| 594 | */ |
||
| 595 | public function set_exclude_sale_items( $exclude_sale_items ) { |
||
| 598 | |||
| 599 | /** |
||
| 600 | * Set the minimum spend amount. |
||
| 601 | * @since 2.7.0 |
||
| 602 | * @param float $amount |
||
| 603 | * @throws WC_Data_Exception |
||
| 604 | */ |
||
| 605 | public function set_minimum_amount( $amount ) { |
||
| 608 | |||
| 609 | /** |
||
| 610 | * Set the maximum spend amount. |
||
| 611 | * @since 2.7.0 |
||
| 612 | * @param float $amount |
||
| 613 | * @throws WC_Data_Exception |
||
| 614 | */ |
||
| 615 | public function set_maximum_amount( $amount ) { |
||
| 618 | |||
| 619 | /** |
||
| 620 | * Set email restrictions. |
||
| 621 | * @since 2.7.0 |
||
| 622 | * @param array $emails |
||
| 623 | * @throws WC_Data_Exception |
||
| 624 | */ |
||
| 625 | public function set_email_restrictions( $emails = array() ) { |
||
| 634 | |||
| 635 | /** |
||
| 636 | * Set which users have used this coupon. |
||
| 637 | * @since 2.7.0 |
||
| 638 | * @param array $used_by |
||
| 639 | * @throws WC_Data_Exception |
||
| 640 | */ |
||
| 641 | public function set_used_by( $used_by ) { |
||
| 644 | |||
| 645 | /* |
||
| 646 | |-------------------------------------------------------------------------- |
||
| 647 | | CRUD methods |
||
| 648 | |-------------------------------------------------------------------------- |
||
| 649 | | |
||
| 650 | | Methods which create, read, update and delete coupons from the database. |
||
| 651 | | |
||
| 652 | | A save method is included for convenience (chooses update or create based |
||
| 653 | | on if the order exists yet). |
||
| 654 | | |
||
| 655 | */ |
||
| 656 | |||
| 657 | /** |
||
| 658 | * Reads an coupon from the database and sets its data to the class. |
||
| 659 | * @since 2.7.0 |
||
| 660 | * @param int $coupon_id |
||
| 661 | */ |
||
| 662 | public function read( $coupon_id ) { |
||
| 704 | |||
| 705 | /** |
||
| 706 | * Create a new coupon. |
||
| 707 | * @since 2.7.0 |
||
| 708 | */ |
||
| 709 | public function create() { |
||
| 730 | |||
| 731 | /** |
||
| 732 | * Updates an existing coupon. |
||
| 733 | * @since 2.7.0 |
||
| 734 | */ |
||
| 735 | public function update() { |
||
| 749 | |||
| 750 | /** |
||
| 751 | * Save data (either create or update depending on if we are working on an existing coupon) |
||
| 752 | * @since 2.7.0 |
||
| 753 | */ |
||
| 754 | public function save() { |
||
| 761 | |||
| 762 | /** |
||
| 763 | * Delete coupon from the database. |
||
| 764 | * @since 2.7.0 |
||
| 765 | */ |
||
| 766 | public function delete() { |
||
| 770 | |||
| 771 | /** |
||
| 772 | * Helper method that updates all the post meta for a coupon based on it's settings in the WC_Coupon class. |
||
| 773 | * @since 2.7.0 |
||
| 774 | * @param int $coupon_id |
||
| 775 | */ |
||
| 776 | private function update_post_meta( $coupon_id ) { |
||
| 795 | |||
| 796 | /** |
||
| 797 | * Developers can programically return coupons. This function will read those values into our WC_Coupon class. |
||
| 798 | * @since 2.7.0 |
||
| 799 | * @param string $code Coupon code |
||
| 800 | * @param array $coupon Array of coupon properties |
||
| 801 | */ |
||
| 802 | public function read_manual_coupon( $code, $coupon ) { |
||
| 841 | |||
| 842 | /* |
||
| 843 | |-------------------------------------------------------------------------- |
||
| 844 | | Other Actions |
||
| 845 | |-------------------------------------------------------------------------- |
||
| 846 | */ |
||
| 847 | |||
| 848 | /** |
||
| 849 | * Increase usage count for current coupon. |
||
| 850 | * |
||
| 851 | * @param string $used_by Either user ID or billing email |
||
| 852 | */ |
||
| 853 | public function inc_usage_count( $used_by = '' ) { |
||
| 863 | |||
| 864 | /** |
||
| 865 | * Decrease usage count for current coupon. |
||
| 866 | * |
||
| 867 | * @param string $used_by Either user ID or billing email |
||
| 868 | */ |
||
| 869 | public function dcr_usage_count( $used_by = '' ) { |
||
| 887 | |||
| 888 | /* |
||
| 889 | |-------------------------------------------------------------------------- |
||
| 890 | | Validation & Error Handling |
||
| 891 | |-------------------------------------------------------------------------- |
||
| 892 | */ |
||
| 893 | |||
| 894 | /** |
||
| 895 | * Returns the error_message string. |
||
| 896 | * |
||
| 897 | * @access public |
||
| 898 | * @return string |
||
| 899 | */ |
||
| 900 | public function get_error_message() { |
||
| 903 | |||
| 904 | /** |
||
| 905 | * Ensure coupon exists or throw exception. |
||
| 906 | * |
||
| 907 | * @throws Exception |
||
| 908 | */ |
||
| 909 | private function validate_exists() { |
||
| 914 | |||
| 915 | /** |
||
| 916 | * Ensure coupon usage limit is valid or throw exception. |
||
| 917 | * |
||
| 918 | * @throws Exception |
||
| 919 | */ |
||
| 920 | private function validate_usage_limit() { |
||
| 925 | |||
| 926 | /** |
||
| 927 | * Ensure coupon user usage limit is valid or throw exception. |
||
| 928 | * |
||
| 929 | * Per user usage limit - check here if user is logged in (against user IDs). |
||
| 930 | * Checked again for emails later on in WC_Cart::check_customer_coupons(). |
||
| 931 | * |
||
| 932 | * @param int $user_id |
||
| 933 | * @throws Exception |
||
| 934 | */ |
||
| 935 | private function validate_user_usage_limit( $user_id = 0 ) { |
||
| 948 | |||
| 949 | /** |
||
| 950 | * Ensure coupon date is valid or throw exception. |
||
| 951 | * |
||
| 952 | * @throws Exception |
||
| 953 | */ |
||
| 954 | private function validate_expiry_date() { |
||
| 959 | |||
| 960 | /** |
||
| 961 | * Ensure coupon amount is valid or throw exception. |
||
| 962 | * |
||
| 963 | * @throws Exception |
||
| 964 | */ |
||
| 965 | private function validate_minimum_amount() { |
||
| 970 | |||
| 971 | /** |
||
| 972 | * Ensure coupon amount is valid or throw exception. |
||
| 973 | * |
||
| 974 | * @throws Exception |
||
| 975 | */ |
||
| 976 | private function validate_maximum_amount() { |
||
| 981 | |||
| 982 | /** |
||
| 983 | * Ensure coupon is valid for products in the cart is valid or throw exception. |
||
| 984 | * |
||
| 985 | * @throws Exception |
||
| 986 | */ |
||
| 987 | View Code Duplication | private function validate_product_ids() { |
|
| 1002 | |||
| 1003 | /** |
||
| 1004 | * Ensure coupon is valid for product categories in the cart is valid or throw exception. |
||
| 1005 | * |
||
| 1006 | * @throws Exception |
||
| 1007 | */ |
||
| 1008 | View Code Duplication | private function validate_product_categories() { |
|
| 1026 | |||
| 1027 | /** |
||
| 1028 | * Ensure coupon is valid for sale items in the cart is valid or throw exception. |
||
| 1029 | * |
||
| 1030 | * @throws Exception |
||
| 1031 | */ |
||
| 1032 | View Code Duplication | private function validate_sale_items() { |
|
| 1053 | |||
| 1054 | /** |
||
| 1055 | * All exclusion rules must pass at the same time for a product coupon to be valid. |
||
| 1056 | */ |
||
| 1057 | private function validate_excluded_items() { |
||
| 1073 | |||
| 1074 | /** |
||
| 1075 | * Cart discounts cannot be added if non-eligble product is found in cart. |
||
| 1076 | */ |
||
| 1077 | private function validate_cart_excluded_items() { |
||
| 1084 | |||
| 1085 | /** |
||
| 1086 | * Exclude products from cart. |
||
| 1087 | * |
||
| 1088 | * @throws Exception |
||
| 1089 | */ |
||
| 1090 | View Code Duplication | private function validate_cart_excluded_product_ids() { |
|
| 1106 | |||
| 1107 | /** |
||
| 1108 | * Exclude categories from cart. |
||
| 1109 | * |
||
| 1110 | * @throws Exception |
||
| 1111 | */ |
||
| 1112 | View Code Duplication | private function validate_cart_excluded_product_categories() { |
|
| 1128 | |||
| 1129 | /** |
||
| 1130 | * Exclude sale items from cart. |
||
| 1131 | * |
||
| 1132 | * @throws Exception |
||
| 1133 | */ |
||
| 1134 | View Code Duplication | private function validate_cart_excluded_sale_items() { |
|
| 1154 | |||
| 1155 | /** |
||
| 1156 | * Check if a coupon is valid. |
||
| 1157 | * |
||
| 1158 | * @return boolean validity |
||
| 1159 | * @throws Exception |
||
| 1160 | */ |
||
| 1161 | public function is_valid() { |
||
| 1185 | |||
| 1186 | /** |
||
| 1187 | * Check if a coupon is valid. |
||
| 1188 | * |
||
| 1189 | * @return bool |
||
| 1190 | */ |
||
| 1191 | public function is_valid_for_cart() { |
||
| 1194 | |||
| 1195 | /** |
||
| 1196 | * Check if a coupon is valid for a product. |
||
| 1197 | * |
||
| 1198 | * @param WC_Product $product |
||
| 1199 | * @return boolean |
||
| 1200 | */ |
||
| 1201 | public function is_valid_for_product( $product, $values = array() ) { |
||
| 1250 | |||
| 1251 | /** |
||
| 1252 | * Converts one of the WC_Coupon message/error codes to a message string and. |
||
| 1253 | * displays the message/error. |
||
| 1254 | * |
||
| 1255 | * @param int $msg_code Message/error code. |
||
| 1256 | */ |
||
| 1257 | public function add_coupon_message( $msg_code ) { |
||
| 1270 | |||
| 1271 | /** |
||
| 1272 | * Map one of the WC_Coupon message codes to a message string. |
||
| 1273 | * |
||
| 1274 | * @param integer $msg_code |
||
| 1275 | * @return string| Message/error string |
||
| 1276 | */ |
||
| 1277 | View Code Duplication | public function get_coupon_message( $msg_code ) { |
|
| 1291 | |||
| 1292 | /** |
||
| 1293 | * Map one of the WC_Coupon error codes to a message string. |
||
| 1294 | * |
||
| 1295 | * @param int $err_code Message/error code. |
||
| 1296 | * @return string| Message/error string |
||
| 1297 | */ |
||
| 1298 | public function get_coupon_error( $err_code ) { |
||
| 1374 | |||
| 1375 | /** |
||
| 1376 | * Map one of the WC_Coupon error codes to an error string. |
||
| 1377 | * No coupon instance will be available where a coupon does not exist, |
||
| 1378 | * so this static method exists. |
||
| 1379 | * |
||
| 1380 | * @param int $err_code Error code |
||
| 1381 | * @return string| Error string |
||
| 1382 | */ |
||
| 1383 | View Code Duplication | public static function get_generic_coupon_error( $err_code ) { |
|
| 1398 | } |
||
| 1399 |
Loading history...
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: