@@ -15,30 +15,30 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class WPInv_Discount extends GetPaid_Data { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Which data store to load. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 18 | + /** |
|
| 19 | + * Which data store to load. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | 23 | protected $data_store_name = 'discount'; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * This is the name of this object type. |
|
| 27 | - * |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $object_type = 'discount'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Discount 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 | - 'status' => 'draft', |
|
| 40 | - 'version' => '', |
|
| 41 | - 'date_created' => null, |
|
| 26 | + * This is the name of this object type. |
|
| 27 | + * |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $object_type = 'discount'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Discount 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 | + 'status' => 'draft', |
|
| 40 | + 'version' => '', |
|
| 41 | + 'date_created' => null, |
|
| 42 | 42 | 'date_modified' => null, |
| 43 | 43 | 'name' => 'no-name', |
| 44 | 44 | 'description' => '', |
@@ -58,144 +58,144 @@ discard block |
||
| 58 | 58 | 'amount' => null, |
| 59 | 59 | ); |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Stores meta in cache for future reads. |
|
| 63 | - * |
|
| 64 | - * A group must be set to to enable caching. |
|
| 65 | - * |
|
| 66 | - * @var string |
|
| 67 | - */ |
|
| 68 | - protected $cache_group = 'getpaid_discounts'; |
|
| 61 | + /** |
|
| 62 | + * Stores meta in cache for future reads. |
|
| 63 | + * |
|
| 64 | + * A group must be set to to enable caching. |
|
| 65 | + * |
|
| 66 | + * @var string |
|
| 67 | + */ |
|
| 68 | + protected $cache_group = 'getpaid_discounts'; |
|
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | 71 | * Stores a reference to the original WP_Post object |
| 72 | 72 | * |
| 73 | 73 | * @var WP_Post |
| 74 | 74 | */ |
| 75 | - protected $post = null; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | - * |
|
| 80 | - * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | - */ |
|
| 82 | - public function __construct( $discount = 0 ) { |
|
| 83 | - parent::__construct( $discount ); |
|
| 84 | - |
|
| 85 | - if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | - $this->set_id( $discount ); |
|
| 87 | - } elseif ( $discount instanceof self ) { |
|
| 88 | - $this->set_id( $discount->get_id() ); |
|
| 89 | - } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | - $this->set_id( $discount->ID ); |
|
| 91 | - } elseif ( is_array( $discount ) ) { |
|
| 92 | - $this->set_props( $discount ); |
|
| 93 | - |
|
| 94 | - if ( isset( $discount['ID'] ) ) { |
|
| 95 | - $this->set_id( $discount['ID'] ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | - $this->set_id( $discount ); |
|
| 100 | - } else { |
|
| 101 | - $this->set_object_read( true ); |
|
| 102 | - } |
|
| 75 | + protected $post = null; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | + * |
|
| 80 | + * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | + */ |
|
| 82 | + public function __construct( $discount = 0 ) { |
|
| 83 | + parent::__construct( $discount ); |
|
| 84 | + |
|
| 85 | + if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | + $this->set_id( $discount ); |
|
| 87 | + } elseif ( $discount instanceof self ) { |
|
| 88 | + $this->set_id( $discount->get_id() ); |
|
| 89 | + } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | + $this->set_id( $discount->ID ); |
|
| 91 | + } elseif ( is_array( $discount ) ) { |
|
| 92 | + $this->set_props( $discount ); |
|
| 93 | + |
|
| 94 | + if ( isset( $discount['ID'] ) ) { |
|
| 95 | + $this->set_id( $discount['ID'] ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | + $this->set_id( $discount ); |
|
| 100 | + } else { |
|
| 101 | + $this->set_object_read( true ); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | 104 | // Load the datastore. |
| 105 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 105 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 106 | 106 | |
| 107 | - if ( $this->get_id() > 0 ) { |
|
| 107 | + if ( $this->get_id() > 0 ) { |
|
| 108 | 108 | $this->post = get_post( $this->get_id() ); |
| 109 | 109 | $this->ID = $this->get_id(); |
| 110 | - $this->data_store->read( $this ); |
|
| 110 | + $this->data_store->read( $this ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Fetch a discount from the db/cache |
|
| 117 | + * |
|
| 118 | + * |
|
| 119 | + * @static |
|
| 120 | + * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | + * @param string|int $value The field value |
|
| 122 | + * @deprecated |
|
| 123 | + * @since 1.0.15 |
|
| 124 | + * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | + */ |
|
| 126 | + public static function get_data_by( $field, $value ) { |
|
| 127 | + |
|
| 128 | + if ( 'id' == strtolower( $field ) ) { |
|
| 129 | + // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | + // to int 1. |
|
| 131 | + if ( ! is_numeric( $value ) ) |
|
| 132 | + return false; |
|
| 133 | + $value = intval( $value ); |
|
| 134 | + if ( $value < 1 ) |
|
| 135 | + return false; |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | + return false; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + $field = trim( $field ); |
|
| 143 | + |
|
| 144 | + // prepare query args |
|
| 145 | + switch ( strtolower( $field ) ) { |
|
| 146 | + case 'id': |
|
| 147 | + $discount_id = $value; |
|
| 148 | + $args = array( 'include' => array( $value ) ); |
|
| 149 | + break; |
|
| 150 | + case 'discount_code': |
|
| 151 | + case 'code': |
|
| 152 | + $value = trim( $value ); |
|
| 153 | + $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | + $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | + break; |
|
| 156 | + case 'name': |
|
| 157 | + $discount_id = 0; |
|
| 158 | + $args = array( 'name' => trim( $value ) ); |
|
| 159 | + break; |
|
| 160 | + default: |
|
| 161 | + $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | + if ( ! is_array( $args ) ) { |
|
| 163 | + return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + // Check if there is a cached value. |
|
| 169 | + if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | + return $discount; |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + $args = array_merge( |
|
| 174 | + $args, |
|
| 175 | + array( |
|
| 176 | + 'post_type' => 'wpi_discount', |
|
| 177 | + 'posts_per_page' => 1, |
|
| 178 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | + ) |
|
| 180 | + ); |
|
| 181 | + |
|
| 182 | + $discount = get_posts( $args ); |
|
| 183 | + |
|
| 184 | + if( empty( $discount ) ) { |
|
| 185 | + return false; |
|
| 111 | 186 | } |
| 112 | 187 | |
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Fetch a discount from the db/cache |
|
| 117 | - * |
|
| 118 | - * |
|
| 119 | - * @static |
|
| 120 | - * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | - * @param string|int $value The field value |
|
| 122 | - * @deprecated |
|
| 123 | - * @since 1.0.15 |
|
| 124 | - * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | - */ |
|
| 126 | - public static function get_data_by( $field, $value ) { |
|
| 127 | - |
|
| 128 | - if ( 'id' == strtolower( $field ) ) { |
|
| 129 | - // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | - // to int 1. |
|
| 131 | - if ( ! is_numeric( $value ) ) |
|
| 132 | - return false; |
|
| 133 | - $value = intval( $value ); |
|
| 134 | - if ( $value < 1 ) |
|
| 135 | - return false; |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | - return false; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - $field = trim( $field ); |
|
| 143 | - |
|
| 144 | - // prepare query args |
|
| 145 | - switch ( strtolower( $field ) ) { |
|
| 146 | - case 'id': |
|
| 147 | - $discount_id = $value; |
|
| 148 | - $args = array( 'include' => array( $value ) ); |
|
| 149 | - break; |
|
| 150 | - case 'discount_code': |
|
| 151 | - case 'code': |
|
| 152 | - $value = trim( $value ); |
|
| 153 | - $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | - $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | - break; |
|
| 156 | - case 'name': |
|
| 157 | - $discount_id = 0; |
|
| 158 | - $args = array( 'name' => trim( $value ) ); |
|
| 159 | - break; |
|
| 160 | - default: |
|
| 161 | - $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | - if ( ! is_array( $args ) ) { |
|
| 163 | - return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - // Check if there is a cached value. |
|
| 169 | - if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | - return $discount; |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - $args = array_merge( |
|
| 174 | - $args, |
|
| 175 | - array( |
|
| 176 | - 'post_type' => 'wpi_discount', |
|
| 177 | - 'posts_per_page' => 1, |
|
| 178 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | - ) |
|
| 180 | - ); |
|
| 181 | - |
|
| 182 | - $discount = get_posts( $args ); |
|
| 183 | - |
|
| 184 | - if( empty( $discount ) ) { |
|
| 185 | - return false; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - $discount = $discount[0]; |
|
| 189 | - |
|
| 190 | - // Prepare the return data. |
|
| 191 | - $return = array( |
|
| 188 | + $discount = $discount[0]; |
|
| 189 | + |
|
| 190 | + // Prepare the return data. |
|
| 191 | + $return = array( |
|
| 192 | 192 | 'ID' => $discount->ID, |
| 193 | 193 | 'code' => get_post_meta( $discount->ID, '_wpi_discount_code', true ), |
| 194 | 194 | 'amount' => get_post_meta( $discount->ID, '_wpi_discount_amount', true ), |
| 195 | 195 | 'date_created' => $discount->post_date, |
| 196 | - 'date_modified' => $discount->post_modified, |
|
| 197 | - 'status' => $discount->post_status, |
|
| 198 | - 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 196 | + 'date_modified' => $discount->post_modified, |
|
| 197 | + 'status' => $discount->post_status, |
|
| 198 | + 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 199 | 199 | 'expiration' => get_post_meta( $discount->ID, '_wpi_discount_expiration', true ), |
| 200 | 200 | 'type' => get_post_meta( $discount->ID, '_wpi_discount_type', true ), |
| 201 | 201 | 'description' => $discount->post_excerpt, |
@@ -209,77 +209,77 @@ discard block |
||
| 209 | 209 | 'max_total' => get_post_meta( $discount->ID, '_wpi_discount_max_total', true ), |
| 210 | 210 | ); |
| 211 | 211 | |
| 212 | - $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | - |
|
| 214 | - // Update the cache with our data |
|
| 215 | - wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | - wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | - |
|
| 218 | - return $return; |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Given a discount code, it returns a discount id. |
|
| 223 | - * |
|
| 224 | - * |
|
| 225 | - * @static |
|
| 226 | - * @param string $discount_code |
|
| 227 | - * @since 1.0.15 |
|
| 228 | - * @return int |
|
| 229 | - */ |
|
| 230 | - public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | - |
|
| 232 | - // Trim the code. |
|
| 233 | - $discount_code = trim( $discount_code ); |
|
| 234 | - |
|
| 235 | - // Ensure a value has been passed. |
|
| 236 | - if ( empty( $discount_code ) ) { |
|
| 237 | - return 0; |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - // Maybe retrieve from the cache. |
|
| 241 | - $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | - if ( ! empty( $discount_id ) ) { |
|
| 243 | - return $discount_id; |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - // Fetch the first discount codes. |
|
| 247 | - $discounts = get_posts( |
|
| 248 | - array( |
|
| 249 | - 'meta_key' => '_wpi_discount_code', |
|
| 250 | - 'meta_value' => $discount_code, |
|
| 251 | - 'post_type' => 'wpi_discount', |
|
| 252 | - 'posts_per_page' => 1, |
|
| 253 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | - 'fields' => 'ids', |
|
| 255 | - ) |
|
| 256 | - ); |
|
| 257 | - |
|
| 258 | - if ( empty( $discounts ) ) { |
|
| 259 | - return 0; |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - $discount_id = $discounts[0]; |
|
| 263 | - |
|
| 264 | - // Update the cache with our data |
|
| 265 | - wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | - |
|
| 267 | - return $discount_id; |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * Magic method for checking the existence of a certain custom field. |
|
| 272 | - * |
|
| 273 | - * @since 1.0.15 |
|
| 274 | - * @access public |
|
| 275 | - * |
|
| 276 | - * @return bool Whether the given discount field is set. |
|
| 277 | - */ |
|
| 278 | - public function __isset( $key ){ |
|
| 279 | - return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - /* |
|
| 212 | + $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | + |
|
| 214 | + // Update the cache with our data |
|
| 215 | + wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | + wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | + |
|
| 218 | + return $return; |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Given a discount code, it returns a discount id. |
|
| 223 | + * |
|
| 224 | + * |
|
| 225 | + * @static |
|
| 226 | + * @param string $discount_code |
|
| 227 | + * @since 1.0.15 |
|
| 228 | + * @return int |
|
| 229 | + */ |
|
| 230 | + public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | + |
|
| 232 | + // Trim the code. |
|
| 233 | + $discount_code = trim( $discount_code ); |
|
| 234 | + |
|
| 235 | + // Ensure a value has been passed. |
|
| 236 | + if ( empty( $discount_code ) ) { |
|
| 237 | + return 0; |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + // Maybe retrieve from the cache. |
|
| 241 | + $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | + if ( ! empty( $discount_id ) ) { |
|
| 243 | + return $discount_id; |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + // Fetch the first discount codes. |
|
| 247 | + $discounts = get_posts( |
|
| 248 | + array( |
|
| 249 | + 'meta_key' => '_wpi_discount_code', |
|
| 250 | + 'meta_value' => $discount_code, |
|
| 251 | + 'post_type' => 'wpi_discount', |
|
| 252 | + 'posts_per_page' => 1, |
|
| 253 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | + 'fields' => 'ids', |
|
| 255 | + ) |
|
| 256 | + ); |
|
| 257 | + |
|
| 258 | + if ( empty( $discounts ) ) { |
|
| 259 | + return 0; |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + $discount_id = $discounts[0]; |
|
| 263 | + |
|
| 264 | + // Update the cache with our data |
|
| 265 | + wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | + |
|
| 267 | + return $discount_id; |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * Magic method for checking the existence of a certain custom field. |
|
| 272 | + * |
|
| 273 | + * @since 1.0.15 |
|
| 274 | + * @access public |
|
| 275 | + * |
|
| 276 | + * @return bool Whether the given discount field is set. |
|
| 277 | + */ |
|
| 278 | + public function __isset( $key ){ |
|
| 279 | + return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + /* |
|
| 283 | 283 | |-------------------------------------------------------------------------- |
| 284 | 284 | | CRUD methods |
| 285 | 285 | |-------------------------------------------------------------------------- |
@@ -294,430 +294,430 @@ discard block |
||
| 294 | 294 | |-------------------------------------------------------------------------- |
| 295 | 295 | */ |
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * Get discount status. |
|
| 299 | - * |
|
| 300 | - * @since 1.0.19 |
|
| 301 | - * @param string $context View or edit context. |
|
| 302 | - * @return string |
|
| 303 | - */ |
|
| 304 | - public function get_status( $context = 'view' ) { |
|
| 305 | - return $this->get_prop( 'status', $context ); |
|
| 297 | + /** |
|
| 298 | + * Get discount status. |
|
| 299 | + * |
|
| 300 | + * @since 1.0.19 |
|
| 301 | + * @param string $context View or edit context. |
|
| 302 | + * @return string |
|
| 303 | + */ |
|
| 304 | + public function get_status( $context = 'view' ) { |
|
| 305 | + return $this->get_prop( 'status', $context ); |
|
| 306 | 306 | } |
| 307 | 307 | |
| 308 | 308 | /** |
| 309 | - * Get plugin version when the discount was created. |
|
| 310 | - * |
|
| 311 | - * @since 1.0.19 |
|
| 312 | - * @param string $context View or edit context. |
|
| 313 | - * @return string |
|
| 314 | - */ |
|
| 315 | - public function get_version( $context = 'view' ) { |
|
| 316 | - return $this->get_prop( 'version', $context ); |
|
| 309 | + * Get plugin version when the discount was created. |
|
| 310 | + * |
|
| 311 | + * @since 1.0.19 |
|
| 312 | + * @param string $context View or edit context. |
|
| 313 | + * @return string |
|
| 314 | + */ |
|
| 315 | + public function get_version( $context = 'view' ) { |
|
| 316 | + return $this->get_prop( 'version', $context ); |
|
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | /** |
| 320 | - * Get date when the discount was created. |
|
| 321 | - * |
|
| 322 | - * @since 1.0.19 |
|
| 323 | - * @param string $context View or edit context. |
|
| 324 | - * @return string |
|
| 325 | - */ |
|
| 326 | - public function get_date_created( $context = 'view' ) { |
|
| 327 | - return $this->get_prop( 'date_created', $context ); |
|
| 320 | + * Get date when the discount was created. |
|
| 321 | + * |
|
| 322 | + * @since 1.0.19 |
|
| 323 | + * @param string $context View or edit context. |
|
| 324 | + * @return string |
|
| 325 | + */ |
|
| 326 | + public function get_date_created( $context = 'view' ) { |
|
| 327 | + return $this->get_prop( 'date_created', $context ); |
|
| 328 | 328 | } |
| 329 | 329 | |
| 330 | 330 | /** |
| 331 | - * Get GMT date when the discount was created. |
|
| 332 | - * |
|
| 333 | - * @since 1.0.19 |
|
| 334 | - * @param string $context View or edit context. |
|
| 335 | - * @return string |
|
| 336 | - */ |
|
| 337 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 331 | + * Get GMT date when the discount was created. |
|
| 332 | + * |
|
| 333 | + * @since 1.0.19 |
|
| 334 | + * @param string $context View or edit context. |
|
| 335 | + * @return string |
|
| 336 | + */ |
|
| 337 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 338 | 338 | $date = $this->get_date_created( $context ); |
| 339 | 339 | |
| 340 | 340 | if ( $date ) { |
| 341 | 341 | $date = get_gmt_from_date( $date ); |
| 342 | 342 | } |
| 343 | - return $date; |
|
| 343 | + return $date; |
|
| 344 | 344 | } |
| 345 | 345 | |
| 346 | 346 | /** |
| 347 | - * Get date when the discount was last modified. |
|
| 348 | - * |
|
| 349 | - * @since 1.0.19 |
|
| 350 | - * @param string $context View or edit context. |
|
| 351 | - * @return string |
|
| 352 | - */ |
|
| 353 | - public function get_date_modified( $context = 'view' ) { |
|
| 354 | - return $this->get_prop( 'date_modified', $context ); |
|
| 347 | + * Get date when the discount was last modified. |
|
| 348 | + * |
|
| 349 | + * @since 1.0.19 |
|
| 350 | + * @param string $context View or edit context. |
|
| 351 | + * @return string |
|
| 352 | + */ |
|
| 353 | + public function get_date_modified( $context = 'view' ) { |
|
| 354 | + return $this->get_prop( 'date_modified', $context ); |
|
| 355 | 355 | } |
| 356 | 356 | |
| 357 | 357 | /** |
| 358 | - * Get GMT date when the discount was last modified. |
|
| 359 | - * |
|
| 360 | - * @since 1.0.19 |
|
| 361 | - * @param string $context View or edit context. |
|
| 362 | - * @return string |
|
| 363 | - */ |
|
| 364 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 358 | + * Get GMT date when the discount was last modified. |
|
| 359 | + * |
|
| 360 | + * @since 1.0.19 |
|
| 361 | + * @param string $context View or edit context. |
|
| 362 | + * @return string |
|
| 363 | + */ |
|
| 364 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 365 | 365 | $date = $this->get_date_modified( $context ); |
| 366 | 366 | |
| 367 | 367 | if ( $date ) { |
| 368 | 368 | $date = get_gmt_from_date( $date ); |
| 369 | 369 | } |
| 370 | - return $date; |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 374 | - * Get the discount name. |
|
| 375 | - * |
|
| 376 | - * @since 1.0.19 |
|
| 377 | - * @param string $context View or edit context. |
|
| 378 | - * @return string |
|
| 379 | - */ |
|
| 380 | - public function get_name( $context = 'view' ) { |
|
| 381 | - return $this->get_prop( 'name', $context ); |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - /** |
|
| 385 | - * Alias of self::get_name(). |
|
| 386 | - * |
|
| 387 | - * @since 1.0.19 |
|
| 388 | - * @param string $context View or edit context. |
|
| 389 | - * @return string |
|
| 390 | - */ |
|
| 391 | - public function get_title( $context = 'view' ) { |
|
| 392 | - return $this->get_name( $context ); |
|
| 393 | - } |
|
| 394 | - |
|
| 395 | - /** |
|
| 396 | - * Get the discount description. |
|
| 397 | - * |
|
| 398 | - * @since 1.0.19 |
|
| 399 | - * @param string $context View or edit context. |
|
| 400 | - * @return string |
|
| 401 | - */ |
|
| 402 | - public function get_description( $context = 'view' ) { |
|
| 403 | - return $this->get_prop( 'description', $context ); |
|
| 404 | - } |
|
| 405 | - |
|
| 406 | - /** |
|
| 407 | - * Alias of self::get_description(). |
|
| 408 | - * |
|
| 409 | - * @since 1.0.19 |
|
| 410 | - * @param string $context View or edit context. |
|
| 411 | - * @return string |
|
| 412 | - */ |
|
| 413 | - public function get_excerpt( $context = 'view' ) { |
|
| 414 | - return $this->get_description( $context ); |
|
| 415 | - } |
|
| 416 | - |
|
| 417 | - /** |
|
| 418 | - * Alias of self::get_description(). |
|
| 419 | - * |
|
| 420 | - * @since 1.0.19 |
|
| 421 | - * @param string $context View or edit context. |
|
| 422 | - * @return string |
|
| 423 | - */ |
|
| 424 | - public function get_summary( $context = 'view' ) { |
|
| 425 | - return $this->get_description( $context ); |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - /** |
|
| 429 | - * Get the owner of the discount. |
|
| 430 | - * |
|
| 431 | - * @since 1.0.19 |
|
| 432 | - * @param string $context View or edit context. |
|
| 433 | - * @return string |
|
| 434 | - */ |
|
| 435 | - public function get_author( $context = 'view' ) { |
|
| 436 | - return (int) $this->get_prop( 'author', $context ); |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - /** |
|
| 440 | - * Get the discount code. |
|
| 441 | - * |
|
| 442 | - * @since 1.0.19 |
|
| 443 | - * @param string $context View or edit context. |
|
| 444 | - * @return string |
|
| 445 | - */ |
|
| 446 | - public function get_code( $context = 'view' ) { |
|
| 447 | - return $this->get_prop( 'code', $context ); |
|
| 448 | - } |
|
| 449 | - |
|
| 450 | - /** |
|
| 451 | - * Alias for self::get_code(). |
|
| 452 | - * |
|
| 453 | - * @since 1.0.19 |
|
| 454 | - * @param string $context View or edit context. |
|
| 455 | - * @return string |
|
| 456 | - */ |
|
| 457 | - public function get_coupon_code( $context = 'view' ) { |
|
| 458 | - return $this->get_code( $context ); |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - /** |
|
| 462 | - * Alias for self::get_code(). |
|
| 463 | - * |
|
| 464 | - * @since 1.0.19 |
|
| 465 | - * @param string $context View or edit context. |
|
| 466 | - * @return string |
|
| 467 | - */ |
|
| 468 | - public function get_discount_code( $context = 'view' ) { |
|
| 469 | - return $this->get_code( $context ); |
|
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * Get the discount's amount. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return float |
|
| 478 | - */ |
|
| 479 | - public function get_amount( $context = 'view' ) { |
|
| 480 | - return $context == 'view' ? floatval( $this->get_prop( 'amount', $context ) ) : $this->get_prop( 'amount', $context ); |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the discount's formated amount/rate. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return string |
|
| 488 | - */ |
|
| 489 | - public function get_formatted_amount() { |
|
| 490 | - |
|
| 491 | - if ( $this->is_type( 'flat' ) ) { |
|
| 492 | - $rate = wpinv_price( $this->get_amount() ); |
|
| 493 | - } else { |
|
| 494 | - $rate = $this->get_amount() . '%'; |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | - } |
|
| 499 | - |
|
| 500 | - /** |
|
| 501 | - * Get the discount's start date. |
|
| 502 | - * |
|
| 503 | - * @since 1.0.19 |
|
| 504 | - * @param string $context View or edit context. |
|
| 505 | - * @return string |
|
| 506 | - */ |
|
| 507 | - public function get_start( $context = 'view' ) { |
|
| 508 | - return $this->get_prop( 'start', $context ); |
|
| 509 | - } |
|
| 510 | - |
|
| 511 | - /** |
|
| 512 | - * Alias for self::get_start(). |
|
| 513 | - * |
|
| 514 | - * @since 1.0.19 |
|
| 515 | - * @param string $context View or edit context. |
|
| 516 | - * @return string |
|
| 517 | - */ |
|
| 518 | - public function get_start_date( $context = 'view' ) { |
|
| 519 | - return $this->get_start( $context ); |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - /** |
|
| 523 | - * Get the discount's expiration date. |
|
| 524 | - * |
|
| 525 | - * @since 1.0.19 |
|
| 526 | - * @param string $context View or edit context. |
|
| 527 | - * @return string |
|
| 528 | - */ |
|
| 529 | - public function get_expiration( $context = 'view' ) { |
|
| 530 | - return $this->get_prop( 'expiration', $context ); |
|
| 531 | - } |
|
| 532 | - |
|
| 533 | - /** |
|
| 534 | - * Alias for self::get_expiration(). |
|
| 535 | - * |
|
| 536 | - * @since 1.0.19 |
|
| 537 | - * @param string $context View or edit context. |
|
| 538 | - * @return string |
|
| 539 | - */ |
|
| 540 | - public function get_expiration_date( $context = 'view' ) { |
|
| 541 | - return $this->get_expiration( $context ); |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - /** |
|
| 545 | - * Alias for self::get_expiration(). |
|
| 546 | - * |
|
| 547 | - * @since 1.0.19 |
|
| 548 | - * @param string $context View or edit context. |
|
| 549 | - * @return string |
|
| 550 | - */ |
|
| 551 | - public function get_end_date( $context = 'view' ) { |
|
| 552 | - return $this->get_expiration( $context ); |
|
| 553 | - } |
|
| 554 | - |
|
| 555 | - /** |
|
| 556 | - * Get the discount's type. |
|
| 557 | - * |
|
| 558 | - * @since 1.0.19 |
|
| 559 | - * @param string $context View or edit context. |
|
| 560 | - * @return string |
|
| 561 | - */ |
|
| 562 | - public function get_type( $context = 'view' ) { |
|
| 563 | - return $this->get_prop( 'type', $context ); |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Get the number of times a discount has been used. |
|
| 568 | - * |
|
| 569 | - * @since 1.0.19 |
|
| 570 | - * @param string $context View or edit context. |
|
| 571 | - * @return int |
|
| 572 | - */ |
|
| 573 | - public function get_uses( $context = 'view' ) { |
|
| 574 | - return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * Get the discount's usage, i.e uses / max uses. |
|
| 579 | - * |
|
| 580 | - * @since 1.0.19 |
|
| 581 | - * @return string |
|
| 582 | - */ |
|
| 583 | - public function get_usage() { |
|
| 584 | - |
|
| 585 | - if ( ! $this->has_limit() ) { |
|
| 586 | - return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | - |
|
| 591 | - } |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * Get the maximum number of time a discount can be used. |
|
| 595 | - * |
|
| 596 | - * @since 1.0.19 |
|
| 597 | - * @param string $context View or edit context. |
|
| 598 | - * @return int |
|
| 599 | - */ |
|
| 600 | - public function get_max_uses( $context = 'view' ) { |
|
| 601 | - $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | - return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | - } |
|
| 604 | - |
|
| 605 | - /** |
|
| 606 | - * Checks if this is a single use discount or not. |
|
| 607 | - * |
|
| 608 | - * @since 1.0.19 |
|
| 609 | - * @param string $context View or edit context. |
|
| 610 | - * @return bool |
|
| 611 | - */ |
|
| 612 | - public function get_is_single_use( $context = 'view' ) { |
|
| 613 | - return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | - } |
|
| 615 | - |
|
| 616 | - /** |
|
| 617 | - * Get the items that can be used with this discount. |
|
| 618 | - * |
|
| 619 | - * @since 1.0.19 |
|
| 620 | - * @param string $context View or edit context. |
|
| 621 | - * @return array |
|
| 622 | - */ |
|
| 623 | - public function get_items( $context = 'view' ) { |
|
| 624 | - return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - /** |
|
| 628 | - * Alias for self::get_items(). |
|
| 629 | - * |
|
| 630 | - * @since 1.0.19 |
|
| 631 | - * @param string $context View or edit context. |
|
| 632 | - * @return array |
|
| 633 | - */ |
|
| 634 | - public function get_allowed_items( $context = 'view' ) { |
|
| 635 | - return $this->get_items( $context ); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * Get the items that are not allowed to use this discount. |
|
| 640 | - * |
|
| 641 | - * @since 1.0.19 |
|
| 642 | - * @param string $context View or edit context. |
|
| 643 | - * @return array |
|
| 644 | - */ |
|
| 645 | - public function get_excluded_items( $context = 'view' ) { |
|
| 646 | - return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - /** |
|
| 650 | - * Checks if this is a recurring discount or not. |
|
| 651 | - * |
|
| 652 | - * @since 1.0.19 |
|
| 653 | - * @param string $context View or edit context. |
|
| 654 | - * @return int|string|bool |
|
| 655 | - */ |
|
| 656 | - public function get_is_recurring( $context = 'view' ) { |
|
| 657 | - return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | - } |
|
| 659 | - |
|
| 660 | - /** |
|
| 661 | - * Get's the minimum total amount allowed for this discount. |
|
| 662 | - * |
|
| 663 | - * @since 1.0.19 |
|
| 664 | - * @param string $context View or edit context. |
|
| 665 | - * @return float |
|
| 666 | - */ |
|
| 667 | - public function get_min_total( $context = 'view' ) { |
|
| 668 | - $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | - return empty( $minimum ) ? null : $minimum; |
|
| 670 | - } |
|
| 671 | - |
|
| 672 | - /** |
|
| 673 | - * Alias for self::get_min_total(). |
|
| 674 | - * |
|
| 675 | - * @since 1.0.19 |
|
| 676 | - * @param string $context View or edit context. |
|
| 677 | - * @return float |
|
| 678 | - */ |
|
| 679 | - public function get_minimum_total( $context = 'view' ) { |
|
| 680 | - return $this->get_min_total( $context ); |
|
| 681 | - } |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Get's the maximum total amount allowed for this discount. |
|
| 685 | - * |
|
| 686 | - * @since 1.0.19 |
|
| 687 | - * @param string $context View or edit context. |
|
| 688 | - * @return float |
|
| 689 | - */ |
|
| 690 | - public function get_max_total( $context = 'view' ) { |
|
| 691 | - $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | - return empty( $maximum ) ? null : $maximum; |
|
| 693 | - } |
|
| 694 | - |
|
| 695 | - /** |
|
| 696 | - * Alias for self::get_max_total(). |
|
| 697 | - * |
|
| 698 | - * @since 1.0.19 |
|
| 699 | - * @param string $context View or edit context. |
|
| 700 | - * @return float |
|
| 701 | - */ |
|
| 702 | - public function get_maximum_total( $context = 'view' ) { |
|
| 703 | - return $this->get_max_total( $context ); |
|
| 704 | - } |
|
| 705 | - |
|
| 706 | - /** |
|
| 707 | - * Magic method for accessing discount properties. |
|
| 708 | - * |
|
| 709 | - * @since 1.0.15 |
|
| 710 | - * @access public |
|
| 711 | - * |
|
| 712 | - * @param string $key Discount data to retrieve |
|
| 713 | - * @param string $context View or edit context. |
|
| 714 | - * @return mixed Value of the given discount property (if set). |
|
| 715 | - */ |
|
| 716 | - public function get( $key, $context = 'view' ) { |
|
| 370 | + return $date; |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | + * Get the discount name. |
|
| 375 | + * |
|
| 376 | + * @since 1.0.19 |
|
| 377 | + * @param string $context View or edit context. |
|
| 378 | + * @return string |
|
| 379 | + */ |
|
| 380 | + public function get_name( $context = 'view' ) { |
|
| 381 | + return $this->get_prop( 'name', $context ); |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + /** |
|
| 385 | + * Alias of self::get_name(). |
|
| 386 | + * |
|
| 387 | + * @since 1.0.19 |
|
| 388 | + * @param string $context View or edit context. |
|
| 389 | + * @return string |
|
| 390 | + */ |
|
| 391 | + public function get_title( $context = 'view' ) { |
|
| 392 | + return $this->get_name( $context ); |
|
| 393 | + } |
|
| 394 | + |
|
| 395 | + /** |
|
| 396 | + * Get the discount description. |
|
| 397 | + * |
|
| 398 | + * @since 1.0.19 |
|
| 399 | + * @param string $context View or edit context. |
|
| 400 | + * @return string |
|
| 401 | + */ |
|
| 402 | + public function get_description( $context = 'view' ) { |
|
| 403 | + return $this->get_prop( 'description', $context ); |
|
| 404 | + } |
|
| 405 | + |
|
| 406 | + /** |
|
| 407 | + * Alias of self::get_description(). |
|
| 408 | + * |
|
| 409 | + * @since 1.0.19 |
|
| 410 | + * @param string $context View or edit context. |
|
| 411 | + * @return string |
|
| 412 | + */ |
|
| 413 | + public function get_excerpt( $context = 'view' ) { |
|
| 414 | + return $this->get_description( $context ); |
|
| 415 | + } |
|
| 416 | + |
|
| 417 | + /** |
|
| 418 | + * Alias of self::get_description(). |
|
| 419 | + * |
|
| 420 | + * @since 1.0.19 |
|
| 421 | + * @param string $context View or edit context. |
|
| 422 | + * @return string |
|
| 423 | + */ |
|
| 424 | + public function get_summary( $context = 'view' ) { |
|
| 425 | + return $this->get_description( $context ); |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + /** |
|
| 429 | + * Get the owner of the discount. |
|
| 430 | + * |
|
| 431 | + * @since 1.0.19 |
|
| 432 | + * @param string $context View or edit context. |
|
| 433 | + * @return string |
|
| 434 | + */ |
|
| 435 | + public function get_author( $context = 'view' ) { |
|
| 436 | + return (int) $this->get_prop( 'author', $context ); |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + /** |
|
| 440 | + * Get the discount code. |
|
| 441 | + * |
|
| 442 | + * @since 1.0.19 |
|
| 443 | + * @param string $context View or edit context. |
|
| 444 | + * @return string |
|
| 445 | + */ |
|
| 446 | + public function get_code( $context = 'view' ) { |
|
| 447 | + return $this->get_prop( 'code', $context ); |
|
| 448 | + } |
|
| 449 | + |
|
| 450 | + /** |
|
| 451 | + * Alias for self::get_code(). |
|
| 452 | + * |
|
| 453 | + * @since 1.0.19 |
|
| 454 | + * @param string $context View or edit context. |
|
| 455 | + * @return string |
|
| 456 | + */ |
|
| 457 | + public function get_coupon_code( $context = 'view' ) { |
|
| 458 | + return $this->get_code( $context ); |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + /** |
|
| 462 | + * Alias for self::get_code(). |
|
| 463 | + * |
|
| 464 | + * @since 1.0.19 |
|
| 465 | + * @param string $context View or edit context. |
|
| 466 | + * @return string |
|
| 467 | + */ |
|
| 468 | + public function get_discount_code( $context = 'view' ) { |
|
| 469 | + return $this->get_code( $context ); |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * Get the discount's amount. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return float |
|
| 478 | + */ |
|
| 479 | + public function get_amount( $context = 'view' ) { |
|
| 480 | + return $context == 'view' ? floatval( $this->get_prop( 'amount', $context ) ) : $this->get_prop( 'amount', $context ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the discount's formated amount/rate. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return string |
|
| 488 | + */ |
|
| 489 | + public function get_formatted_amount() { |
|
| 490 | + |
|
| 491 | + if ( $this->is_type( 'flat' ) ) { |
|
| 492 | + $rate = wpinv_price( $this->get_amount() ); |
|
| 493 | + } else { |
|
| 494 | + $rate = $this->get_amount() . '%'; |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + /** |
|
| 501 | + * Get the discount's start date. |
|
| 502 | + * |
|
| 503 | + * @since 1.0.19 |
|
| 504 | + * @param string $context View or edit context. |
|
| 505 | + * @return string |
|
| 506 | + */ |
|
| 507 | + public function get_start( $context = 'view' ) { |
|
| 508 | + return $this->get_prop( 'start', $context ); |
|
| 509 | + } |
|
| 510 | + |
|
| 511 | + /** |
|
| 512 | + * Alias for self::get_start(). |
|
| 513 | + * |
|
| 514 | + * @since 1.0.19 |
|
| 515 | + * @param string $context View or edit context. |
|
| 516 | + * @return string |
|
| 517 | + */ |
|
| 518 | + public function get_start_date( $context = 'view' ) { |
|
| 519 | + return $this->get_start( $context ); |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + /** |
|
| 523 | + * Get the discount's expiration date. |
|
| 524 | + * |
|
| 525 | + * @since 1.0.19 |
|
| 526 | + * @param string $context View or edit context. |
|
| 527 | + * @return string |
|
| 528 | + */ |
|
| 529 | + public function get_expiration( $context = 'view' ) { |
|
| 530 | + return $this->get_prop( 'expiration', $context ); |
|
| 531 | + } |
|
| 532 | + |
|
| 533 | + /** |
|
| 534 | + * Alias for self::get_expiration(). |
|
| 535 | + * |
|
| 536 | + * @since 1.0.19 |
|
| 537 | + * @param string $context View or edit context. |
|
| 538 | + * @return string |
|
| 539 | + */ |
|
| 540 | + public function get_expiration_date( $context = 'view' ) { |
|
| 541 | + return $this->get_expiration( $context ); |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + /** |
|
| 545 | + * Alias for self::get_expiration(). |
|
| 546 | + * |
|
| 547 | + * @since 1.0.19 |
|
| 548 | + * @param string $context View or edit context. |
|
| 549 | + * @return string |
|
| 550 | + */ |
|
| 551 | + public function get_end_date( $context = 'view' ) { |
|
| 552 | + return $this->get_expiration( $context ); |
|
| 553 | + } |
|
| 554 | + |
|
| 555 | + /** |
|
| 556 | + * Get the discount's type. |
|
| 557 | + * |
|
| 558 | + * @since 1.0.19 |
|
| 559 | + * @param string $context View or edit context. |
|
| 560 | + * @return string |
|
| 561 | + */ |
|
| 562 | + public function get_type( $context = 'view' ) { |
|
| 563 | + return $this->get_prop( 'type', $context ); |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Get the number of times a discount has been used. |
|
| 568 | + * |
|
| 569 | + * @since 1.0.19 |
|
| 570 | + * @param string $context View or edit context. |
|
| 571 | + * @return int |
|
| 572 | + */ |
|
| 573 | + public function get_uses( $context = 'view' ) { |
|
| 574 | + return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * Get the discount's usage, i.e uses / max uses. |
|
| 579 | + * |
|
| 580 | + * @since 1.0.19 |
|
| 581 | + * @return string |
|
| 582 | + */ |
|
| 583 | + public function get_usage() { |
|
| 584 | + |
|
| 585 | + if ( ! $this->has_limit() ) { |
|
| 586 | + return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | + |
|
| 591 | + } |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * Get the maximum number of time a discount can be used. |
|
| 595 | + * |
|
| 596 | + * @since 1.0.19 |
|
| 597 | + * @param string $context View or edit context. |
|
| 598 | + * @return int |
|
| 599 | + */ |
|
| 600 | + public function get_max_uses( $context = 'view' ) { |
|
| 601 | + $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | + return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | + } |
|
| 604 | + |
|
| 605 | + /** |
|
| 606 | + * Checks if this is a single use discount or not. |
|
| 607 | + * |
|
| 608 | + * @since 1.0.19 |
|
| 609 | + * @param string $context View or edit context. |
|
| 610 | + * @return bool |
|
| 611 | + */ |
|
| 612 | + public function get_is_single_use( $context = 'view' ) { |
|
| 613 | + return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | + } |
|
| 615 | + |
|
| 616 | + /** |
|
| 617 | + * Get the items that can be used with this discount. |
|
| 618 | + * |
|
| 619 | + * @since 1.0.19 |
|
| 620 | + * @param string $context View or edit context. |
|
| 621 | + * @return array |
|
| 622 | + */ |
|
| 623 | + public function get_items( $context = 'view' ) { |
|
| 624 | + return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + /** |
|
| 628 | + * Alias for self::get_items(). |
|
| 629 | + * |
|
| 630 | + * @since 1.0.19 |
|
| 631 | + * @param string $context View or edit context. |
|
| 632 | + * @return array |
|
| 633 | + */ |
|
| 634 | + public function get_allowed_items( $context = 'view' ) { |
|
| 635 | + return $this->get_items( $context ); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * Get the items that are not allowed to use this discount. |
|
| 640 | + * |
|
| 641 | + * @since 1.0.19 |
|
| 642 | + * @param string $context View or edit context. |
|
| 643 | + * @return array |
|
| 644 | + */ |
|
| 645 | + public function get_excluded_items( $context = 'view' ) { |
|
| 646 | + return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + /** |
|
| 650 | + * Checks if this is a recurring discount or not. |
|
| 651 | + * |
|
| 652 | + * @since 1.0.19 |
|
| 653 | + * @param string $context View or edit context. |
|
| 654 | + * @return int|string|bool |
|
| 655 | + */ |
|
| 656 | + public function get_is_recurring( $context = 'view' ) { |
|
| 657 | + return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | + } |
|
| 659 | + |
|
| 660 | + /** |
|
| 661 | + * Get's the minimum total amount allowed for this discount. |
|
| 662 | + * |
|
| 663 | + * @since 1.0.19 |
|
| 664 | + * @param string $context View or edit context. |
|
| 665 | + * @return float |
|
| 666 | + */ |
|
| 667 | + public function get_min_total( $context = 'view' ) { |
|
| 668 | + $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | + return empty( $minimum ) ? null : $minimum; |
|
| 670 | + } |
|
| 671 | + |
|
| 672 | + /** |
|
| 673 | + * Alias for self::get_min_total(). |
|
| 674 | + * |
|
| 675 | + * @since 1.0.19 |
|
| 676 | + * @param string $context View or edit context. |
|
| 677 | + * @return float |
|
| 678 | + */ |
|
| 679 | + public function get_minimum_total( $context = 'view' ) { |
|
| 680 | + return $this->get_min_total( $context ); |
|
| 681 | + } |
|
| 682 | + |
|
| 683 | + /** |
|
| 684 | + * Get's the maximum total amount allowed for this discount. |
|
| 685 | + * |
|
| 686 | + * @since 1.0.19 |
|
| 687 | + * @param string $context View or edit context. |
|
| 688 | + * @return float |
|
| 689 | + */ |
|
| 690 | + public function get_max_total( $context = 'view' ) { |
|
| 691 | + $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | + return empty( $maximum ) ? null : $maximum; |
|
| 693 | + } |
|
| 694 | + |
|
| 695 | + /** |
|
| 696 | + * Alias for self::get_max_total(). |
|
| 697 | + * |
|
| 698 | + * @since 1.0.19 |
|
| 699 | + * @param string $context View or edit context. |
|
| 700 | + * @return float |
|
| 701 | + */ |
|
| 702 | + public function get_maximum_total( $context = 'view' ) { |
|
| 703 | + return $this->get_max_total( $context ); |
|
| 704 | + } |
|
| 705 | + |
|
| 706 | + /** |
|
| 707 | + * Magic method for accessing discount properties. |
|
| 708 | + * |
|
| 709 | + * @since 1.0.15 |
|
| 710 | + * @access public |
|
| 711 | + * |
|
| 712 | + * @param string $key Discount data to retrieve |
|
| 713 | + * @param string $context View or edit context. |
|
| 714 | + * @return mixed Value of the given discount property (if set). |
|
| 715 | + */ |
|
| 716 | + public function get( $key, $context = 'view' ) { |
|
| 717 | 717 | return $this->get_prop( $key, $context ); |
| 718 | - } |
|
| 718 | + } |
|
| 719 | 719 | |
| 720 | - /* |
|
| 720 | + /* |
|
| 721 | 721 | |-------------------------------------------------------------------------- |
| 722 | 722 | | Setters |
| 723 | 723 | |-------------------------------------------------------------------------- |
@@ -727,41 +727,41 @@ discard block |
||
| 727 | 727 | | object. |
| 728 | 728 | */ |
| 729 | 729 | |
| 730 | - /** |
|
| 731 | - * Sets discount status. |
|
| 732 | - * |
|
| 733 | - * @since 1.0.19 |
|
| 734 | - * @param string $status New status. |
|
| 735 | - * @return array details of change. |
|
| 736 | - */ |
|
| 737 | - public function set_status( $status ) { |
|
| 730 | + /** |
|
| 731 | + * Sets discount status. |
|
| 732 | + * |
|
| 733 | + * @since 1.0.19 |
|
| 734 | + * @param string $status New status. |
|
| 735 | + * @return array details of change. |
|
| 736 | + */ |
|
| 737 | + public function set_status( $status ) { |
|
| 738 | 738 | $old_status = $this->get_status(); |
| 739 | 739 | |
| 740 | 740 | $this->set_prop( 'status', $status ); |
| 741 | 741 | |
| 742 | - return array( |
|
| 743 | - 'from' => $old_status, |
|
| 744 | - 'to' => $status, |
|
| 745 | - ); |
|
| 742 | + return array( |
|
| 743 | + 'from' => $old_status, |
|
| 744 | + 'to' => $status, |
|
| 745 | + ); |
|
| 746 | 746 | } |
| 747 | 747 | |
| 748 | 748 | /** |
| 749 | - * Set plugin version when the discount was created. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - */ |
|
| 753 | - public function set_version( $value ) { |
|
| 754 | - $this->set_prop( 'version', $value ); |
|
| 749 | + * Set plugin version when the discount was created. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + */ |
|
| 753 | + public function set_version( $value ) { |
|
| 754 | + $this->set_prop( 'version', $value ); |
|
| 755 | 755 | } |
| 756 | 756 | |
| 757 | 757 | /** |
| 758 | - * Set date when the discount was created. |
|
| 759 | - * |
|
| 760 | - * @since 1.0.19 |
|
| 761 | - * @param string $value Value to set. |
|
| 758 | + * Set date when the discount was created. |
|
| 759 | + * |
|
| 760 | + * @since 1.0.19 |
|
| 761 | + * @param string $value Value to set. |
|
| 762 | 762 | * @return bool Whether or not the date was set. |
| 763 | - */ |
|
| 764 | - public function set_date_created( $value ) { |
|
| 763 | + */ |
|
| 764 | + public function set_date_created( $value ) { |
|
| 765 | 765 | $date = strtotime( $value ); |
| 766 | 766 | |
| 767 | 767 | if ( $date ) { |
@@ -774,13 +774,13 @@ discard block |
||
| 774 | 774 | } |
| 775 | 775 | |
| 776 | 776 | /** |
| 777 | - * Set date when the discount was last modified. |
|
| 778 | - * |
|
| 779 | - * @since 1.0.19 |
|
| 780 | - * @param string $value Value to set. |
|
| 777 | + * Set date when the discount was last modified. |
|
| 778 | + * |
|
| 779 | + * @since 1.0.19 |
|
| 780 | + * @param string $value Value to set. |
|
| 781 | 781 | * @return bool Whether or not the date was set. |
| 782 | - */ |
|
| 783 | - public function set_date_modified( $value ) { |
|
| 782 | + */ |
|
| 783 | + public function set_date_modified( $value ) { |
|
| 784 | 784 | $date = strtotime( $value ); |
| 785 | 785 | |
| 786 | 786 | if ( $date ) { |
@@ -793,324 +793,324 @@ discard block |
||
| 793 | 793 | } |
| 794 | 794 | |
| 795 | 795 | /** |
| 796 | - * Set the discount name. |
|
| 797 | - * |
|
| 798 | - * @since 1.0.19 |
|
| 799 | - * @param string $value New name. |
|
| 800 | - */ |
|
| 801 | - public function set_name( $value ) { |
|
| 796 | + * Set the discount name. |
|
| 797 | + * |
|
| 798 | + * @since 1.0.19 |
|
| 799 | + * @param string $value New name. |
|
| 800 | + */ |
|
| 801 | + public function set_name( $value ) { |
|
| 802 | 802 | $name = sanitize_text_field( $value ); |
| 803 | - $this->set_prop( 'name', $name ); |
|
| 803 | + $this->set_prop( 'name', $name ); |
|
| 804 | 804 | } |
| 805 | 805 | |
| 806 | 806 | /** |
| 807 | - * Alias of self::set_name(). |
|
| 808 | - * |
|
| 809 | - * @since 1.0.19 |
|
| 810 | - * @param string $value New name. |
|
| 811 | - */ |
|
| 812 | - public function set_title( $value ) { |
|
| 813 | - $this->set_name( $value ); |
|
| 807 | + * Alias of self::set_name(). |
|
| 808 | + * |
|
| 809 | + * @since 1.0.19 |
|
| 810 | + * @param string $value New name. |
|
| 811 | + */ |
|
| 812 | + public function set_title( $value ) { |
|
| 813 | + $this->set_name( $value ); |
|
| 814 | 814 | } |
| 815 | 815 | |
| 816 | 816 | /** |
| 817 | - * Set the discount description. |
|
| 818 | - * |
|
| 819 | - * @since 1.0.19 |
|
| 820 | - * @param string $value New description. |
|
| 821 | - */ |
|
| 822 | - public function set_description( $value ) { |
|
| 823 | - $description = wp_kses_post( $value ); |
|
| 824 | - return $this->set_prop( 'description', $description ); |
|
| 825 | - } |
|
| 826 | - |
|
| 827 | - /** |
|
| 828 | - * Alias of self::set_description(). |
|
| 829 | - * |
|
| 830 | - * @since 1.0.19 |
|
| 831 | - * @param string $value New description. |
|
| 832 | - */ |
|
| 833 | - public function set_excerpt( $value ) { |
|
| 834 | - $this->set_description( $value ); |
|
| 835 | - } |
|
| 836 | - |
|
| 837 | - /** |
|
| 838 | - * Alias of self::set_description(). |
|
| 839 | - * |
|
| 840 | - * @since 1.0.19 |
|
| 841 | - * @param string $value New description. |
|
| 842 | - */ |
|
| 843 | - public function set_summary( $value ) { |
|
| 844 | - $this->set_description( $value ); |
|
| 845 | - } |
|
| 846 | - |
|
| 847 | - /** |
|
| 848 | - * Set the owner of the discount. |
|
| 849 | - * |
|
| 850 | - * @since 1.0.19 |
|
| 851 | - * @param int $value New author. |
|
| 852 | - */ |
|
| 853 | - public function set_author( $value ) { |
|
| 854 | - $this->set_prop( 'author', (int) $value ); |
|
| 855 | - } |
|
| 856 | - |
|
| 857 | - /** |
|
| 858 | - * Sets the discount code. |
|
| 859 | - * |
|
| 860 | - * @since 1.0.19 |
|
| 861 | - * @param string $value New discount code. |
|
| 862 | - */ |
|
| 863 | - public function set_code( $value ) { |
|
| 864 | - $code = sanitize_text_field( $value ); |
|
| 865 | - $this->set_prop( 'code', $code ); |
|
| 866 | - } |
|
| 867 | - |
|
| 868 | - /** |
|
| 869 | - * Alias of self::set_code(). |
|
| 870 | - * |
|
| 871 | - * @since 1.0.19 |
|
| 872 | - * @param string $value New discount code. |
|
| 873 | - */ |
|
| 874 | - public function set_coupon_code( $value ) { |
|
| 875 | - $this->set_code( $value ); |
|
| 876 | - } |
|
| 877 | - |
|
| 878 | - /** |
|
| 879 | - * Alias of self::set_code(). |
|
| 880 | - * |
|
| 881 | - * @since 1.0.19 |
|
| 882 | - * @param string $value New discount code. |
|
| 883 | - */ |
|
| 884 | - public function set_discount_code( $value ) { |
|
| 885 | - $this->set_code( $value ); |
|
| 886 | - } |
|
| 887 | - |
|
| 888 | - /** |
|
| 889 | - * Sets the discount amount. |
|
| 890 | - * |
|
| 891 | - * @since 1.0.19 |
|
| 892 | - * @param float $value New discount code. |
|
| 893 | - */ |
|
| 894 | - public function set_amount( $value ) { |
|
| 895 | - $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | - $this->set_prop( 'amount', $amount ); |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - /** |
|
| 900 | - * Sets the discount's start date. |
|
| 901 | - * |
|
| 902 | - * @since 1.0.19 |
|
| 903 | - * @param float $value New start date. |
|
| 904 | - */ |
|
| 905 | - public function set_start( $value ) { |
|
| 906 | - $date = strtotime( $value ); |
|
| 817 | + * Set the discount description. |
|
| 818 | + * |
|
| 819 | + * @since 1.0.19 |
|
| 820 | + * @param string $value New description. |
|
| 821 | + */ |
|
| 822 | + public function set_description( $value ) { |
|
| 823 | + $description = wp_kses_post( $value ); |
|
| 824 | + return $this->set_prop( 'description', $description ); |
|
| 825 | + } |
|
| 826 | + |
|
| 827 | + /** |
|
| 828 | + * Alias of self::set_description(). |
|
| 829 | + * |
|
| 830 | + * @since 1.0.19 |
|
| 831 | + * @param string $value New description. |
|
| 832 | + */ |
|
| 833 | + public function set_excerpt( $value ) { |
|
| 834 | + $this->set_description( $value ); |
|
| 835 | + } |
|
| 836 | + |
|
| 837 | + /** |
|
| 838 | + * Alias of self::set_description(). |
|
| 839 | + * |
|
| 840 | + * @since 1.0.19 |
|
| 841 | + * @param string $value New description. |
|
| 842 | + */ |
|
| 843 | + public function set_summary( $value ) { |
|
| 844 | + $this->set_description( $value ); |
|
| 845 | + } |
|
| 846 | + |
|
| 847 | + /** |
|
| 848 | + * Set the owner of the discount. |
|
| 849 | + * |
|
| 850 | + * @since 1.0.19 |
|
| 851 | + * @param int $value New author. |
|
| 852 | + */ |
|
| 853 | + public function set_author( $value ) { |
|
| 854 | + $this->set_prop( 'author', (int) $value ); |
|
| 855 | + } |
|
| 856 | + |
|
| 857 | + /** |
|
| 858 | + * Sets the discount code. |
|
| 859 | + * |
|
| 860 | + * @since 1.0.19 |
|
| 861 | + * @param string $value New discount code. |
|
| 862 | + */ |
|
| 863 | + public function set_code( $value ) { |
|
| 864 | + $code = sanitize_text_field( $value ); |
|
| 865 | + $this->set_prop( 'code', $code ); |
|
| 866 | + } |
|
| 867 | + |
|
| 868 | + /** |
|
| 869 | + * Alias of self::set_code(). |
|
| 870 | + * |
|
| 871 | + * @since 1.0.19 |
|
| 872 | + * @param string $value New discount code. |
|
| 873 | + */ |
|
| 874 | + public function set_coupon_code( $value ) { |
|
| 875 | + $this->set_code( $value ); |
|
| 876 | + } |
|
| 877 | + |
|
| 878 | + /** |
|
| 879 | + * Alias of self::set_code(). |
|
| 880 | + * |
|
| 881 | + * @since 1.0.19 |
|
| 882 | + * @param string $value New discount code. |
|
| 883 | + */ |
|
| 884 | + public function set_discount_code( $value ) { |
|
| 885 | + $this->set_code( $value ); |
|
| 886 | + } |
|
| 887 | + |
|
| 888 | + /** |
|
| 889 | + * Sets the discount amount. |
|
| 890 | + * |
|
| 891 | + * @since 1.0.19 |
|
| 892 | + * @param float $value New discount code. |
|
| 893 | + */ |
|
| 894 | + public function set_amount( $value ) { |
|
| 895 | + $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | + $this->set_prop( 'amount', $amount ); |
|
| 897 | + } |
|
| 898 | + |
|
| 899 | + /** |
|
| 900 | + * Sets the discount's start date. |
|
| 901 | + * |
|
| 902 | + * @since 1.0.19 |
|
| 903 | + * @param float $value New start date. |
|
| 904 | + */ |
|
| 905 | + public function set_start( $value ) { |
|
| 906 | + $date = strtotime( $value ); |
|
| 907 | 907 | |
| 908 | 908 | if ( $date ) { |
| 909 | 909 | $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
| 910 | 910 | return true; |
| 911 | - } |
|
| 911 | + } |
|
| 912 | 912 | |
| 913 | - $this->set_prop( 'start', '' ); |
|
| 913 | + $this->set_prop( 'start', '' ); |
|
| 914 | 914 | |
| 915 | 915 | return false; |
| 916 | - } |
|
| 917 | - |
|
| 918 | - /** |
|
| 919 | - * Alias of self::set_start(). |
|
| 920 | - * |
|
| 921 | - * @since 1.0.19 |
|
| 922 | - * @param string $value New start date. |
|
| 923 | - */ |
|
| 924 | - public function set_start_date( $value ) { |
|
| 925 | - $this->set_start( $value ); |
|
| 926 | - } |
|
| 927 | - |
|
| 928 | - /** |
|
| 929 | - * Sets the discount's expiration date. |
|
| 930 | - * |
|
| 931 | - * @since 1.0.19 |
|
| 932 | - * @param float $value New expiration date. |
|
| 933 | - */ |
|
| 934 | - public function set_expiration( $value ) { |
|
| 935 | - $date = strtotime( $value ); |
|
| 916 | + } |
|
| 917 | + |
|
| 918 | + /** |
|
| 919 | + * Alias of self::set_start(). |
|
| 920 | + * |
|
| 921 | + * @since 1.0.19 |
|
| 922 | + * @param string $value New start date. |
|
| 923 | + */ |
|
| 924 | + public function set_start_date( $value ) { |
|
| 925 | + $this->set_start( $value ); |
|
| 926 | + } |
|
| 927 | + |
|
| 928 | + /** |
|
| 929 | + * Sets the discount's expiration date. |
|
| 930 | + * |
|
| 931 | + * @since 1.0.19 |
|
| 932 | + * @param float $value New expiration date. |
|
| 933 | + */ |
|
| 934 | + public function set_expiration( $value ) { |
|
| 935 | + $date = strtotime( $value ); |
|
| 936 | 936 | |
| 937 | 937 | if ( $date ) { |
| 938 | 938 | $this->set_prop( 'expiration', date( 'Y-m-d H:i', $date ) ); |
| 939 | 939 | return true; |
| 940 | 940 | } |
| 941 | 941 | |
| 942 | - $this->set_prop( 'expiration', '' ); |
|
| 942 | + $this->set_prop( 'expiration', '' ); |
|
| 943 | 943 | return false; |
| 944 | - } |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Alias of self::set_expiration(). |
|
| 948 | - * |
|
| 949 | - * @since 1.0.19 |
|
| 950 | - * @param string $value New expiration date. |
|
| 951 | - */ |
|
| 952 | - public function set_expiration_date( $value ) { |
|
| 953 | - $this->set_expiration( $value ); |
|
| 954 | - } |
|
| 955 | - |
|
| 956 | - /** |
|
| 957 | - * Alias of self::set_expiration(). |
|
| 958 | - * |
|
| 959 | - * @since 1.0.19 |
|
| 960 | - * @param string $value New expiration date. |
|
| 961 | - */ |
|
| 962 | - public function set_end_date( $value ) { |
|
| 963 | - $this->set_expiration( $value ); |
|
| 964 | - } |
|
| 965 | - |
|
| 966 | - /** |
|
| 967 | - * Sets the discount type. |
|
| 968 | - * |
|
| 969 | - * @since 1.0.19 |
|
| 970 | - * @param string $value New discount type. |
|
| 971 | - */ |
|
| 972 | - public function set_type( $value ) { |
|
| 973 | - if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | - $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | - } |
|
| 976 | - } |
|
| 977 | - |
|
| 978 | - /** |
|
| 979 | - * Sets the number of times a discount has been used. |
|
| 980 | - * |
|
| 981 | - * @since 1.0.19 |
|
| 982 | - * @param int $value usage count. |
|
| 983 | - */ |
|
| 984 | - public function set_uses( $value ) { |
|
| 985 | - |
|
| 986 | - $value = (int) $value; |
|
| 987 | - |
|
| 988 | - if ( $value < 0 ) { |
|
| 989 | - $value = 0; |
|
| 990 | - } |
|
| 991 | - |
|
| 992 | - $this->set_prop( 'uses', (int) $value ); |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - /** |
|
| 996 | - * Sets the maximum number of times a discount can be used. |
|
| 997 | - * |
|
| 998 | - * @since 1.0.19 |
|
| 999 | - * @param int $value maximum usage count. |
|
| 1000 | - */ |
|
| 1001 | - public function set_max_uses( $value ) { |
|
| 1002 | - $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | - } |
|
| 1004 | - |
|
| 1005 | - /** |
|
| 1006 | - * Sets if this is a single use discount or not. |
|
| 1007 | - * |
|
| 1008 | - * @since 1.0.19 |
|
| 1009 | - * @param int|bool $value is single use. |
|
| 1010 | - */ |
|
| 1011 | - public function set_is_single_use( $value ) { |
|
| 1012 | - $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | - } |
|
| 1014 | - |
|
| 1015 | - /** |
|
| 1016 | - * Sets the items that can be used with this discount. |
|
| 1017 | - * |
|
| 1018 | - * @since 1.0.19 |
|
| 1019 | - * @param array $value items. |
|
| 1020 | - */ |
|
| 1021 | - public function set_items( $value ) { |
|
| 1022 | - $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | - } |
|
| 1024 | - |
|
| 1025 | - /** |
|
| 1026 | - * Alias for self::set_items(). |
|
| 1027 | - * |
|
| 1028 | - * @since 1.0.19 |
|
| 1029 | - * @param array $value items. |
|
| 1030 | - */ |
|
| 1031 | - public function set_allowed_items( $value ) { |
|
| 1032 | - $this->set_items( $value ); |
|
| 1033 | - } |
|
| 1034 | - |
|
| 1035 | - /** |
|
| 1036 | - * Sets the items that can not be used with this discount. |
|
| 1037 | - * |
|
| 1038 | - * @since 1.0.19 |
|
| 1039 | - * @param array $value items. |
|
| 1040 | - */ |
|
| 1041 | - public function set_excluded_items( $value ) { |
|
| 1042 | - $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | - } |
|
| 1044 | - |
|
| 1045 | - /** |
|
| 1046 | - * Sets if this is a recurring discounts or not. |
|
| 1047 | - * |
|
| 1048 | - * @since 1.0.19 |
|
| 1049 | - * @param int|bool $value is recurring. |
|
| 1050 | - */ |
|
| 1051 | - public function set_is_recurring( $value ) { |
|
| 1052 | - $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | - } |
|
| 1054 | - |
|
| 1055 | - /** |
|
| 1056 | - * Sets the minimum total that can not be used with this discount. |
|
| 1057 | - * |
|
| 1058 | - * @since 1.0.19 |
|
| 1059 | - * @param float $value minimum total. |
|
| 1060 | - */ |
|
| 1061 | - public function set_min_total( $value ) { |
|
| 1062 | - $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | - } |
|
| 1064 | - |
|
| 1065 | - /** |
|
| 1066 | - * Alias for self::set_min_total(). |
|
| 1067 | - * |
|
| 1068 | - * @since 1.0.19 |
|
| 1069 | - * @param float $value minimum total. |
|
| 1070 | - */ |
|
| 1071 | - public function set_minimum_total( $value ) { |
|
| 1072 | - $this->set_min_total( $value ); |
|
| 1073 | - } |
|
| 1074 | - |
|
| 1075 | - /** |
|
| 1076 | - * Sets the maximum total that can not be used with this discount. |
|
| 1077 | - * |
|
| 1078 | - * @since 1.0.19 |
|
| 1079 | - * @param float $value maximum total. |
|
| 1080 | - */ |
|
| 1081 | - public function set_max_total( $value ) { |
|
| 1082 | - $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | - } |
|
| 1084 | - |
|
| 1085 | - /** |
|
| 1086 | - * Alias for self::set_max_total(). |
|
| 1087 | - * |
|
| 1088 | - * @since 1.0.19 |
|
| 1089 | - * @param float $value maximum total. |
|
| 1090 | - */ |
|
| 1091 | - public function set_maximum_total( $value ) { |
|
| 1092 | - $this->set_max_total( $value ); |
|
| 1093 | - } |
|
| 1094 | - |
|
| 1095 | - /** |
|
| 1096 | - * @deprecated |
|
| 1097 | - */ |
|
| 1098 | - public function refresh(){} |
|
| 1099 | - |
|
| 1100 | - /** |
|
| 1101 | - * @deprecated |
|
| 1102 | - * |
|
| 1103 | - */ |
|
| 1104 | - public function update_status( $status = 'publish' ){ |
|
| 1105 | - |
|
| 1106 | - if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | - $this->set_status( $status ); |
|
| 1108 | - $this->save(); |
|
| 1109 | - } |
|
| 1110 | - |
|
| 1111 | - } |
|
| 1112 | - |
|
| 1113 | - /* |
|
| 944 | + } |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Alias of self::set_expiration(). |
|
| 948 | + * |
|
| 949 | + * @since 1.0.19 |
|
| 950 | + * @param string $value New expiration date. |
|
| 951 | + */ |
|
| 952 | + public function set_expiration_date( $value ) { |
|
| 953 | + $this->set_expiration( $value ); |
|
| 954 | + } |
|
| 955 | + |
|
| 956 | + /** |
|
| 957 | + * Alias of self::set_expiration(). |
|
| 958 | + * |
|
| 959 | + * @since 1.0.19 |
|
| 960 | + * @param string $value New expiration date. |
|
| 961 | + */ |
|
| 962 | + public function set_end_date( $value ) { |
|
| 963 | + $this->set_expiration( $value ); |
|
| 964 | + } |
|
| 965 | + |
|
| 966 | + /** |
|
| 967 | + * Sets the discount type. |
|
| 968 | + * |
|
| 969 | + * @since 1.0.19 |
|
| 970 | + * @param string $value New discount type. |
|
| 971 | + */ |
|
| 972 | + public function set_type( $value ) { |
|
| 973 | + if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | + $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | + } |
|
| 976 | + } |
|
| 977 | + |
|
| 978 | + /** |
|
| 979 | + * Sets the number of times a discount has been used. |
|
| 980 | + * |
|
| 981 | + * @since 1.0.19 |
|
| 982 | + * @param int $value usage count. |
|
| 983 | + */ |
|
| 984 | + public function set_uses( $value ) { |
|
| 985 | + |
|
| 986 | + $value = (int) $value; |
|
| 987 | + |
|
| 988 | + if ( $value < 0 ) { |
|
| 989 | + $value = 0; |
|
| 990 | + } |
|
| 991 | + |
|
| 992 | + $this->set_prop( 'uses', (int) $value ); |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + /** |
|
| 996 | + * Sets the maximum number of times a discount can be used. |
|
| 997 | + * |
|
| 998 | + * @since 1.0.19 |
|
| 999 | + * @param int $value maximum usage count. |
|
| 1000 | + */ |
|
| 1001 | + public function set_max_uses( $value ) { |
|
| 1002 | + $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | + } |
|
| 1004 | + |
|
| 1005 | + /** |
|
| 1006 | + * Sets if this is a single use discount or not. |
|
| 1007 | + * |
|
| 1008 | + * @since 1.0.19 |
|
| 1009 | + * @param int|bool $value is single use. |
|
| 1010 | + */ |
|
| 1011 | + public function set_is_single_use( $value ) { |
|
| 1012 | + $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | + } |
|
| 1014 | + |
|
| 1015 | + /** |
|
| 1016 | + * Sets the items that can be used with this discount. |
|
| 1017 | + * |
|
| 1018 | + * @since 1.0.19 |
|
| 1019 | + * @param array $value items. |
|
| 1020 | + */ |
|
| 1021 | + public function set_items( $value ) { |
|
| 1022 | + $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | + } |
|
| 1024 | + |
|
| 1025 | + /** |
|
| 1026 | + * Alias for self::set_items(). |
|
| 1027 | + * |
|
| 1028 | + * @since 1.0.19 |
|
| 1029 | + * @param array $value items. |
|
| 1030 | + */ |
|
| 1031 | + public function set_allowed_items( $value ) { |
|
| 1032 | + $this->set_items( $value ); |
|
| 1033 | + } |
|
| 1034 | + |
|
| 1035 | + /** |
|
| 1036 | + * Sets the items that can not be used with this discount. |
|
| 1037 | + * |
|
| 1038 | + * @since 1.0.19 |
|
| 1039 | + * @param array $value items. |
|
| 1040 | + */ |
|
| 1041 | + public function set_excluded_items( $value ) { |
|
| 1042 | + $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | + } |
|
| 1044 | + |
|
| 1045 | + /** |
|
| 1046 | + * Sets if this is a recurring discounts or not. |
|
| 1047 | + * |
|
| 1048 | + * @since 1.0.19 |
|
| 1049 | + * @param int|bool $value is recurring. |
|
| 1050 | + */ |
|
| 1051 | + public function set_is_recurring( $value ) { |
|
| 1052 | + $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | + } |
|
| 1054 | + |
|
| 1055 | + /** |
|
| 1056 | + * Sets the minimum total that can not be used with this discount. |
|
| 1057 | + * |
|
| 1058 | + * @since 1.0.19 |
|
| 1059 | + * @param float $value minimum total. |
|
| 1060 | + */ |
|
| 1061 | + public function set_min_total( $value ) { |
|
| 1062 | + $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | + } |
|
| 1064 | + |
|
| 1065 | + /** |
|
| 1066 | + * Alias for self::set_min_total(). |
|
| 1067 | + * |
|
| 1068 | + * @since 1.0.19 |
|
| 1069 | + * @param float $value minimum total. |
|
| 1070 | + */ |
|
| 1071 | + public function set_minimum_total( $value ) { |
|
| 1072 | + $this->set_min_total( $value ); |
|
| 1073 | + } |
|
| 1074 | + |
|
| 1075 | + /** |
|
| 1076 | + * Sets the maximum total that can not be used with this discount. |
|
| 1077 | + * |
|
| 1078 | + * @since 1.0.19 |
|
| 1079 | + * @param float $value maximum total. |
|
| 1080 | + */ |
|
| 1081 | + public function set_max_total( $value ) { |
|
| 1082 | + $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | + } |
|
| 1084 | + |
|
| 1085 | + /** |
|
| 1086 | + * Alias for self::set_max_total(). |
|
| 1087 | + * |
|
| 1088 | + * @since 1.0.19 |
|
| 1089 | + * @param float $value maximum total. |
|
| 1090 | + */ |
|
| 1091 | + public function set_maximum_total( $value ) { |
|
| 1092 | + $this->set_max_total( $value ); |
|
| 1093 | + } |
|
| 1094 | + |
|
| 1095 | + /** |
|
| 1096 | + * @deprecated |
|
| 1097 | + */ |
|
| 1098 | + public function refresh(){} |
|
| 1099 | + |
|
| 1100 | + /** |
|
| 1101 | + * @deprecated |
|
| 1102 | + * |
|
| 1103 | + */ |
|
| 1104 | + public function update_status( $status = 'publish' ){ |
|
| 1105 | + |
|
| 1106 | + if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | + $this->set_status( $status ); |
|
| 1108 | + $this->save(); |
|
| 1109 | + } |
|
| 1110 | + |
|
| 1111 | + } |
|
| 1112 | + |
|
| 1113 | + /* |
|
| 1114 | 1114 | |-------------------------------------------------------------------------- |
| 1115 | 1115 | | Conditionals |
| 1116 | 1116 | |-------------------------------------------------------------------------- |
@@ -1119,263 +1119,263 @@ discard block |
||
| 1119 | 1119 | | |
| 1120 | 1120 | */ |
| 1121 | 1121 | |
| 1122 | - /** |
|
| 1123 | - * Checks whether a discount exists in the database or not |
|
| 1124 | - * |
|
| 1125 | - * @since 1.0.15 |
|
| 1126 | - */ |
|
| 1127 | - public function exists(){ |
|
| 1128 | - $id = $this->get_id(); |
|
| 1129 | - return ! empty( $id ); |
|
| 1130 | - } |
|
| 1131 | - |
|
| 1132 | - /** |
|
| 1133 | - * Checks the discount type. |
|
| 1134 | - * |
|
| 1135 | - * |
|
| 1136 | - * @param string $type the discount type to check against |
|
| 1137 | - * @since 1.0.15 |
|
| 1138 | - * @return bool |
|
| 1139 | - */ |
|
| 1140 | - public function is_type( $type ) { |
|
| 1141 | - return $this->get_type() == $type; |
|
| 1142 | - } |
|
| 1143 | - |
|
| 1144 | - /** |
|
| 1145 | - * Checks whether the discount is published or not |
|
| 1146 | - * |
|
| 1147 | - * @since 1.0.15 |
|
| 1148 | - * @return bool |
|
| 1149 | - */ |
|
| 1150 | - public function is_active() { |
|
| 1151 | - return $this->get_status() == 'publish'; |
|
| 1152 | - } |
|
| 1153 | - |
|
| 1154 | - /** |
|
| 1155 | - * Checks whether the discount has max uses |
|
| 1156 | - * |
|
| 1157 | - * @since 1.0.15 |
|
| 1158 | - * @return bool |
|
| 1159 | - */ |
|
| 1160 | - public function has_limit() { |
|
| 1161 | - $limit = $this->get_max_uses(); |
|
| 1162 | - return ! empty( $limit ); |
|
| 1163 | - } |
|
| 1164 | - |
|
| 1165 | - /** |
|
| 1166 | - * Checks whether the discount has ever been used. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.15 |
|
| 1169 | - * @return bool |
|
| 1170 | - */ |
|
| 1171 | - public function has_uses() { |
|
| 1172 | - return $this->get_uses() > 0; |
|
| 1173 | - } |
|
| 1174 | - |
|
| 1175 | - /** |
|
| 1176 | - * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | - * |
|
| 1178 | - * @since 1.0.15 |
|
| 1179 | - * @return bool |
|
| 1180 | - */ |
|
| 1181 | - public function has_exceeded_limit() { |
|
| 1182 | - |
|
| 1183 | - if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | - $exceeded = false ; |
|
| 1185 | - } else { |
|
| 1186 | - $exceeded = (int) $this->get_max_uses() <= $this->get_uses(); |
|
| 1187 | - } |
|
| 1188 | - |
|
| 1189 | - return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
| 1190 | - } |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * Checks whether the discount has an expiration date. |
|
| 1194 | - * |
|
| 1195 | - * @since 1.0.15 |
|
| 1196 | - * @return bool |
|
| 1197 | - */ |
|
| 1198 | - public function has_expiration_date() { |
|
| 1199 | - $date = $this->get_expiration_date(); |
|
| 1200 | - return ! empty( $date ); |
|
| 1201 | - } |
|
| 1202 | - |
|
| 1203 | - /** |
|
| 1204 | - * Checks if the discount is expired |
|
| 1205 | - * |
|
| 1206 | - * @since 1.0.15 |
|
| 1207 | - * @return bool |
|
| 1208 | - */ |
|
| 1209 | - public function is_expired() { |
|
| 1210 | - $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | - return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
| 1212 | - } |
|
| 1213 | - |
|
| 1214 | - /** |
|
| 1215 | - * Checks whether the discount has a start date. |
|
| 1216 | - * |
|
| 1217 | - * @since 1.0.15 |
|
| 1218 | - * @return bool |
|
| 1219 | - */ |
|
| 1220 | - public function has_start_date() { |
|
| 1221 | - $date = $this->get_start_date(); |
|
| 1222 | - return ! empty( $date ); |
|
| 1223 | - } |
|
| 1224 | - |
|
| 1225 | - /** |
|
| 1226 | - * Checks the discount start date. |
|
| 1227 | - * |
|
| 1228 | - * @since 1.0.15 |
|
| 1229 | - * @return bool |
|
| 1230 | - */ |
|
| 1231 | - public function has_started() { |
|
| 1232 | - $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | - return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
| 1234 | - } |
|
| 1235 | - |
|
| 1236 | - /** |
|
| 1237 | - * Checks the discount has allowed items or not. |
|
| 1238 | - * |
|
| 1239 | - * @since 1.0.15 |
|
| 1240 | - * @return bool |
|
| 1241 | - */ |
|
| 1242 | - public function has_allowed_items() { |
|
| 1243 | - $allowed_items = $this->get_allowed_items(); |
|
| 1244 | - return ! empty( $allowed_items ); |
|
| 1245 | - } |
|
| 1246 | - |
|
| 1247 | - /** |
|
| 1248 | - * Checks the discount has excluded items or not. |
|
| 1249 | - * |
|
| 1250 | - * @since 1.0.15 |
|
| 1251 | - * @return bool |
|
| 1252 | - */ |
|
| 1253 | - public function has_excluded_items() { |
|
| 1254 | - $excluded_items = $this->get_excluded_items(); |
|
| 1255 | - return ! empty( $excluded_items ); |
|
| 1256 | - } |
|
| 1257 | - |
|
| 1258 | - /** |
|
| 1259 | - * Check if a discount is valid for a given item id. |
|
| 1260 | - * |
|
| 1261 | - * @param int|int[] $item_ids |
|
| 1262 | - * @since 1.0.15 |
|
| 1263 | - * @return boolean |
|
| 1264 | - */ |
|
| 1265 | - public function is_valid_for_items( $item_ids ) { |
|
| 1266 | - |
|
| 1267 | - $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | - $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | - $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | - |
|
| 1271 | - if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | - return false; |
|
| 1273 | - } |
|
| 1274 | - |
|
| 1275 | - if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | - return false; |
|
| 1277 | - } |
|
| 1278 | - |
|
| 1279 | - return true; |
|
| 1280 | - } |
|
| 1281 | - |
|
| 1282 | - /** |
|
| 1283 | - * Check if a discount is valid for the given amount |
|
| 1284 | - * |
|
| 1285 | - * @param float $amount The amount to check against |
|
| 1286 | - * @since 1.0.15 |
|
| 1287 | - * @return boolean |
|
| 1288 | - */ |
|
| 1289 | - public function is_valid_for_amount( $amount ) { |
|
| 1290 | - return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | - } |
|
| 1292 | - |
|
| 1293 | - /** |
|
| 1294 | - * Checks if the minimum amount is set |
|
| 1295 | - * |
|
| 1296 | - * @since 1.0.15 |
|
| 1297 | - * @return boolean |
|
| 1298 | - */ |
|
| 1299 | - public function has_minimum_amount() { |
|
| 1300 | - $minimum = $this->get_minimum_total(); |
|
| 1301 | - return ! empty( $minimum ); |
|
| 1302 | - } |
|
| 1303 | - |
|
| 1304 | - /** |
|
| 1305 | - * Checks if the minimum amount is met |
|
| 1306 | - * |
|
| 1307 | - * @param float $amount The amount to check against |
|
| 1308 | - * @since 1.0.15 |
|
| 1309 | - * @return boolean |
|
| 1310 | - */ |
|
| 1311 | - public function is_minimum_amount_met( $amount ) { |
|
| 1312 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | - $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | - return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1315 | - } |
|
| 1316 | - |
|
| 1317 | - /** |
|
| 1318 | - * Checks if the maximum amount is set |
|
| 1319 | - * |
|
| 1320 | - * @since 1.0.15 |
|
| 1321 | - * @return boolean |
|
| 1322 | - */ |
|
| 1323 | - public function has_maximum_amount() { |
|
| 1324 | - $maximum = $this->get_maximum_total(); |
|
| 1325 | - return ! empty( $maximum ); |
|
| 1326 | - } |
|
| 1327 | - |
|
| 1328 | - /** |
|
| 1329 | - * Checks if the maximum amount is met |
|
| 1330 | - * |
|
| 1331 | - * @param float $amount The amount to check against |
|
| 1332 | - * @since 1.0.15 |
|
| 1333 | - * @return boolean |
|
| 1334 | - */ |
|
| 1335 | - public function is_maximum_amount_met( $amount ) { |
|
| 1336 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | - $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | - return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1339 | - } |
|
| 1340 | - |
|
| 1341 | - /** |
|
| 1342 | - * Checks if the discount is recurring. |
|
| 1343 | - * |
|
| 1344 | - * @since 1.0.15 |
|
| 1345 | - * @return boolean |
|
| 1346 | - */ |
|
| 1347 | - public function is_recurring() { |
|
| 1348 | - $recurring = $this->get_is_recurring(); |
|
| 1349 | - return ! empty( $recurring ); |
|
| 1350 | - } |
|
| 1351 | - |
|
| 1352 | - /** |
|
| 1353 | - * Checks if the discount is single use. |
|
| 1354 | - * |
|
| 1355 | - * @since 1.0.15 |
|
| 1356 | - * @return boolean |
|
| 1357 | - */ |
|
| 1358 | - public function is_single_use() { |
|
| 1359 | - $usage = $this->get_is_single_use(); |
|
| 1360 | - return ! empty( $usage ); |
|
| 1361 | - } |
|
| 1362 | - |
|
| 1363 | - /** |
|
| 1364 | - * Check if a discount is valid for the given user |
|
| 1365 | - * |
|
| 1366 | - * @param int|string $user |
|
| 1367 | - * @since 1.0.15 |
|
| 1368 | - * @return boolean |
|
| 1369 | - */ |
|
| 1370 | - public function is_valid_for_user( $user ) { |
|
| 1371 | - |
|
| 1372 | - // Ensure that the discount is single use. |
|
| 1373 | - if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | - return true; |
|
| 1375 | - } |
|
| 1376 | - |
|
| 1377 | - // Prepare the user id. |
|
| 1378 | - $user_id = 0; |
|
| 1122 | + /** |
|
| 1123 | + * Checks whether a discount exists in the database or not |
|
| 1124 | + * |
|
| 1125 | + * @since 1.0.15 |
|
| 1126 | + */ |
|
| 1127 | + public function exists(){ |
|
| 1128 | + $id = $this->get_id(); |
|
| 1129 | + return ! empty( $id ); |
|
| 1130 | + } |
|
| 1131 | + |
|
| 1132 | + /** |
|
| 1133 | + * Checks the discount type. |
|
| 1134 | + * |
|
| 1135 | + * |
|
| 1136 | + * @param string $type the discount type to check against |
|
| 1137 | + * @since 1.0.15 |
|
| 1138 | + * @return bool |
|
| 1139 | + */ |
|
| 1140 | + public function is_type( $type ) { |
|
| 1141 | + return $this->get_type() == $type; |
|
| 1142 | + } |
|
| 1143 | + |
|
| 1144 | + /** |
|
| 1145 | + * Checks whether the discount is published or not |
|
| 1146 | + * |
|
| 1147 | + * @since 1.0.15 |
|
| 1148 | + * @return bool |
|
| 1149 | + */ |
|
| 1150 | + public function is_active() { |
|
| 1151 | + return $this->get_status() == 'publish'; |
|
| 1152 | + } |
|
| 1153 | + |
|
| 1154 | + /** |
|
| 1155 | + * Checks whether the discount has max uses |
|
| 1156 | + * |
|
| 1157 | + * @since 1.0.15 |
|
| 1158 | + * @return bool |
|
| 1159 | + */ |
|
| 1160 | + public function has_limit() { |
|
| 1161 | + $limit = $this->get_max_uses(); |
|
| 1162 | + return ! empty( $limit ); |
|
| 1163 | + } |
|
| 1164 | + |
|
| 1165 | + /** |
|
| 1166 | + * Checks whether the discount has ever been used. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.15 |
|
| 1169 | + * @return bool |
|
| 1170 | + */ |
|
| 1171 | + public function has_uses() { |
|
| 1172 | + return $this->get_uses() > 0; |
|
| 1173 | + } |
|
| 1174 | + |
|
| 1175 | + /** |
|
| 1176 | + * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | + * |
|
| 1178 | + * @since 1.0.15 |
|
| 1179 | + * @return bool |
|
| 1180 | + */ |
|
| 1181 | + public function has_exceeded_limit() { |
|
| 1182 | + |
|
| 1183 | + if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | + $exceeded = false ; |
|
| 1185 | + } else { |
|
| 1186 | + $exceeded = (int) $this->get_max_uses() <= $this->get_uses(); |
|
| 1187 | + } |
|
| 1188 | + |
|
| 1189 | + return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
| 1190 | + } |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * Checks whether the discount has an expiration date. |
|
| 1194 | + * |
|
| 1195 | + * @since 1.0.15 |
|
| 1196 | + * @return bool |
|
| 1197 | + */ |
|
| 1198 | + public function has_expiration_date() { |
|
| 1199 | + $date = $this->get_expiration_date(); |
|
| 1200 | + return ! empty( $date ); |
|
| 1201 | + } |
|
| 1202 | + |
|
| 1203 | + /** |
|
| 1204 | + * Checks if the discount is expired |
|
| 1205 | + * |
|
| 1206 | + * @since 1.0.15 |
|
| 1207 | + * @return bool |
|
| 1208 | + */ |
|
| 1209 | + public function is_expired() { |
|
| 1210 | + $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | + return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
| 1212 | + } |
|
| 1213 | + |
|
| 1214 | + /** |
|
| 1215 | + * Checks whether the discount has a start date. |
|
| 1216 | + * |
|
| 1217 | + * @since 1.0.15 |
|
| 1218 | + * @return bool |
|
| 1219 | + */ |
|
| 1220 | + public function has_start_date() { |
|
| 1221 | + $date = $this->get_start_date(); |
|
| 1222 | + return ! empty( $date ); |
|
| 1223 | + } |
|
| 1224 | + |
|
| 1225 | + /** |
|
| 1226 | + * Checks the discount start date. |
|
| 1227 | + * |
|
| 1228 | + * @since 1.0.15 |
|
| 1229 | + * @return bool |
|
| 1230 | + */ |
|
| 1231 | + public function has_started() { |
|
| 1232 | + $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | + return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
| 1234 | + } |
|
| 1235 | + |
|
| 1236 | + /** |
|
| 1237 | + * Checks the discount has allowed items or not. |
|
| 1238 | + * |
|
| 1239 | + * @since 1.0.15 |
|
| 1240 | + * @return bool |
|
| 1241 | + */ |
|
| 1242 | + public function has_allowed_items() { |
|
| 1243 | + $allowed_items = $this->get_allowed_items(); |
|
| 1244 | + return ! empty( $allowed_items ); |
|
| 1245 | + } |
|
| 1246 | + |
|
| 1247 | + /** |
|
| 1248 | + * Checks the discount has excluded items or not. |
|
| 1249 | + * |
|
| 1250 | + * @since 1.0.15 |
|
| 1251 | + * @return bool |
|
| 1252 | + */ |
|
| 1253 | + public function has_excluded_items() { |
|
| 1254 | + $excluded_items = $this->get_excluded_items(); |
|
| 1255 | + return ! empty( $excluded_items ); |
|
| 1256 | + } |
|
| 1257 | + |
|
| 1258 | + /** |
|
| 1259 | + * Check if a discount is valid for a given item id. |
|
| 1260 | + * |
|
| 1261 | + * @param int|int[] $item_ids |
|
| 1262 | + * @since 1.0.15 |
|
| 1263 | + * @return boolean |
|
| 1264 | + */ |
|
| 1265 | + public function is_valid_for_items( $item_ids ) { |
|
| 1266 | + |
|
| 1267 | + $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | + $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | + $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | + |
|
| 1271 | + if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | + return false; |
|
| 1273 | + } |
|
| 1274 | + |
|
| 1275 | + if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | + return false; |
|
| 1277 | + } |
|
| 1278 | + |
|
| 1279 | + return true; |
|
| 1280 | + } |
|
| 1281 | + |
|
| 1282 | + /** |
|
| 1283 | + * Check if a discount is valid for the given amount |
|
| 1284 | + * |
|
| 1285 | + * @param float $amount The amount to check against |
|
| 1286 | + * @since 1.0.15 |
|
| 1287 | + * @return boolean |
|
| 1288 | + */ |
|
| 1289 | + public function is_valid_for_amount( $amount ) { |
|
| 1290 | + return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | + } |
|
| 1292 | + |
|
| 1293 | + /** |
|
| 1294 | + * Checks if the minimum amount is set |
|
| 1295 | + * |
|
| 1296 | + * @since 1.0.15 |
|
| 1297 | + * @return boolean |
|
| 1298 | + */ |
|
| 1299 | + public function has_minimum_amount() { |
|
| 1300 | + $minimum = $this->get_minimum_total(); |
|
| 1301 | + return ! empty( $minimum ); |
|
| 1302 | + } |
|
| 1303 | + |
|
| 1304 | + /** |
|
| 1305 | + * Checks if the minimum amount is met |
|
| 1306 | + * |
|
| 1307 | + * @param float $amount The amount to check against |
|
| 1308 | + * @since 1.0.15 |
|
| 1309 | + * @return boolean |
|
| 1310 | + */ |
|
| 1311 | + public function is_minimum_amount_met( $amount ) { |
|
| 1312 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | + $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | + return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1315 | + } |
|
| 1316 | + |
|
| 1317 | + /** |
|
| 1318 | + * Checks if the maximum amount is set |
|
| 1319 | + * |
|
| 1320 | + * @since 1.0.15 |
|
| 1321 | + * @return boolean |
|
| 1322 | + */ |
|
| 1323 | + public function has_maximum_amount() { |
|
| 1324 | + $maximum = $this->get_maximum_total(); |
|
| 1325 | + return ! empty( $maximum ); |
|
| 1326 | + } |
|
| 1327 | + |
|
| 1328 | + /** |
|
| 1329 | + * Checks if the maximum amount is met |
|
| 1330 | + * |
|
| 1331 | + * @param float $amount The amount to check against |
|
| 1332 | + * @since 1.0.15 |
|
| 1333 | + * @return boolean |
|
| 1334 | + */ |
|
| 1335 | + public function is_maximum_amount_met( $amount ) { |
|
| 1336 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | + $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | + return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1339 | + } |
|
| 1340 | + |
|
| 1341 | + /** |
|
| 1342 | + * Checks if the discount is recurring. |
|
| 1343 | + * |
|
| 1344 | + * @since 1.0.15 |
|
| 1345 | + * @return boolean |
|
| 1346 | + */ |
|
| 1347 | + public function is_recurring() { |
|
| 1348 | + $recurring = $this->get_is_recurring(); |
|
| 1349 | + return ! empty( $recurring ); |
|
| 1350 | + } |
|
| 1351 | + |
|
| 1352 | + /** |
|
| 1353 | + * Checks if the discount is single use. |
|
| 1354 | + * |
|
| 1355 | + * @since 1.0.15 |
|
| 1356 | + * @return boolean |
|
| 1357 | + */ |
|
| 1358 | + public function is_single_use() { |
|
| 1359 | + $usage = $this->get_is_single_use(); |
|
| 1360 | + return ! empty( $usage ); |
|
| 1361 | + } |
|
| 1362 | + |
|
| 1363 | + /** |
|
| 1364 | + * Check if a discount is valid for the given user |
|
| 1365 | + * |
|
| 1366 | + * @param int|string $user |
|
| 1367 | + * @since 1.0.15 |
|
| 1368 | + * @return boolean |
|
| 1369 | + */ |
|
| 1370 | + public function is_valid_for_user( $user ) { |
|
| 1371 | + |
|
| 1372 | + // Ensure that the discount is single use. |
|
| 1373 | + if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | + return true; |
|
| 1375 | + } |
|
| 1376 | + |
|
| 1377 | + // Prepare the user id. |
|
| 1378 | + $user_id = 0; |
|
| 1379 | 1379 | if ( is_numeric( $user ) ) { |
| 1380 | 1380 | $user_id = absint( $user ); |
| 1381 | 1381 | } else if ( is_email( $user ) && $user_data = get_user_by( 'email', $user ) ) { |
@@ -1384,117 +1384,117 @@ discard block |
||
| 1384 | 1384 | $user_id = $user_data->ID; |
| 1385 | 1385 | } |
| 1386 | 1386 | |
| 1387 | - // Ensure that we have a user. |
|
| 1388 | - if ( empty( $user_id ) ) { |
|
| 1389 | - return true; |
|
| 1390 | - } |
|
| 1387 | + // Ensure that we have a user. |
|
| 1388 | + if ( empty( $user_id ) ) { |
|
| 1389 | + return true; |
|
| 1390 | + } |
|
| 1391 | 1391 | |
| 1392 | - // Get all payments with matching user id. |
|
| 1392 | + // Get all payments with matching user id. |
|
| 1393 | 1393 | $payments = wpinv_get_invoices( array( 'user' => $user_id, 'limit' => false, 'paginate' => false ) ); |
| 1394 | - $code = strtolower( $this->get_code() ); |
|
| 1395 | - |
|
| 1396 | - // For each payment... |
|
| 1397 | - foreach ( $payments as $payment ) { |
|
| 1398 | - |
|
| 1399 | - // Only check for paid invoices. |
|
| 1400 | - if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | - return false; |
|
| 1402 | - } |
|
| 1403 | - |
|
| 1404 | - } |
|
| 1405 | - |
|
| 1406 | - return true; |
|
| 1407 | - } |
|
| 1408 | - |
|
| 1409 | - /** |
|
| 1410 | - * Deletes the discount from the database |
|
| 1411 | - * |
|
| 1412 | - * @since 1.0.15 |
|
| 1413 | - * @return boolean |
|
| 1414 | - */ |
|
| 1415 | - public function remove() { |
|
| 1416 | - return $this->delete(); |
|
| 1417 | - } |
|
| 1418 | - |
|
| 1419 | - /** |
|
| 1420 | - * Increases a discount's usage. |
|
| 1421 | - * |
|
| 1422 | - * @since 1.0.15 |
|
| 1423 | - * @param int $by The number of usages to increas by. |
|
| 1424 | - * @return int |
|
| 1425 | - */ |
|
| 1426 | - public function increase_usage( $by = 1 ) { |
|
| 1427 | - |
|
| 1428 | - // Abort if zero. |
|
| 1429 | - if ( empty( $by ) ) { |
|
| 1430 | - return; |
|
| 1431 | - } |
|
| 1432 | - |
|
| 1433 | - // Increase the usage. |
|
| 1434 | - $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | - |
|
| 1436 | - // Save the discount. |
|
| 1437 | - $this->save(); |
|
| 1438 | - |
|
| 1439 | - // Fire relevant hooks. |
|
| 1440 | - if( (int) $by > 0 ) { |
|
| 1441 | - do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1442 | - } else { |
|
| 1443 | - do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1444 | - } |
|
| 1445 | - |
|
| 1446 | - // Return the number of times the discount has been used. |
|
| 1447 | - return $this->get_uses(); |
|
| 1448 | - } |
|
| 1449 | - |
|
| 1450 | - /** |
|
| 1451 | - * Alias of self::__toString() |
|
| 1452 | - * |
|
| 1453 | - * @since 1.0.15 |
|
| 1454 | - * @return string|false |
|
| 1455 | - */ |
|
| 1456 | - public function get_data_as_json() { |
|
| 1457 | - return $this->__toString(); |
|
| 1458 | - } |
|
| 1459 | - |
|
| 1460 | - /** |
|
| 1461 | - * Returns a discount's discounted amount. |
|
| 1462 | - * |
|
| 1463 | - * @since 1.0.15 |
|
| 1464 | - * @param float $amount |
|
| 1465 | - * @return float |
|
| 1466 | - */ |
|
| 1467 | - public function get_discounted_amount( $amount ) { |
|
| 1468 | - |
|
| 1469 | - // Convert amount to float. |
|
| 1470 | - $amount = (float) $amount; |
|
| 1471 | - |
|
| 1472 | - // Get discount amount. |
|
| 1473 | - $discount_amount = $this->get_amount(); |
|
| 1474 | - |
|
| 1475 | - if ( empty( $discount_amount ) ) { |
|
| 1476 | - return 0; |
|
| 1477 | - } |
|
| 1478 | - |
|
| 1479 | - // Format the amount. |
|
| 1480 | - $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1481 | - |
|
| 1482 | - // If this is a percentage discount. |
|
| 1483 | - if ( $this->is_type( 'percent' ) ) { |
|
| 1394 | + $code = strtolower( $this->get_code() ); |
|
| 1395 | + |
|
| 1396 | + // For each payment... |
|
| 1397 | + foreach ( $payments as $payment ) { |
|
| 1398 | + |
|
| 1399 | + // Only check for paid invoices. |
|
| 1400 | + if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | + return false; |
|
| 1402 | + } |
|
| 1403 | + |
|
| 1404 | + } |
|
| 1405 | + |
|
| 1406 | + return true; |
|
| 1407 | + } |
|
| 1408 | + |
|
| 1409 | + /** |
|
| 1410 | + * Deletes the discount from the database |
|
| 1411 | + * |
|
| 1412 | + * @since 1.0.15 |
|
| 1413 | + * @return boolean |
|
| 1414 | + */ |
|
| 1415 | + public function remove() { |
|
| 1416 | + return $this->delete(); |
|
| 1417 | + } |
|
| 1418 | + |
|
| 1419 | + /** |
|
| 1420 | + * Increases a discount's usage. |
|
| 1421 | + * |
|
| 1422 | + * @since 1.0.15 |
|
| 1423 | + * @param int $by The number of usages to increas by. |
|
| 1424 | + * @return int |
|
| 1425 | + */ |
|
| 1426 | + public function increase_usage( $by = 1 ) { |
|
| 1427 | + |
|
| 1428 | + // Abort if zero. |
|
| 1429 | + if ( empty( $by ) ) { |
|
| 1430 | + return; |
|
| 1431 | + } |
|
| 1432 | + |
|
| 1433 | + // Increase the usage. |
|
| 1434 | + $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | + |
|
| 1436 | + // Save the discount. |
|
| 1437 | + $this->save(); |
|
| 1438 | + |
|
| 1439 | + // Fire relevant hooks. |
|
| 1440 | + if( (int) $by > 0 ) { |
|
| 1441 | + do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1442 | + } else { |
|
| 1443 | + do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1444 | + } |
|
| 1445 | + |
|
| 1446 | + // Return the number of times the discount has been used. |
|
| 1447 | + return $this->get_uses(); |
|
| 1448 | + } |
|
| 1449 | + |
|
| 1450 | + /** |
|
| 1451 | + * Alias of self::__toString() |
|
| 1452 | + * |
|
| 1453 | + * @since 1.0.15 |
|
| 1454 | + * @return string|false |
|
| 1455 | + */ |
|
| 1456 | + public function get_data_as_json() { |
|
| 1457 | + return $this->__toString(); |
|
| 1458 | + } |
|
| 1459 | + |
|
| 1460 | + /** |
|
| 1461 | + * Returns a discount's discounted amount. |
|
| 1462 | + * |
|
| 1463 | + * @since 1.0.15 |
|
| 1464 | + * @param float $amount |
|
| 1465 | + * @return float |
|
| 1466 | + */ |
|
| 1467 | + public function get_discounted_amount( $amount ) { |
|
| 1468 | + |
|
| 1469 | + // Convert amount to float. |
|
| 1470 | + $amount = (float) $amount; |
|
| 1471 | + |
|
| 1472 | + // Get discount amount. |
|
| 1473 | + $discount_amount = $this->get_amount(); |
|
| 1474 | + |
|
| 1475 | + if ( empty( $discount_amount ) ) { |
|
| 1476 | + return 0; |
|
| 1477 | + } |
|
| 1478 | + |
|
| 1479 | + // Format the amount. |
|
| 1480 | + $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1481 | + |
|
| 1482 | + // If this is a percentage discount. |
|
| 1483 | + if ( $this->is_type( 'percent' ) ) { |
|
| 1484 | 1484 | $discount_amount = $amount * ( $discount_amount / 100 ); |
| 1485 | - } |
|
| 1485 | + } |
|
| 1486 | 1486 | |
| 1487 | - // Discount can not be less than zero... |
|
| 1488 | - if ( $discount_amount < 0 ) { |
|
| 1489 | - $discount_amount = 0; |
|
| 1490 | - } |
|
| 1487 | + // Discount can not be less than zero... |
|
| 1488 | + if ( $discount_amount < 0 ) { |
|
| 1489 | + $discount_amount = 0; |
|
| 1490 | + } |
|
| 1491 | 1491 | |
| 1492 | - // ... or more than the amount. |
|
| 1493 | - if ( $discount_amount > $amount ) { |
|
| 1494 | - $discount_amount = $amount; |
|
| 1495 | - } |
|
| 1492 | + // ... or more than the amount. |
|
| 1493 | + if ( $discount_amount > $amount ) { |
|
| 1494 | + $discount_amount = $amount; |
|
| 1495 | + } |
|
| 1496 | 1496 | |
| 1497 | - return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | - } |
|
| 1497 | + return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | + } |
|
| 1499 | 1499 | |
| 1500 | 1500 | } |
@@ -24,14 +24,14 @@ |
||
| 24 | 24 | } |
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Highlights sub menus. |
|
| 28 | - */ |
|
| 29 | - public function set_admin_menu_class() { |
|
| 30 | - global $current_screen, $parent_file, $submenu_file; |
|
| 27 | + * Highlights sub menus. |
|
| 28 | + */ |
|
| 29 | + public function set_admin_menu_class() { |
|
| 30 | + global $current_screen, $parent_file, $submenu_file; |
|
| 31 | 31 | |
| 32 | 32 | if ( ! empty( $current_screen->id ) && in_array( $current_screen->id , array( 'wpi_discount', 'wpi_payment_form', 'wpi_invoice' ) ) ) { |
| 33 | - $parent_file = 'wpinv'; |
|
| 34 | - $submenu_file = 'edit.php?post_type=' . $current_screen->id; |
|
| 33 | + $parent_file = 'wpinv'; |
|
| 34 | + $submenu_file = 'edit.php?post_type=' . $current_screen->id; |
|
| 35 | 35 | } |
| 36 | 36 | |
| 37 | 37 | } |
@@ -3,7 +3,7 @@ discard block |
||
| 3 | 3 | * Setup menus in WP admin. |
| 4 | 4 | */ |
| 5 | 5 | |
| 6 | -defined( 'ABSPATH' ) || exit; |
|
| 6 | +defined('ABSPATH') || exit; |
|
| 7 | 7 | |
| 8 | 8 | /** |
| 9 | 9 | * WC_Admin_Menus Class. |
@@ -13,14 +13,14 @@ discard block |
||
| 13 | 13 | * Hook in tabs. |
| 14 | 14 | */ |
| 15 | 15 | public function __construct() { |
| 16 | - add_action( 'admin_head', array( $this, 'set_admin_menu_class' ) ); |
|
| 17 | - add_action( 'admin_menu', array( $this, 'admin_menu' ), 10 ); |
|
| 18 | - add_action( 'admin_menu', array( $this, 'add_customers_menu' ), 18 ); |
|
| 19 | - add_action( 'admin_menu', array( $this, 'add_subscriptions_menu' ), 40 ); |
|
| 20 | - add_action( 'admin_menu', array( $this, 'add_addons_menu' ), 100 ); |
|
| 21 | - add_action( 'admin_menu', array( $this, 'add_settings_menu' ), 60 ); |
|
| 22 | - add_action( 'admin_menu', array( $this, 'remove_admin_submenus' ), 10 ); |
|
| 23 | - add_action( 'admin_head-nav-menus.php', array( $this, 'add_nav_menu_meta_boxes' ) ); |
|
| 16 | + add_action('admin_head', array($this, 'set_admin_menu_class')); |
|
| 17 | + add_action('admin_menu', array($this, 'admin_menu'), 10); |
|
| 18 | + add_action('admin_menu', array($this, 'add_customers_menu'), 18); |
|
| 19 | + add_action('admin_menu', array($this, 'add_subscriptions_menu'), 40); |
|
| 20 | + add_action('admin_menu', array($this, 'add_addons_menu'), 100); |
|
| 21 | + add_action('admin_menu', array($this, 'add_settings_menu'), 60); |
|
| 22 | + add_action('admin_menu', array($this, 'remove_admin_submenus'), 10); |
|
| 23 | + add_action('admin_head-nav-menus.php', array($this, 'add_nav_menu_meta_boxes')); |
|
| 24 | 24 | } |
| 25 | 25 | |
| 26 | 26 | /** |
@@ -29,7 +29,7 @@ discard block |
||
| 29 | 29 | public function set_admin_menu_class() { |
| 30 | 30 | global $current_screen, $parent_file, $submenu_file; |
| 31 | 31 | |
| 32 | - if ( ! empty( $current_screen->id ) && in_array( $current_screen->id , array( 'wpi_discount', 'wpi_payment_form', 'wpi_invoice' ) ) ) { |
|
| 32 | + if (!empty($current_screen->id) && in_array($current_screen->id, array('wpi_discount', 'wpi_payment_form', 'wpi_invoice'))) { |
|
| 33 | 33 | $parent_file = 'wpinv'; |
| 34 | 34 | $submenu_file = 'edit.php?post_type=' . $current_screen->id; |
| 35 | 35 | } |
@@ -38,14 +38,14 @@ discard block |
||
| 38 | 38 | |
| 39 | 39 | public function admin_menu() { |
| 40 | 40 | |
| 41 | - $capability = apply_filters( 'invoicing_capability', wpinv_get_capability() ); |
|
| 41 | + $capability = apply_filters('invoicing_capability', wpinv_get_capability()); |
|
| 42 | 42 | add_menu_page( |
| 43 | - __( 'GetPaid', 'invoicing' ), |
|
| 44 | - __( 'GetPaid', 'invoicing' ), |
|
| 43 | + __('GetPaid', 'invoicing'), |
|
| 44 | + __('GetPaid', 'invoicing'), |
|
| 45 | 45 | $capability, |
| 46 | 46 | 'wpinv', |
| 47 | 47 | null, |
| 48 | - 'data:image/svg+xml;base64,' . base64_encode( file_get_contents( WPINV_PLUGIN_DIR . 'assets/images/GetPaid.svg' ) ), |
|
| 48 | + 'data:image/svg+xml;base64,' . base64_encode(file_get_contents(WPINV_PLUGIN_DIR . 'assets/images/GetPaid.svg')), |
|
| 49 | 49 | '54.123460' |
| 50 | 50 | ); |
| 51 | 51 | |
@@ -57,11 +57,11 @@ discard block |
||
| 57 | 57 | public function add_customers_menu() { |
| 58 | 58 | add_submenu_page( |
| 59 | 59 | 'wpinv', |
| 60 | - __( 'Customers', 'invoicing' ), |
|
| 61 | - __( 'Customers', 'invoicing' ), |
|
| 60 | + __('Customers', 'invoicing'), |
|
| 61 | + __('Customers', 'invoicing'), |
|
| 62 | 62 | wpinv_get_capability(), |
| 63 | 63 | 'wpinv-customers', |
| 64 | - array( $this, 'customers_page' ) |
|
| 64 | + array($this, 'customers_page') |
|
| 65 | 65 | ); |
| 66 | 66 | } |
| 67 | 67 | |
@@ -71,8 +71,8 @@ discard block |
||
| 71 | 71 | public function add_subscriptions_menu() { |
| 72 | 72 | add_submenu_page( |
| 73 | 73 | 'wpinv', |
| 74 | - __( 'Subscriptions', 'invoicing' ), |
|
| 75 | - __( 'Subscriptions', 'invoicing' ), |
|
| 74 | + __('Subscriptions', 'invoicing'), |
|
| 75 | + __('Subscriptions', 'invoicing'), |
|
| 76 | 76 | wpinv_get_capability(), |
| 77 | 77 | 'wpinv-subscriptions', |
| 78 | 78 | 'wpinv_subscriptions_page' |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | * Displays the customers page. |
| 84 | 84 | */ |
| 85 | 85 | public function customers_page() { |
| 86 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-customers-table.php' ); |
|
| 86 | + require_once(WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-customers-table.php'); |
|
| 87 | 87 | ?> |
| 88 | 88 | <div class="wrap wpi-customers-wrap"> |
| 89 | 89 | <style> |
@@ -91,12 +91,12 @@ discard block |
||
| 91 | 91 | width: 30%; |
| 92 | 92 | } |
| 93 | 93 | </style> |
| 94 | - <h1><?php echo esc_html( __( 'Customers', 'invoicing' ) ); ?></h1> |
|
| 94 | + <h1><?php echo esc_html(__('Customers', 'invoicing')); ?></h1> |
|
| 95 | 95 | <form method="post"> |
| 96 | 96 | <?php |
| 97 | 97 | $table = new WPInv_Customers_Table(); |
| 98 | 98 | $table->prepare_items(); |
| 99 | - $table->search_box( __( 'Search Customers', 'invoicing' ), 'search-customers' ); |
|
| 99 | + $table->search_box(__('Search Customers', 'invoicing'), 'search-customers'); |
|
| 100 | 100 | $table->display(); |
| 101 | 101 | ?> |
| 102 | 102 | </form> |
@@ -110,16 +110,16 @@ discard block |
||
| 110 | 110 | public function add_settings_menu() { |
| 111 | 111 | add_submenu_page( |
| 112 | 112 | 'wpinv', |
| 113 | - __( 'Invoice Settings', 'invoicing' ), |
|
| 114 | - __( 'Settings', 'invoicing' ), |
|
| 115 | - apply_filters( 'invoicing_capability', wpinv_get_capability() ), |
|
| 113 | + __('Invoice Settings', 'invoicing'), |
|
| 114 | + __('Settings', 'invoicing'), |
|
| 115 | + apply_filters('invoicing_capability', wpinv_get_capability()), |
|
| 116 | 116 | 'wpinv-settings', |
| 117 | - array( $this, 'options_page' ) |
|
| 117 | + array($this, 'options_page') |
|
| 118 | 118 | ); |
| 119 | 119 | } |
| 120 | 120 | |
| 121 | - public function add_addons_menu(){ |
|
| 122 | - if ( !apply_filters( 'wpi_show_addons_page', true ) ) { |
|
| 121 | + public function add_addons_menu() { |
|
| 122 | + if (!apply_filters('wpi_show_addons_page', true)) { |
|
| 123 | 123 | return; |
| 124 | 124 | } |
| 125 | 125 | |
@@ -129,78 +129,78 @@ discard block |
||
| 129 | 129 | __('Extensions', 'invoicing'), |
| 130 | 130 | 'manage_options', |
| 131 | 131 | 'wpi-addons', |
| 132 | - array( $this, 'addons_page' ) |
|
| 132 | + array($this, 'addons_page') |
|
| 133 | 133 | ); |
| 134 | 134 | } |
| 135 | 135 | |
| 136 | - public function addons_page(){ |
|
| 136 | + public function addons_page() { |
|
| 137 | 137 | $addon_obj = new WPInv_Admin_Addons(); |
| 138 | 138 | $addon_obj->output(); |
| 139 | 139 | } |
| 140 | 140 | |
| 141 | 141 | function options_page() { |
| 142 | - $page = isset( $_GET['page'] ) ? strtolower( $_GET['page'] ) : false; |
|
| 142 | + $page = isset($_GET['page']) ? strtolower($_GET['page']) : false; |
|
| 143 | 143 | |
| 144 | - if ( $page !== 'wpinv-settings' ) { |
|
| 144 | + if ($page !== 'wpinv-settings') { |
|
| 145 | 145 | return; |
| 146 | 146 | } |
| 147 | 147 | |
| 148 | 148 | $settings_tabs = wpinv_get_settings_tabs(); |
| 149 | 149 | $settings_tabs = empty($settings_tabs) ? array() : $settings_tabs; |
| 150 | - $active_tab = isset( $_GET['tab'] ) && array_key_exists( $_GET['tab'], $settings_tabs ) ? sanitize_text_field( $_GET['tab'] ) : 'general'; |
|
| 151 | - $sections = wpinv_get_settings_tab_sections( $active_tab ); |
|
| 150 | + $active_tab = isset($_GET['tab']) && array_key_exists($_GET['tab'], $settings_tabs) ? sanitize_text_field($_GET['tab']) : 'general'; |
|
| 151 | + $sections = wpinv_get_settings_tab_sections($active_tab); |
|
| 152 | 152 | $key = 'main'; |
| 153 | 153 | |
| 154 | - if ( is_array( $sections ) ) { |
|
| 155 | - $key = key( $sections ); |
|
| 154 | + if (is_array($sections)) { |
|
| 155 | + $key = key($sections); |
|
| 156 | 156 | } |
| 157 | 157 | |
| 158 | - $registered_sections = wpinv_get_settings_tab_sections( $active_tab ); |
|
| 159 | - $section = isset( $_GET['section'] ) && ! empty( $registered_sections ) && array_key_exists( $_GET['section'], $registered_sections ) ? $_GET['section'] : $key; |
|
| 158 | + $registered_sections = wpinv_get_settings_tab_sections($active_tab); |
|
| 159 | + $section = isset($_GET['section']) && !empty($registered_sections) && array_key_exists($_GET['section'], $registered_sections) ? $_GET['section'] : $key; |
|
| 160 | 160 | ob_start(); |
| 161 | 161 | ?> |
| 162 | 162 | <div class="wrap"> |
| 163 | 163 | <h1 class="nav-tab-wrapper"> |
| 164 | 164 | <?php |
| 165 | - foreach( wpinv_get_settings_tabs() as $tab_id => $tab_name ) { |
|
| 166 | - $tab_url = add_query_arg( array( |
|
| 165 | + foreach (wpinv_get_settings_tabs() as $tab_id => $tab_name) { |
|
| 166 | + $tab_url = add_query_arg(array( |
|
| 167 | 167 | 'settings-updated' => false, |
| 168 | 168 | 'tab' => $tab_id, |
| 169 | - ) ); |
|
| 169 | + )); |
|
| 170 | 170 | |
| 171 | 171 | // Remove the section from the tabs so we always end up at the main section |
| 172 | - $tab_url = remove_query_arg( 'section', $tab_url ); |
|
| 173 | - $tab_url = remove_query_arg( 'wpi_sub', $tab_url ); |
|
| 172 | + $tab_url = remove_query_arg('section', $tab_url); |
|
| 173 | + $tab_url = remove_query_arg('wpi_sub', $tab_url); |
|
| 174 | 174 | |
| 175 | 175 | $active = $active_tab == $tab_id ? ' nav-tab-active' : ''; |
| 176 | 176 | |
| 177 | - echo '<a href="' . esc_url( $tab_url ) . '" title="' . esc_attr( $tab_name ) . '" class="nav-tab' . $active . '">'; |
|
| 178 | - echo esc_html( $tab_name ); |
|
| 177 | + echo '<a href="' . esc_url($tab_url) . '" title="' . esc_attr($tab_name) . '" class="nav-tab' . $active . '">'; |
|
| 178 | + echo esc_html($tab_name); |
|
| 179 | 179 | echo '</a>'; |
| 180 | 180 | } |
| 181 | 181 | ?> |
| 182 | 182 | </h1> |
| 183 | 183 | <?php |
| 184 | - $number_of_sections = count( $sections ); |
|
| 184 | + $number_of_sections = count($sections); |
|
| 185 | 185 | $number = 0; |
| 186 | - if ( $number_of_sections > 1 ) { |
|
| 186 | + if ($number_of_sections > 1) { |
|
| 187 | 187 | echo '<div><ul class="subsubsub">'; |
| 188 | - foreach( $sections as $section_id => $section_name ) { |
|
| 188 | + foreach ($sections as $section_id => $section_name) { |
|
| 189 | 189 | echo '<li>'; |
| 190 | 190 | $number++; |
| 191 | - $tab_url = add_query_arg( array( |
|
| 191 | + $tab_url = add_query_arg(array( |
|
| 192 | 192 | 'settings-updated' => false, |
| 193 | 193 | 'tab' => $active_tab, |
| 194 | 194 | 'section' => $section_id |
| 195 | - ) ); |
|
| 196 | - $tab_url = remove_query_arg( 'wpi_sub', $tab_url ); |
|
| 195 | + )); |
|
| 196 | + $tab_url = remove_query_arg('wpi_sub', $tab_url); |
|
| 197 | 197 | $class = ''; |
| 198 | - if ( $section == $section_id ) { |
|
| 198 | + if ($section == $section_id) { |
|
| 199 | 199 | $class = 'current'; |
| 200 | 200 | } |
| 201 | - echo '<a class="' . $class . '" href="' . esc_url( $tab_url ) . '">' . $section_name . '</a>'; |
|
| 201 | + echo '<a class="' . $class . '" href="' . esc_url($tab_url) . '">' . $section_name . '</a>'; |
|
| 202 | 202 | |
| 203 | - if ( $number != $number_of_sections ) { |
|
| 203 | + if ($number != $number_of_sections) { |
|
| 204 | 204 | echo ' | '; |
| 205 | 205 | } |
| 206 | 206 | echo '</li>'; |
@@ -212,20 +212,20 @@ discard block |
||
| 212 | 212 | <form method="post" action="options.php"> |
| 213 | 213 | <table class="form-table"> |
| 214 | 214 | <?php |
| 215 | - settings_fields( 'wpinv_settings' ); |
|
| 215 | + settings_fields('wpinv_settings'); |
|
| 216 | 216 | |
| 217 | - if ( 'main' === $section ) { |
|
| 218 | - do_action( 'wpinv_settings_tab_top', $active_tab ); |
|
| 217 | + if ('main' === $section) { |
|
| 218 | + do_action('wpinv_settings_tab_top', $active_tab); |
|
| 219 | 219 | } |
| 220 | 220 | |
| 221 | - do_action( 'wpinv_settings_tab_top_' . $active_tab . '_' . $section, $active_tab, $section ); |
|
| 222 | - do_settings_sections( 'wpinv_settings_' . $active_tab . '_' . $section, $active_tab, $section ); |
|
| 223 | - do_action( 'wpinv_settings_tab_bottom_' . $active_tab . '_' . $section, $active_tab, $section ); |
|
| 224 | - do_action( 'getpaid_settings_tab_bottom', $active_tab, $section ); |
|
| 221 | + do_action('wpinv_settings_tab_top_' . $active_tab . '_' . $section, $active_tab, $section); |
|
| 222 | + do_settings_sections('wpinv_settings_' . $active_tab . '_' . $section, $active_tab, $section); |
|
| 223 | + do_action('wpinv_settings_tab_bottom_' . $active_tab . '_' . $section, $active_tab, $section); |
|
| 224 | + do_action('getpaid_settings_tab_bottom', $active_tab, $section); |
|
| 225 | 225 | |
| 226 | 226 | // For backwards compatibility |
| 227 | - if ( 'main' === $section ) { |
|
| 228 | - do_action( 'wpinv_settings_tab_bottom', $active_tab ); |
|
| 227 | + if ('main' === $section) { |
|
| 228 | + do_action('wpinv_settings_tab_bottom', $active_tab); |
|
| 229 | 229 | } |
| 230 | 230 | ?> |
| 231 | 231 | </table> |
@@ -239,7 +239,7 @@ discard block |
||
| 239 | 239 | } |
| 240 | 240 | |
| 241 | 241 | public function remove_admin_submenus() { |
| 242 | - remove_submenu_page( 'edit.php?post_type=wpi_invoice', 'post-new.php?post_type=wpi_invoice' ); |
|
| 242 | + remove_submenu_page('edit.php?post_type=wpi_invoice', 'post-new.php?post_type=wpi_invoice'); |
|
| 243 | 243 | } |
| 244 | 244 | |
| 245 | 245 | /** |
@@ -249,8 +249,8 @@ discard block |
||
| 249 | 249 | |
| 250 | 250 | add_meta_box( |
| 251 | 251 | 'wpinv_endpoints_nav_link', |
| 252 | - __( 'GetPaid endpoints', 'invoicing' ), |
|
| 253 | - array( $this, 'nav_menu_links' ), |
|
| 252 | + __('GetPaid endpoints', 'invoicing'), |
|
| 253 | + array($this, 'nav_menu_links'), |
|
| 254 | 254 | 'nav-menus', |
| 255 | 255 | 'side', |
| 256 | 256 | 'low' |
@@ -265,12 +265,12 @@ discard block |
||
| 265 | 265 | $endpoints = $this->get_menu_items(); |
| 266 | 266 | ?> |
| 267 | 267 | <div id="invoicing-endpoints" class="posttypediv"> |
| 268 | - <?php if ( ! empty( $endpoints['pages'] ) ) : ?> |
|
| 268 | + <?php if (!empty($endpoints['pages'])) : ?> |
|
| 269 | 269 | <div id="tabs-panel-invoicing-endpoints" class="tabs-panel tabs-panel-active"> |
| 270 | 270 | <ul id="invoicing-endpoints-checklist" class="categorychecklist form-no-clear"> |
| 271 | 271 | <?php |
| 272 | - $walker = new Walker_Nav_Menu_Checklist( array() ); |
|
| 273 | - echo walk_nav_menu_tree( array_map( 'wp_setup_nav_menu_item', $endpoints['pages'] ), 0, (object) array( 'walker' => $walker ) ); |
|
| 272 | + $walker = new Walker_Nav_Menu_Checklist(array()); |
|
| 273 | + echo walk_nav_menu_tree(array_map('wp_setup_nav_menu_item', $endpoints['pages']), 0, (object) array('walker' => $walker)); |
|
| 274 | 274 | ?> |
| 275 | 275 | </ul> |
| 276 | 276 | </div> |
@@ -279,11 +279,11 @@ discard block |
||
| 279 | 279 | <p class="button-controls wp-clearfix" data-items-type="invoicing-endpoints"> |
| 280 | 280 | <span class="list-controls hide-if-no-js"> |
| 281 | 281 | <input type="checkbox" id="invoicing-endpoints-tab" class="select-all"> |
| 282 | - <label for="invoicing-endpoints-tab"><?php _e( 'Select all', 'invoicing' ); ?></label> |
|
| 282 | + <label for="invoicing-endpoints-tab"><?php _e('Select all', 'invoicing'); ?></label> |
|
| 283 | 283 | </span> |
| 284 | 284 | |
| 285 | 285 | <span class="add-to-menu"> |
| 286 | - <input type="submit" class="button submit-add-to-menu right" value="<?php esc_attr_e( 'Add to menu', 'invoicing' ); ?>" name="add-invoicing-endpoints-item" id="submit-invoicing-endpoints"> |
|
| 286 | + <input type="submit" class="button submit-add-to-menu right" value="<?php esc_attr_e('Add to menu', 'invoicing'); ?>" name="add-invoicing-endpoints-item" id="submit-invoicing-endpoints"> |
|
| 287 | 287 | <span class="spinner"></span> |
| 288 | 288 | </span> |
| 289 | 289 | </p> |
@@ -296,35 +296,35 @@ discard block |
||
| 296 | 296 | * |
| 297 | 297 | * @return array. |
| 298 | 298 | */ |
| 299 | - public function get_menu_items(){ |
|
| 299 | + public function get_menu_items() { |
|
| 300 | 300 | $items = array(); |
| 301 | 301 | |
| 302 | 302 | $pages = array( |
| 303 | 303 | array( |
| 304 | - 'id' => wpinv_get_option( 'invoice_history_page' ), |
|
| 305 | - 'label' => __( 'My Invoices', 'invoicing' ), |
|
| 304 | + 'id' => wpinv_get_option('invoice_history_page'), |
|
| 305 | + 'label' => __('My Invoices', 'invoicing'), |
|
| 306 | 306 | ), |
| 307 | 307 | array( |
| 308 | - 'id' => wpinv_get_option( 'invoice_subscription_page' ), |
|
| 309 | - 'label' => __( 'My Subscriptions', 'invoicing' ), |
|
| 308 | + 'id' => wpinv_get_option('invoice_subscription_page'), |
|
| 309 | + 'label' => __('My Subscriptions', 'invoicing'), |
|
| 310 | 310 | ) |
| 311 | 311 | ); |
| 312 | 312 | |
| 313 | - foreach ( apply_filters( 'getpaid_menu_pages', $pages ) as $page ) { |
|
| 313 | + foreach (apply_filters('getpaid_menu_pages', $pages) as $page) { |
|
| 314 | 314 | |
| 315 | - if ( (int) $page['id'] > 0 ) { |
|
| 315 | + if ((int) $page['id'] > 0) { |
|
| 316 | 316 | |
| 317 | 317 | $item = new stdClass(); |
| 318 | 318 | $item->object_id = (int) $page['id']; |
| 319 | 319 | $item->db_id = 0; |
| 320 | - $item->object = 'page'; |
|
| 320 | + $item->object = 'page'; |
|
| 321 | 321 | $item->menu_item_parent = 0; |
| 322 | 322 | $item->type = 'post_type'; |
| 323 | - $item->title = sanitize_text_field( $page['label'] ); |
|
| 324 | - $item->url = get_permalink( (int) $page['id'] ); |
|
| 323 | + $item->title = sanitize_text_field($page['label']); |
|
| 324 | + $item->url = get_permalink((int) $page['id']); |
|
| 325 | 325 | $item->target = ''; |
| 326 | 326 | $item->attr_title = ''; |
| 327 | - $item->classes = array( 'wpinv-menu-item' ); |
|
| 327 | + $item->classes = array('wpinv-menu-item'); |
|
| 328 | 328 | $item->xfn = ''; |
| 329 | 329 | |
| 330 | 330 | $items['pages'][] = $item; |
@@ -333,7 +333,7 @@ discard block |
||
| 333 | 333 | |
| 334 | 334 | } |
| 335 | 335 | |
| 336 | - return apply_filters( 'wpinv_menu_items', $items ); |
|
| 336 | + return apply_filters('wpinv_menu_items', $items); |
|
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | } |