@@ -6,7 +6,7 @@ discard block |
||
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | if ( ! defined( 'ABSPATH' ) ) { |
| 9 | - exit; // Exit if accessed directly |
|
| 9 | + exit; // Exit if accessed directly |
|
| 10 | 10 | } |
| 11 | 11 | |
| 12 | 12 | /** |
@@ -15,10 +15,10 @@ discard block |
||
| 15 | 15 | class GetPaid_Meta_Box_Invoice_Subscription { |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | - * Output the subscription metabox. |
|
| 19 | - * |
|
| 20 | - * @param WP_Post $post |
|
| 21 | - */ |
|
| 18 | + * Output the subscription metabox. |
|
| 19 | + * |
|
| 20 | + * @param WP_Post $post |
|
| 21 | + */ |
|
| 22 | 22 | public static function output( $post ) { |
| 23 | 23 | |
| 24 | 24 | // Fetch the invoice. |
@@ -34,10 +34,10 @@ discard block |
||
| 34 | 34 | } |
| 35 | 35 | |
| 36 | 36 | /** |
| 37 | - * Output the subscription invoices. |
|
| 38 | - * |
|
| 39 | - * @param WP_Post $post |
|
| 40 | - */ |
|
| 37 | + * Output the subscription invoices. |
|
| 38 | + * |
|
| 39 | + * @param WP_Post $post |
|
| 40 | + */ |
|
| 41 | 41 | public static function output_invoices( $post ) { |
| 42 | 42 | |
| 43 | 43 | // Fetch the invoice. |
@@ -53,10 +53,10 @@ discard block |
||
| 53 | 53 | } |
| 54 | 54 | |
| 55 | 55 | /** |
| 56 | - * Outputs related subscriptions. |
|
| 57 | - * |
|
| 58 | - * @param WP_Post $post |
|
| 59 | - */ |
|
| 56 | + * Outputs related subscriptions. |
|
| 57 | + * |
|
| 58 | + * @param WP_Post $post |
|
| 59 | + */ |
|
| 60 | 60 | public static function output_related( $post ) { |
| 61 | 61 | |
| 62 | 62 | // Fetch the invoice. |
@@ -140,7 +140,7 @@ discard block |
||
| 140 | 140 | * @param string $default_path The root path to the default template. Defaults to invoicing/templates |
| 141 | 141 | */ |
| 142 | 142 | function wpinv_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) { |
| 143 | - return getpaid_template()->get_template( $template_name, $args, $template_path, $default_path ); |
|
| 143 | + return getpaid_template()->get_template( $template_name, $args, $template_path, $default_path ); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | /** |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | * @return string |
| 159 | 159 | */ |
| 160 | 160 | function wpinv_get_theme_template_dir_name() { |
| 161 | - return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) ); |
|
| 161 | + return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) ); |
|
| 162 | 162 | } |
| 163 | 163 | |
| 164 | 164 | /** |
@@ -175,122 +175,122 @@ discard block |
||
| 175 | 175 | } |
| 176 | 176 | |
| 177 | 177 | function wpinv_get_template_part( $slug, $name = null, $load = true ) { |
| 178 | - do_action( 'get_template_part_' . $slug, $slug, $name ); |
|
| 178 | + do_action( 'get_template_part_' . $slug, $slug, $name ); |
|
| 179 | 179 | |
| 180 | - // Setup possible parts |
|
| 181 | - $templates = array(); |
|
| 182 | - if ( isset( $name ) ) |
|
| 183 | - $templates[] = $slug . '-' . $name . '.php'; |
|
| 184 | - $templates[] = $slug . '.php'; |
|
| 180 | + // Setup possible parts |
|
| 181 | + $templates = array(); |
|
| 182 | + if ( isset( $name ) ) |
|
| 183 | + $templates[] = $slug . '-' . $name . '.php'; |
|
| 184 | + $templates[] = $slug . '.php'; |
|
| 185 | 185 | |
| 186 | - // Allow template parts to be filtered |
|
| 187 | - $templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name ); |
|
| 186 | + // Allow template parts to be filtered |
|
| 187 | + $templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name ); |
|
| 188 | 188 | |
| 189 | - // Return the part that is found |
|
| 190 | - return wpinv_locate_tmpl( $templates, $load, false ); |
|
| 189 | + // Return the part that is found |
|
| 190 | + return wpinv_locate_tmpl( $templates, $load, false ); |
|
| 191 | 191 | } |
| 192 | 192 | |
| 193 | 193 | function wpinv_locate_tmpl( $template_names, $load = false, $require_once = true ) { |
| 194 | - // No file found yet |
|
| 195 | - $located = false; |
|
| 194 | + // No file found yet |
|
| 195 | + $located = false; |
|
| 196 | 196 | |
| 197 | - // Try to find a template file |
|
| 198 | - foreach ( (array)$template_names as $template_name ) { |
|
| 197 | + // Try to find a template file |
|
| 198 | + foreach ( (array)$template_names as $template_name ) { |
|
| 199 | 199 | |
| 200 | - // Continue if template is empty |
|
| 201 | - if ( empty( $template_name ) ) |
|
| 202 | - continue; |
|
| 200 | + // Continue if template is empty |
|
| 201 | + if ( empty( $template_name ) ) |
|
| 202 | + continue; |
|
| 203 | 203 | |
| 204 | - // Trim off any slashes from the template name |
|
| 205 | - $template_name = ltrim( $template_name, '/' ); |
|
| 204 | + // Trim off any slashes from the template name |
|
| 205 | + $template_name = ltrim( $template_name, '/' ); |
|
| 206 | 206 | |
| 207 | - // try locating this template file by looping through the template paths |
|
| 208 | - foreach( wpinv_get_theme_template_paths() as $template_path ) { |
|
| 207 | + // try locating this template file by looping through the template paths |
|
| 208 | + foreach( wpinv_get_theme_template_paths() as $template_path ) { |
|
| 209 | 209 | |
| 210 | - if( file_exists( $template_path . $template_name ) ) { |
|
| 211 | - $located = $template_path . $template_name; |
|
| 212 | - break; |
|
| 213 | - } |
|
| 214 | - } |
|
| 210 | + if( file_exists( $template_path . $template_name ) ) { |
|
| 211 | + $located = $template_path . $template_name; |
|
| 212 | + break; |
|
| 213 | + } |
|
| 214 | + } |
|
| 215 | 215 | |
| 216 | - if( !empty( $located ) ) { |
|
| 217 | - break; |
|
| 218 | - } |
|
| 219 | - } |
|
| 216 | + if( !empty( $located ) ) { |
|
| 217 | + break; |
|
| 218 | + } |
|
| 219 | + } |
|
| 220 | 220 | |
| 221 | - if ( ( true == $load ) && ! empty( $located ) ) |
|
| 222 | - load_template( $located, $require_once ); |
|
| 221 | + if ( ( true == $load ) && ! empty( $located ) ) |
|
| 222 | + load_template( $located, $require_once ); |
|
| 223 | 223 | |
| 224 | - return $located; |
|
| 224 | + return $located; |
|
| 225 | 225 | } |
| 226 | 226 | |
| 227 | 227 | function wpinv_get_theme_template_paths() { |
| 228 | - $template_dir = wpinv_get_theme_template_dir_name(); |
|
| 228 | + $template_dir = wpinv_get_theme_template_dir_name(); |
|
| 229 | 229 | |
| 230 | - $file_paths = array( |
|
| 231 | - 1 => trailingslashit( get_stylesheet_directory() ) . $template_dir, |
|
| 232 | - 10 => trailingslashit( get_template_directory() ) . $template_dir, |
|
| 233 | - 100 => wpinv_get_templates_dir() |
|
| 234 | - ); |
|
| 230 | + $file_paths = array( |
|
| 231 | + 1 => trailingslashit( get_stylesheet_directory() ) . $template_dir, |
|
| 232 | + 10 => trailingslashit( get_template_directory() ) . $template_dir, |
|
| 233 | + 100 => wpinv_get_templates_dir() |
|
| 234 | + ); |
|
| 235 | 235 | |
| 236 | - $file_paths = apply_filters( 'wpinv_template_paths', $file_paths ); |
|
| 236 | + $file_paths = apply_filters( 'wpinv_template_paths', $file_paths ); |
|
| 237 | 237 | |
| 238 | - // sort the file paths based on priority |
|
| 239 | - ksort( $file_paths, SORT_NUMERIC ); |
|
| 238 | + // sort the file paths based on priority |
|
| 239 | + ksort( $file_paths, SORT_NUMERIC ); |
|
| 240 | 240 | |
| 241 | - return array_map( 'trailingslashit', $file_paths ); |
|
| 241 | + return array_map( 'trailingslashit', $file_paths ); |
|
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | function wpinv_checkout_meta_tags() { |
| 245 | 245 | |
| 246 | - $pages = array(); |
|
| 247 | - $pages[] = wpinv_get_option( 'success_page' ); |
|
| 248 | - $pages[] = wpinv_get_option( 'failure_page' ); |
|
| 249 | - $pages[] = wpinv_get_option( 'invoice_history_page' ); |
|
| 250 | - $pages[] = wpinv_get_option( 'invoice_subscription_page' ); |
|
| 246 | + $pages = array(); |
|
| 247 | + $pages[] = wpinv_get_option( 'success_page' ); |
|
| 248 | + $pages[] = wpinv_get_option( 'failure_page' ); |
|
| 249 | + $pages[] = wpinv_get_option( 'invoice_history_page' ); |
|
| 250 | + $pages[] = wpinv_get_option( 'invoice_subscription_page' ); |
|
| 251 | 251 | |
| 252 | - if( !wpinv_is_checkout() && !is_page( $pages ) ) { |
|
| 253 | - return; |
|
| 254 | - } |
|
| 252 | + if( !wpinv_is_checkout() && !is_page( $pages ) ) { |
|
| 253 | + return; |
|
| 254 | + } |
|
| 255 | 255 | |
| 256 | - echo '<meta name="robots" content="noindex,nofollow" />' . "\n"; |
|
| 256 | + echo '<meta name="robots" content="noindex,nofollow" />' . "\n"; |
|
| 257 | 257 | } |
| 258 | 258 | add_action( 'wp_head', 'wpinv_checkout_meta_tags' ); |
| 259 | 259 | |
| 260 | 260 | function wpinv_add_body_classes( $class ) { |
| 261 | - $classes = (array)$class; |
|
| 261 | + $classes = (array)$class; |
|
| 262 | 262 | |
| 263 | - if( wpinv_is_checkout() ) { |
|
| 264 | - $classes[] = 'wpinv-checkout'; |
|
| 265 | - $classes[] = 'wpinv-page'; |
|
| 266 | - } |
|
| 263 | + if( wpinv_is_checkout() ) { |
|
| 264 | + $classes[] = 'wpinv-checkout'; |
|
| 265 | + $classes[] = 'wpinv-page'; |
|
| 266 | + } |
|
| 267 | 267 | |
| 268 | - if( wpinv_is_success_page() ) { |
|
| 269 | - $classes[] = 'wpinv-success'; |
|
| 270 | - $classes[] = 'wpinv-page'; |
|
| 271 | - } |
|
| 268 | + if( wpinv_is_success_page() ) { |
|
| 269 | + $classes[] = 'wpinv-success'; |
|
| 270 | + $classes[] = 'wpinv-page'; |
|
| 271 | + } |
|
| 272 | 272 | |
| 273 | - if( wpinv_is_failed_transaction_page() ) { |
|
| 274 | - $classes[] = 'wpinv-failed-transaction'; |
|
| 275 | - $classes[] = 'wpinv-page'; |
|
| 276 | - } |
|
| 273 | + if( wpinv_is_failed_transaction_page() ) { |
|
| 274 | + $classes[] = 'wpinv-failed-transaction'; |
|
| 275 | + $classes[] = 'wpinv-page'; |
|
| 276 | + } |
|
| 277 | 277 | |
| 278 | - if( wpinv_is_invoice_history_page() ) { |
|
| 279 | - $classes[] = 'wpinv-history'; |
|
| 280 | - $classes[] = 'wpinv-page'; |
|
| 281 | - } |
|
| 278 | + if( wpinv_is_invoice_history_page() ) { |
|
| 279 | + $classes[] = 'wpinv-history'; |
|
| 280 | + $classes[] = 'wpinv-page'; |
|
| 281 | + } |
|
| 282 | 282 | |
| 283 | - if( wpinv_is_subscriptions_history_page() ) { |
|
| 284 | - $classes[] = 'wpinv-subscription'; |
|
| 285 | - $classes[] = 'wpinv-page'; |
|
| 286 | - } |
|
| 283 | + if( wpinv_is_subscriptions_history_page() ) { |
|
| 284 | + $classes[] = 'wpinv-subscription'; |
|
| 285 | + $classes[] = 'wpinv-page'; |
|
| 286 | + } |
|
| 287 | 287 | |
| 288 | - if( wpinv_is_test_mode() ) { |
|
| 289 | - $classes[] = 'wpinv-test-mode'; |
|
| 290 | - $classes[] = 'wpinv-page'; |
|
| 291 | - } |
|
| 288 | + if( wpinv_is_test_mode() ) { |
|
| 289 | + $classes[] = 'wpinv-test-mode'; |
|
| 290 | + $classes[] = 'wpinv-page'; |
|
| 291 | + } |
|
| 292 | 292 | |
| 293 | - return array_unique( $classes ); |
|
| 293 | + return array_unique( $classes ); |
|
| 294 | 294 | } |
| 295 | 295 | add_filter( 'body_class', 'wpinv_add_body_classes' ); |
| 296 | 296 | |
@@ -821,21 +821,21 @@ discard block |
||
| 821 | 821 | |
| 822 | 822 | $formatted_address = str_ireplace( array_keys( $replacements ), $replacements, $format ); |
| 823 | 823 | |
| 824 | - // Remove unavailable tags. |
|
| 824 | + // Remove unavailable tags. |
|
| 825 | 825 | $formatted_address = preg_replace( "/\{\{\w+\}\}/", '', $formatted_address ); |
| 826 | 826 | |
| 827 | 827 | // Clean up white space. |
| 828 | - $formatted_address = preg_replace( '/ +/', ' ', trim( $formatted_address ) ); |
|
| 828 | + $formatted_address = preg_replace( '/ +/', ' ', trim( $formatted_address ) ); |
|
| 829 | 829 | $formatted_address = preg_replace( '/\n\n+/', "\n", $formatted_address ); |
| 830 | 830 | |
| 831 | 831 | // Break newlines apart and remove empty lines/trim commas and white space. |
| 832 | - $formatted_address = array_filter( array_map( 'wpinv_trim_formatted_address_line', explode( "\n", $formatted_address ) ) ); |
|
| 832 | + $formatted_address = array_filter( array_map( 'wpinv_trim_formatted_address_line', explode( "\n", $formatted_address ) ) ); |
|
| 833 | 833 | |
| 834 | 834 | // Add html breaks. |
| 835 | - $formatted_address = implode( $separator, $formatted_address ); |
|
| 835 | + $formatted_address = implode( $separator, $formatted_address ); |
|
| 836 | 836 | |
| 837 | - // We're done! |
|
| 838 | - return $formatted_address; |
|
| 837 | + // We're done! |
|
| 838 | + return $formatted_address; |
|
| 839 | 839 | |
| 840 | 840 | } |
| 841 | 841 | |
@@ -881,7 +881,7 @@ discard block |
||
| 881 | 881 | function getpaid_display_invoice_subscriptions( $invoice ) { |
| 882 | 882 | |
| 883 | 883 | // Subscriptions. |
| 884 | - $subscriptions = getpaid_get_invoice_subscriptions( $invoice ); |
|
| 884 | + $subscriptions = getpaid_get_invoice_subscriptions( $invoice ); |
|
| 885 | 885 | |
| 886 | 886 | if ( empty( $subscriptions ) || ! $invoice->is_recurring() ) { |
| 887 | 887 | return; |
@@ -1089,7 +1089,7 @@ discard block |
||
| 1089 | 1089 | } |
| 1090 | 1090 | |
| 1091 | 1091 | function wpinv_empty_cart_message() { |
| 1092 | - return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' ); |
|
| 1092 | + return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' ); |
|
| 1093 | 1093 | } |
| 1094 | 1094 | |
| 1095 | 1095 | /** |
@@ -1281,10 +1281,10 @@ discard block |
||
| 1281 | 1281 | |
| 1282 | 1282 | if ( 0 == count( $form->get_items() ) ) { |
| 1283 | 1283 | echo aui()->alert( |
| 1284 | - array( |
|
| 1285 | - 'type' => 'warning', |
|
| 1286 | - 'content' => __( 'No published items found', 'invoicing' ), |
|
| 1287 | - ) |
|
| 1284 | + array( |
|
| 1285 | + 'type' => 'warning', |
|
| 1286 | + 'content' => __( 'No published items found', 'invoicing' ), |
|
| 1287 | + ) |
|
| 1288 | 1288 | ); |
| 1289 | 1289 | return; |
| 1290 | 1290 | } |
@@ -1302,21 +1302,21 @@ discard block |
||
| 1302 | 1302 | $invoice = wpinv_get_invoice( $invoice_id ); |
| 1303 | 1303 | |
| 1304 | 1304 | if ( empty( $invoice ) ) { |
| 1305 | - echo aui()->alert( |
|
| 1306 | - array( |
|
| 1307 | - 'type' => 'warning', |
|
| 1308 | - 'content' => __( 'Invoice not found', 'invoicing' ), |
|
| 1309 | - ) |
|
| 1305 | + echo aui()->alert( |
|
| 1306 | + array( |
|
| 1307 | + 'type' => 'warning', |
|
| 1308 | + 'content' => __( 'Invoice not found', 'invoicing' ), |
|
| 1309 | + ) |
|
| 1310 | 1310 | ); |
| 1311 | 1311 | return; |
| 1312 | 1312 | } |
| 1313 | 1313 | |
| 1314 | 1314 | if ( $invoice->is_paid() ) { |
| 1315 | - echo aui()->alert( |
|
| 1316 | - array( |
|
| 1317 | - 'type' => 'warning', |
|
| 1318 | - 'content' => __( 'Invoice has already been paid', 'invoicing' ), |
|
| 1319 | - ) |
|
| 1315 | + echo aui()->alert( |
|
| 1316 | + array( |
|
| 1317 | + 'type' => 'warning', |
|
| 1318 | + 'content' => __( 'Invoice has already been paid', 'invoicing' ), |
|
| 1319 | + ) |
|
| 1320 | 1320 | ); |
| 1321 | 1321 | return; |
| 1322 | 1322 | } |
@@ -1378,7 +1378,7 @@ discard block |
||
| 1378 | 1378 | return "<button class='btn btn-primary getpaid-payment-button' type='button' data-form='$form'>$label</button>"; |
| 1379 | 1379 | } |
| 1380 | 1380 | |
| 1381 | - if ( ! empty( $items ) ) { |
|
| 1381 | + if ( ! empty( $items ) ) { |
|
| 1382 | 1382 | $items = esc_attr( $items ); |
| 1383 | 1383 | return "<button class='btn btn-primary getpaid-payment-button' type='button' data-item='$items'>$label</button>"; |
| 1384 | 1384 | } |
@@ -6,7 +6,7 @@ discard block |
||
| 6 | 6 | if ( ! defined( 'ABSPATH' ) ) exit; |
| 7 | 7 | |
| 8 | 8 | if ( ! class_exists( 'WP_List_Table' ) ) { |
| 9 | - include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 9 | + include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 10 | 10 | } |
| 11 | 11 | |
| 12 | 12 | /** |
@@ -14,406 +14,406 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | class WPInv_Subscriptions_List_Table extends WP_List_Table { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * URL of this page |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - * @since 1.0.19 |
|
| 22 | - */ |
|
| 23 | - public $base_url; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * Query |
|
| 27 | - * |
|
| 28 | - * @var GetPaid_Subscriptions_Query |
|
| 29 | - * @since 1.0.19 |
|
| 30 | - */ |
|
| 31 | - public $query; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Total subscriptions |
|
| 35 | - * |
|
| 36 | - * @var string |
|
| 37 | - * @since 1.0.0 |
|
| 38 | - */ |
|
| 39 | - public $total_count; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * Current status subscriptions |
|
| 43 | - * |
|
| 44 | - * @var string |
|
| 45 | - * @since 1.0.0 |
|
| 46 | - */ |
|
| 47 | - public $current_total_count; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Status counts |
|
| 51 | - * |
|
| 52 | - * @var array |
|
| 53 | - * @since 1.0.19 |
|
| 54 | - */ |
|
| 55 | - public $status_counts; |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Number of results to show per page |
|
| 59 | - * |
|
| 60 | - * @var int |
|
| 61 | - * @since 1.0.0 |
|
| 62 | - */ |
|
| 63 | - public $per_page = 10; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Constructor function. |
|
| 67 | - */ |
|
| 68 | - public function __construct() { |
|
| 69 | - |
|
| 70 | - parent::__construct( |
|
| 71 | - array( |
|
| 72 | - 'singular' => 'subscription', |
|
| 73 | - 'plural' => 'subscriptions', |
|
| 74 | - ) |
|
| 75 | - ); |
|
| 76 | - |
|
| 77 | - $this->process_bulk_action(); |
|
| 78 | - |
|
| 79 | - $this->prepare_query(); |
|
| 80 | - |
|
| 81 | - $this->base_url = remove_query_arg( 'status' ); |
|
| 82 | - |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Prepares the display query |
|
| 87 | - */ |
|
| 88 | - public function prepare_query() { |
|
| 89 | - |
|
| 90 | - // Prepare query args. |
|
| 91 | - $query = array( |
|
| 92 | - 'number' => $this->per_page, |
|
| 93 | - 'paged' => $this->get_paged(), |
|
| 94 | - 'status' => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all', |
|
| 95 | - 'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id', |
|
| 96 | - 'order' => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC', |
|
| 97 | - ); |
|
| 98 | - |
|
| 99 | - // Prepare class properties. |
|
| 100 | - $this->query = new GetPaid_Subscriptions_Query( $query ); |
|
| 101 | - $this->total_count = $this->query->get_total(); |
|
| 102 | - $this->current_total_count = $this->query->get_total(); |
|
| 103 | - $this->items = $this->query->get_results(); |
|
| 104 | - $this->status_counts = getpaid_get_subscription_status_counts( $query ); |
|
| 105 | - |
|
| 106 | - if ( 'all' != $query['status'] ) { |
|
| 107 | - unset( $query['status'] ); |
|
| 108 | - $this->total_count = getpaid_get_subscriptions( $query, 'count' ); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Gets the list of views available on this table. |
|
| 115 | - * |
|
| 116 | - * The format is an associative array: |
|
| 117 | - * - `'id' => 'link'` |
|
| 118 | - * |
|
| 119 | - * @since 1.0.0 |
|
| 120 | - * |
|
| 121 | - * @return array |
|
| 122 | - */ |
|
| 123 | - public function get_views() { |
|
| 124 | - |
|
| 125 | - $current = isset( $_GET['status'] ) ? $_GET['status'] : 'all'; |
|
| 126 | - $views = array( |
|
| 127 | - |
|
| 128 | - 'all' => sprintf( |
|
| 129 | - '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 130 | - esc_url( add_query_arg( 'status', false, $this->base_url ) ), |
|
| 131 | - $current === 'all' ? ' class="current"' : '', |
|
| 132 | - __('All','invoicing' ), |
|
| 133 | - $this->total_count |
|
| 134 | - ) |
|
| 135 | - |
|
| 136 | - ); |
|
| 137 | - |
|
| 138 | - foreach ( array_filter( $this->status_counts ) as $status => $count ) { |
|
| 139 | - |
|
| 140 | - $views[ $status ] = sprintf( |
|
| 141 | - '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 142 | - esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ), |
|
| 143 | - $current === $status ? ' class="current"' : '', |
|
| 144 | - sanitize_text_field( getpaid_get_subscription_status_label( $status ) ), |
|
| 145 | - $count |
|
| 146 | - ); |
|
| 147 | - |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - return $views; |
|
| 151 | - |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Render most columns |
|
| 156 | - * |
|
| 157 | - * @access private |
|
| 158 | - * @since 1.0.0 |
|
| 159 | - * @return string |
|
| 160 | - */ |
|
| 161 | - public function column_default( $item, $column_name ) { |
|
| 162 | - return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name ); |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * This is how checkbox column renders. |
|
| 167 | - * |
|
| 168 | - * @param WPInv_Subscription $item |
|
| 169 | - * @return string |
|
| 170 | - */ |
|
| 171 | - public function column_cb( $item ) { |
|
| 172 | - return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) ); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * Status column |
|
| 177 | - * |
|
| 178 | - * @param WPInv_Subscription $item |
|
| 179 | - * @since 1.0.0 |
|
| 180 | - * @return string |
|
| 181 | - */ |
|
| 182 | - public function column_status( $item ) { |
|
| 183 | - return $item->get_status_label_html(); |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * Subscription column |
|
| 188 | - * |
|
| 189 | - * @param WPInv_Subscription $item |
|
| 190 | - * @since 1.0.0 |
|
| 191 | - * @return string |
|
| 192 | - */ |
|
| 193 | - public function column_subscription( $item ) { |
|
| 194 | - |
|
| 195 | - $username = __( '(Missing User)', 'invoicing' ); |
|
| 196 | - |
|
| 197 | - $user = get_userdata( $item->get_customer_id() ); |
|
| 198 | - if ( $user ) { |
|
| 199 | - |
|
| 200 | - $username = sprintf( |
|
| 201 | - '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 202 | - absint( $user->ID ), |
|
| 203 | - ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 204 | - ); |
|
| 205 | - |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name |
|
| 209 | - $column_content = sprintf( |
|
| 210 | - _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ), |
|
| 211 | - '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">', |
|
| 212 | - '<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>', |
|
| 213 | - $username |
|
| 214 | - ); |
|
| 215 | - |
|
| 216 | - $row_actions = array(); |
|
| 217 | - |
|
| 218 | - // View subscription. |
|
| 219 | - $view_url = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) )); |
|
| 220 | - $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>'; |
|
| 221 | - |
|
| 222 | - // View invoice. |
|
| 223 | - $invoice = get_post( $item->get_parent_invoice_id() ); |
|
| 224 | - |
|
| 225 | - if ( ! empty( $invoice ) ) { |
|
| 226 | - $invoice_url = get_edit_post_link( $invoice ); |
|
| 227 | - $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>'; |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - $delete_url = esc_url( |
|
| 231 | - wp_nonce_url( |
|
| 232 | - add_query_arg( |
|
| 233 | - array( |
|
| 234 | - 'getpaid-admin-action' => 'subscription_manual_delete', |
|
| 235 | - 'id' => $item->get_id(), |
|
| 236 | - ) |
|
| 237 | - ), |
|
| 238 | - 'getpaid-nonce', |
|
| 239 | - 'getpaid-nonce' |
|
| 240 | - ) |
|
| 241 | - ); |
|
| 242 | - $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>'; |
|
| 243 | - |
|
| 244 | - $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) ); |
|
| 245 | - |
|
| 246 | - return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions; |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - /** |
|
| 250 | - * Renewal date column |
|
| 251 | - * |
|
| 252 | - * @param WPInv_Subscription $item |
|
| 253 | - * @since 1.0.0 |
|
| 254 | - * @return string |
|
| 255 | - */ |
|
| 256 | - public function column_renewal_date( $item ) { |
|
| 257 | - return getpaid_format_date_value( $item->get_expiration() ); |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - /** |
|
| 261 | - * Start date column |
|
| 262 | - * |
|
| 263 | - * @param WPInv_Subscription $item |
|
| 264 | - * @since 1.0.0 |
|
| 265 | - * @return string |
|
| 266 | - */ |
|
| 267 | - public function column_start_date( $item ) { |
|
| 268 | - return getpaid_format_date_value( $item->get_date_created() ); |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - /** |
|
| 272 | - * Amount column |
|
| 273 | - * |
|
| 274 | - * @param WPInv_Subscription $item |
|
| 275 | - * @since 1.0.19 |
|
| 276 | - * @return string |
|
| 277 | - */ |
|
| 278 | - public static function column_amount( $item ) { |
|
| 279 | - $amount = getpaid_get_formatted_subscription_amount( $item ); |
|
| 280 | - return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>"; |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - /** |
|
| 284 | - * Billing Times column |
|
| 285 | - * |
|
| 286 | - * @param WPInv_Subscription $item |
|
| 287 | - * @since 1.0.0 |
|
| 288 | - * @return string |
|
| 289 | - */ |
|
| 290 | - public function column_renewals( $item ) { |
|
| 291 | - $max_bills = $item->get_bill_times(); |
|
| 292 | - return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 293 | - } |
|
| 294 | - |
|
| 295 | - /** |
|
| 296 | - * Product ID column |
|
| 297 | - * |
|
| 298 | - * @param WPInv_Subscription $item |
|
| 299 | - * @since 1.0.0 |
|
| 300 | - * @return string |
|
| 301 | - */ |
|
| 302 | - public function column_item( $item ) { |
|
| 303 | - $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() ); |
|
| 304 | - |
|
| 305 | - if ( empty( $subscription_group ) ) { |
|
| 306 | - return $this->generate_item_markup( $item->get_product_id() ); |
|
| 307 | - } |
|
| 308 | - |
|
| 309 | - $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 310 | - return implode( ' | ', $markup ); |
|
| 311 | - |
|
| 312 | - } |
|
| 313 | - |
|
| 314 | - /** |
|
| 315 | - * Generates the items markup. |
|
| 316 | - * |
|
| 317 | - * @param int $item_id |
|
| 318 | - * @since 1.0.0 |
|
| 319 | - * @return string |
|
| 320 | - */ |
|
| 321 | - public static function generate_item_markup( $item_id ) { |
|
| 322 | - $item = get_post( $item_id ); |
|
| 323 | - |
|
| 324 | - if ( ! empty( $item ) ) { |
|
| 325 | - $link = get_edit_post_link( $item ); |
|
| 326 | - $link = esc_url( $link ); |
|
| 327 | - $name = esc_html( get_the_title( $item ) ); |
|
| 328 | - return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name; |
|
| 329 | - } else { |
|
| 330 | - return sprintf( __( 'Item #%s', 'invoicing' ), $item_id ); |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - } |
|
| 334 | - |
|
| 335 | - /** |
|
| 336 | - * Retrieve the current page number |
|
| 337 | - * |
|
| 338 | - * @return int |
|
| 339 | - */ |
|
| 340 | - public function get_paged() { |
|
| 341 | - return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * Setup the final data for the table |
|
| 346 | - * |
|
| 347 | - */ |
|
| 348 | - public function prepare_items() { |
|
| 349 | - |
|
| 350 | - $columns = $this->get_columns(); |
|
| 351 | - $hidden = array(); |
|
| 352 | - $sortable = $this->get_sortable_columns(); |
|
| 353 | - |
|
| 354 | - $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 355 | - |
|
| 356 | - $this->set_pagination_args( |
|
| 357 | - array( |
|
| 358 | - 'total_items' => $this->current_total_count, |
|
| 359 | - 'per_page' => $this->per_page, |
|
| 360 | - 'total_pages' => ceil( $this->current_total_count / $this->per_page ) |
|
| 361 | - ) |
|
| 362 | - ); |
|
| 363 | - } |
|
| 364 | - |
|
| 365 | - /** |
|
| 366 | - * Table columns |
|
| 367 | - * |
|
| 368 | - * @return array |
|
| 369 | - */ |
|
| 370 | - public function get_columns(){ |
|
| 371 | - $columns = array( |
|
| 372 | - 'cb' => '<input type="checkbox" />', |
|
| 373 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 374 | - 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 375 | - 'renewal_date' => __( 'Next Payment', 'invoicing' ), |
|
| 376 | - 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 377 | - 'item' => __( 'Items', 'invoicing' ), |
|
| 378 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 379 | - ); |
|
| 380 | - |
|
| 381 | - return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns ); |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - /** |
|
| 385 | - * Sortable table columns. |
|
| 386 | - * |
|
| 387 | - * @return array |
|
| 388 | - */ |
|
| 389 | - public function get_sortable_columns() { |
|
| 390 | - $sortable = array( |
|
| 391 | - 'subscription' => array( 'id', true ), |
|
| 392 | - 'start_date' => array( 'created', true ), |
|
| 393 | - 'renewal_date' => array( 'expiration', true ), |
|
| 394 | - 'renewals' => array( 'bill_times', true ), |
|
| 395 | - 'item' => array( 'product_id', true ), |
|
| 396 | - 'status' => array( 'status', true ), |
|
| 397 | - ); |
|
| 398 | - |
|
| 399 | - return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable ); |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - /** |
|
| 403 | - * Whether the table has items to display or not |
|
| 404 | - * |
|
| 405 | - * @return bool |
|
| 406 | - */ |
|
| 407 | - public function has_items() { |
|
| 408 | - return ! empty( $this->current_total_count ); |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - /** |
|
| 412 | - * Processes bulk actions. |
|
| 413 | - * |
|
| 414 | - */ |
|
| 415 | - public function process_bulk_action() { |
|
| 416 | - |
|
| 417 | - } |
|
| 17 | + /** |
|
| 18 | + * URL of this page |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + * @since 1.0.19 |
|
| 22 | + */ |
|
| 23 | + public $base_url; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * Query |
|
| 27 | + * |
|
| 28 | + * @var GetPaid_Subscriptions_Query |
|
| 29 | + * @since 1.0.19 |
|
| 30 | + */ |
|
| 31 | + public $query; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Total subscriptions |
|
| 35 | + * |
|
| 36 | + * @var string |
|
| 37 | + * @since 1.0.0 |
|
| 38 | + */ |
|
| 39 | + public $total_count; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * Current status subscriptions |
|
| 43 | + * |
|
| 44 | + * @var string |
|
| 45 | + * @since 1.0.0 |
|
| 46 | + */ |
|
| 47 | + public $current_total_count; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Status counts |
|
| 51 | + * |
|
| 52 | + * @var array |
|
| 53 | + * @since 1.0.19 |
|
| 54 | + */ |
|
| 55 | + public $status_counts; |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Number of results to show per page |
|
| 59 | + * |
|
| 60 | + * @var int |
|
| 61 | + * @since 1.0.0 |
|
| 62 | + */ |
|
| 63 | + public $per_page = 10; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Constructor function. |
|
| 67 | + */ |
|
| 68 | + public function __construct() { |
|
| 69 | + |
|
| 70 | + parent::__construct( |
|
| 71 | + array( |
|
| 72 | + 'singular' => 'subscription', |
|
| 73 | + 'plural' => 'subscriptions', |
|
| 74 | + ) |
|
| 75 | + ); |
|
| 76 | + |
|
| 77 | + $this->process_bulk_action(); |
|
| 78 | + |
|
| 79 | + $this->prepare_query(); |
|
| 80 | + |
|
| 81 | + $this->base_url = remove_query_arg( 'status' ); |
|
| 82 | + |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Prepares the display query |
|
| 87 | + */ |
|
| 88 | + public function prepare_query() { |
|
| 89 | + |
|
| 90 | + // Prepare query args. |
|
| 91 | + $query = array( |
|
| 92 | + 'number' => $this->per_page, |
|
| 93 | + 'paged' => $this->get_paged(), |
|
| 94 | + 'status' => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all', |
|
| 95 | + 'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id', |
|
| 96 | + 'order' => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC', |
|
| 97 | + ); |
|
| 98 | + |
|
| 99 | + // Prepare class properties. |
|
| 100 | + $this->query = new GetPaid_Subscriptions_Query( $query ); |
|
| 101 | + $this->total_count = $this->query->get_total(); |
|
| 102 | + $this->current_total_count = $this->query->get_total(); |
|
| 103 | + $this->items = $this->query->get_results(); |
|
| 104 | + $this->status_counts = getpaid_get_subscription_status_counts( $query ); |
|
| 105 | + |
|
| 106 | + if ( 'all' != $query['status'] ) { |
|
| 107 | + unset( $query['status'] ); |
|
| 108 | + $this->total_count = getpaid_get_subscriptions( $query, 'count' ); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Gets the list of views available on this table. |
|
| 115 | + * |
|
| 116 | + * The format is an associative array: |
|
| 117 | + * - `'id' => 'link'` |
|
| 118 | + * |
|
| 119 | + * @since 1.0.0 |
|
| 120 | + * |
|
| 121 | + * @return array |
|
| 122 | + */ |
|
| 123 | + public function get_views() { |
|
| 124 | + |
|
| 125 | + $current = isset( $_GET['status'] ) ? $_GET['status'] : 'all'; |
|
| 126 | + $views = array( |
|
| 127 | + |
|
| 128 | + 'all' => sprintf( |
|
| 129 | + '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 130 | + esc_url( add_query_arg( 'status', false, $this->base_url ) ), |
|
| 131 | + $current === 'all' ? ' class="current"' : '', |
|
| 132 | + __('All','invoicing' ), |
|
| 133 | + $this->total_count |
|
| 134 | + ) |
|
| 135 | + |
|
| 136 | + ); |
|
| 137 | + |
|
| 138 | + foreach ( array_filter( $this->status_counts ) as $status => $count ) { |
|
| 139 | + |
|
| 140 | + $views[ $status ] = sprintf( |
|
| 141 | + '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 142 | + esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ), |
|
| 143 | + $current === $status ? ' class="current"' : '', |
|
| 144 | + sanitize_text_field( getpaid_get_subscription_status_label( $status ) ), |
|
| 145 | + $count |
|
| 146 | + ); |
|
| 147 | + |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + return $views; |
|
| 151 | + |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Render most columns |
|
| 156 | + * |
|
| 157 | + * @access private |
|
| 158 | + * @since 1.0.0 |
|
| 159 | + * @return string |
|
| 160 | + */ |
|
| 161 | + public function column_default( $item, $column_name ) { |
|
| 162 | + return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name ); |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * This is how checkbox column renders. |
|
| 167 | + * |
|
| 168 | + * @param WPInv_Subscription $item |
|
| 169 | + * @return string |
|
| 170 | + */ |
|
| 171 | + public function column_cb( $item ) { |
|
| 172 | + return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) ); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * Status column |
|
| 177 | + * |
|
| 178 | + * @param WPInv_Subscription $item |
|
| 179 | + * @since 1.0.0 |
|
| 180 | + * @return string |
|
| 181 | + */ |
|
| 182 | + public function column_status( $item ) { |
|
| 183 | + return $item->get_status_label_html(); |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * Subscription column |
|
| 188 | + * |
|
| 189 | + * @param WPInv_Subscription $item |
|
| 190 | + * @since 1.0.0 |
|
| 191 | + * @return string |
|
| 192 | + */ |
|
| 193 | + public function column_subscription( $item ) { |
|
| 194 | + |
|
| 195 | + $username = __( '(Missing User)', 'invoicing' ); |
|
| 196 | + |
|
| 197 | + $user = get_userdata( $item->get_customer_id() ); |
|
| 198 | + if ( $user ) { |
|
| 199 | + |
|
| 200 | + $username = sprintf( |
|
| 201 | + '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 202 | + absint( $user->ID ), |
|
| 203 | + ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 204 | + ); |
|
| 205 | + |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name |
|
| 209 | + $column_content = sprintf( |
|
| 210 | + _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ), |
|
| 211 | + '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">', |
|
| 212 | + '<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>', |
|
| 213 | + $username |
|
| 214 | + ); |
|
| 215 | + |
|
| 216 | + $row_actions = array(); |
|
| 217 | + |
|
| 218 | + // View subscription. |
|
| 219 | + $view_url = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) )); |
|
| 220 | + $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>'; |
|
| 221 | + |
|
| 222 | + // View invoice. |
|
| 223 | + $invoice = get_post( $item->get_parent_invoice_id() ); |
|
| 224 | + |
|
| 225 | + if ( ! empty( $invoice ) ) { |
|
| 226 | + $invoice_url = get_edit_post_link( $invoice ); |
|
| 227 | + $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>'; |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + $delete_url = esc_url( |
|
| 231 | + wp_nonce_url( |
|
| 232 | + add_query_arg( |
|
| 233 | + array( |
|
| 234 | + 'getpaid-admin-action' => 'subscription_manual_delete', |
|
| 235 | + 'id' => $item->get_id(), |
|
| 236 | + ) |
|
| 237 | + ), |
|
| 238 | + 'getpaid-nonce', |
|
| 239 | + 'getpaid-nonce' |
|
| 240 | + ) |
|
| 241 | + ); |
|
| 242 | + $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>'; |
|
| 243 | + |
|
| 244 | + $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) ); |
|
| 245 | + |
|
| 246 | + return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions; |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + /** |
|
| 250 | + * Renewal date column |
|
| 251 | + * |
|
| 252 | + * @param WPInv_Subscription $item |
|
| 253 | + * @since 1.0.0 |
|
| 254 | + * @return string |
|
| 255 | + */ |
|
| 256 | + public function column_renewal_date( $item ) { |
|
| 257 | + return getpaid_format_date_value( $item->get_expiration() ); |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + /** |
|
| 261 | + * Start date column |
|
| 262 | + * |
|
| 263 | + * @param WPInv_Subscription $item |
|
| 264 | + * @since 1.0.0 |
|
| 265 | + * @return string |
|
| 266 | + */ |
|
| 267 | + public function column_start_date( $item ) { |
|
| 268 | + return getpaid_format_date_value( $item->get_date_created() ); |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + /** |
|
| 272 | + * Amount column |
|
| 273 | + * |
|
| 274 | + * @param WPInv_Subscription $item |
|
| 275 | + * @since 1.0.19 |
|
| 276 | + * @return string |
|
| 277 | + */ |
|
| 278 | + public static function column_amount( $item ) { |
|
| 279 | + $amount = getpaid_get_formatted_subscription_amount( $item ); |
|
| 280 | + return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>"; |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + /** |
|
| 284 | + * Billing Times column |
|
| 285 | + * |
|
| 286 | + * @param WPInv_Subscription $item |
|
| 287 | + * @since 1.0.0 |
|
| 288 | + * @return string |
|
| 289 | + */ |
|
| 290 | + public function column_renewals( $item ) { |
|
| 291 | + $max_bills = $item->get_bill_times(); |
|
| 292 | + return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 293 | + } |
|
| 294 | + |
|
| 295 | + /** |
|
| 296 | + * Product ID column |
|
| 297 | + * |
|
| 298 | + * @param WPInv_Subscription $item |
|
| 299 | + * @since 1.0.0 |
|
| 300 | + * @return string |
|
| 301 | + */ |
|
| 302 | + public function column_item( $item ) { |
|
| 303 | + $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() ); |
|
| 304 | + |
|
| 305 | + if ( empty( $subscription_group ) ) { |
|
| 306 | + return $this->generate_item_markup( $item->get_product_id() ); |
|
| 307 | + } |
|
| 308 | + |
|
| 309 | + $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 310 | + return implode( ' | ', $markup ); |
|
| 311 | + |
|
| 312 | + } |
|
| 313 | + |
|
| 314 | + /** |
|
| 315 | + * Generates the items markup. |
|
| 316 | + * |
|
| 317 | + * @param int $item_id |
|
| 318 | + * @since 1.0.0 |
|
| 319 | + * @return string |
|
| 320 | + */ |
|
| 321 | + public static function generate_item_markup( $item_id ) { |
|
| 322 | + $item = get_post( $item_id ); |
|
| 323 | + |
|
| 324 | + if ( ! empty( $item ) ) { |
|
| 325 | + $link = get_edit_post_link( $item ); |
|
| 326 | + $link = esc_url( $link ); |
|
| 327 | + $name = esc_html( get_the_title( $item ) ); |
|
| 328 | + return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name; |
|
| 329 | + } else { |
|
| 330 | + return sprintf( __( 'Item #%s', 'invoicing' ), $item_id ); |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + } |
|
| 334 | + |
|
| 335 | + /** |
|
| 336 | + * Retrieve the current page number |
|
| 337 | + * |
|
| 338 | + * @return int |
|
| 339 | + */ |
|
| 340 | + public function get_paged() { |
|
| 341 | + return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * Setup the final data for the table |
|
| 346 | + * |
|
| 347 | + */ |
|
| 348 | + public function prepare_items() { |
|
| 349 | + |
|
| 350 | + $columns = $this->get_columns(); |
|
| 351 | + $hidden = array(); |
|
| 352 | + $sortable = $this->get_sortable_columns(); |
|
| 353 | + |
|
| 354 | + $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 355 | + |
|
| 356 | + $this->set_pagination_args( |
|
| 357 | + array( |
|
| 358 | + 'total_items' => $this->current_total_count, |
|
| 359 | + 'per_page' => $this->per_page, |
|
| 360 | + 'total_pages' => ceil( $this->current_total_count / $this->per_page ) |
|
| 361 | + ) |
|
| 362 | + ); |
|
| 363 | + } |
|
| 364 | + |
|
| 365 | + /** |
|
| 366 | + * Table columns |
|
| 367 | + * |
|
| 368 | + * @return array |
|
| 369 | + */ |
|
| 370 | + public function get_columns(){ |
|
| 371 | + $columns = array( |
|
| 372 | + 'cb' => '<input type="checkbox" />', |
|
| 373 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 374 | + 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 375 | + 'renewal_date' => __( 'Next Payment', 'invoicing' ), |
|
| 376 | + 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 377 | + 'item' => __( 'Items', 'invoicing' ), |
|
| 378 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 379 | + ); |
|
| 380 | + |
|
| 381 | + return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns ); |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + /** |
|
| 385 | + * Sortable table columns. |
|
| 386 | + * |
|
| 387 | + * @return array |
|
| 388 | + */ |
|
| 389 | + public function get_sortable_columns() { |
|
| 390 | + $sortable = array( |
|
| 391 | + 'subscription' => array( 'id', true ), |
|
| 392 | + 'start_date' => array( 'created', true ), |
|
| 393 | + 'renewal_date' => array( 'expiration', true ), |
|
| 394 | + 'renewals' => array( 'bill_times', true ), |
|
| 395 | + 'item' => array( 'product_id', true ), |
|
| 396 | + 'status' => array( 'status', true ), |
|
| 397 | + ); |
|
| 398 | + |
|
| 399 | + return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable ); |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + /** |
|
| 403 | + * Whether the table has items to display or not |
|
| 404 | + * |
|
| 405 | + * @return bool |
|
| 406 | + */ |
|
| 407 | + public function has_items() { |
|
| 408 | + return ! empty( $this->current_total_count ); |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + /** |
|
| 412 | + * Processes bulk actions. |
|
| 413 | + * |
|
| 414 | + */ |
|
| 415 | + public function process_bulk_action() { |
|
| 416 | + |
|
| 417 | + } |
|
| 418 | 418 | |
| 419 | 419 | } |
@@ -14,144 +14,144 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | class WPInv_Subscriptions_Widget extends WP_Super_Duper { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * Register the widget with WordPress. |
|
| 19 | - * |
|
| 20 | - */ |
|
| 21 | - public function __construct() { |
|
| 22 | - |
|
| 23 | - $options = array( |
|
| 24 | - 'textdomain' => 'invoicing', |
|
| 25 | - 'block-icon' => 'controls-repeat', |
|
| 26 | - 'block-category'=> 'widgets', |
|
| 27 | - 'block-keywords'=> "['invoicing','subscriptions', 'getpaid']", |
|
| 28 | - 'class_name' => __CLASS__, |
|
| 29 | - 'base_id' => 'wpinv_subscriptions', |
|
| 30 | - 'name' => __( 'GetPaid > Subscriptions', 'invoicing' ), |
|
| 31 | - 'widget_ops' => array( |
|
| 32 | - 'classname' => 'getpaid-subscriptions bsui', |
|
| 33 | - 'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ), |
|
| 34 | - ), |
|
| 35 | - 'arguments' => array( |
|
| 36 | - 'title' => array( |
|
| 37 | - 'title' => __( 'Widget title', 'invoicing' ), |
|
| 38 | - 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
| 39 | - 'type' => 'text', |
|
| 40 | - 'desc_tip' => true, |
|
| 41 | - 'default' => '', |
|
| 42 | - 'advanced' => false |
|
| 43 | - ), |
|
| 44 | - ) |
|
| 45 | - |
|
| 46 | - ); |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - parent::__construct( $options ); |
|
| 50 | - } |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Retrieves current user's subscriptions. |
|
| 54 | - * |
|
| 55 | - * @return GetPaid_Subscriptions_Query |
|
| 56 | - */ |
|
| 57 | - public function get_subscriptions() { |
|
| 58 | - |
|
| 59 | - // Prepare license args. |
|
| 60 | - $args = array( |
|
| 61 | - 'customer_in' => get_current_user_id(), |
|
| 62 | - 'paged' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
| 63 | - ); |
|
| 64 | - |
|
| 65 | - return new GetPaid_Subscriptions_Query( $args ); |
|
| 66 | - |
|
| 67 | - } |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * The Super block output function. |
|
| 71 | - * |
|
| 72 | - * @param array $args |
|
| 73 | - * @param array $widget_args |
|
| 74 | - * @param string $content |
|
| 75 | - * |
|
| 76 | - * @return mixed|string|bool |
|
| 77 | - */ |
|
| 78 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 79 | - |
|
| 80 | - // Ensure that the user is logged in. |
|
| 81 | - if ( ! is_user_logged_in() ) { |
|
| 82 | - |
|
| 83 | - return aui()->alert( |
|
| 84 | - array( |
|
| 85 | - 'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ), |
|
| 86 | - 'type' => 'error', |
|
| 87 | - ) |
|
| 88 | - ); |
|
| 89 | - |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - // Are we displaying a single subscription? |
|
| 93 | - if ( isset( $_GET['subscription'] ) ) { |
|
| 94 | - return $this->display_single_subscription( trim( $_GET['subscription'] ) ); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - // Retrieve the user's subscriptions. |
|
| 98 | - $subscriptions = $this->get_subscriptions(); |
|
| 99 | - |
|
| 100 | - // Start the output buffer. |
|
| 101 | - ob_start(); |
|
| 102 | - |
|
| 103 | - // Backwards compatibility. |
|
| 104 | - do_action( 'wpinv_before_user_subscriptions' ); |
|
| 105 | - |
|
| 106 | - // Display errors and notices. |
|
| 107 | - wpinv_print_errors(); |
|
| 108 | - |
|
| 109 | - do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions ); |
|
| 110 | - |
|
| 111 | - // Print the table header. |
|
| 112 | - $this->print_table_header(); |
|
| 113 | - |
|
| 114 | - // Print table body. |
|
| 115 | - $this->print_table_body( $subscriptions->get_results() ); |
|
| 116 | - |
|
| 117 | - // Print table footer. |
|
| 118 | - $this->print_table_footer(); |
|
| 119 | - |
|
| 120 | - // Print the navigation. |
|
| 121 | - $this->print_navigation( $subscriptions->get_total() ); |
|
| 122 | - |
|
| 123 | - // Backwards compatibility. |
|
| 124 | - do_action( 'wpinv_after_user_subscriptions' ); |
|
| 125 | - |
|
| 126 | - // Return the output. |
|
| 127 | - return ob_get_clean(); |
|
| 128 | - |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * Retrieves the subscription columns. |
|
| 133 | - * |
|
| 134 | - * @return array |
|
| 135 | - */ |
|
| 136 | - public function get_subscriptions_table_columns() { |
|
| 17 | + /** |
|
| 18 | + * Register the widget with WordPress. |
|
| 19 | + * |
|
| 20 | + */ |
|
| 21 | + public function __construct() { |
|
| 22 | + |
|
| 23 | + $options = array( |
|
| 24 | + 'textdomain' => 'invoicing', |
|
| 25 | + 'block-icon' => 'controls-repeat', |
|
| 26 | + 'block-category'=> 'widgets', |
|
| 27 | + 'block-keywords'=> "['invoicing','subscriptions', 'getpaid']", |
|
| 28 | + 'class_name' => __CLASS__, |
|
| 29 | + 'base_id' => 'wpinv_subscriptions', |
|
| 30 | + 'name' => __( 'GetPaid > Subscriptions', 'invoicing' ), |
|
| 31 | + 'widget_ops' => array( |
|
| 32 | + 'classname' => 'getpaid-subscriptions bsui', |
|
| 33 | + 'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ), |
|
| 34 | + ), |
|
| 35 | + 'arguments' => array( |
|
| 36 | + 'title' => array( |
|
| 37 | + 'title' => __( 'Widget title', 'invoicing' ), |
|
| 38 | + 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
| 39 | + 'type' => 'text', |
|
| 40 | + 'desc_tip' => true, |
|
| 41 | + 'default' => '', |
|
| 42 | + 'advanced' => false |
|
| 43 | + ), |
|
| 44 | + ) |
|
| 45 | + |
|
| 46 | + ); |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + parent::__construct( $options ); |
|
| 50 | + } |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Retrieves current user's subscriptions. |
|
| 54 | + * |
|
| 55 | + * @return GetPaid_Subscriptions_Query |
|
| 56 | + */ |
|
| 57 | + public function get_subscriptions() { |
|
| 58 | + |
|
| 59 | + // Prepare license args. |
|
| 60 | + $args = array( |
|
| 61 | + 'customer_in' => get_current_user_id(), |
|
| 62 | + 'paged' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
| 63 | + ); |
|
| 64 | + |
|
| 65 | + return new GetPaid_Subscriptions_Query( $args ); |
|
| 66 | + |
|
| 67 | + } |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * The Super block output function. |
|
| 71 | + * |
|
| 72 | + * @param array $args |
|
| 73 | + * @param array $widget_args |
|
| 74 | + * @param string $content |
|
| 75 | + * |
|
| 76 | + * @return mixed|string|bool |
|
| 77 | + */ |
|
| 78 | + public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 79 | + |
|
| 80 | + // Ensure that the user is logged in. |
|
| 81 | + if ( ! is_user_logged_in() ) { |
|
| 82 | + |
|
| 83 | + return aui()->alert( |
|
| 84 | + array( |
|
| 85 | + 'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ), |
|
| 86 | + 'type' => 'error', |
|
| 87 | + ) |
|
| 88 | + ); |
|
| 89 | + |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + // Are we displaying a single subscription? |
|
| 93 | + if ( isset( $_GET['subscription'] ) ) { |
|
| 94 | + return $this->display_single_subscription( trim( $_GET['subscription'] ) ); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + // Retrieve the user's subscriptions. |
|
| 98 | + $subscriptions = $this->get_subscriptions(); |
|
| 99 | + |
|
| 100 | + // Start the output buffer. |
|
| 101 | + ob_start(); |
|
| 102 | + |
|
| 103 | + // Backwards compatibility. |
|
| 104 | + do_action( 'wpinv_before_user_subscriptions' ); |
|
| 105 | + |
|
| 106 | + // Display errors and notices. |
|
| 107 | + wpinv_print_errors(); |
|
| 108 | + |
|
| 109 | + do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions ); |
|
| 110 | + |
|
| 111 | + // Print the table header. |
|
| 112 | + $this->print_table_header(); |
|
| 113 | + |
|
| 114 | + // Print table body. |
|
| 115 | + $this->print_table_body( $subscriptions->get_results() ); |
|
| 116 | + |
|
| 117 | + // Print table footer. |
|
| 118 | + $this->print_table_footer(); |
|
| 119 | + |
|
| 120 | + // Print the navigation. |
|
| 121 | + $this->print_navigation( $subscriptions->get_total() ); |
|
| 122 | + |
|
| 123 | + // Backwards compatibility. |
|
| 124 | + do_action( 'wpinv_after_user_subscriptions' ); |
|
| 125 | + |
|
| 126 | + // Return the output. |
|
| 127 | + return ob_get_clean(); |
|
| 128 | + |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * Retrieves the subscription columns. |
|
| 133 | + * |
|
| 134 | + * @return array |
|
| 135 | + */ |
|
| 136 | + public function get_subscriptions_table_columns() { |
|
| 137 | 137 | |
| 138 | - $columns = array( |
|
| 139 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 140 | - 'amount' => __( 'Amount', 'invoicing' ), |
|
| 141 | - 'renewal-date' => __( 'Next payment', 'invoicing' ), |
|
| 142 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 143 | - ); |
|
| 138 | + $columns = array( |
|
| 139 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 140 | + 'amount' => __( 'Amount', 'invoicing' ), |
|
| 141 | + 'renewal-date' => __( 'Next payment', 'invoicing' ), |
|
| 142 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 143 | + ); |
|
| 144 | 144 | |
| 145 | - return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns ); |
|
| 146 | - } |
|
| 145 | + return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns ); |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Displays the table header. |
|
| 150 | - * |
|
| 151 | - */ |
|
| 152 | - public function print_table_header() { |
|
| 148 | + /** |
|
| 149 | + * Displays the table header. |
|
| 150 | + * |
|
| 151 | + */ |
|
| 152 | + public function print_table_header() { |
|
| 153 | 153 | |
| 154 | - ?> |
|
| 154 | + ?> |
|
| 155 | 155 | |
| 156 | 156 | <table class="table table-bordered table-striped"> |
| 157 | 157 | |
@@ -167,121 +167,121 @@ discard block |
||
| 167 | 167 | |
| 168 | 168 | <?php |
| 169 | 169 | |
| 170 | - } |
|
| 170 | + } |
|
| 171 | 171 | |
| 172 | - /** |
|
| 173 | - * Displays the table body. |
|
| 174 | - * |
|
| 175 | - * @param WPInv_Subscription[] $subscriptions |
|
| 176 | - */ |
|
| 177 | - public function print_table_body( $subscriptions ) { |
|
| 172 | + /** |
|
| 173 | + * Displays the table body. |
|
| 174 | + * |
|
| 175 | + * @param WPInv_Subscription[] $subscriptions |
|
| 176 | + */ |
|
| 177 | + public function print_table_body( $subscriptions ) { |
|
| 178 | 178 | |
| 179 | - if ( empty( $subscriptions ) ) { |
|
| 180 | - $this->print_table_body_no_subscriptions(); |
|
| 181 | - } else { |
|
| 182 | - $this->print_table_body_subscriptions( $subscriptions ); |
|
| 183 | - } |
|
| 179 | + if ( empty( $subscriptions ) ) { |
|
| 180 | + $this->print_table_body_no_subscriptions(); |
|
| 181 | + } else { |
|
| 182 | + $this->print_table_body_subscriptions( $subscriptions ); |
|
| 183 | + } |
|
| 184 | 184 | |
| 185 | - } |
|
| 185 | + } |
|
| 186 | 186 | |
| 187 | - /** |
|
| 188 | - * Displays the table body if no subscriptions were found. |
|
| 189 | - * |
|
| 190 | - */ |
|
| 191 | - public function print_table_body_no_subscriptions() { |
|
| 187 | + /** |
|
| 188 | + * Displays the table body if no subscriptions were found. |
|
| 189 | + * |
|
| 190 | + */ |
|
| 191 | + public function print_table_body_no_subscriptions() { |
|
| 192 | 192 | |
| 193 | - ?> |
|
| 193 | + ?> |
|
| 194 | 194 | <tbody> |
| 195 | 195 | |
| 196 | 196 | <tr> |
| 197 | 197 | <td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>"> |
| 198 | 198 | |
| 199 | 199 | <?php |
| 200 | - echo aui()->alert( |
|
| 201 | - array( |
|
| 202 | - 'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ), |
|
| 203 | - 'type' => 'warning', |
|
| 204 | - ) |
|
| 205 | - ); |
|
| 206 | - ?> |
|
| 200 | + echo aui()->alert( |
|
| 201 | + array( |
|
| 202 | + 'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ), |
|
| 203 | + 'type' => 'warning', |
|
| 204 | + ) |
|
| 205 | + ); |
|
| 206 | + ?> |
|
| 207 | 207 | |
| 208 | 208 | </td> |
| 209 | 209 | </tr> |
| 210 | 210 | |
| 211 | 211 | </tbody> |
| 212 | 212 | <?php |
| 213 | - } |
|
| 213 | + } |
|
| 214 | 214 | |
| 215 | - /** |
|
| 216 | - * Displays the table body if subscriptions were found. |
|
| 217 | - * |
|
| 218 | - * @param WPInv_Subscription[] $subscriptions |
|
| 219 | - */ |
|
| 220 | - public function print_table_body_subscriptions( $subscriptions ) { |
|
| 215 | + /** |
|
| 216 | + * Displays the table body if subscriptions were found. |
|
| 217 | + * |
|
| 218 | + * @param WPInv_Subscription[] $subscriptions |
|
| 219 | + */ |
|
| 220 | + public function print_table_body_subscriptions( $subscriptions ) { |
|
| 221 | 221 | |
| 222 | - ?> |
|
| 222 | + ?> |
|
| 223 | 223 | <tbody> |
| 224 | 224 | |
| 225 | 225 | <?php foreach ( $subscriptions as $subscription ) : ?> |
| 226 | 226 | <tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>"> |
| 227 | 227 | <?php |
| 228 | - wpinv_get_template( |
|
| 229 | - 'subscriptions/subscriptions-table-row.php', |
|
| 230 | - array( |
|
| 231 | - 'subscription' => $subscription, |
|
| 232 | - 'widget' => $this |
|
| 233 | - ) |
|
| 234 | - ); |
|
| 235 | - ?> |
|
| 228 | + wpinv_get_template( |
|
| 229 | + 'subscriptions/subscriptions-table-row.php', |
|
| 230 | + array( |
|
| 231 | + 'subscription' => $subscription, |
|
| 232 | + 'widget' => $this |
|
| 233 | + ) |
|
| 234 | + ); |
|
| 235 | + ?> |
|
| 236 | 236 | </tr> |
| 237 | 237 | <?php endforeach; ?> |
| 238 | 238 | |
| 239 | 239 | </tbody> |
| 240 | 240 | <?php |
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Adds row actions to a column |
|
| 245 | - * |
|
| 246 | - * @param string $content column content |
|
| 247 | - * @param WPInv_Subscription $subscription |
|
| 248 | - * @since 1.0.0 |
|
| 249 | - * @return string |
|
| 250 | - */ |
|
| 251 | - public function add_row_actions( $content, $subscription ) { |
|
| 252 | - |
|
| 253 | - // Prepare row actions. |
|
| 254 | - $actions = array(); |
|
| 255 | - |
|
| 256 | - // View subscription action. |
|
| 257 | - $view_url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
| 258 | - $view_url = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) ); |
|
| 259 | - $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>'; |
|
| 260 | - |
|
| 261 | - // Filter the actions. |
|
| 262 | - $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription ); |
|
| 263 | - |
|
| 264 | - $sanitized = array(); |
|
| 265 | - foreach ( $actions as $key => $action ) { |
|
| 266 | - $key = sanitize_html_class( $key ); |
|
| 267 | - $action = wp_kses_post( $action ); |
|
| 268 | - $sanitized[] = "<span class='$key'>$action</span>"; |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - $row_actions = "<small class='form-text getpaid-subscription-item-actions'>"; |
|
| 272 | - $row_actions .= implode( ' | ', $sanitized ); |
|
| 273 | - $row_actions .= '</small>'; |
|
| 274 | - |
|
| 275 | - return $content . $row_actions; |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * Displays the table footer. |
|
| 280 | - * |
|
| 281 | - */ |
|
| 282 | - public function print_table_footer() { |
|
| 283 | - |
|
| 284 | - ?> |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Adds row actions to a column |
|
| 245 | + * |
|
| 246 | + * @param string $content column content |
|
| 247 | + * @param WPInv_Subscription $subscription |
|
| 248 | + * @since 1.0.0 |
|
| 249 | + * @return string |
|
| 250 | + */ |
|
| 251 | + public function add_row_actions( $content, $subscription ) { |
|
| 252 | + |
|
| 253 | + // Prepare row actions. |
|
| 254 | + $actions = array(); |
|
| 255 | + |
|
| 256 | + // View subscription action. |
|
| 257 | + $view_url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
| 258 | + $view_url = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) ); |
|
| 259 | + $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>'; |
|
| 260 | + |
|
| 261 | + // Filter the actions. |
|
| 262 | + $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription ); |
|
| 263 | + |
|
| 264 | + $sanitized = array(); |
|
| 265 | + foreach ( $actions as $key => $action ) { |
|
| 266 | + $key = sanitize_html_class( $key ); |
|
| 267 | + $action = wp_kses_post( $action ); |
|
| 268 | + $sanitized[] = "<span class='$key'>$action</span>"; |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + $row_actions = "<small class='form-text getpaid-subscription-item-actions'>"; |
|
| 272 | + $row_actions .= implode( ' | ', $sanitized ); |
|
| 273 | + $row_actions .= '</small>'; |
|
| 274 | + |
|
| 275 | + return $content . $row_actions; |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * Displays the table footer. |
|
| 280 | + * |
|
| 281 | + */ |
|
| 282 | + public function print_table_footer() { |
|
| 283 | + |
|
| 284 | + ?> |
|
| 285 | 285 | |
| 286 | 286 | <tfoot> |
| 287 | 287 | <tr> |
@@ -296,143 +296,143 @@ discard block |
||
| 296 | 296 | </table> |
| 297 | 297 | <?php |
| 298 | 298 | |
| 299 | - } |
|
| 299 | + } |
|
| 300 | 300 | |
| 301 | - /** |
|
| 302 | - * Displays the navigation. |
|
| 303 | - * |
|
| 304 | - * @param int $total |
|
| 305 | - */ |
|
| 306 | - public function print_navigation( $total ) { |
|
| 301 | + /** |
|
| 302 | + * Displays the navigation. |
|
| 303 | + * |
|
| 304 | + * @param int $total |
|
| 305 | + */ |
|
| 306 | + public function print_navigation( $total ) { |
|
| 307 | 307 | |
| 308 | - if ( $total < 1 ) { |
|
| 308 | + if ( $total < 1 ) { |
|
| 309 | 309 | |
| 310 | - // Out-of-bounds, run the query again without LIMIT for total count. |
|
| 311 | - $args = array( |
|
| 312 | - 'customer_in' => get_current_user_id(), |
|
| 313 | - 'fields' => 'id', |
|
| 314 | - ); |
|
| 310 | + // Out-of-bounds, run the query again without LIMIT for total count. |
|
| 311 | + $args = array( |
|
| 312 | + 'customer_in' => get_current_user_id(), |
|
| 313 | + 'fields' => 'id', |
|
| 314 | + ); |
|
| 315 | 315 | |
| 316 | - $count_query = new GetPaid_Subscriptions_Query( $args ); |
|
| 317 | - $total = $count_query->get_total(); |
|
| 318 | - } |
|
| 316 | + $count_query = new GetPaid_Subscriptions_Query( $args ); |
|
| 317 | + $total = $count_query->get_total(); |
|
| 318 | + } |
|
| 319 | 319 | |
| 320 | - // Abort if we do not have pages. |
|
| 321 | - if ( 2 > $total ) { |
|
| 322 | - return; |
|
| 323 | - } |
|
| 320 | + // Abort if we do not have pages. |
|
| 321 | + if ( 2 > $total ) { |
|
| 322 | + return; |
|
| 323 | + } |
|
| 324 | 324 | |
| 325 | - ?> |
|
| 325 | + ?> |
|
| 326 | 326 | |
| 327 | 327 | <div class="getpaid-subscriptions-pagination"> |
| 328 | 328 | <?php |
| 329 | - $big = 999999; |
|
| 330 | - |
|
| 331 | - echo getpaid_paginate_links( |
|
| 332 | - array( |
|
| 333 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 334 | - 'format' => '?paged=%#%', |
|
| 335 | - 'total' => (int) ceil( $total / 10 ), |
|
| 336 | - ) |
|
| 337 | - ); |
|
| 338 | - ?> |
|
| 329 | + $big = 999999; |
|
| 330 | + |
|
| 331 | + echo getpaid_paginate_links( |
|
| 332 | + array( |
|
| 333 | + 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 334 | + 'format' => '?paged=%#%', |
|
| 335 | + 'total' => (int) ceil( $total / 10 ), |
|
| 336 | + ) |
|
| 337 | + ); |
|
| 338 | + ?> |
|
| 339 | 339 | </div> |
| 340 | 340 | |
| 341 | 341 | <?php |
| 342 | - } |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * Returns a single subscription's columns. |
|
| 346 | - * |
|
| 347 | - * @param WPInv_Subscription $subscription |
|
| 348 | - * |
|
| 349 | - * @return array |
|
| 350 | - */ |
|
| 351 | - public function get_single_subscription_columns( $subscription ) { |
|
| 352 | - |
|
| 353 | - // Prepare subscription detail columns. |
|
| 354 | - $subscription_group = getpaid_get_invoice_subscription_group( $subscription->get_parent_invoice_id(), $subscription->get_id() ); |
|
| 355 | - $items_count = empty( $subscription_group ) ? 1 : count( $subscription_group['items'] ); |
|
| 356 | - $fields = apply_filters( |
|
| 357 | - 'getpaid_single_subscription_details_fields', |
|
| 358 | - array( |
|
| 359 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 360 | - 'initial_amount' => __( 'Initial amount', 'invoicing' ), |
|
| 361 | - 'recurring_amount' => __( 'Recurring amount', 'invoicing' ), |
|
| 362 | - 'start_date' => __( 'Start date', 'invoicing' ), |
|
| 363 | - 'expiry_date' => __( 'Next payment', 'invoicing' ), |
|
| 364 | - 'payments' => __( 'Payments', 'invoicing' ), |
|
| 365 | - 'item' => _n( 'Item', 'Items', $items_count, 'invoicing' ), |
|
| 366 | - ), |
|
| 367 | - $subscription |
|
| 368 | - ); |
|
| 369 | - |
|
| 370 | - if ( isset( $fields['expiry_date'] ) ) { |
|
| 371 | - |
|
| 372 | - if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) { |
|
| 373 | - $fields['expiry_date'] = __( 'End date', 'invoicing' ); |
|
| 374 | - } |
|
| 375 | - |
|
| 376 | - if ( 'pending' == $subscription->get_status() ) { |
|
| 377 | - unset( $fields['expiry_date'] ); |
|
| 378 | - } |
|
| 379 | - |
|
| 380 | - } |
|
| 381 | - |
|
| 382 | - if ( isset( $fields['start_date'] ) && 'pending' == $subscription->get_status() ) { |
|
| 383 | - unset( $fields['start_date'] ); |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) { |
|
| 387 | - unset( $fields['initial_amount'] ); |
|
| 388 | - } |
|
| 389 | - |
|
| 390 | - return $fields; |
|
| 391 | - } |
|
| 392 | - |
|
| 393 | - /** |
|
| 394 | - * Displays a single subscription. |
|
| 395 | - * |
|
| 396 | - * @param string $subscription |
|
| 397 | - * |
|
| 398 | - * @return string |
|
| 399 | - */ |
|
| 400 | - public function display_single_subscription( $subscription ) { |
|
| 401 | - |
|
| 402 | - // Fetch the subscription. |
|
| 403 | - $subscription = new WPInv_Subscription( (int) $subscription ); |
|
| 404 | - |
|
| 405 | - if ( ! $subscription->exists() ) { |
|
| 406 | - |
|
| 407 | - return aui()->alert( |
|
| 408 | - array( |
|
| 409 | - 'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ), |
|
| 410 | - 'type' => 'error', |
|
| 411 | - ) |
|
| 412 | - ); |
|
| 413 | - |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - // Ensure that the user owns this subscription key. |
|
| 417 | - if ( get_current_user_id() != $subscription->get_customer_id() && ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 418 | - |
|
| 419 | - return aui()->alert( |
|
| 420 | - array( |
|
| 421 | - 'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ), |
|
| 422 | - 'type' => 'error', |
|
| 423 | - ) |
|
| 424 | - ); |
|
| 425 | - |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - return wpinv_get_template_html( |
|
| 429 | - 'subscriptions/subscription-details.php', |
|
| 430 | - array( |
|
| 431 | - 'subscription' => $subscription, |
|
| 432 | - 'widget' => $this |
|
| 433 | - ) |
|
| 434 | - ); |
|
| 435 | - |
|
| 436 | - } |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * Returns a single subscription's columns. |
|
| 346 | + * |
|
| 347 | + * @param WPInv_Subscription $subscription |
|
| 348 | + * |
|
| 349 | + * @return array |
|
| 350 | + */ |
|
| 351 | + public function get_single_subscription_columns( $subscription ) { |
|
| 352 | + |
|
| 353 | + // Prepare subscription detail columns. |
|
| 354 | + $subscription_group = getpaid_get_invoice_subscription_group( $subscription->get_parent_invoice_id(), $subscription->get_id() ); |
|
| 355 | + $items_count = empty( $subscription_group ) ? 1 : count( $subscription_group['items'] ); |
|
| 356 | + $fields = apply_filters( |
|
| 357 | + 'getpaid_single_subscription_details_fields', |
|
| 358 | + array( |
|
| 359 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 360 | + 'initial_amount' => __( 'Initial amount', 'invoicing' ), |
|
| 361 | + 'recurring_amount' => __( 'Recurring amount', 'invoicing' ), |
|
| 362 | + 'start_date' => __( 'Start date', 'invoicing' ), |
|
| 363 | + 'expiry_date' => __( 'Next payment', 'invoicing' ), |
|
| 364 | + 'payments' => __( 'Payments', 'invoicing' ), |
|
| 365 | + 'item' => _n( 'Item', 'Items', $items_count, 'invoicing' ), |
|
| 366 | + ), |
|
| 367 | + $subscription |
|
| 368 | + ); |
|
| 369 | + |
|
| 370 | + if ( isset( $fields['expiry_date'] ) ) { |
|
| 371 | + |
|
| 372 | + if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) { |
|
| 373 | + $fields['expiry_date'] = __( 'End date', 'invoicing' ); |
|
| 374 | + } |
|
| 375 | + |
|
| 376 | + if ( 'pending' == $subscription->get_status() ) { |
|
| 377 | + unset( $fields['expiry_date'] ); |
|
| 378 | + } |
|
| 379 | + |
|
| 380 | + } |
|
| 381 | + |
|
| 382 | + if ( isset( $fields['start_date'] ) && 'pending' == $subscription->get_status() ) { |
|
| 383 | + unset( $fields['start_date'] ); |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) { |
|
| 387 | + unset( $fields['initial_amount'] ); |
|
| 388 | + } |
|
| 389 | + |
|
| 390 | + return $fields; |
|
| 391 | + } |
|
| 392 | + |
|
| 393 | + /** |
|
| 394 | + * Displays a single subscription. |
|
| 395 | + * |
|
| 396 | + * @param string $subscription |
|
| 397 | + * |
|
| 398 | + * @return string |
|
| 399 | + */ |
|
| 400 | + public function display_single_subscription( $subscription ) { |
|
| 401 | + |
|
| 402 | + // Fetch the subscription. |
|
| 403 | + $subscription = new WPInv_Subscription( (int) $subscription ); |
|
| 404 | + |
|
| 405 | + if ( ! $subscription->exists() ) { |
|
| 406 | + |
|
| 407 | + return aui()->alert( |
|
| 408 | + array( |
|
| 409 | + 'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ), |
|
| 410 | + 'type' => 'error', |
|
| 411 | + ) |
|
| 412 | + ); |
|
| 413 | + |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + // Ensure that the user owns this subscription key. |
|
| 417 | + if ( get_current_user_id() != $subscription->get_customer_id() && ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 418 | + |
|
| 419 | + return aui()->alert( |
|
| 420 | + array( |
|
| 421 | + 'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ), |
|
| 422 | + 'type' => 'error', |
|
| 423 | + ) |
|
| 424 | + ); |
|
| 425 | + |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + return wpinv_get_template_html( |
|
| 429 | + 'subscriptions/subscription-details.php', |
|
| 430 | + array( |
|
| 431 | + 'subscription' => $subscription, |
|
| 432 | + 'widget' => $this |
|
| 433 | + ) |
|
| 434 | + ); |
|
| 435 | + |
|
| 436 | + } |
|
| 437 | 437 | |
| 438 | 438 | } |
@@ -46,64 +46,64 @@ discard block |
||
| 46 | 46 | <td style="width: 65%"> |
| 47 | 47 | <?php |
| 48 | 48 | |
| 49 | - switch ( $key ) { |
|
| 49 | + switch ( $key ) { |
|
| 50 | 50 | |
| 51 | - case 'status': |
|
| 52 | - echo sanitize_text_field( $subscription->get_status_label() ); |
|
| 53 | - break; |
|
| 51 | + case 'status': |
|
| 52 | + echo sanitize_text_field( $subscription->get_status_label() ); |
|
| 53 | + break; |
|
| 54 | 54 | |
| 55 | - case 'start_date': |
|
| 56 | - echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) ); |
|
| 57 | - break; |
|
| 55 | + case 'start_date': |
|
| 56 | + echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) ); |
|
| 57 | + break; |
|
| 58 | 58 | |
| 59 | - case 'expiry_date': |
|
| 60 | - echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) ); |
|
| 61 | - break; |
|
| 59 | + case 'expiry_date': |
|
| 60 | + echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) ); |
|
| 61 | + break; |
|
| 62 | 62 | |
| 63 | - case 'initial_amount': |
|
| 64 | - echo wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 63 | + case 'initial_amount': |
|
| 64 | + echo wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 65 | 65 | |
| 66 | - if ( $subscription->has_trial_period() ) { |
|
| 66 | + if ( $subscription->has_trial_period() ) { |
|
| 67 | 67 | |
| 68 | - echo "<small class='text-muted'> "; |
|
| 69 | - printf( |
|
| 70 | - _x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ), |
|
| 71 | - sanitize_text_field( $subscription->get_trial_period() ) |
|
| 72 | - ); |
|
| 73 | - echo '</small>'; |
|
| 68 | + echo "<small class='text-muted'> "; |
|
| 69 | + printf( |
|
| 70 | + _x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ), |
|
| 71 | + sanitize_text_field( $subscription->get_trial_period() ) |
|
| 72 | + ); |
|
| 73 | + echo '</small>'; |
|
| 74 | 74 | |
| 75 | - } |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - break; |
|
| 77 | + break; |
|
| 78 | 78 | |
| 79 | - case 'recurring_amount': |
|
| 80 | - $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
| 81 | - $amount = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 82 | - echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" ); |
|
| 83 | - break; |
|
| 79 | + case 'recurring_amount': |
|
| 80 | + $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
| 81 | + $amount = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 82 | + echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" ); |
|
| 83 | + break; |
|
| 84 | 84 | |
| 85 | - case 'item': |
|
| 85 | + case 'item': |
|
| 86 | 86 | |
| 87 | - if ( empty( $subscription_group ) ) { |
|
| 88 | - echo WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() ); |
|
| 89 | - } else { |
|
| 90 | - $markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 91 | - echo implode( ' | ', $markup ); |
|
| 92 | - } |
|
| 87 | + if ( empty( $subscription_group ) ) { |
|
| 88 | + echo WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() ); |
|
| 89 | + } else { |
|
| 90 | + $markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 91 | + echo implode( ' | ', $markup ); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - break; |
|
| 94 | + break; |
|
| 95 | 95 | |
| 96 | - case 'payments': |
|
| 96 | + case 'payments': |
|
| 97 | 97 | |
| 98 | - $max_activations = (int) $subscription->get_bill_times(); |
|
| 99 | - echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "∞" : $max_activations ); |
|
| 98 | + $max_activations = (int) $subscription->get_bill_times(); |
|
| 99 | + echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "∞" : $max_activations ); |
|
| 100 | 100 | |
| 101 | - break; |
|
| 101 | + break; |
|
| 102 | 102 | |
| 103 | - } |
|
| 104 | - do_action( "getpaid_render_single_subscription_column_$key", $subscription ); |
|
| 103 | + } |
|
| 104 | + do_action( "getpaid_render_single_subscription_column_$key", $subscription ); |
|
| 105 | 105 | |
| 106 | - ?> |
|
| 106 | + ?> |
|
| 107 | 107 | </td> |
| 108 | 108 | |
| 109 | 109 | </tr> |
@@ -130,17 +130,17 @@ discard block |
||
| 130 | 130 | <span class="form-text"> |
| 131 | 131 | |
| 132 | 132 | <?php |
| 133 | - if ( $subscription->can_cancel() ) { |
|
| 134 | - printf( |
|
| 135 | - '<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a> ', |
|
| 136 | - esc_url( $subscription->get_cancel_url() ), |
|
| 137 | - esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ), |
|
| 138 | - __( 'Cancel Subscription', 'invoicing' ) |
|
| 139 | - ); |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - do_action( 'getpaid-single-subscription-page-actions', $subscription ); |
|
| 143 | - ?> |
|
| 133 | + if ( $subscription->can_cancel() ) { |
|
| 134 | + printf( |
|
| 135 | + '<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a> ', |
|
| 136 | + esc_url( $subscription->get_cancel_url() ), |
|
| 137 | + esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ), |
|
| 138 | + __( 'Cancel Subscription', 'invoicing' ) |
|
| 139 | + ); |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + do_action( 'getpaid-single-subscription-page-actions', $subscription ); |
|
| 143 | + ?> |
|
| 144 | 144 | |
| 145 | 145 | <a href="<?php echo esc_url( getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) ); ?>" class="btn btn-secondary btn-sm"><?php _e( 'Go Back', 'invoicing' ); ?></a> |
| 146 | 146 | </span> |
@@ -12,8 +12,8 @@ discard block |
||
| 12 | 12 | class WPInv_Subscriptions { |
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | - * Class constructor. |
|
| 16 | - */ |
|
| 15 | + * Class constructor. |
|
| 16 | + */ |
|
| 17 | 17 | public function __construct(){ |
| 18 | 18 | |
| 19 | 19 | // Fire gateway specific hooks when a subscription changes. |
@@ -89,12 +89,12 @@ discard block |
||
| 89 | 89 | } |
| 90 | 90 | |
| 91 | 91 | /** |
| 92 | - * Processes subscription status changes. |
|
| 92 | + * Processes subscription status changes. |
|
| 93 | 93 | * |
| 94 | 94 | * @param WPInv_Subscription $subscription |
| 95 | 95 | * @param string $from |
| 96 | 96 | * @param string $to |
| 97 | - */ |
|
| 97 | + */ |
|
| 98 | 98 | public function process_subscription_status_change( $subscription, $from, $to ) { |
| 99 | 99 | |
| 100 | 100 | $gateway = $subscription->get_gateway(); |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | /** |
@@ -10,198 +10,198 @@ discard block |
||
| 10 | 10 | class GetPaid_Payment_Form_Submission { |
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | - * Submission ID |
|
| 14 | - * |
|
| 15 | - * @var string |
|
| 16 | - */ |
|
| 17 | - public $id = null; |
|
| 18 | - |
|
| 19 | - /** |
|
| 20 | - * The raw submission data. |
|
| 21 | - * |
|
| 22 | - * @var array |
|
| 23 | - */ |
|
| 24 | - protected $data = null; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Submission totals |
|
| 28 | - * |
|
| 29 | - * @var array |
|
| 30 | - */ |
|
| 31 | - protected $totals = array( |
|
| 32 | - |
|
| 33 | - 'subtotal' => array( |
|
| 34 | - 'initial' => 0, |
|
| 35 | - 'recurring' => 0, |
|
| 36 | - ), |
|
| 37 | - |
|
| 38 | - 'discount' => array( |
|
| 39 | - 'initial' => 0, |
|
| 40 | - 'recurring' => 0, |
|
| 41 | - ), |
|
| 42 | - |
|
| 43 | - 'fees' => array( |
|
| 44 | - 'initial' => 0, |
|
| 45 | - 'recurring' => 0, |
|
| 46 | - ), |
|
| 47 | - |
|
| 48 | - 'taxes' => array( |
|
| 49 | - 'initial' => 0, |
|
| 50 | - 'recurring' => 0, |
|
| 51 | - ), |
|
| 52 | - |
|
| 53 | - ); |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * Sets the associated payment form. |
|
| 57 | - * |
|
| 58 | - * @var GetPaid_Payment_Form |
|
| 59 | - */ |
|
| 13 | + * Submission ID |
|
| 14 | + * |
|
| 15 | + * @var string |
|
| 16 | + */ |
|
| 17 | + public $id = null; |
|
| 18 | + |
|
| 19 | + /** |
|
| 20 | + * The raw submission data. |
|
| 21 | + * |
|
| 22 | + * @var array |
|
| 23 | + */ |
|
| 24 | + protected $data = null; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Submission totals |
|
| 28 | + * |
|
| 29 | + * @var array |
|
| 30 | + */ |
|
| 31 | + protected $totals = array( |
|
| 32 | + |
|
| 33 | + 'subtotal' => array( |
|
| 34 | + 'initial' => 0, |
|
| 35 | + 'recurring' => 0, |
|
| 36 | + ), |
|
| 37 | + |
|
| 38 | + 'discount' => array( |
|
| 39 | + 'initial' => 0, |
|
| 40 | + 'recurring' => 0, |
|
| 41 | + ), |
|
| 42 | + |
|
| 43 | + 'fees' => array( |
|
| 44 | + 'initial' => 0, |
|
| 45 | + 'recurring' => 0, |
|
| 46 | + ), |
|
| 47 | + |
|
| 48 | + 'taxes' => array( |
|
| 49 | + 'initial' => 0, |
|
| 50 | + 'recurring' => 0, |
|
| 51 | + ), |
|
| 52 | + |
|
| 53 | + ); |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * Sets the associated payment form. |
|
| 57 | + * |
|
| 58 | + * @var GetPaid_Payment_Form |
|
| 59 | + */ |
|
| 60 | 60 | protected $payment_form = null; |
| 61 | 61 | |
| 62 | 62 | /** |
| 63 | - * The country for the submission. |
|
| 64 | - * |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 67 | - public $country = null; |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * The state for the submission. |
|
| 71 | - * |
|
| 72 | - * @since 1.0.19 |
|
| 73 | - * @var string |
|
| 74 | - */ |
|
| 75 | - public $state = null; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * The invoice associated with the submission. |
|
| 79 | - * |
|
| 80 | - * @var WPInv_Invoice |
|
| 81 | - */ |
|
| 82 | - protected $invoice = null; |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * The recurring item for the submission. |
|
| 86 | - * |
|
| 87 | - * @var int |
|
| 88 | - */ |
|
| 89 | - public $has_recurring = 0; |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * An array of fees for the submission. |
|
| 93 | - * |
|
| 94 | - * @var array |
|
| 95 | - */ |
|
| 96 | - protected $fees = array(); |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * An array of discounts for the submission. |
|
| 100 | - * |
|
| 101 | - * @var array |
|
| 102 | - */ |
|
| 103 | - protected $discounts = array(); |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * An array of taxes for the submission. |
|
| 107 | - * |
|
| 108 | - * @var array |
|
| 109 | - */ |
|
| 110 | - protected $taxes = array(); |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * An array of items for the submission. |
|
| 114 | - * |
|
| 115 | - * @var GetPaid_Form_Item[] |
|
| 116 | - */ |
|
| 117 | - protected $items = array(); |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * The last error. |
|
| 121 | - * |
|
| 122 | - * @var string |
|
| 123 | - */ |
|
| 124 | - public $last_error = null; |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * The last error code. |
|
| 128 | - * |
|
| 129 | - * @var string |
|
| 130 | - */ |
|
| 131 | - public $last_error_code = null; |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Class constructor. |
|
| 135 | - * |
|
| 136 | - */ |
|
| 137 | - public function __construct() { |
|
| 138 | - |
|
| 139 | - // Set the state and country to the default state and country. |
|
| 140 | - $this->country = wpinv_default_billing_country(); |
|
| 141 | - $this->state = wpinv_get_default_state(); |
|
| 142 | - |
|
| 143 | - // Do we have an actual submission? |
|
| 144 | - if ( isset( $_POST['getpaid_payment_form_submission'] ) ) { |
|
| 145 | - $this->load_data( $_POST ); |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * Loads submission data. |
|
| 152 | - * |
|
| 153 | - * @param array $data |
|
| 154 | - */ |
|
| 155 | - public function load_data( $data ) { |
|
| 156 | - |
|
| 157 | - // Remove slashes from the submitted data... |
|
| 158 | - $data = wp_unslash( $data ); |
|
| 159 | - |
|
| 160 | - // Allow plugins to filter the data. |
|
| 161 | - $data = apply_filters( 'getpaid_submission_data', $data, $this ); |
|
| 162 | - |
|
| 163 | - // Cache it... |
|
| 164 | - $this->data = $data; |
|
| 165 | - |
|
| 166 | - // Then generate a unique id from the data. |
|
| 167 | - $this->id = md5( wp_json_encode( $data ) ); |
|
| 168 | - |
|
| 169 | - // Finally, process the submission. |
|
| 170 | - try { |
|
| 171 | - |
|
| 172 | - // Each process is passed an instance of the class (with reference) |
|
| 173 | - // and should throw an Exception whenever it encounters one. |
|
| 174 | - $processors = apply_filters( |
|
| 175 | - 'getpaid_payment_form_submission_processors', |
|
| 176 | - array( |
|
| 177 | - array( $this, 'process_payment_form' ), |
|
| 178 | - array( $this, 'process_invoice' ), |
|
| 179 | - array( $this, 'process_fees' ), |
|
| 180 | - array( $this, 'process_items' ), |
|
| 181 | - array( $this, 'process_discount' ), |
|
| 182 | - array( $this, 'process_taxes' ), |
|
| 183 | - ), |
|
| 184 | - $this |
|
| 185 | - ); |
|
| 186 | - |
|
| 187 | - foreach ( $processors as $processor ) { |
|
| 188 | - call_user_func_array( $processor, array( &$this ) ); |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - } catch( GetPaid_Payment_Exception $e ) { |
|
| 192 | - $this->last_error = $e->getMessage(); |
|
| 193 | - $this->last_error_code = $e->getErrorCode(); |
|
| 194 | - } catch ( Exception $e ) { |
|
| 195 | - $this->last_error = $e->getMessage(); |
|
| 196 | - $this->last_error_code = $e->getCode(); |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - // Fired when we are done processing a submission. |
|
| 200 | - do_action_ref_array( 'getpaid_process_submission', array( &$this ) ); |
|
| 201 | - |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - /* |
|
| 63 | + * The country for the submission. |
|
| 64 | + * |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | + public $country = null; |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * The state for the submission. |
|
| 71 | + * |
|
| 72 | + * @since 1.0.19 |
|
| 73 | + * @var string |
|
| 74 | + */ |
|
| 75 | + public $state = null; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * The invoice associated with the submission. |
|
| 79 | + * |
|
| 80 | + * @var WPInv_Invoice |
|
| 81 | + */ |
|
| 82 | + protected $invoice = null; |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * The recurring item for the submission. |
|
| 86 | + * |
|
| 87 | + * @var int |
|
| 88 | + */ |
|
| 89 | + public $has_recurring = 0; |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * An array of fees for the submission. |
|
| 93 | + * |
|
| 94 | + * @var array |
|
| 95 | + */ |
|
| 96 | + protected $fees = array(); |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * An array of discounts for the submission. |
|
| 100 | + * |
|
| 101 | + * @var array |
|
| 102 | + */ |
|
| 103 | + protected $discounts = array(); |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * An array of taxes for the submission. |
|
| 107 | + * |
|
| 108 | + * @var array |
|
| 109 | + */ |
|
| 110 | + protected $taxes = array(); |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * An array of items for the submission. |
|
| 114 | + * |
|
| 115 | + * @var GetPaid_Form_Item[] |
|
| 116 | + */ |
|
| 117 | + protected $items = array(); |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * The last error. |
|
| 121 | + * |
|
| 122 | + * @var string |
|
| 123 | + */ |
|
| 124 | + public $last_error = null; |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * The last error code. |
|
| 128 | + * |
|
| 129 | + * @var string |
|
| 130 | + */ |
|
| 131 | + public $last_error_code = null; |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Class constructor. |
|
| 135 | + * |
|
| 136 | + */ |
|
| 137 | + public function __construct() { |
|
| 138 | + |
|
| 139 | + // Set the state and country to the default state and country. |
|
| 140 | + $this->country = wpinv_default_billing_country(); |
|
| 141 | + $this->state = wpinv_get_default_state(); |
|
| 142 | + |
|
| 143 | + // Do we have an actual submission? |
|
| 144 | + if ( isset( $_POST['getpaid_payment_form_submission'] ) ) { |
|
| 145 | + $this->load_data( $_POST ); |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * Loads submission data. |
|
| 152 | + * |
|
| 153 | + * @param array $data |
|
| 154 | + */ |
|
| 155 | + public function load_data( $data ) { |
|
| 156 | + |
|
| 157 | + // Remove slashes from the submitted data... |
|
| 158 | + $data = wp_unslash( $data ); |
|
| 159 | + |
|
| 160 | + // Allow plugins to filter the data. |
|
| 161 | + $data = apply_filters( 'getpaid_submission_data', $data, $this ); |
|
| 162 | + |
|
| 163 | + // Cache it... |
|
| 164 | + $this->data = $data; |
|
| 165 | + |
|
| 166 | + // Then generate a unique id from the data. |
|
| 167 | + $this->id = md5( wp_json_encode( $data ) ); |
|
| 168 | + |
|
| 169 | + // Finally, process the submission. |
|
| 170 | + try { |
|
| 171 | + |
|
| 172 | + // Each process is passed an instance of the class (with reference) |
|
| 173 | + // and should throw an Exception whenever it encounters one. |
|
| 174 | + $processors = apply_filters( |
|
| 175 | + 'getpaid_payment_form_submission_processors', |
|
| 176 | + array( |
|
| 177 | + array( $this, 'process_payment_form' ), |
|
| 178 | + array( $this, 'process_invoice' ), |
|
| 179 | + array( $this, 'process_fees' ), |
|
| 180 | + array( $this, 'process_items' ), |
|
| 181 | + array( $this, 'process_discount' ), |
|
| 182 | + array( $this, 'process_taxes' ), |
|
| 183 | + ), |
|
| 184 | + $this |
|
| 185 | + ); |
|
| 186 | + |
|
| 187 | + foreach ( $processors as $processor ) { |
|
| 188 | + call_user_func_array( $processor, array( &$this ) ); |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + } catch( GetPaid_Payment_Exception $e ) { |
|
| 192 | + $this->last_error = $e->getMessage(); |
|
| 193 | + $this->last_error_code = $e->getErrorCode(); |
|
| 194 | + } catch ( Exception $e ) { |
|
| 195 | + $this->last_error = $e->getMessage(); |
|
| 196 | + $this->last_error_code = $e->getCode(); |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + // Fired when we are done processing a submission. |
|
| 200 | + do_action_ref_array( 'getpaid_process_submission', array( &$this ) ); |
|
| 201 | + |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + /* |
|
| 205 | 205 | |-------------------------------------------------------------------------- |
| 206 | 206 | | Payment Forms. |
| 207 | 207 | |-------------------------------------------------------------------------- |
@@ -210,39 +210,39 @@ discard block |
||
| 210 | 210 | | submission has an active payment form etc. |
| 211 | 211 | */ |
| 212 | 212 | |
| 213 | - /** |
|
| 214 | - * Prepares the submission's payment form. |
|
| 215 | - * |
|
| 216 | - * @since 1.0.19 |
|
| 217 | - */ |
|
| 218 | - public function process_payment_form() { |
|
| 213 | + /** |
|
| 214 | + * Prepares the submission's payment form. |
|
| 215 | + * |
|
| 216 | + * @since 1.0.19 |
|
| 217 | + */ |
|
| 218 | + public function process_payment_form() { |
|
| 219 | 219 | |
| 220 | - // Every submission needs an active payment form. |
|
| 221 | - if ( empty( $this->data['form_id'] ) ) { |
|
| 222 | - throw new Exception( __( 'Missing payment form', 'invoicing' ) ); |
|
| 223 | - } |
|
| 220 | + // Every submission needs an active payment form. |
|
| 221 | + if ( empty( $this->data['form_id'] ) ) { |
|
| 222 | + throw new Exception( __( 'Missing payment form', 'invoicing' ) ); |
|
| 223 | + } |
|
| 224 | 224 | |
| 225 | - // Fetch the payment form. |
|
| 226 | - $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] ); |
|
| 225 | + // Fetch the payment form. |
|
| 226 | + $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] ); |
|
| 227 | 227 | |
| 228 | - if ( ! $this->payment_form->is_active() ) { |
|
| 229 | - throw new Exception( __( 'Payment form not active', 'invoicing' ) ); |
|
| 230 | - } |
|
| 228 | + if ( ! $this->payment_form->is_active() ) { |
|
| 229 | + throw new Exception( __( 'Payment form not active', 'invoicing' ) ); |
|
| 230 | + } |
|
| 231 | 231 | |
| 232 | - do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) ); |
|
| 233 | - } |
|
| 232 | + do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) ); |
|
| 233 | + } |
|
| 234 | 234 | |
| 235 | 235 | /** |
| 236 | - * Returns the payment form. |
|
| 237 | - * |
|
| 238 | - * @since 1.0.19 |
|
| 239 | - * @return GetPaid_Payment_Form |
|
| 240 | - */ |
|
| 241 | - public function get_payment_form() { |
|
| 242 | - return $this->payment_form; |
|
| 243 | - } |
|
| 236 | + * Returns the payment form. |
|
| 237 | + * |
|
| 238 | + * @since 1.0.19 |
|
| 239 | + * @return GetPaid_Payment_Form |
|
| 240 | + */ |
|
| 241 | + public function get_payment_form() { |
|
| 242 | + return $this->payment_form; |
|
| 243 | + } |
|
| 244 | 244 | |
| 245 | - /* |
|
| 245 | + /* |
|
| 246 | 246 | |-------------------------------------------------------------------------- |
| 247 | 247 | | Invoices. |
| 248 | 248 | |-------------------------------------------------------------------------- |
@@ -251,84 +251,84 @@ discard block |
||
| 251 | 251 | | might be for an existing invoice. |
| 252 | 252 | */ |
| 253 | 253 | |
| 254 | - /** |
|
| 255 | - * Prepares the submission's invoice. |
|
| 256 | - * |
|
| 257 | - * @since 1.0.19 |
|
| 258 | - */ |
|
| 259 | - public function process_invoice() { |
|
| 254 | + /** |
|
| 255 | + * Prepares the submission's invoice. |
|
| 256 | + * |
|
| 257 | + * @since 1.0.19 |
|
| 258 | + */ |
|
| 259 | + public function process_invoice() { |
|
| 260 | 260 | |
| 261 | - // Abort if there is no invoice. |
|
| 262 | - if ( empty( $this->data['invoice_id'] ) ) { |
|
| 263 | - return; |
|
| 264 | - } |
|
| 261 | + // Abort if there is no invoice. |
|
| 262 | + if ( empty( $this->data['invoice_id'] ) ) { |
|
| 263 | + return; |
|
| 264 | + } |
|
| 265 | 265 | |
| 266 | - // If the submission is for an existing invoice, ensure that it exists |
|
| 267 | - // and that it is not paid for. |
|
| 268 | - $invoice = wpinv_get_invoice( $this->data['invoice_id'] ); |
|
| 266 | + // If the submission is for an existing invoice, ensure that it exists |
|
| 267 | + // and that it is not paid for. |
|
| 268 | + $invoice = wpinv_get_invoice( $this->data['invoice_id'] ); |
|
| 269 | 269 | |
| 270 | 270 | if ( empty( $invoice ) ) { |
| 271 | - throw new Exception( __( 'Invalid invoice', 'invoicing' ) ); |
|
| 272 | - } |
|
| 271 | + throw new Exception( __( 'Invalid invoice', 'invoicing' ) ); |
|
| 272 | + } |
|
| 273 | 273 | |
| 274 | - if ( $invoice->is_paid() ) { |
|
| 275 | - throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) ); |
|
| 276 | - } |
|
| 274 | + if ( $invoice->is_paid() ) { |
|
| 275 | + throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) ); |
|
| 276 | + } |
|
| 277 | 277 | |
| 278 | - $this->payment_form->invoice = $invoice; |
|
| 279 | - if ( ! $this->payment_form->is_default() ) { |
|
| 278 | + $this->payment_form->invoice = $invoice; |
|
| 279 | + if ( ! $this->payment_form->is_default() ) { |
|
| 280 | 280 | |
| 281 | - $items = array(); |
|
| 282 | - $item_ids = array(); |
|
| 281 | + $items = array(); |
|
| 282 | + $item_ids = array(); |
|
| 283 | 283 | |
| 284 | - foreach ( $invoice->get_items() as $item ) { |
|
| 285 | - if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
| 286 | - $item_ids[] = $item->get_id(); |
|
| 287 | - $items[] = $item; |
|
| 288 | - } |
|
| 289 | - } |
|
| 284 | + foreach ( $invoice->get_items() as $item ) { |
|
| 285 | + if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
| 286 | + $item_ids[] = $item->get_id(); |
|
| 287 | + $items[] = $item; |
|
| 288 | + } |
|
| 289 | + } |
|
| 290 | 290 | |
| 291 | - foreach ( $this->payment_form->get_items() as $item ) { |
|
| 292 | - if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
| 293 | - $item_ids[] = $item->get_id(); |
|
| 294 | - $items[] = $item; |
|
| 295 | - } |
|
| 296 | - } |
|
| 291 | + foreach ( $this->payment_form->get_items() as $item ) { |
|
| 292 | + if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
| 293 | + $item_ids[] = $item->get_id(); |
|
| 294 | + $items[] = $item; |
|
| 295 | + } |
|
| 296 | + } |
|
| 297 | 297 | |
| 298 | - $this->payment_form->set_items( $items ); |
|
| 298 | + $this->payment_form->set_items( $items ); |
|
| 299 | 299 | |
| 300 | - } else { |
|
| 301 | - $this->payment_form->set_items( $invoice->get_items() ); |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - $this->country = $invoice->get_country(); |
|
| 305 | - $this->state = $invoice->get_state(); |
|
| 306 | - $this->invoice = $invoice; |
|
| 307 | - |
|
| 308 | - do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) ); |
|
| 309 | - } |
|
| 310 | - |
|
| 311 | - /** |
|
| 312 | - * Returns the associated invoice. |
|
| 313 | - * |
|
| 314 | - * @since 1.0.19 |
|
| 315 | - * @return WPInv_Invoice |
|
| 316 | - */ |
|
| 317 | - public function get_invoice() { |
|
| 318 | - return $this->invoice; |
|
| 319 | - } |
|
| 320 | - |
|
| 321 | - /** |
|
| 322 | - * Checks whether there is an invoice associated with this submission. |
|
| 323 | - * |
|
| 324 | - * @since 1.0.19 |
|
| 325 | - * @return bool |
|
| 326 | - */ |
|
| 327 | - public function has_invoice() { |
|
| 328 | - return ! empty( $this->invoice ); |
|
| 329 | - } |
|
| 330 | - |
|
| 331 | - /* |
|
| 300 | + } else { |
|
| 301 | + $this->payment_form->set_items( $invoice->get_items() ); |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + $this->country = $invoice->get_country(); |
|
| 305 | + $this->state = $invoice->get_state(); |
|
| 306 | + $this->invoice = $invoice; |
|
| 307 | + |
|
| 308 | + do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) ); |
|
| 309 | + } |
|
| 310 | + |
|
| 311 | + /** |
|
| 312 | + * Returns the associated invoice. |
|
| 313 | + * |
|
| 314 | + * @since 1.0.19 |
|
| 315 | + * @return WPInv_Invoice |
|
| 316 | + */ |
|
| 317 | + public function get_invoice() { |
|
| 318 | + return $this->invoice; |
|
| 319 | + } |
|
| 320 | + |
|
| 321 | + /** |
|
| 322 | + * Checks whether there is an invoice associated with this submission. |
|
| 323 | + * |
|
| 324 | + * @since 1.0.19 |
|
| 325 | + * @return bool |
|
| 326 | + */ |
|
| 327 | + public function has_invoice() { |
|
| 328 | + return ! empty( $this->invoice ); |
|
| 329 | + } |
|
| 330 | + |
|
| 331 | + /* |
|
| 332 | 332 | |-------------------------------------------------------------------------- |
| 333 | 333 | | Items. |
| 334 | 334 | |-------------------------------------------------------------------------- |
@@ -337,129 +337,129 @@ discard block |
||
| 337 | 337 | | recurring item. But can have an unlimited number of non-recurring items. |
| 338 | 338 | */ |
| 339 | 339 | |
| 340 | - /** |
|
| 341 | - * Prepares the submission's items. |
|
| 342 | - * |
|
| 343 | - * @since 1.0.19 |
|
| 344 | - */ |
|
| 345 | - public function process_items() { |
|
| 346 | - |
|
| 347 | - $processor = new GetPaid_Payment_Form_Submission_Items( $this ); |
|
| 348 | - |
|
| 349 | - foreach ( $processor->items as $item ) { |
|
| 350 | - $this->add_item( $item ); |
|
| 351 | - } |
|
| 352 | - |
|
| 353 | - do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) ); |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * Adds an item to the submission. |
|
| 358 | - * |
|
| 359 | - * @since 1.0.19 |
|
| 360 | - * @param GetPaid_Form_Item $item |
|
| 361 | - */ |
|
| 362 | - public function add_item( $item ) { |
|
| 363 | - |
|
| 364 | - // Make sure that it is available for purchase. |
|
| 365 | - if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) { |
|
| 366 | - return; |
|
| 367 | - } |
|
| 368 | - |
|
| 369 | - // Each submission can only contain one recurring item. |
|
| 370 | - if ( $item->is_recurring() ) { |
|
| 371 | - $this->has_recurring = $item->get_id(); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - // Update the items and totals. |
|
| 375 | - $this->items[ $item->get_id() ] = $item; |
|
| 376 | - $this->totals['subtotal']['initial'] += $item->get_sub_total(); |
|
| 377 | - $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total(); |
|
| 378 | - |
|
| 379 | - } |
|
| 380 | - |
|
| 381 | - /** |
|
| 382 | - * Removes a specific item. |
|
| 383 | - * |
|
| 384 | - * You should not call this method after the discounts and taxes |
|
| 385 | - * have been calculated. |
|
| 386 | - * |
|
| 387 | - * @since 1.0.19 |
|
| 388 | - */ |
|
| 389 | - public function remove_item( $item_id ) { |
|
| 390 | - |
|
| 391 | - if ( isset( $this->items[ $item_id ] ) ) { |
|
| 392 | - $this->totals['subtotal']['initial'] -= $this->items[ $item_id ]->get_sub_total(); |
|
| 393 | - $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total(); |
|
| 394 | - |
|
| 395 | - if ( $this->items[ $item_id ]->is_recurring() ) { |
|
| 396 | - $this->has_recurring = 0; |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - unset( $this->items[ $item_id ] ); |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - } |
|
| 403 | - |
|
| 404 | - /** |
|
| 405 | - * Returns the subtotal. |
|
| 406 | - * |
|
| 407 | - * @since 1.0.19 |
|
| 408 | - */ |
|
| 409 | - public function get_subtotal() { |
|
| 410 | - |
|
| 411 | - if ( wpinv_prices_include_tax() ) { |
|
| 412 | - return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial']; |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - return $this->totals['subtotal']['initial']; |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - /** |
|
| 419 | - * Returns the recurring subtotal. |
|
| 420 | - * |
|
| 421 | - * @since 1.0.19 |
|
| 422 | - */ |
|
| 423 | - public function get_recurring_subtotal() { |
|
| 424 | - |
|
| 425 | - if ( wpinv_prices_include_tax() ) { |
|
| 426 | - return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring']; |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - return $this->totals['subtotal']['recurring']; |
|
| 430 | - } |
|
| 431 | - |
|
| 432 | - /** |
|
| 433 | - * Returns all items. |
|
| 434 | - * |
|
| 435 | - * @since 1.0.19 |
|
| 436 | - * @return GetPaid_Form_Item[] |
|
| 437 | - */ |
|
| 438 | - public function get_items() { |
|
| 439 | - return $this->items; |
|
| 440 | - } |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * Checks if there's a single subscription group in the submission. |
|
| 444 | - * |
|
| 445 | - * @since 2.3.0 |
|
| 446 | - * @return bool |
|
| 447 | - */ |
|
| 448 | - public function has_subscription_group() { |
|
| 449 | - return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) ); |
|
| 450 | - } |
|
| 451 | - |
|
| 452 | - /** |
|
| 453 | - * Checks if there are multipe subscription groups in the submission. |
|
| 454 | - * |
|
| 455 | - * @since 2.3.0 |
|
| 456 | - * @return bool |
|
| 457 | - */ |
|
| 458 | - public function has_multiple_subscription_groups() { |
|
| 459 | - return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) ); |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - /* |
|
| 340 | + /** |
|
| 341 | + * Prepares the submission's items. |
|
| 342 | + * |
|
| 343 | + * @since 1.0.19 |
|
| 344 | + */ |
|
| 345 | + public function process_items() { |
|
| 346 | + |
|
| 347 | + $processor = new GetPaid_Payment_Form_Submission_Items( $this ); |
|
| 348 | + |
|
| 349 | + foreach ( $processor->items as $item ) { |
|
| 350 | + $this->add_item( $item ); |
|
| 351 | + } |
|
| 352 | + |
|
| 353 | + do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) ); |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * Adds an item to the submission. |
|
| 358 | + * |
|
| 359 | + * @since 1.0.19 |
|
| 360 | + * @param GetPaid_Form_Item $item |
|
| 361 | + */ |
|
| 362 | + public function add_item( $item ) { |
|
| 363 | + |
|
| 364 | + // Make sure that it is available for purchase. |
|
| 365 | + if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) { |
|
| 366 | + return; |
|
| 367 | + } |
|
| 368 | + |
|
| 369 | + // Each submission can only contain one recurring item. |
|
| 370 | + if ( $item->is_recurring() ) { |
|
| 371 | + $this->has_recurring = $item->get_id(); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + // Update the items and totals. |
|
| 375 | + $this->items[ $item->get_id() ] = $item; |
|
| 376 | + $this->totals['subtotal']['initial'] += $item->get_sub_total(); |
|
| 377 | + $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total(); |
|
| 378 | + |
|
| 379 | + } |
|
| 380 | + |
|
| 381 | + /** |
|
| 382 | + * Removes a specific item. |
|
| 383 | + * |
|
| 384 | + * You should not call this method after the discounts and taxes |
|
| 385 | + * have been calculated. |
|
| 386 | + * |
|
| 387 | + * @since 1.0.19 |
|
| 388 | + */ |
|
| 389 | + public function remove_item( $item_id ) { |
|
| 390 | + |
|
| 391 | + if ( isset( $this->items[ $item_id ] ) ) { |
|
| 392 | + $this->totals['subtotal']['initial'] -= $this->items[ $item_id ]->get_sub_total(); |
|
| 393 | + $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total(); |
|
| 394 | + |
|
| 395 | + if ( $this->items[ $item_id ]->is_recurring() ) { |
|
| 396 | + $this->has_recurring = 0; |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + unset( $this->items[ $item_id ] ); |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + } |
|
| 403 | + |
|
| 404 | + /** |
|
| 405 | + * Returns the subtotal. |
|
| 406 | + * |
|
| 407 | + * @since 1.0.19 |
|
| 408 | + */ |
|
| 409 | + public function get_subtotal() { |
|
| 410 | + |
|
| 411 | + if ( wpinv_prices_include_tax() ) { |
|
| 412 | + return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial']; |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + return $this->totals['subtotal']['initial']; |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + /** |
|
| 419 | + * Returns the recurring subtotal. |
|
| 420 | + * |
|
| 421 | + * @since 1.0.19 |
|
| 422 | + */ |
|
| 423 | + public function get_recurring_subtotal() { |
|
| 424 | + |
|
| 425 | + if ( wpinv_prices_include_tax() ) { |
|
| 426 | + return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring']; |
|
| 427 | + } |
|
| 428 | + |
|
| 429 | + return $this->totals['subtotal']['recurring']; |
|
| 430 | + } |
|
| 431 | + |
|
| 432 | + /** |
|
| 433 | + * Returns all items. |
|
| 434 | + * |
|
| 435 | + * @since 1.0.19 |
|
| 436 | + * @return GetPaid_Form_Item[] |
|
| 437 | + */ |
|
| 438 | + public function get_items() { |
|
| 439 | + return $this->items; |
|
| 440 | + } |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * Checks if there's a single subscription group in the submission. |
|
| 444 | + * |
|
| 445 | + * @since 2.3.0 |
|
| 446 | + * @return bool |
|
| 447 | + */ |
|
| 448 | + public function has_subscription_group() { |
|
| 449 | + return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) ); |
|
| 450 | + } |
|
| 451 | + |
|
| 452 | + /** |
|
| 453 | + * Checks if there are multipe subscription groups in the submission. |
|
| 454 | + * |
|
| 455 | + * @since 2.3.0 |
|
| 456 | + * @return bool |
|
| 457 | + */ |
|
| 458 | + public function has_multiple_subscription_groups() { |
|
| 459 | + return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) ); |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + /* |
|
| 463 | 463 | |-------------------------------------------------------------------------- |
| 464 | 464 | | Taxes |
| 465 | 465 | |-------------------------------------------------------------------------- |
@@ -468,128 +468,128 @@ discard block |
||
| 468 | 468 | | or only one-time. |
| 469 | 469 | */ |
| 470 | 470 | |
| 471 | - /** |
|
| 472 | - * Prepares the submission's taxes. |
|
| 473 | - * |
|
| 474 | - * @since 1.0.19 |
|
| 475 | - */ |
|
| 476 | - public function process_taxes() { |
|
| 477 | - |
|
| 478 | - // Abort if we're not using taxes. |
|
| 479 | - if ( ! $this->use_taxes() ) { |
|
| 480 | - return; |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - // If a custom country && state has been passed in, use it to calculate taxes. |
|
| 484 | - $country = $this->get_field( 'wpinv_country', 'billing' ); |
|
| 485 | - if ( ! empty( $country ) ) { |
|
| 486 | - $this->country = $country; |
|
| 487 | - } |
|
| 488 | - |
|
| 489 | - $state = $this->get_field( 'wpinv_state', 'billing' ); |
|
| 490 | - if ( ! empty( $state ) ) { |
|
| 491 | - $this->state = $state; |
|
| 492 | - } |
|
| 493 | - |
|
| 494 | - // Confirm if the provided country and the ip country are similar. |
|
| 495 | - $address_confirmed = $this->get_field( 'confirm-address' ); |
|
| 496 | - if ( wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) { |
|
| 497 | - throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) ); |
|
| 498 | - } |
|
| 499 | - |
|
| 500 | - // Abort if the country is not taxable. |
|
| 501 | - if ( ! wpinv_is_country_taxable( $this->country ) ) { |
|
| 502 | - return; |
|
| 503 | - } |
|
| 504 | - |
|
| 505 | - $processor = new GetPaid_Payment_Form_Submission_Taxes( $this ); |
|
| 506 | - |
|
| 507 | - foreach ( $processor->taxes as $tax ) { |
|
| 508 | - $this->add_tax( $tax ); |
|
| 509 | - } |
|
| 510 | - |
|
| 511 | - do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) ); |
|
| 512 | - } |
|
| 513 | - |
|
| 514 | - /** |
|
| 515 | - * Adds a tax to the submission. |
|
| 516 | - * |
|
| 517 | - * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required. |
|
| 518 | - * @since 1.0.19 |
|
| 519 | - */ |
|
| 520 | - public function add_tax( $tax ) { |
|
| 521 | - |
|
| 522 | - if ( wpinv_round_tax_per_tax_rate() ) { |
|
| 523 | - $tax['initial_tax'] = wpinv_round_amount( $tax['initial_tax'] ); |
|
| 524 | - $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] ); |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - $this->taxes[ $tax['name'] ] = $tax; |
|
| 528 | - $this->totals['taxes']['initial'] += wpinv_sanitize_amount( $tax['initial_tax'] ); |
|
| 529 | - $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] ); |
|
| 530 | - |
|
| 531 | - } |
|
| 532 | - |
|
| 533 | - /** |
|
| 534 | - * Removes a specific tax. |
|
| 535 | - * |
|
| 536 | - * @since 1.0.19 |
|
| 537 | - */ |
|
| 538 | - public function remove_tax( $tax_name ) { |
|
| 539 | - |
|
| 540 | - if ( isset( $this->taxes[ $tax_name ] ) ) { |
|
| 541 | - $this->totals['taxes']['initial'] -= $this->taxes[ $tax_name ]['initial_tax']; |
|
| 542 | - $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax']; |
|
| 543 | - unset( $this->taxes[ $tax_name ] ); |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - } |
|
| 547 | - |
|
| 548 | - /** |
|
| 549 | - * Whether or not we'll use taxes for the submission. |
|
| 550 | - * |
|
| 551 | - * @since 1.0.19 |
|
| 552 | - */ |
|
| 553 | - public function use_taxes() { |
|
| 554 | - |
|
| 555 | - $use_taxes = wpinv_use_taxes(); |
|
| 556 | - |
|
| 557 | - if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) { |
|
| 558 | - $use_taxes = false; |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this ); |
|
| 562 | - |
|
| 563 | - } |
|
| 564 | - |
|
| 565 | - /** |
|
| 566 | - * Returns the tax. |
|
| 567 | - * |
|
| 568 | - * @since 1.0.19 |
|
| 569 | - */ |
|
| 570 | - public function get_tax() { |
|
| 571 | - return $this->totals['taxes']['initial']; |
|
| 572 | - } |
|
| 573 | - |
|
| 574 | - /** |
|
| 575 | - * Returns the recurring tax. |
|
| 576 | - * |
|
| 577 | - * @since 1.0.19 |
|
| 578 | - */ |
|
| 579 | - public function get_recurring_tax() { |
|
| 580 | - return $this->totals['taxes']['recurring']; |
|
| 581 | - } |
|
| 582 | - |
|
| 583 | - /** |
|
| 584 | - * Returns all taxes. |
|
| 585 | - * |
|
| 586 | - * @since 1.0.19 |
|
| 587 | - */ |
|
| 588 | - public function get_taxes() { |
|
| 589 | - return $this->taxes; |
|
| 590 | - } |
|
| 591 | - |
|
| 592 | - /* |
|
| 471 | + /** |
|
| 472 | + * Prepares the submission's taxes. |
|
| 473 | + * |
|
| 474 | + * @since 1.0.19 |
|
| 475 | + */ |
|
| 476 | + public function process_taxes() { |
|
| 477 | + |
|
| 478 | + // Abort if we're not using taxes. |
|
| 479 | + if ( ! $this->use_taxes() ) { |
|
| 480 | + return; |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + // If a custom country && state has been passed in, use it to calculate taxes. |
|
| 484 | + $country = $this->get_field( 'wpinv_country', 'billing' ); |
|
| 485 | + if ( ! empty( $country ) ) { |
|
| 486 | + $this->country = $country; |
|
| 487 | + } |
|
| 488 | + |
|
| 489 | + $state = $this->get_field( 'wpinv_state', 'billing' ); |
|
| 490 | + if ( ! empty( $state ) ) { |
|
| 491 | + $this->state = $state; |
|
| 492 | + } |
|
| 493 | + |
|
| 494 | + // Confirm if the provided country and the ip country are similar. |
|
| 495 | + $address_confirmed = $this->get_field( 'confirm-address' ); |
|
| 496 | + if ( wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) { |
|
| 497 | + throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) ); |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + // Abort if the country is not taxable. |
|
| 501 | + if ( ! wpinv_is_country_taxable( $this->country ) ) { |
|
| 502 | + return; |
|
| 503 | + } |
|
| 504 | + |
|
| 505 | + $processor = new GetPaid_Payment_Form_Submission_Taxes( $this ); |
|
| 506 | + |
|
| 507 | + foreach ( $processor->taxes as $tax ) { |
|
| 508 | + $this->add_tax( $tax ); |
|
| 509 | + } |
|
| 510 | + |
|
| 511 | + do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) ); |
|
| 512 | + } |
|
| 513 | + |
|
| 514 | + /** |
|
| 515 | + * Adds a tax to the submission. |
|
| 516 | + * |
|
| 517 | + * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required. |
|
| 518 | + * @since 1.0.19 |
|
| 519 | + */ |
|
| 520 | + public function add_tax( $tax ) { |
|
| 521 | + |
|
| 522 | + if ( wpinv_round_tax_per_tax_rate() ) { |
|
| 523 | + $tax['initial_tax'] = wpinv_round_amount( $tax['initial_tax'] ); |
|
| 524 | + $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] ); |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + $this->taxes[ $tax['name'] ] = $tax; |
|
| 528 | + $this->totals['taxes']['initial'] += wpinv_sanitize_amount( $tax['initial_tax'] ); |
|
| 529 | + $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] ); |
|
| 530 | + |
|
| 531 | + } |
|
| 532 | + |
|
| 533 | + /** |
|
| 534 | + * Removes a specific tax. |
|
| 535 | + * |
|
| 536 | + * @since 1.0.19 |
|
| 537 | + */ |
|
| 538 | + public function remove_tax( $tax_name ) { |
|
| 539 | + |
|
| 540 | + if ( isset( $this->taxes[ $tax_name ] ) ) { |
|
| 541 | + $this->totals['taxes']['initial'] -= $this->taxes[ $tax_name ]['initial_tax']; |
|
| 542 | + $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax']; |
|
| 543 | + unset( $this->taxes[ $tax_name ] ); |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + } |
|
| 547 | + |
|
| 548 | + /** |
|
| 549 | + * Whether or not we'll use taxes for the submission. |
|
| 550 | + * |
|
| 551 | + * @since 1.0.19 |
|
| 552 | + */ |
|
| 553 | + public function use_taxes() { |
|
| 554 | + |
|
| 555 | + $use_taxes = wpinv_use_taxes(); |
|
| 556 | + |
|
| 557 | + if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) { |
|
| 558 | + $use_taxes = false; |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this ); |
|
| 562 | + |
|
| 563 | + } |
|
| 564 | + |
|
| 565 | + /** |
|
| 566 | + * Returns the tax. |
|
| 567 | + * |
|
| 568 | + * @since 1.0.19 |
|
| 569 | + */ |
|
| 570 | + public function get_tax() { |
|
| 571 | + return $this->totals['taxes']['initial']; |
|
| 572 | + } |
|
| 573 | + |
|
| 574 | + /** |
|
| 575 | + * Returns the recurring tax. |
|
| 576 | + * |
|
| 577 | + * @since 1.0.19 |
|
| 578 | + */ |
|
| 579 | + public function get_recurring_tax() { |
|
| 580 | + return $this->totals['taxes']['recurring']; |
|
| 581 | + } |
|
| 582 | + |
|
| 583 | + /** |
|
| 584 | + * Returns all taxes. |
|
| 585 | + * |
|
| 586 | + * @since 1.0.19 |
|
| 587 | + */ |
|
| 588 | + public function get_taxes() { |
|
| 589 | + return $this->taxes; |
|
| 590 | + } |
|
| 591 | + |
|
| 592 | + /* |
|
| 593 | 593 | |-------------------------------------------------------------------------- |
| 594 | 594 | | Discounts |
| 595 | 595 | |-------------------------------------------------------------------------- |
@@ -598,99 +598,99 @@ discard block |
||
| 598 | 598 | | or only one-time. They also do not have to come from a discount code. |
| 599 | 599 | */ |
| 600 | 600 | |
| 601 | - /** |
|
| 602 | - * Prepares the submission's discount. |
|
| 603 | - * |
|
| 604 | - * @since 1.0.19 |
|
| 605 | - */ |
|
| 606 | - public function process_discount() { |
|
| 607 | - |
|
| 608 | - $initial_total = $this->get_subtotal() + $this->get_fee() + $this->get_tax(); |
|
| 609 | - $recurring_total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax(); |
|
| 610 | - $processor = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total ); |
|
| 611 | - |
|
| 612 | - foreach ( $processor->discounts as $discount ) { |
|
| 613 | - $this->add_discount( $discount ); |
|
| 614 | - } |
|
| 615 | - |
|
| 616 | - do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) ); |
|
| 617 | - } |
|
| 618 | - |
|
| 619 | - /** |
|
| 620 | - * Adds a discount to the submission. |
|
| 621 | - * |
|
| 622 | - * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
| 623 | - * @since 1.0.19 |
|
| 624 | - */ |
|
| 625 | - public function add_discount( $discount ) { |
|
| 626 | - $this->discounts[ $discount['name'] ] = $discount; |
|
| 627 | - $this->totals['discount']['initial'] += wpinv_sanitize_amount( $discount['initial_discount'] ); |
|
| 628 | - $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] ); |
|
| 629 | - } |
|
| 630 | - |
|
| 631 | - /** |
|
| 632 | - * Removes a discount from the submission. |
|
| 633 | - * |
|
| 634 | - * @since 1.0.19 |
|
| 635 | - */ |
|
| 636 | - public function remove_discount( $name ) { |
|
| 637 | - |
|
| 638 | - if ( isset( $this->discounts[ $name ] ) ) { |
|
| 639 | - $this->totals['discount']['initial'] -= $this->discounts[ $name ]['initial_discount']; |
|
| 640 | - $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount']; |
|
| 641 | - unset( $this->discounts[ $name ] ); |
|
| 642 | - } |
|
| 643 | - |
|
| 644 | - } |
|
| 645 | - |
|
| 646 | - /** |
|
| 647 | - * Checks whether there is a discount code associated with this submission. |
|
| 648 | - * |
|
| 649 | - * @since 1.0.19 |
|
| 650 | - * @return bool |
|
| 651 | - */ |
|
| 652 | - public function has_discount_code() { |
|
| 653 | - return ! empty( $this->discounts['discount_code'] ); |
|
| 654 | - } |
|
| 655 | - |
|
| 656 | - /** |
|
| 657 | - * Returns the discount code. |
|
| 658 | - * |
|
| 659 | - * @since 1.0.19 |
|
| 660 | - * @return string |
|
| 661 | - */ |
|
| 662 | - public function get_discount_code() { |
|
| 663 | - return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : ''; |
|
| 664 | - } |
|
| 665 | - |
|
| 666 | - /** |
|
| 667 | - * Returns the discount. |
|
| 668 | - * |
|
| 669 | - * @since 1.0.19 |
|
| 670 | - */ |
|
| 671 | - public function get_discount() { |
|
| 672 | - return $this->totals['discount']['initial']; |
|
| 673 | - } |
|
| 674 | - |
|
| 675 | - /** |
|
| 676 | - * Returns the recurring discount. |
|
| 677 | - * |
|
| 678 | - * @since 1.0.19 |
|
| 679 | - */ |
|
| 680 | - public function get_recurring_discount() { |
|
| 681 | - return $this->totals['discount']['recurring']; |
|
| 682 | - } |
|
| 683 | - |
|
| 684 | - /** |
|
| 685 | - * Returns all discounts. |
|
| 686 | - * |
|
| 687 | - * @since 1.0.19 |
|
| 688 | - */ |
|
| 689 | - public function get_discounts() { |
|
| 690 | - return $this->discounts; |
|
| 691 | - } |
|
| 692 | - |
|
| 693 | - /* |
|
| 601 | + /** |
|
| 602 | + * Prepares the submission's discount. |
|
| 603 | + * |
|
| 604 | + * @since 1.0.19 |
|
| 605 | + */ |
|
| 606 | + public function process_discount() { |
|
| 607 | + |
|
| 608 | + $initial_total = $this->get_subtotal() + $this->get_fee() + $this->get_tax(); |
|
| 609 | + $recurring_total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax(); |
|
| 610 | + $processor = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total ); |
|
| 611 | + |
|
| 612 | + foreach ( $processor->discounts as $discount ) { |
|
| 613 | + $this->add_discount( $discount ); |
|
| 614 | + } |
|
| 615 | + |
|
| 616 | + do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) ); |
|
| 617 | + } |
|
| 618 | + |
|
| 619 | + /** |
|
| 620 | + * Adds a discount to the submission. |
|
| 621 | + * |
|
| 622 | + * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
| 623 | + * @since 1.0.19 |
|
| 624 | + */ |
|
| 625 | + public function add_discount( $discount ) { |
|
| 626 | + $this->discounts[ $discount['name'] ] = $discount; |
|
| 627 | + $this->totals['discount']['initial'] += wpinv_sanitize_amount( $discount['initial_discount'] ); |
|
| 628 | + $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] ); |
|
| 629 | + } |
|
| 630 | + |
|
| 631 | + /** |
|
| 632 | + * Removes a discount from the submission. |
|
| 633 | + * |
|
| 634 | + * @since 1.0.19 |
|
| 635 | + */ |
|
| 636 | + public function remove_discount( $name ) { |
|
| 637 | + |
|
| 638 | + if ( isset( $this->discounts[ $name ] ) ) { |
|
| 639 | + $this->totals['discount']['initial'] -= $this->discounts[ $name ]['initial_discount']; |
|
| 640 | + $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount']; |
|
| 641 | + unset( $this->discounts[ $name ] ); |
|
| 642 | + } |
|
| 643 | + |
|
| 644 | + } |
|
| 645 | + |
|
| 646 | + /** |
|
| 647 | + * Checks whether there is a discount code associated with this submission. |
|
| 648 | + * |
|
| 649 | + * @since 1.0.19 |
|
| 650 | + * @return bool |
|
| 651 | + */ |
|
| 652 | + public function has_discount_code() { |
|
| 653 | + return ! empty( $this->discounts['discount_code'] ); |
|
| 654 | + } |
|
| 655 | + |
|
| 656 | + /** |
|
| 657 | + * Returns the discount code. |
|
| 658 | + * |
|
| 659 | + * @since 1.0.19 |
|
| 660 | + * @return string |
|
| 661 | + */ |
|
| 662 | + public function get_discount_code() { |
|
| 663 | + return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : ''; |
|
| 664 | + } |
|
| 665 | + |
|
| 666 | + /** |
|
| 667 | + * Returns the discount. |
|
| 668 | + * |
|
| 669 | + * @since 1.0.19 |
|
| 670 | + */ |
|
| 671 | + public function get_discount() { |
|
| 672 | + return $this->totals['discount']['initial']; |
|
| 673 | + } |
|
| 674 | + |
|
| 675 | + /** |
|
| 676 | + * Returns the recurring discount. |
|
| 677 | + * |
|
| 678 | + * @since 1.0.19 |
|
| 679 | + */ |
|
| 680 | + public function get_recurring_discount() { |
|
| 681 | + return $this->totals['discount']['recurring']; |
|
| 682 | + } |
|
| 683 | + |
|
| 684 | + /** |
|
| 685 | + * Returns all discounts. |
|
| 686 | + * |
|
| 687 | + * @since 1.0.19 |
|
| 688 | + */ |
|
| 689 | + public function get_discounts() { |
|
| 690 | + return $this->discounts; |
|
| 691 | + } |
|
| 692 | + |
|
| 693 | + /* |
|
| 694 | 694 | |-------------------------------------------------------------------------- |
| 695 | 695 | | Fees |
| 696 | 696 | |-------------------------------------------------------------------------- |
@@ -700,89 +700,89 @@ discard block |
||
| 700 | 700 | | fees. |
| 701 | 701 | */ |
| 702 | 702 | |
| 703 | - /** |
|
| 704 | - * Prepares the submission's fees. |
|
| 705 | - * |
|
| 706 | - * @since 1.0.19 |
|
| 707 | - */ |
|
| 708 | - public function process_fees() { |
|
| 709 | - |
|
| 710 | - $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this ); |
|
| 711 | - |
|
| 712 | - foreach ( $fees_processor->fees as $fee ) { |
|
| 713 | - $this->add_fee( $fee ); |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) ); |
|
| 717 | - } |
|
| 718 | - |
|
| 719 | - /** |
|
| 720 | - * Adds a fee to the submission. |
|
| 721 | - * |
|
| 722 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 723 | - * @since 1.0.19 |
|
| 724 | - */ |
|
| 725 | - public function add_fee( $fee ) { |
|
| 726 | - |
|
| 727 | - $this->fees[ $fee['name'] ] = $fee; |
|
| 728 | - $this->totals['fees']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
| 729 | - $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
| 730 | - |
|
| 731 | - } |
|
| 732 | - |
|
| 733 | - /** |
|
| 734 | - * Removes a fee from the submission. |
|
| 735 | - * |
|
| 736 | - * @since 1.0.19 |
|
| 737 | - */ |
|
| 738 | - public function remove_fee( $name ) { |
|
| 739 | - |
|
| 740 | - if ( isset( $this->fees[ $name ] ) ) { |
|
| 741 | - $this->totals['fees']['initial'] -= $this->fees[ $name ]['initial_fee']; |
|
| 742 | - $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee']; |
|
| 743 | - unset( $this->fees[ $name ] ); |
|
| 744 | - } |
|
| 745 | - |
|
| 746 | - } |
|
| 747 | - |
|
| 748 | - /** |
|
| 749 | - * Returns the fees. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - */ |
|
| 753 | - public function get_fee() { |
|
| 754 | - return $this->totals['fees']['initial']; |
|
| 755 | - } |
|
| 756 | - |
|
| 757 | - /** |
|
| 758 | - * Returns the recurring fees. |
|
| 759 | - * |
|
| 760 | - * @since 1.0.19 |
|
| 761 | - */ |
|
| 762 | - public function get_recurring_fee() { |
|
| 763 | - return $this->totals['fees']['recurring']; |
|
| 764 | - } |
|
| 765 | - |
|
| 766 | - /** |
|
| 767 | - * Returns all fees. |
|
| 768 | - * |
|
| 769 | - * @since 1.0.19 |
|
| 770 | - */ |
|
| 771 | - public function get_fees() { |
|
| 772 | - return $this->fees; |
|
| 773 | - } |
|
| 774 | - |
|
| 775 | - /** |
|
| 776 | - * Checks if there are any fees for the form. |
|
| 777 | - * |
|
| 778 | - * @return bool |
|
| 779 | - * @since 1.0.19 |
|
| 780 | - */ |
|
| 781 | - public function has_fees() { |
|
| 782 | - return count( $this->fees ) !== 0; |
|
| 783 | - } |
|
| 784 | - |
|
| 785 | - /* |
|
| 703 | + /** |
|
| 704 | + * Prepares the submission's fees. |
|
| 705 | + * |
|
| 706 | + * @since 1.0.19 |
|
| 707 | + */ |
|
| 708 | + public function process_fees() { |
|
| 709 | + |
|
| 710 | + $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this ); |
|
| 711 | + |
|
| 712 | + foreach ( $fees_processor->fees as $fee ) { |
|
| 713 | + $this->add_fee( $fee ); |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) ); |
|
| 717 | + } |
|
| 718 | + |
|
| 719 | + /** |
|
| 720 | + * Adds a fee to the submission. |
|
| 721 | + * |
|
| 722 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 723 | + * @since 1.0.19 |
|
| 724 | + */ |
|
| 725 | + public function add_fee( $fee ) { |
|
| 726 | + |
|
| 727 | + $this->fees[ $fee['name'] ] = $fee; |
|
| 728 | + $this->totals['fees']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
| 729 | + $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
| 730 | + |
|
| 731 | + } |
|
| 732 | + |
|
| 733 | + /** |
|
| 734 | + * Removes a fee from the submission. |
|
| 735 | + * |
|
| 736 | + * @since 1.0.19 |
|
| 737 | + */ |
|
| 738 | + public function remove_fee( $name ) { |
|
| 739 | + |
|
| 740 | + if ( isset( $this->fees[ $name ] ) ) { |
|
| 741 | + $this->totals['fees']['initial'] -= $this->fees[ $name ]['initial_fee']; |
|
| 742 | + $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee']; |
|
| 743 | + unset( $this->fees[ $name ] ); |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + } |
|
| 747 | + |
|
| 748 | + /** |
|
| 749 | + * Returns the fees. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + */ |
|
| 753 | + public function get_fee() { |
|
| 754 | + return $this->totals['fees']['initial']; |
|
| 755 | + } |
|
| 756 | + |
|
| 757 | + /** |
|
| 758 | + * Returns the recurring fees. |
|
| 759 | + * |
|
| 760 | + * @since 1.0.19 |
|
| 761 | + */ |
|
| 762 | + public function get_recurring_fee() { |
|
| 763 | + return $this->totals['fees']['recurring']; |
|
| 764 | + } |
|
| 765 | + |
|
| 766 | + /** |
|
| 767 | + * Returns all fees. |
|
| 768 | + * |
|
| 769 | + * @since 1.0.19 |
|
| 770 | + */ |
|
| 771 | + public function get_fees() { |
|
| 772 | + return $this->fees; |
|
| 773 | + } |
|
| 774 | + |
|
| 775 | + /** |
|
| 776 | + * Checks if there are any fees for the form. |
|
| 777 | + * |
|
| 778 | + * @return bool |
|
| 779 | + * @since 1.0.19 |
|
| 780 | + */ |
|
| 781 | + public function has_fees() { |
|
| 782 | + return count( $this->fees ) !== 0; |
|
| 783 | + } |
|
| 784 | + |
|
| 785 | + /* |
|
| 786 | 786 | |-------------------------------------------------------------------------- |
| 787 | 787 | | MISC |
| 788 | 788 | |-------------------------------------------------------------------------- |
@@ -790,119 +790,119 @@ discard block |
||
| 790 | 790 | | Extra submission functions. |
| 791 | 791 | */ |
| 792 | 792 | |
| 793 | - /** |
|
| 794 | - * Checks if this is the initial fetch. |
|
| 795 | - * |
|
| 796 | - * @return bool |
|
| 797 | - * @since 1.0.19 |
|
| 798 | - */ |
|
| 799 | - public function is_initial_fetch() { |
|
| 800 | - return empty( $this->data['initial_state'] ); |
|
| 801 | - } |
|
| 802 | - |
|
| 803 | - /** |
|
| 804 | - * Returns the total amount to collect for this submission. |
|
| 805 | - * |
|
| 806 | - * @since 1.0.19 |
|
| 807 | - */ |
|
| 808 | - public function get_total() { |
|
| 809 | - $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() - $this->get_discount(); |
|
| 810 | - return max( $total, 0 ); |
|
| 811 | - } |
|
| 812 | - |
|
| 813 | - /** |
|
| 814 | - * Returns the recurring total amount to collect for this submission. |
|
| 815 | - * |
|
| 816 | - * @since 1.0.19 |
|
| 817 | - */ |
|
| 818 | - public function get_recurring_total() { |
|
| 819 | - $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() - $this->get_recurring_discount(); |
|
| 820 | - return max( $total, 0 ); |
|
| 821 | - } |
|
| 822 | - |
|
| 823 | - /** |
|
| 824 | - * Whether payment details should be collected for this submission. |
|
| 825 | - * |
|
| 826 | - * @since 1.0.19 |
|
| 827 | - */ |
|
| 828 | - public function should_collect_payment_details() { |
|
| 829 | - $initial = $this->get_total(); |
|
| 830 | - $recurring = $this->get_recurring_total(); |
|
| 831 | - |
|
| 832 | - if ( $this->has_recurring == 0 ) { |
|
| 833 | - $recurring = 0; |
|
| 834 | - } |
|
| 835 | - |
|
| 836 | - $collect = $initial > 0 || $recurring > 0; |
|
| 837 | - return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this ); |
|
| 838 | - } |
|
| 839 | - |
|
| 840 | - /** |
|
| 841 | - * Returns the billing email of the user. |
|
| 842 | - * |
|
| 843 | - * @since 1.0.19 |
|
| 844 | - */ |
|
| 845 | - public function get_billing_email() { |
|
| 846 | - return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this ); |
|
| 847 | - } |
|
| 848 | - |
|
| 849 | - /** |
|
| 850 | - * Checks if the submitter has a billing email. |
|
| 851 | - * |
|
| 852 | - * @since 1.0.19 |
|
| 853 | - */ |
|
| 854 | - public function has_billing_email() { |
|
| 855 | - $billing_email = $this->get_billing_email(); |
|
| 856 | - return ! empty( $billing_email ) && is_email( $billing_email ); |
|
| 857 | - } |
|
| 858 | - |
|
| 859 | - /** |
|
| 860 | - * Returns the appropriate currency for the submission. |
|
| 861 | - * |
|
| 862 | - * @since 1.0.19 |
|
| 863 | - * @return string |
|
| 864 | - */ |
|
| 865 | - public function get_currency() { |
|
| 866 | - return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency(); |
|
| 867 | - } |
|
| 868 | - |
|
| 869 | - /** |
|
| 870 | - * Returns the raw submission data. |
|
| 871 | - * |
|
| 872 | - * @since 1.0.19 |
|
| 873 | - * @return array |
|
| 874 | - */ |
|
| 875 | - public function get_data() { |
|
| 876 | - return $this->data; |
|
| 877 | - } |
|
| 878 | - |
|
| 879 | - /** |
|
| 880 | - * Returns a field from the submission data |
|
| 881 | - * |
|
| 882 | - * @param string $field |
|
| 883 | - * @since 1.0.19 |
|
| 884 | - * @return mixed|null |
|
| 885 | - */ |
|
| 886 | - public function get_field( $field, $sub_array_key = null ) { |
|
| 887 | - return getpaid_get_array_field( $this->data, $field, $sub_array_key ); |
|
| 888 | - } |
|
| 889 | - |
|
| 890 | - /** |
|
| 891 | - * Checks if a required field is set. |
|
| 892 | - * |
|
| 893 | - * @since 1.0.19 |
|
| 894 | - */ |
|
| 895 | - public function is_required_field_set( $field ) { |
|
| 896 | - return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] ); |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - /** |
|
| 900 | - * Formats an amount |
|
| 901 | - * |
|
| 902 | - * @since 1.0.19 |
|
| 903 | - */ |
|
| 904 | - public function format_amount( $amount ) { |
|
| 905 | - return wpinv_price( $amount, $this->get_currency() ); |
|
| 906 | - } |
|
| 793 | + /** |
|
| 794 | + * Checks if this is the initial fetch. |
|
| 795 | + * |
|
| 796 | + * @return bool |
|
| 797 | + * @since 1.0.19 |
|
| 798 | + */ |
|
| 799 | + public function is_initial_fetch() { |
|
| 800 | + return empty( $this->data['initial_state'] ); |
|
| 801 | + } |
|
| 802 | + |
|
| 803 | + /** |
|
| 804 | + * Returns the total amount to collect for this submission. |
|
| 805 | + * |
|
| 806 | + * @since 1.0.19 |
|
| 807 | + */ |
|
| 808 | + public function get_total() { |
|
| 809 | + $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() - $this->get_discount(); |
|
| 810 | + return max( $total, 0 ); |
|
| 811 | + } |
|
| 812 | + |
|
| 813 | + /** |
|
| 814 | + * Returns the recurring total amount to collect for this submission. |
|
| 815 | + * |
|
| 816 | + * @since 1.0.19 |
|
| 817 | + */ |
|
| 818 | + public function get_recurring_total() { |
|
| 819 | + $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() - $this->get_recurring_discount(); |
|
| 820 | + return max( $total, 0 ); |
|
| 821 | + } |
|
| 822 | + |
|
| 823 | + /** |
|
| 824 | + * Whether payment details should be collected for this submission. |
|
| 825 | + * |
|
| 826 | + * @since 1.0.19 |
|
| 827 | + */ |
|
| 828 | + public function should_collect_payment_details() { |
|
| 829 | + $initial = $this->get_total(); |
|
| 830 | + $recurring = $this->get_recurring_total(); |
|
| 831 | + |
|
| 832 | + if ( $this->has_recurring == 0 ) { |
|
| 833 | + $recurring = 0; |
|
| 834 | + } |
|
| 835 | + |
|
| 836 | + $collect = $initial > 0 || $recurring > 0; |
|
| 837 | + return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this ); |
|
| 838 | + } |
|
| 839 | + |
|
| 840 | + /** |
|
| 841 | + * Returns the billing email of the user. |
|
| 842 | + * |
|
| 843 | + * @since 1.0.19 |
|
| 844 | + */ |
|
| 845 | + public function get_billing_email() { |
|
| 846 | + return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this ); |
|
| 847 | + } |
|
| 848 | + |
|
| 849 | + /** |
|
| 850 | + * Checks if the submitter has a billing email. |
|
| 851 | + * |
|
| 852 | + * @since 1.0.19 |
|
| 853 | + */ |
|
| 854 | + public function has_billing_email() { |
|
| 855 | + $billing_email = $this->get_billing_email(); |
|
| 856 | + return ! empty( $billing_email ) && is_email( $billing_email ); |
|
| 857 | + } |
|
| 858 | + |
|
| 859 | + /** |
|
| 860 | + * Returns the appropriate currency for the submission. |
|
| 861 | + * |
|
| 862 | + * @since 1.0.19 |
|
| 863 | + * @return string |
|
| 864 | + */ |
|
| 865 | + public function get_currency() { |
|
| 866 | + return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency(); |
|
| 867 | + } |
|
| 868 | + |
|
| 869 | + /** |
|
| 870 | + * Returns the raw submission data. |
|
| 871 | + * |
|
| 872 | + * @since 1.0.19 |
|
| 873 | + * @return array |
|
| 874 | + */ |
|
| 875 | + public function get_data() { |
|
| 876 | + return $this->data; |
|
| 877 | + } |
|
| 878 | + |
|
| 879 | + /** |
|
| 880 | + * Returns a field from the submission data |
|
| 881 | + * |
|
| 882 | + * @param string $field |
|
| 883 | + * @since 1.0.19 |
|
| 884 | + * @return mixed|null |
|
| 885 | + */ |
|
| 886 | + public function get_field( $field, $sub_array_key = null ) { |
|
| 887 | + return getpaid_get_array_field( $this->data, $field, $sub_array_key ); |
|
| 888 | + } |
|
| 889 | + |
|
| 890 | + /** |
|
| 891 | + * Checks if a required field is set. |
|
| 892 | + * |
|
| 893 | + * @since 1.0.19 |
|
| 894 | + */ |
|
| 895 | + public function is_required_field_set( $field ) { |
|
| 896 | + return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] ); |
|
| 897 | + } |
|
| 898 | + |
|
| 899 | + /** |
|
| 900 | + * Formats an amount |
|
| 901 | + * |
|
| 902 | + * @since 1.0.19 |
|
| 903 | + */ |
|
| 904 | + public function format_amount( $amount ) { |
|
| 905 | + return wpinv_price( $amount, $this->get_currency() ); |
|
| 906 | + } |
|
| 907 | 907 | |
| 908 | 908 | } |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | /** |
@@ -10,30 +10,30 @@ discard block |
||
| 10 | 10 | class WPInv_Item extends GetPaid_Data { |
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | - * Which data store to load. |
|
| 14 | - * |
|
| 15 | - * @var string |
|
| 16 | - */ |
|
| 13 | + * Which data store to load. |
|
| 14 | + * |
|
| 15 | + * @var string |
|
| 16 | + */ |
|
| 17 | 17 | protected $data_store_name = 'item'; |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * This is the name of this object type. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - protected $object_type = 'item'; |
|
| 20 | + * This is the name of this object type. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + protected $object_type = 'item'; |
|
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | - * |
|
| 29 | - * @since 1.0.19 |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 32 | - protected $data = array( |
|
| 33 | - 'parent_id' => 0, |
|
| 34 | - 'status' => 'draft', |
|
| 35 | - 'version' => '', |
|
| 36 | - 'date_created' => null, |
|
| 27 | + * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | + * |
|
| 29 | + * @since 1.0.19 |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | + protected $data = array( |
|
| 33 | + 'parent_id' => 0, |
|
| 34 | + 'status' => 'draft', |
|
| 35 | + 'version' => '', |
|
| 36 | + 'date_created' => null, |
|
| 37 | 37 | 'date_modified' => null, |
| 38 | 38 | 'name' => '', |
| 39 | 39 | 'description' => '', |
@@ -58,13 +58,13 @@ discard block |
||
| 58 | 58 | ); |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | - * Stores meta in cache for future reads. |
|
| 62 | - * |
|
| 63 | - * A group must be set to to enable caching. |
|
| 64 | - * |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 67 | - protected $cache_group = 'getpaid_items'; |
|
| 61 | + * Stores meta in cache for future reads. |
|
| 62 | + * |
|
| 63 | + * A group must be set to to enable caching. |
|
| 64 | + * |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | + protected $cache_group = 'getpaid_items'; |
|
| 68 | 68 | |
| 69 | 69 | /** |
| 70 | 70 | * Stores a reference to the original WP_Post object |
@@ -74,37 +74,37 @@ discard block |
||
| 74 | 74 | protected $post = null; |
| 75 | 75 | |
| 76 | 76 | /** |
| 77 | - * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | - * |
|
| 79 | - * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | - */ |
|
| 81 | - public function __construct( $item = 0 ) { |
|
| 82 | - parent::__construct( $item ); |
|
| 83 | - |
|
| 84 | - if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | - $this->set_id( $item ); |
|
| 86 | - } elseif ( $item instanceof self ) { |
|
| 87 | - $this->set_id( $item->get_id() ); |
|
| 88 | - } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | - $this->set_id( $item->ID ); |
|
| 90 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | - $this->set_id( $item_id ); |
|
| 92 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | - $this->set_id( $item_id ); |
|
| 94 | - } else { |
|
| 95 | - $this->set_object_read( true ); |
|
| 96 | - } |
|
| 77 | + * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | + * |
|
| 79 | + * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | + */ |
|
| 81 | + public function __construct( $item = 0 ) { |
|
| 82 | + parent::__construct( $item ); |
|
| 83 | + |
|
| 84 | + if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | + $this->set_id( $item ); |
|
| 86 | + } elseif ( $item instanceof self ) { |
|
| 87 | + $this->set_id( $item->get_id() ); |
|
| 88 | + } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | + $this->set_id( $item->ID ); |
|
| 90 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | + $this->set_id( $item_id ); |
|
| 92 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | + $this->set_id( $item_id ); |
|
| 94 | + } else { |
|
| 95 | + $this->set_object_read( true ); |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | 98 | // Load the datastore. |
| 99 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 99 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 100 | 100 | |
| 101 | - if ( $this->get_id() > 0 ) { |
|
| 101 | + if ( $this->get_id() > 0 ) { |
|
| 102 | 102 | $this->post = get_post( $this->get_id() ); |
| 103 | 103 | $this->ID = $this->get_id(); |
| 104 | - $this->data_store->read( $this ); |
|
| 104 | + $this->data_store->read( $this ); |
|
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - } |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | 109 | /* |
| 110 | 110 | |-------------------------------------------------------------------------- |
@@ -122,401 +122,401 @@ discard block |
||
| 122 | 122 | */ |
| 123 | 123 | |
| 124 | 124 | /** |
| 125 | - * Get parent item ID. |
|
| 126 | - * |
|
| 127 | - * @since 1.0.19 |
|
| 128 | - * @param string $context View or edit context. |
|
| 129 | - * @return int |
|
| 130 | - */ |
|
| 131 | - public function get_parent_id( $context = 'view' ) { |
|
| 132 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
| 125 | + * Get parent item ID. |
|
| 126 | + * |
|
| 127 | + * @since 1.0.19 |
|
| 128 | + * @param string $context View or edit context. |
|
| 129 | + * @return int |
|
| 130 | + */ |
|
| 131 | + public function get_parent_id( $context = 'view' ) { |
|
| 132 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | 135 | /** |
| 136 | - * Get item status. |
|
| 137 | - * |
|
| 138 | - * @since 1.0.19 |
|
| 139 | - * @param string $context View or edit context. |
|
| 140 | - * @return string |
|
| 141 | - */ |
|
| 142 | - public function get_status( $context = 'view' ) { |
|
| 143 | - return $this->get_prop( 'status', $context ); |
|
| 136 | + * Get item status. |
|
| 137 | + * |
|
| 138 | + * @since 1.0.19 |
|
| 139 | + * @param string $context View or edit context. |
|
| 140 | + * @return string |
|
| 141 | + */ |
|
| 142 | + public function get_status( $context = 'view' ) { |
|
| 143 | + return $this->get_prop( 'status', $context ); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | /** |
| 147 | - * Get plugin version when the item was created. |
|
| 148 | - * |
|
| 149 | - * @since 1.0.19 |
|
| 150 | - * @param string $context View or edit context. |
|
| 151 | - * @return string |
|
| 152 | - */ |
|
| 153 | - public function get_version( $context = 'view' ) { |
|
| 154 | - return $this->get_prop( 'version', $context ); |
|
| 147 | + * Get plugin version when the item was created. |
|
| 148 | + * |
|
| 149 | + * @since 1.0.19 |
|
| 150 | + * @param string $context View or edit context. |
|
| 151 | + * @return string |
|
| 152 | + */ |
|
| 153 | + public function get_version( $context = 'view' ) { |
|
| 154 | + return $this->get_prop( 'version', $context ); |
|
| 155 | 155 | } |
| 156 | 156 | |
| 157 | 157 | /** |
| 158 | - * Get date when the item was created. |
|
| 159 | - * |
|
| 160 | - * @since 1.0.19 |
|
| 161 | - * @param string $context View or edit context. |
|
| 162 | - * @return string |
|
| 163 | - */ |
|
| 164 | - public function get_date_created( $context = 'view' ) { |
|
| 165 | - return $this->get_prop( 'date_created', $context ); |
|
| 158 | + * Get date when the item was created. |
|
| 159 | + * |
|
| 160 | + * @since 1.0.19 |
|
| 161 | + * @param string $context View or edit context. |
|
| 162 | + * @return string |
|
| 163 | + */ |
|
| 164 | + public function get_date_created( $context = 'view' ) { |
|
| 165 | + return $this->get_prop( 'date_created', $context ); |
|
| 166 | 166 | } |
| 167 | 167 | |
| 168 | 168 | /** |
| 169 | - * Get GMT date when the item was created. |
|
| 170 | - * |
|
| 171 | - * @since 1.0.19 |
|
| 172 | - * @param string $context View or edit context. |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 169 | + * Get GMT date when the item was created. |
|
| 170 | + * |
|
| 171 | + * @since 1.0.19 |
|
| 172 | + * @param string $context View or edit context. |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 176 | 176 | $date = $this->get_date_created( $context ); |
| 177 | 177 | |
| 178 | 178 | if ( $date ) { |
| 179 | 179 | $date = get_gmt_from_date( $date ); |
| 180 | 180 | } |
| 181 | - return $date; |
|
| 181 | + return $date; |
|
| 182 | 182 | } |
| 183 | 183 | |
| 184 | 184 | /** |
| 185 | - * Get date when the item was last modified. |
|
| 186 | - * |
|
| 187 | - * @since 1.0.19 |
|
| 188 | - * @param string $context View or edit context. |
|
| 189 | - * @return string |
|
| 190 | - */ |
|
| 191 | - public function get_date_modified( $context = 'view' ) { |
|
| 192 | - return $this->get_prop( 'date_modified', $context ); |
|
| 185 | + * Get date when the item was last modified. |
|
| 186 | + * |
|
| 187 | + * @since 1.0.19 |
|
| 188 | + * @param string $context View or edit context. |
|
| 189 | + * @return string |
|
| 190 | + */ |
|
| 191 | + public function get_date_modified( $context = 'view' ) { |
|
| 192 | + return $this->get_prop( 'date_modified', $context ); |
|
| 193 | 193 | } |
| 194 | 194 | |
| 195 | 195 | /** |
| 196 | - * Get GMT date when the item was last modified. |
|
| 197 | - * |
|
| 198 | - * @since 1.0.19 |
|
| 199 | - * @param string $context View or edit context. |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 196 | + * Get GMT date when the item was last modified. |
|
| 197 | + * |
|
| 198 | + * @since 1.0.19 |
|
| 199 | + * @param string $context View or edit context. |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 203 | 203 | $date = $this->get_date_modified( $context ); |
| 204 | 204 | |
| 205 | 205 | if ( $date ) { |
| 206 | 206 | $date = get_gmt_from_date( $date ); |
| 207 | 207 | } |
| 208 | - return $date; |
|
| 208 | + return $date; |
|
| 209 | 209 | } |
| 210 | 210 | |
| 211 | 211 | /** |
| 212 | - * Get the item name. |
|
| 213 | - * |
|
| 214 | - * @since 1.0.19 |
|
| 215 | - * @param string $context View or edit context. |
|
| 216 | - * @return string |
|
| 217 | - */ |
|
| 218 | - public function get_name( $context = 'view' ) { |
|
| 219 | - return $this->get_prop( 'name', $context ); |
|
| 212 | + * Get the item name. |
|
| 213 | + * |
|
| 214 | + * @since 1.0.19 |
|
| 215 | + * @param string $context View or edit context. |
|
| 216 | + * @return string |
|
| 217 | + */ |
|
| 218 | + public function get_name( $context = 'view' ) { |
|
| 219 | + return $this->get_prop( 'name', $context ); |
|
| 220 | 220 | } |
| 221 | 221 | |
| 222 | 222 | /** |
| 223 | - * Alias of self::get_name(). |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * @param string $context View or edit context. |
|
| 227 | - * @return string |
|
| 228 | - */ |
|
| 229 | - public function get_title( $context = 'view' ) { |
|
| 230 | - return $this->get_name( $context ); |
|
| 223 | + * Alias of self::get_name(). |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * @param string $context View or edit context. |
|
| 227 | + * @return string |
|
| 228 | + */ |
|
| 229 | + public function get_title( $context = 'view' ) { |
|
| 230 | + return $this->get_name( $context ); |
|
| 231 | 231 | } |
| 232 | 232 | |
| 233 | 233 | /** |
| 234 | - * Get the item description. |
|
| 235 | - * |
|
| 236 | - * @since 1.0.19 |
|
| 237 | - * @param string $context View or edit context. |
|
| 238 | - * @return string |
|
| 239 | - */ |
|
| 240 | - public function get_description( $context = 'view' ) { |
|
| 241 | - return $this->get_prop( 'description', $context ); |
|
| 234 | + * Get the item description. |
|
| 235 | + * |
|
| 236 | + * @since 1.0.19 |
|
| 237 | + * @param string $context View or edit context. |
|
| 238 | + * @return string |
|
| 239 | + */ |
|
| 240 | + public function get_description( $context = 'view' ) { |
|
| 241 | + return $this->get_prop( 'description', $context ); |
|
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | /** |
| 245 | - * Alias of self::get_description(). |
|
| 246 | - * |
|
| 247 | - * @since 1.0.19 |
|
| 248 | - * @param string $context View or edit context. |
|
| 249 | - * @return string |
|
| 250 | - */ |
|
| 251 | - public function get_excerpt( $context = 'view' ) { |
|
| 252 | - return $this->get_description( $context ); |
|
| 245 | + * Alias of self::get_description(). |
|
| 246 | + * |
|
| 247 | + * @since 1.0.19 |
|
| 248 | + * @param string $context View or edit context. |
|
| 249 | + * @return string |
|
| 250 | + */ |
|
| 251 | + public function get_excerpt( $context = 'view' ) { |
|
| 252 | + return $this->get_description( $context ); |
|
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | /** |
| 256 | - * Alias of self::get_description(). |
|
| 257 | - * |
|
| 258 | - * @since 1.0.19 |
|
| 259 | - * @param string $context View or edit context. |
|
| 260 | - * @return string |
|
| 261 | - */ |
|
| 262 | - public function get_summary( $context = 'view' ) { |
|
| 263 | - return $this->get_description( $context ); |
|
| 256 | + * Alias of self::get_description(). |
|
| 257 | + * |
|
| 258 | + * @since 1.0.19 |
|
| 259 | + * @param string $context View or edit context. |
|
| 260 | + * @return string |
|
| 261 | + */ |
|
| 262 | + public function get_summary( $context = 'view' ) { |
|
| 263 | + return $this->get_description( $context ); |
|
| 264 | 264 | } |
| 265 | 265 | |
| 266 | 266 | /** |
| 267 | - * Get the owner of the item. |
|
| 268 | - * |
|
| 269 | - * @since 1.0.19 |
|
| 270 | - * @param string $context View or edit context. |
|
| 271 | - * @return int |
|
| 272 | - */ |
|
| 273 | - public function get_author( $context = 'view' ) { |
|
| 274 | - return (int) $this->get_prop( 'author', $context ); |
|
| 275 | - } |
|
| 267 | + * Get the owner of the item. |
|
| 268 | + * |
|
| 269 | + * @since 1.0.19 |
|
| 270 | + * @param string $context View or edit context. |
|
| 271 | + * @return int |
|
| 272 | + */ |
|
| 273 | + public function get_author( $context = 'view' ) { |
|
| 274 | + return (int) $this->get_prop( 'author', $context ); |
|
| 275 | + } |
|
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * Alias of self::get_author(). |
|
| 279 | - * |
|
| 280 | - * @since 1.0.19 |
|
| 281 | - * @param string $context View or edit context. |
|
| 282 | - * @return int |
|
| 283 | - */ |
|
| 284 | - public function get_owner( $context = 'view' ) { |
|
| 285 | - return $this->get_author( $context ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Get the price of the item. |
|
| 290 | - * |
|
| 291 | - * @since 1.0.19 |
|
| 292 | - * @param string $context View or edit context. |
|
| 293 | - * @return float |
|
| 294 | - */ |
|
| 295 | - public function get_price( $context = 'view' ) { |
|
| 277 | + /** |
|
| 278 | + * Alias of self::get_author(). |
|
| 279 | + * |
|
| 280 | + * @since 1.0.19 |
|
| 281 | + * @param string $context View or edit context. |
|
| 282 | + * @return int |
|
| 283 | + */ |
|
| 284 | + public function get_owner( $context = 'view' ) { |
|
| 285 | + return $this->get_author( $context ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Get the price of the item. |
|
| 290 | + * |
|
| 291 | + * @since 1.0.19 |
|
| 292 | + * @param string $context View or edit context. |
|
| 293 | + * @return float |
|
| 294 | + */ |
|
| 295 | + public function get_price( $context = 'view' ) { |
|
| 296 | 296 | return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) ); |
| 297 | - } |
|
| 297 | + } |
|
| 298 | 298 | |
| 299 | - /** |
|
| 300 | - * Get the inital price of the item. |
|
| 301 | - * |
|
| 302 | - * @since 1.0.19 |
|
| 303 | - * @param string $context View or edit context. |
|
| 304 | - * @return float |
|
| 305 | - */ |
|
| 306 | - public function get_initial_price( $context = 'view' ) { |
|
| 299 | + /** |
|
| 300 | + * Get the inital price of the item. |
|
| 301 | + * |
|
| 302 | + * @since 1.0.19 |
|
| 303 | + * @param string $context View or edit context. |
|
| 304 | + * @return float |
|
| 305 | + */ |
|
| 306 | + public function get_initial_price( $context = 'view' ) { |
|
| 307 | 307 | |
| 308 | - $price = (float) $this->get_price( $context ); |
|
| 308 | + $price = (float) $this->get_price( $context ); |
|
| 309 | 309 | |
| 310 | - if ( $this->has_free_trial() ) { |
|
| 311 | - $price = 0; |
|
| 312 | - } |
|
| 310 | + if ( $this->has_free_trial() ) { |
|
| 311 | + $price = 0; |
|
| 312 | + } |
|
| 313 | 313 | |
| 314 | 314 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) ); |
| 315 | 315 | } |
| 316 | 316 | |
| 317 | 317 | /** |
| 318 | - * Returns a formated price. |
|
| 319 | - * |
|
| 320 | - * @since 1.0.19 |
|
| 321 | - * @param string $context View or edit context. |
|
| 322 | - * @return string |
|
| 323 | - */ |
|
| 318 | + * Returns a formated price. |
|
| 319 | + * |
|
| 320 | + * @since 1.0.19 |
|
| 321 | + * @param string $context View or edit context. |
|
| 322 | + * @return string |
|
| 323 | + */ |
|
| 324 | 324 | public function get_the_price() { |
| 325 | 325 | return wpinv_price( $this->get_price() ); |
| 326 | - } |
|
| 327 | - |
|
| 328 | - /** |
|
| 329 | - * Returns the formated initial price. |
|
| 330 | - * |
|
| 331 | - * @since 1.0.19 |
|
| 332 | - * @param string $context View or edit context. |
|
| 333 | - * @return string |
|
| 334 | - */ |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + /** |
|
| 329 | + * Returns the formated initial price. |
|
| 330 | + * |
|
| 331 | + * @since 1.0.19 |
|
| 332 | + * @param string $context View or edit context. |
|
| 333 | + * @return string |
|
| 334 | + */ |
|
| 335 | 335 | public function get_the_initial_price() { |
| 336 | 336 | return wpinv_price( $this->get_initial_price() ); |
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | /** |
| 340 | - * Get the VAT rule of the item. |
|
| 341 | - * |
|
| 342 | - * @since 1.0.19 |
|
| 343 | - * @param string $context View or edit context. |
|
| 344 | - * @return string |
|
| 345 | - */ |
|
| 346 | - public function get_vat_rule( $context = 'view' ) { |
|
| 340 | + * Get the VAT rule of the item. |
|
| 341 | + * |
|
| 342 | + * @since 1.0.19 |
|
| 343 | + * @param string $context View or edit context. |
|
| 344 | + * @return string |
|
| 345 | + */ |
|
| 346 | + public function get_vat_rule( $context = 'view' ) { |
|
| 347 | 347 | return $this->get_prop( 'vat_rule', $context ); |
| 348 | 348 | } |
| 349 | 349 | |
| 350 | 350 | /** |
| 351 | - * Get the VAT class of the item. |
|
| 352 | - * |
|
| 353 | - * @since 1.0.19 |
|
| 354 | - * @param string $context View or edit context. |
|
| 355 | - * @return string |
|
| 356 | - */ |
|
| 357 | - public function get_vat_class( $context = 'view' ) { |
|
| 351 | + * Get the VAT class of the item. |
|
| 352 | + * |
|
| 353 | + * @since 1.0.19 |
|
| 354 | + * @param string $context View or edit context. |
|
| 355 | + * @return string |
|
| 356 | + */ |
|
| 357 | + public function get_vat_class( $context = 'view' ) { |
|
| 358 | 358 | return $this->get_prop( 'vat_class', $context ); |
| 359 | 359 | } |
| 360 | 360 | |
| 361 | 361 | /** |
| 362 | - * Get the type of the item. |
|
| 363 | - * |
|
| 364 | - * @since 1.0.19 |
|
| 365 | - * @param string $context View or edit context. |
|
| 366 | - * @return string |
|
| 367 | - */ |
|
| 368 | - public function get_type( $context = 'view' ) { |
|
| 362 | + * Get the type of the item. |
|
| 363 | + * |
|
| 364 | + * @since 1.0.19 |
|
| 365 | + * @param string $context View or edit context. |
|
| 366 | + * @return string |
|
| 367 | + */ |
|
| 368 | + public function get_type( $context = 'view' ) { |
|
| 369 | 369 | return $this->get_prop( 'type', $context ); |
| 370 | 370 | } |
| 371 | 371 | |
| 372 | 372 | /** |
| 373 | - * Get the custom id of the item. |
|
| 374 | - * |
|
| 375 | - * @since 1.0.19 |
|
| 376 | - * @param string $context View or edit context. |
|
| 377 | - * @return string |
|
| 378 | - */ |
|
| 379 | - public function get_custom_id( $context = 'view' ) { |
|
| 373 | + * Get the custom id of the item. |
|
| 374 | + * |
|
| 375 | + * @since 1.0.19 |
|
| 376 | + * @param string $context View or edit context. |
|
| 377 | + * @return string |
|
| 378 | + */ |
|
| 379 | + public function get_custom_id( $context = 'view' ) { |
|
| 380 | 380 | return $this->get_prop( 'custom_id', $context ); |
| 381 | 381 | } |
| 382 | 382 | |
| 383 | 383 | /** |
| 384 | - * Get the custom name of the item. |
|
| 385 | - * |
|
| 386 | - * @since 1.0.19 |
|
| 387 | - * @param string $context View or edit context. |
|
| 388 | - * @return string |
|
| 389 | - */ |
|
| 390 | - public function get_custom_name( $context = 'view' ) { |
|
| 384 | + * Get the custom name of the item. |
|
| 385 | + * |
|
| 386 | + * @since 1.0.19 |
|
| 387 | + * @param string $context View or edit context. |
|
| 388 | + * @return string |
|
| 389 | + */ |
|
| 390 | + public function get_custom_name( $context = 'view' ) { |
|
| 391 | 391 | return $this->get_prop( 'custom_name', $context ); |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | 394 | /** |
| 395 | - * Get the custom singular name of the item. |
|
| 396 | - * |
|
| 397 | - * @since 1.0.19 |
|
| 398 | - * @param string $context View or edit context. |
|
| 399 | - * @return string |
|
| 400 | - */ |
|
| 401 | - public function get_custom_singular_name( $context = 'view' ) { |
|
| 395 | + * Get the custom singular name of the item. |
|
| 396 | + * |
|
| 397 | + * @since 1.0.19 |
|
| 398 | + * @param string $context View or edit context. |
|
| 399 | + * @return string |
|
| 400 | + */ |
|
| 401 | + public function get_custom_singular_name( $context = 'view' ) { |
|
| 402 | 402 | return $this->get_prop( 'custom_singular_name', $context ); |
| 403 | 403 | } |
| 404 | 404 | |
| 405 | 405 | /** |
| 406 | - * Checks if an item is editable.. |
|
| 407 | - * |
|
| 408 | - * @since 1.0.19 |
|
| 409 | - * @param string $context View or edit context. |
|
| 410 | - * @return int |
|
| 411 | - */ |
|
| 412 | - public function get_is_editable( $context = 'view' ) { |
|
| 406 | + * Checks if an item is editable.. |
|
| 407 | + * |
|
| 408 | + * @since 1.0.19 |
|
| 409 | + * @param string $context View or edit context. |
|
| 410 | + * @return int |
|
| 411 | + */ |
|
| 412 | + public function get_is_editable( $context = 'view' ) { |
|
| 413 | 413 | return (int) $this->get_prop( 'is_editable', $context ); |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | 416 | /** |
| 417 | - * Alias of self::get_is_editable(). |
|
| 418 | - * |
|
| 419 | - * @since 1.0.19 |
|
| 420 | - * @param string $context View or edit context. |
|
| 421 | - * @return int |
|
| 422 | - */ |
|
| 423 | - public function get_editable( $context = 'view' ) { |
|
| 424 | - return $this->get_is_editable( $context ); |
|
| 417 | + * Alias of self::get_is_editable(). |
|
| 418 | + * |
|
| 419 | + * @since 1.0.19 |
|
| 420 | + * @param string $context View or edit context. |
|
| 421 | + * @return int |
|
| 422 | + */ |
|
| 423 | + public function get_editable( $context = 'view' ) { |
|
| 424 | + return $this->get_is_editable( $context ); |
|
| 425 | 425 | } |
| 426 | 426 | |
| 427 | 427 | /** |
| 428 | - * Checks if dynamic pricing is enabled. |
|
| 429 | - * |
|
| 430 | - * @since 1.0.19 |
|
| 431 | - * @param string $context View or edit context. |
|
| 432 | - * @return int |
|
| 433 | - */ |
|
| 434 | - public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 428 | + * Checks if dynamic pricing is enabled. |
|
| 429 | + * |
|
| 430 | + * @since 1.0.19 |
|
| 431 | + * @param string $context View or edit context. |
|
| 432 | + * @return int |
|
| 433 | + */ |
|
| 434 | + public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 435 | 435 | return (int) $this->get_prop( 'is_dynamic_pricing', $context ); |
| 436 | 436 | } |
| 437 | 437 | |
| 438 | 438 | /** |
| 439 | - * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | - * |
|
| 441 | - * @since 1.0.19 |
|
| 442 | - * @param string $context View or edit context. |
|
| 443 | - * @return float |
|
| 444 | - */ |
|
| 445 | - public function get_minimum_price( $context = 'view' ) { |
|
| 439 | + * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | + * |
|
| 441 | + * @since 1.0.19 |
|
| 442 | + * @param string $context View or edit context. |
|
| 443 | + * @return float |
|
| 444 | + */ |
|
| 445 | + public function get_minimum_price( $context = 'view' ) { |
|
| 446 | 446 | return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) ); |
| 447 | 447 | } |
| 448 | 448 | |
| 449 | 449 | /** |
| 450 | - * Checks if this is a recurring item. |
|
| 451 | - * |
|
| 452 | - * @since 1.0.19 |
|
| 453 | - * @param string $context View or edit context. |
|
| 454 | - * @return int |
|
| 455 | - */ |
|
| 456 | - public function get_is_recurring( $context = 'view' ) { |
|
| 450 | + * Checks if this is a recurring item. |
|
| 451 | + * |
|
| 452 | + * @since 1.0.19 |
|
| 453 | + * @param string $context View or edit context. |
|
| 454 | + * @return int |
|
| 455 | + */ |
|
| 456 | + public function get_is_recurring( $context = 'view' ) { |
|
| 457 | 457 | return (int) $this->get_prop( 'is_recurring', $context ); |
| 458 | - } |
|
| 458 | + } |
|
| 459 | 459 | |
| 460 | - /** |
|
| 461 | - * Get the recurring price of the item. |
|
| 462 | - * |
|
| 463 | - * @since 1.0.19 |
|
| 464 | - * @param string $context View or edit context. |
|
| 465 | - * @return float |
|
| 466 | - */ |
|
| 467 | - public function get_recurring_price( $context = 'view' ) { |
|
| 468 | - $price = $this->get_price( $context ); |
|
| 460 | + /** |
|
| 461 | + * Get the recurring price of the item. |
|
| 462 | + * |
|
| 463 | + * @since 1.0.19 |
|
| 464 | + * @param string $context View or edit context. |
|
| 465 | + * @return float |
|
| 466 | + */ |
|
| 467 | + public function get_recurring_price( $context = 'view' ) { |
|
| 468 | + $price = $this->get_price( $context ); |
|
| 469 | 469 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) ); |
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * Get the formatted recurring price of the item. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return string |
|
| 478 | - */ |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * Get the formatted recurring price of the item. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return string |
|
| 478 | + */ |
|
| 479 | 479 | public function get_the_recurring_price() { |
| 480 | 480 | return wpinv_price( $this->get_recurring_price() ); |
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the first renewal date (in timestamps) of the item. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return int |
|
| 488 | - */ |
|
| 489 | - public function get_first_renewal_date() { |
|
| 490 | - |
|
| 491 | - $periods = array( |
|
| 492 | - 'D' => 'days', |
|
| 493 | - 'W' => 'weeks', |
|
| 494 | - 'M' => 'months', |
|
| 495 | - 'Y' => 'years', |
|
| 496 | - ); |
|
| 497 | - |
|
| 498 | - $period = $this->get_recurring_period(); |
|
| 499 | - $interval = $this->get_recurring_interval(); |
|
| 500 | - |
|
| 501 | - if ( $this->has_free_trial() ) { |
|
| 502 | - $period = $this->get_trial_period(); |
|
| 503 | - $interval = $this->get_trial_interval(); |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - $period = $periods[ $period ]; |
|
| 507 | - $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | - $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the first renewal date (in timestamps) of the item. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return int |
|
| 488 | + */ |
|
| 489 | + public function get_first_renewal_date() { |
|
| 490 | + |
|
| 491 | + $periods = array( |
|
| 492 | + 'D' => 'days', |
|
| 493 | + 'W' => 'weeks', |
|
| 494 | + 'M' => 'months', |
|
| 495 | + 'Y' => 'years', |
|
| 496 | + ); |
|
| 497 | + |
|
| 498 | + $period = $this->get_recurring_period(); |
|
| 499 | + $interval = $this->get_recurring_interval(); |
|
| 500 | + |
|
| 501 | + if ( $this->has_free_trial() ) { |
|
| 502 | + $period = $this->get_trial_period(); |
|
| 503 | + $interval = $this->get_trial_interval(); |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + $period = $periods[ $period ]; |
|
| 507 | + $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | + $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 509 | 509 | return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this ); |
| 510 | 510 | } |
| 511 | 511 | |
| 512 | 512 | /** |
| 513 | - * Get the recurring period. |
|
| 514 | - * |
|
| 515 | - * @since 1.0.19 |
|
| 516 | - * @param bool $full Return abbreviation or in full. |
|
| 517 | - * @return string |
|
| 518 | - */ |
|
| 519 | - public function get_recurring_period( $full = false ) { |
|
| 513 | + * Get the recurring period. |
|
| 514 | + * |
|
| 515 | + * @since 1.0.19 |
|
| 516 | + * @param bool $full Return abbreviation or in full. |
|
| 517 | + * @return string |
|
| 518 | + */ |
|
| 519 | + public function get_recurring_period( $full = false ) { |
|
| 520 | 520 | $period = $this->get_prop( 'recurring_period', 'view' ); |
| 521 | 521 | |
| 522 | 522 | if ( $full && ! is_bool( $full ) ) { |
@@ -527,58 +527,58 @@ discard block |
||
| 527 | 527 | } |
| 528 | 528 | |
| 529 | 529 | /** |
| 530 | - * Get the recurring interval. |
|
| 531 | - * |
|
| 532 | - * @since 1.0.19 |
|
| 533 | - * @param string $context View or edit context. |
|
| 534 | - * @return int |
|
| 535 | - */ |
|
| 536 | - public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | - $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 538 | - return max( 1, $interval ); |
|
| 530 | + * Get the recurring interval. |
|
| 531 | + * |
|
| 532 | + * @since 1.0.19 |
|
| 533 | + * @param string $context View or edit context. |
|
| 534 | + * @return int |
|
| 535 | + */ |
|
| 536 | + public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | + $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 538 | + return max( 1, $interval ); |
|
| 539 | 539 | } |
| 540 | 540 | |
| 541 | 541 | /** |
| 542 | - * Get the recurring limit. |
|
| 543 | - * |
|
| 544 | - * @since 1.0.19 |
|
| 545 | - * @param string $context View or edit context. |
|
| 546 | - * @return int |
|
| 547 | - */ |
|
| 548 | - public function get_recurring_limit( $context = 'view' ) { |
|
| 542 | + * Get the recurring limit. |
|
| 543 | + * |
|
| 544 | + * @since 1.0.19 |
|
| 545 | + * @param string $context View or edit context. |
|
| 546 | + * @return int |
|
| 547 | + */ |
|
| 548 | + public function get_recurring_limit( $context = 'view' ) { |
|
| 549 | 549 | return (int) $this->get_prop( 'recurring_limit', $context ); |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | 552 | /** |
| 553 | - * Checks if we have a free trial. |
|
| 554 | - * |
|
| 555 | - * @since 1.0.19 |
|
| 556 | - * @param string $context View or edit context. |
|
| 557 | - * @return int |
|
| 558 | - */ |
|
| 559 | - public function get_is_free_trial( $context = 'view' ) { |
|
| 553 | + * Checks if we have a free trial. |
|
| 554 | + * |
|
| 555 | + * @since 1.0.19 |
|
| 556 | + * @param string $context View or edit context. |
|
| 557 | + * @return int |
|
| 558 | + */ |
|
| 559 | + public function get_is_free_trial( $context = 'view' ) { |
|
| 560 | 560 | return (int) $this->get_prop( 'is_free_trial', $context ); |
| 561 | 561 | } |
| 562 | 562 | |
| 563 | 563 | /** |
| 564 | - * Alias for self::get_is_free_trial(). |
|
| 565 | - * |
|
| 566 | - * @since 1.0.19 |
|
| 567 | - * @param string $context View or edit context. |
|
| 568 | - * @return int |
|
| 569 | - */ |
|
| 570 | - public function get_free_trial( $context = 'view' ) { |
|
| 564 | + * Alias for self::get_is_free_trial(). |
|
| 565 | + * |
|
| 566 | + * @since 1.0.19 |
|
| 567 | + * @param string $context View or edit context. |
|
| 568 | + * @return int |
|
| 569 | + */ |
|
| 570 | + public function get_free_trial( $context = 'view' ) { |
|
| 571 | 571 | return $this->get_is_free_trial( $context ); |
| 572 | 572 | } |
| 573 | 573 | |
| 574 | 574 | /** |
| 575 | - * Get the trial period. |
|
| 576 | - * |
|
| 577 | - * @since 1.0.19 |
|
| 578 | - * @param bool $full Return abbreviation or in full. |
|
| 579 | - * @return string |
|
| 580 | - */ |
|
| 581 | - public function get_trial_period( $full = false ) { |
|
| 575 | + * Get the trial period. |
|
| 576 | + * |
|
| 577 | + * @since 1.0.19 |
|
| 578 | + * @param bool $full Return abbreviation or in full. |
|
| 579 | + * @return string |
|
| 580 | + */ |
|
| 581 | + public function get_trial_period( $full = false ) { |
|
| 582 | 582 | $period = $this->get_prop( 'trial_period', 'view' ); |
| 583 | 583 | |
| 584 | 584 | if ( $full && ! is_bool( $full ) ) { |
@@ -589,104 +589,104 @@ discard block |
||
| 589 | 589 | } |
| 590 | 590 | |
| 591 | 591 | /** |
| 592 | - * Get the trial interval. |
|
| 593 | - * |
|
| 594 | - * @since 1.0.19 |
|
| 595 | - * @param string $context View or edit context. |
|
| 596 | - * @return int |
|
| 597 | - */ |
|
| 598 | - public function get_trial_interval( $context = 'view' ) { |
|
| 592 | + * Get the trial interval. |
|
| 593 | + * |
|
| 594 | + * @since 1.0.19 |
|
| 595 | + * @param string $context View or edit context. |
|
| 596 | + * @return int |
|
| 597 | + */ |
|
| 598 | + public function get_trial_interval( $context = 'view' ) { |
|
| 599 | 599 | return (int) $this->get_prop( 'trial_interval', $context ); |
| 600 | - } |
|
| 600 | + } |
|
| 601 | 601 | |
| 602 | - /** |
|
| 603 | - * Get the item's edit url. |
|
| 604 | - * |
|
| 605 | - * @since 1.0.19 |
|
| 606 | - * @return string |
|
| 607 | - */ |
|
| 608 | - public function get_edit_url() { |
|
| 602 | + /** |
|
| 603 | + * Get the item's edit url. |
|
| 604 | + * |
|
| 605 | + * @since 1.0.19 |
|
| 606 | + * @return string |
|
| 607 | + */ |
|
| 608 | + public function get_edit_url() { |
|
| 609 | 609 | return get_edit_post_link( $this->get_id(), 'edit' ); |
| 610 | - } |
|
| 611 | - |
|
| 612 | - /** |
|
| 613 | - * Given an item's name/custom id, it returns its id. |
|
| 614 | - * |
|
| 615 | - * |
|
| 616 | - * @static |
|
| 617 | - * @param string $value The item name or custom id. |
|
| 618 | - * @param string $field Either name or custom_id. |
|
| 619 | - * @param string $type in case you need to search for a given type. |
|
| 620 | - * @since 1.0.15 |
|
| 621 | - * @return int |
|
| 622 | - */ |
|
| 623 | - public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 624 | - |
|
| 625 | - // Trim the value. |
|
| 626 | - $value = sanitize_text_field( $value ); |
|
| 627 | - if ( empty( $value ) ) { |
|
| 628 | - return 0; |
|
| 629 | - } |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + /** |
|
| 613 | + * Given an item's name/custom id, it returns its id. |
|
| 614 | + * |
|
| 615 | + * |
|
| 616 | + * @static |
|
| 617 | + * @param string $value The item name or custom id. |
|
| 618 | + * @param string $field Either name or custom_id. |
|
| 619 | + * @param string $type in case you need to search for a given type. |
|
| 620 | + * @since 1.0.15 |
|
| 621 | + * @return int |
|
| 622 | + */ |
|
| 623 | + public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 624 | + |
|
| 625 | + // Trim the value. |
|
| 626 | + $value = sanitize_text_field( $value ); |
|
| 627 | + if ( empty( $value ) ) { |
|
| 628 | + return 0; |
|
| 629 | + } |
|
| 630 | 630 | |
| 631 | 631 | // Valid fields. |
| 632 | 632 | $fields = array( 'custom_id', 'name', 'slug' ); |
| 633 | 633 | |
| 634 | - // Ensure a field has been passed. |
|
| 635 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 636 | - return 0; |
|
| 637 | - } |
|
| 638 | - |
|
| 639 | - if ( $field == 'name' ) { |
|
| 640 | - $field = 'slug'; |
|
| 641 | - } |
|
| 642 | - |
|
| 643 | - // Maybe retrieve from the cache. |
|
| 644 | - $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 645 | - if ( ! empty( $item_id ) ) { |
|
| 646 | - return $item_id; |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - // Fetch from the db. |
|
| 650 | - $items = array(); |
|
| 651 | - if ( $field == 'slug' ) { |
|
| 652 | - $items = get_posts( |
|
| 653 | - array( |
|
| 654 | - 'post_type' => 'wpi_item', |
|
| 655 | - 'name' => $value, |
|
| 656 | - 'posts_per_page' => 1, |
|
| 657 | - 'post_status' => 'any', |
|
| 658 | - ) |
|
| 659 | - ); |
|
| 660 | - } |
|
| 661 | - |
|
| 662 | - if ( $field =='custom_id' ) { |
|
| 663 | - $items = get_posts( |
|
| 664 | - array( |
|
| 665 | - 'post_type' => 'wpi_item', |
|
| 666 | - 'posts_per_page' => 1, |
|
| 667 | - 'post_status' => 'any', |
|
| 668 | - 'meta_query' => array( |
|
| 669 | - array( |
|
| 670 | - 'key' => '_wpinv_type', |
|
| 671 | - 'value' => $type, |
|
| 672 | - ), |
|
| 673 | - array( |
|
| 674 | - 'key' => '_wpinv_custom_id', |
|
| 675 | - 'value' => $value, |
|
| 676 | - ) |
|
| 677 | - ) |
|
| 678 | - ) |
|
| 679 | - ); |
|
| 680 | - } |
|
| 681 | - |
|
| 682 | - if ( empty( $items ) ) { |
|
| 683 | - return 0; |
|
| 684 | - } |
|
| 685 | - |
|
| 686 | - // Update the cache with our data |
|
| 687 | - wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 688 | - |
|
| 689 | - return $items[0]->ID; |
|
| 634 | + // Ensure a field has been passed. |
|
| 635 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 636 | + return 0; |
|
| 637 | + } |
|
| 638 | + |
|
| 639 | + if ( $field == 'name' ) { |
|
| 640 | + $field = 'slug'; |
|
| 641 | + } |
|
| 642 | + |
|
| 643 | + // Maybe retrieve from the cache. |
|
| 644 | + $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 645 | + if ( ! empty( $item_id ) ) { |
|
| 646 | + return $item_id; |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + // Fetch from the db. |
|
| 650 | + $items = array(); |
|
| 651 | + if ( $field == 'slug' ) { |
|
| 652 | + $items = get_posts( |
|
| 653 | + array( |
|
| 654 | + 'post_type' => 'wpi_item', |
|
| 655 | + 'name' => $value, |
|
| 656 | + 'posts_per_page' => 1, |
|
| 657 | + 'post_status' => 'any', |
|
| 658 | + ) |
|
| 659 | + ); |
|
| 660 | + } |
|
| 661 | + |
|
| 662 | + if ( $field =='custom_id' ) { |
|
| 663 | + $items = get_posts( |
|
| 664 | + array( |
|
| 665 | + 'post_type' => 'wpi_item', |
|
| 666 | + 'posts_per_page' => 1, |
|
| 667 | + 'post_status' => 'any', |
|
| 668 | + 'meta_query' => array( |
|
| 669 | + array( |
|
| 670 | + 'key' => '_wpinv_type', |
|
| 671 | + 'value' => $type, |
|
| 672 | + ), |
|
| 673 | + array( |
|
| 674 | + 'key' => '_wpinv_custom_id', |
|
| 675 | + 'value' => $value, |
|
| 676 | + ) |
|
| 677 | + ) |
|
| 678 | + ) |
|
| 679 | + ); |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + if ( empty( $items ) ) { |
|
| 683 | + return 0; |
|
| 684 | + } |
|
| 685 | + |
|
| 686 | + // Update the cache with our data |
|
| 687 | + wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 688 | + |
|
| 689 | + return $items[0]->ID; |
|
| 690 | 690 | } |
| 691 | 691 | |
| 692 | 692 | /** |
@@ -719,52 +719,52 @@ discard block |
||
| 719 | 719 | */ |
| 720 | 720 | |
| 721 | 721 | /** |
| 722 | - * Set parent order ID. |
|
| 723 | - * |
|
| 724 | - * @since 1.0.19 |
|
| 725 | - */ |
|
| 726 | - public function set_parent_id( $value ) { |
|
| 727 | - if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 728 | - return; |
|
| 729 | - } |
|
| 730 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 731 | - } |
|
| 732 | - |
|
| 733 | - /** |
|
| 734 | - * Sets item status. |
|
| 735 | - * |
|
| 736 | - * @since 1.0.19 |
|
| 737 | - * @param string $status New status. |
|
| 738 | - * @return array details of change. |
|
| 739 | - */ |
|
| 740 | - public function set_status( $status ) { |
|
| 722 | + * Set parent order ID. |
|
| 723 | + * |
|
| 724 | + * @since 1.0.19 |
|
| 725 | + */ |
|
| 726 | + public function set_parent_id( $value ) { |
|
| 727 | + if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 728 | + return; |
|
| 729 | + } |
|
| 730 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 731 | + } |
|
| 732 | + |
|
| 733 | + /** |
|
| 734 | + * Sets item status. |
|
| 735 | + * |
|
| 736 | + * @since 1.0.19 |
|
| 737 | + * @param string $status New status. |
|
| 738 | + * @return array details of change. |
|
| 739 | + */ |
|
| 740 | + public function set_status( $status ) { |
|
| 741 | 741 | $old_status = $this->get_status(); |
| 742 | 742 | |
| 743 | 743 | $this->set_prop( 'status', $status ); |
| 744 | 744 | |
| 745 | - return array( |
|
| 746 | - 'from' => $old_status, |
|
| 747 | - 'to' => $status, |
|
| 748 | - ); |
|
| 745 | + return array( |
|
| 746 | + 'from' => $old_status, |
|
| 747 | + 'to' => $status, |
|
| 748 | + ); |
|
| 749 | 749 | } |
| 750 | 750 | |
| 751 | 751 | /** |
| 752 | - * Set plugin version when the item was created. |
|
| 753 | - * |
|
| 754 | - * @since 1.0.19 |
|
| 755 | - */ |
|
| 756 | - public function set_version( $value ) { |
|
| 757 | - $this->set_prop( 'version', $value ); |
|
| 752 | + * Set plugin version when the item was created. |
|
| 753 | + * |
|
| 754 | + * @since 1.0.19 |
|
| 755 | + */ |
|
| 756 | + public function set_version( $value ) { |
|
| 757 | + $this->set_prop( 'version', $value ); |
|
| 758 | 758 | } |
| 759 | 759 | |
| 760 | 760 | /** |
| 761 | - * Set date when the item was created. |
|
| 762 | - * |
|
| 763 | - * @since 1.0.19 |
|
| 764 | - * @param string $value Value to set. |
|
| 761 | + * Set date when the item was created. |
|
| 762 | + * |
|
| 763 | + * @since 1.0.19 |
|
| 764 | + * @param string $value Value to set. |
|
| 765 | 765 | * @return bool Whether or not the date was set. |
| 766 | - */ |
|
| 767 | - public function set_date_created( $value ) { |
|
| 766 | + */ |
|
| 767 | + public function set_date_created( $value ) { |
|
| 768 | 768 | $date = strtotime( $value ); |
| 769 | 769 | |
| 770 | 770 | if ( $date ) { |
@@ -777,13 +777,13 @@ discard block |
||
| 777 | 777 | } |
| 778 | 778 | |
| 779 | 779 | /** |
| 780 | - * Set date when the item was last modified. |
|
| 781 | - * |
|
| 782 | - * @since 1.0.19 |
|
| 783 | - * @param string $value Value to set. |
|
| 780 | + * Set date when the item was last modified. |
|
| 781 | + * |
|
| 782 | + * @since 1.0.19 |
|
| 783 | + * @param string $value Value to set. |
|
| 784 | 784 | * @return bool Whether or not the date was set. |
| 785 | - */ |
|
| 786 | - public function set_date_modified( $value ) { |
|
| 785 | + */ |
|
| 786 | + public function set_date_modified( $value ) { |
|
| 787 | 787 | $date = strtotime( $value ); |
| 788 | 788 | |
| 789 | 789 | if ( $date ) { |
@@ -796,115 +796,115 @@ discard block |
||
| 796 | 796 | } |
| 797 | 797 | |
| 798 | 798 | /** |
| 799 | - * Set the item name. |
|
| 800 | - * |
|
| 801 | - * @since 1.0.19 |
|
| 802 | - * @param string $value New name. |
|
| 803 | - */ |
|
| 804 | - public function set_name( $value ) { |
|
| 799 | + * Set the item name. |
|
| 800 | + * |
|
| 801 | + * @since 1.0.19 |
|
| 802 | + * @param string $value New name. |
|
| 803 | + */ |
|
| 804 | + public function set_name( $value ) { |
|
| 805 | 805 | $name = sanitize_text_field( $value ); |
| 806 | - $this->set_prop( 'name', $name ); |
|
| 806 | + $this->set_prop( 'name', $name ); |
|
| 807 | 807 | } |
| 808 | 808 | |
| 809 | 809 | /** |
| 810 | - * Alias of self::set_name(). |
|
| 811 | - * |
|
| 812 | - * @since 1.0.19 |
|
| 813 | - * @param string $value New name. |
|
| 814 | - */ |
|
| 815 | - public function set_title( $value ) { |
|
| 816 | - $this->set_name( $value ); |
|
| 810 | + * Alias of self::set_name(). |
|
| 811 | + * |
|
| 812 | + * @since 1.0.19 |
|
| 813 | + * @param string $value New name. |
|
| 814 | + */ |
|
| 815 | + public function set_title( $value ) { |
|
| 816 | + $this->set_name( $value ); |
|
| 817 | 817 | } |
| 818 | 818 | |
| 819 | 819 | /** |
| 820 | - * Set the item description. |
|
| 821 | - * |
|
| 822 | - * @since 1.0.19 |
|
| 823 | - * @param string $value New description. |
|
| 824 | - */ |
|
| 825 | - public function set_description( $value ) { |
|
| 826 | - $description = wp_kses_post( $value ); |
|
| 827 | - return $this->set_prop( 'description', $description ); |
|
| 820 | + * Set the item description. |
|
| 821 | + * |
|
| 822 | + * @since 1.0.19 |
|
| 823 | + * @param string $value New description. |
|
| 824 | + */ |
|
| 825 | + public function set_description( $value ) { |
|
| 826 | + $description = wp_kses_post( $value ); |
|
| 827 | + return $this->set_prop( 'description', $description ); |
|
| 828 | 828 | } |
| 829 | 829 | |
| 830 | 830 | /** |
| 831 | - * Alias of self::set_description(). |
|
| 832 | - * |
|
| 833 | - * @since 1.0.19 |
|
| 834 | - * @param string $value New description. |
|
| 835 | - */ |
|
| 836 | - public function set_excerpt( $value ) { |
|
| 837 | - $this->set_description( $value ); |
|
| 831 | + * Alias of self::set_description(). |
|
| 832 | + * |
|
| 833 | + * @since 1.0.19 |
|
| 834 | + * @param string $value New description. |
|
| 835 | + */ |
|
| 836 | + public function set_excerpt( $value ) { |
|
| 837 | + $this->set_description( $value ); |
|
| 838 | 838 | } |
| 839 | 839 | |
| 840 | 840 | /** |
| 841 | - * Alias of self::set_description(). |
|
| 842 | - * |
|
| 843 | - * @since 1.0.19 |
|
| 844 | - * @param string $value New description. |
|
| 845 | - */ |
|
| 846 | - public function set_summary( $value ) { |
|
| 847 | - $this->set_description( $value ); |
|
| 841 | + * Alias of self::set_description(). |
|
| 842 | + * |
|
| 843 | + * @since 1.0.19 |
|
| 844 | + * @param string $value New description. |
|
| 845 | + */ |
|
| 846 | + public function set_summary( $value ) { |
|
| 847 | + $this->set_description( $value ); |
|
| 848 | 848 | } |
| 849 | 849 | |
| 850 | 850 | /** |
| 851 | - * Set the owner of the item. |
|
| 852 | - * |
|
| 853 | - * @since 1.0.19 |
|
| 854 | - * @param int $value New author. |
|
| 855 | - */ |
|
| 856 | - public function set_author( $value ) { |
|
| 857 | - $this->set_prop( 'author', (int) $value ); |
|
| 858 | - } |
|
| 851 | + * Set the owner of the item. |
|
| 852 | + * |
|
| 853 | + * @since 1.0.19 |
|
| 854 | + * @param int $value New author. |
|
| 855 | + */ |
|
| 856 | + public function set_author( $value ) { |
|
| 857 | + $this->set_prop( 'author', (int) $value ); |
|
| 858 | + } |
|
| 859 | 859 | |
| 860 | - /** |
|
| 861 | - * Alias of self::set_author(). |
|
| 862 | - * |
|
| 863 | - * @since 1.0.19 |
|
| 864 | - * @param int $value New author. |
|
| 865 | - */ |
|
| 866 | - public function set_owner( $value ) { |
|
| 867 | - $this->set_author( $value ); |
|
| 868 | - } |
|
| 869 | - |
|
| 870 | - /** |
|
| 871 | - * Set the price of the item. |
|
| 872 | - * |
|
| 873 | - * @since 1.0.19 |
|
| 874 | - * @param float $value New price. |
|
| 875 | - */ |
|
| 876 | - public function set_price( $value ) { |
|
| 860 | + /** |
|
| 861 | + * Alias of self::set_author(). |
|
| 862 | + * |
|
| 863 | + * @since 1.0.19 |
|
| 864 | + * @param int $value New author. |
|
| 865 | + */ |
|
| 866 | + public function set_owner( $value ) { |
|
| 867 | + $this->set_author( $value ); |
|
| 868 | + } |
|
| 869 | + |
|
| 870 | + /** |
|
| 871 | + * Set the price of the item. |
|
| 872 | + * |
|
| 873 | + * @since 1.0.19 |
|
| 874 | + * @param float $value New price. |
|
| 875 | + */ |
|
| 876 | + public function set_price( $value ) { |
|
| 877 | 877 | $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) ); |
| 878 | 878 | } |
| 879 | 879 | |
| 880 | 880 | /** |
| 881 | - * Set the VAT rule of the item. |
|
| 882 | - * |
|
| 883 | - * @since 1.0.19 |
|
| 884 | - * @param string $value new rule. |
|
| 885 | - */ |
|
| 886 | - public function set_vat_rule( $value ) { |
|
| 881 | + * Set the VAT rule of the item. |
|
| 882 | + * |
|
| 883 | + * @since 1.0.19 |
|
| 884 | + * @param string $value new rule. |
|
| 885 | + */ |
|
| 886 | + public function set_vat_rule( $value ) { |
|
| 887 | 887 | $this->set_prop( 'vat_rule', $value ); |
| 888 | 888 | } |
| 889 | 889 | |
| 890 | 890 | /** |
| 891 | - * Set the VAT class of the item. |
|
| 892 | - * |
|
| 893 | - * @since 1.0.19 |
|
| 894 | - * @param string $value new class. |
|
| 895 | - */ |
|
| 896 | - public function set_vat_class( $value ) { |
|
| 891 | + * Set the VAT class of the item. |
|
| 892 | + * |
|
| 893 | + * @since 1.0.19 |
|
| 894 | + * @param string $value new class. |
|
| 895 | + */ |
|
| 896 | + public function set_vat_class( $value ) { |
|
| 897 | 897 | $this->set_prop( 'vat_class', $value ); |
| 898 | 898 | } |
| 899 | 899 | |
| 900 | 900 | /** |
| 901 | - * Set the type of the item. |
|
| 902 | - * |
|
| 903 | - * @since 1.0.19 |
|
| 904 | - * @param string $value new item type. |
|
| 905 | - * @return string |
|
| 906 | - */ |
|
| 907 | - public function set_type( $value ) { |
|
| 901 | + * Set the type of the item. |
|
| 902 | + * |
|
| 903 | + * @since 1.0.19 |
|
| 904 | + * @param string $value new item type. |
|
| 905 | + * @return string |
|
| 906 | + */ |
|
| 907 | + public function set_type( $value ) { |
|
| 908 | 908 | |
| 909 | 909 | if ( empty( $value ) ) { |
| 910 | 910 | $value = 'custom'; |
@@ -914,132 +914,132 @@ discard block |
||
| 914 | 914 | } |
| 915 | 915 | |
| 916 | 916 | /** |
| 917 | - * Set the custom id of the item. |
|
| 918 | - * |
|
| 919 | - * @since 1.0.19 |
|
| 920 | - * @param string $value new custom id. |
|
| 921 | - */ |
|
| 922 | - public function set_custom_id( $value ) { |
|
| 917 | + * Set the custom id of the item. |
|
| 918 | + * |
|
| 919 | + * @since 1.0.19 |
|
| 920 | + * @param string $value new custom id. |
|
| 921 | + */ |
|
| 922 | + public function set_custom_id( $value ) { |
|
| 923 | 923 | $this->set_prop( 'custom_id', $value ); |
| 924 | 924 | } |
| 925 | 925 | |
| 926 | 926 | /** |
| 927 | - * Set the custom name of the item. |
|
| 928 | - * |
|
| 929 | - * @since 1.0.19 |
|
| 930 | - * @param string $value new custom name. |
|
| 931 | - */ |
|
| 932 | - public function set_custom_name( $value ) { |
|
| 927 | + * Set the custom name of the item. |
|
| 928 | + * |
|
| 929 | + * @since 1.0.19 |
|
| 930 | + * @param string $value new custom name. |
|
| 931 | + */ |
|
| 932 | + public function set_custom_name( $value ) { |
|
| 933 | 933 | $this->set_prop( 'custom_name', $value ); |
| 934 | 934 | } |
| 935 | 935 | |
| 936 | 936 | /** |
| 937 | - * Set the custom singular name of the item. |
|
| 938 | - * |
|
| 939 | - * @since 1.0.19 |
|
| 940 | - * @param string $value new custom singular name. |
|
| 941 | - */ |
|
| 942 | - public function set_custom_singular_name( $value ) { |
|
| 937 | + * Set the custom singular name of the item. |
|
| 938 | + * |
|
| 939 | + * @since 1.0.19 |
|
| 940 | + * @param string $value new custom singular name. |
|
| 941 | + */ |
|
| 942 | + public function set_custom_singular_name( $value ) { |
|
| 943 | 943 | $this->set_prop( 'custom_singular_name', $value ); |
| 944 | 944 | } |
| 945 | 945 | |
| 946 | 946 | /** |
| 947 | - * Sets if an item is editable.. |
|
| 948 | - * |
|
| 949 | - * @since 1.0.19 |
|
| 950 | - * @param int|bool $value whether or not the item is editable. |
|
| 951 | - */ |
|
| 952 | - public function set_is_editable( $value ) { |
|
| 953 | - $this->set_prop( 'is_editable', (int) $value ); |
|
| 947 | + * Sets if an item is editable.. |
|
| 948 | + * |
|
| 949 | + * @since 1.0.19 |
|
| 950 | + * @param int|bool $value whether or not the item is editable. |
|
| 951 | + */ |
|
| 952 | + public function set_is_editable( $value ) { |
|
| 953 | + $this->set_prop( 'is_editable', (int) $value ); |
|
| 954 | 954 | } |
| 955 | 955 | |
| 956 | 956 | /** |
| 957 | - * Sets if dynamic pricing is enabled. |
|
| 958 | - * |
|
| 959 | - * @since 1.0.19 |
|
| 960 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 961 | - */ |
|
| 962 | - public function set_is_dynamic_pricing( $value ) { |
|
| 957 | + * Sets if dynamic pricing is enabled. |
|
| 958 | + * |
|
| 959 | + * @since 1.0.19 |
|
| 960 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 961 | + */ |
|
| 962 | + public function set_is_dynamic_pricing( $value ) { |
|
| 963 | 963 | $this->set_prop( 'is_dynamic_pricing', (int) $value ); |
| 964 | 964 | } |
| 965 | 965 | |
| 966 | 966 | /** |
| 967 | - * Sets the minimum price if dynamic pricing is enabled. |
|
| 968 | - * |
|
| 969 | - * @since 1.0.19 |
|
| 970 | - * @param float $value minimum price. |
|
| 971 | - */ |
|
| 972 | - public function set_minimum_price( $value ) { |
|
| 967 | + * Sets the minimum price if dynamic pricing is enabled. |
|
| 968 | + * |
|
| 969 | + * @since 1.0.19 |
|
| 970 | + * @param float $value minimum price. |
|
| 971 | + */ |
|
| 972 | + public function set_minimum_price( $value ) { |
|
| 973 | 973 | $this->set_prop( 'minimum_price', (float) wpinv_sanitize_amount( $value ) ); |
| 974 | 974 | } |
| 975 | 975 | |
| 976 | 976 | /** |
| 977 | - * Sets if this is a recurring item. |
|
| 978 | - * |
|
| 979 | - * @since 1.0.19 |
|
| 980 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 981 | - */ |
|
| 982 | - public function set_is_recurring( $value ) { |
|
| 977 | + * Sets if this is a recurring item. |
|
| 978 | + * |
|
| 979 | + * @since 1.0.19 |
|
| 980 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 981 | + */ |
|
| 982 | + public function set_is_recurring( $value ) { |
|
| 983 | 983 | $this->set_prop( 'is_recurring', (int) $value ); |
| 984 | 984 | } |
| 985 | 985 | |
| 986 | 986 | /** |
| 987 | - * Set the recurring period. |
|
| 988 | - * |
|
| 989 | - * @since 1.0.19 |
|
| 990 | - * @param string $value new period. |
|
| 991 | - */ |
|
| 992 | - public function set_recurring_period( $value ) { |
|
| 987 | + * Set the recurring period. |
|
| 988 | + * |
|
| 989 | + * @since 1.0.19 |
|
| 990 | + * @param string $value new period. |
|
| 991 | + */ |
|
| 992 | + public function set_recurring_period( $value ) { |
|
| 993 | 993 | $this->set_prop( 'recurring_period', $value ); |
| 994 | 994 | } |
| 995 | 995 | |
| 996 | 996 | /** |
| 997 | - * Set the recurring interval. |
|
| 998 | - * |
|
| 999 | - * @since 1.0.19 |
|
| 1000 | - * @param int $value recurring interval. |
|
| 1001 | - */ |
|
| 1002 | - public function set_recurring_interval( $value ) { |
|
| 997 | + * Set the recurring interval. |
|
| 998 | + * |
|
| 999 | + * @since 1.0.19 |
|
| 1000 | + * @param int $value recurring interval. |
|
| 1001 | + */ |
|
| 1002 | + public function set_recurring_interval( $value ) { |
|
| 1003 | 1003 | return $this->set_prop( 'recurring_interval', (int) $value ); |
| 1004 | 1004 | } |
| 1005 | 1005 | |
| 1006 | 1006 | /** |
| 1007 | - * Get the recurring limit. |
|
| 1008 | - * @since 1.0.19 |
|
| 1009 | - * @param int $value The recurring limit. |
|
| 1010 | - * @return int |
|
| 1011 | - */ |
|
| 1012 | - public function set_recurring_limit( $value ) { |
|
| 1007 | + * Get the recurring limit. |
|
| 1008 | + * @since 1.0.19 |
|
| 1009 | + * @param int $value The recurring limit. |
|
| 1010 | + * @return int |
|
| 1011 | + */ |
|
| 1012 | + public function set_recurring_limit( $value ) { |
|
| 1013 | 1013 | $this->set_prop( 'recurring_limit', (int) $value ); |
| 1014 | 1014 | } |
| 1015 | 1015 | |
| 1016 | 1016 | /** |
| 1017 | - * Checks if we have a free trial. |
|
| 1018 | - * |
|
| 1019 | - * @since 1.0.19 |
|
| 1020 | - * @param int|bool $value whether or not it has a free trial. |
|
| 1021 | - */ |
|
| 1022 | - public function set_is_free_trial( $value ) { |
|
| 1017 | + * Checks if we have a free trial. |
|
| 1018 | + * |
|
| 1019 | + * @since 1.0.19 |
|
| 1020 | + * @param int|bool $value whether or not it has a free trial. |
|
| 1021 | + */ |
|
| 1022 | + public function set_is_free_trial( $value ) { |
|
| 1023 | 1023 | $this->set_prop( 'is_free_trial', (int) $value ); |
| 1024 | 1024 | } |
| 1025 | 1025 | |
| 1026 | 1026 | /** |
| 1027 | - * Set the trial period. |
|
| 1028 | - * |
|
| 1029 | - * @since 1.0.19 |
|
| 1030 | - * @param string $value trial period. |
|
| 1031 | - */ |
|
| 1032 | - public function set_trial_period( $value ) { |
|
| 1027 | + * Set the trial period. |
|
| 1028 | + * |
|
| 1029 | + * @since 1.0.19 |
|
| 1030 | + * @param string $value trial period. |
|
| 1031 | + */ |
|
| 1032 | + public function set_trial_period( $value ) { |
|
| 1033 | 1033 | $this->set_prop( 'trial_period', $value ); |
| 1034 | 1034 | } |
| 1035 | 1035 | |
| 1036 | 1036 | /** |
| 1037 | - * Set the trial interval. |
|
| 1038 | - * |
|
| 1039 | - * @since 1.0.19 |
|
| 1040 | - * @param int $value trial interval. |
|
| 1041 | - */ |
|
| 1042 | - public function set_trial_interval( $value ) { |
|
| 1037 | + * Set the trial interval. |
|
| 1038 | + * |
|
| 1039 | + * @since 1.0.19 |
|
| 1040 | + * @param int $value trial interval. |
|
| 1041 | + */ |
|
| 1042 | + public function set_trial_interval( $value ) { |
|
| 1043 | 1043 | $this->set_prop( 'trial_interval', $value ); |
| 1044 | 1044 | } |
| 1045 | 1045 | |
@@ -1047,17 +1047,17 @@ discard block |
||
| 1047 | 1047 | * Create an item. For backwards compatibilty. |
| 1048 | 1048 | * |
| 1049 | 1049 | * @deprecated |
| 1050 | - * @return int item id |
|
| 1050 | + * @return int item id |
|
| 1051 | 1051 | */ |
| 1052 | 1052 | public function create( $data = array() ) { |
| 1053 | 1053 | |
| 1054 | - // Set the properties. |
|
| 1055 | - if ( is_array( $data ) ) { |
|
| 1056 | - $this->set_props( $data ); |
|
| 1057 | - } |
|
| 1054 | + // Set the properties. |
|
| 1055 | + if ( is_array( $data ) ) { |
|
| 1056 | + $this->set_props( $data ); |
|
| 1057 | + } |
|
| 1058 | 1058 | |
| 1059 | - // Save the item. |
|
| 1060 | - return $this->save(); |
|
| 1059 | + // Save the item. |
|
| 1060 | + return $this->save(); |
|
| 1061 | 1061 | |
| 1062 | 1062 | } |
| 1063 | 1063 | |
@@ -1065,7 +1065,7 @@ discard block |
||
| 1065 | 1065 | * Updates an item. For backwards compatibilty. |
| 1066 | 1066 | * |
| 1067 | 1067 | * @deprecated |
| 1068 | - * @return int item id |
|
| 1068 | + * @return int item id |
|
| 1069 | 1069 | */ |
| 1070 | 1070 | public function update( $data = array() ) { |
| 1071 | 1071 | return $this->create( $data ); |
@@ -1081,93 +1081,93 @@ discard block |
||
| 1081 | 1081 | */ |
| 1082 | 1082 | |
| 1083 | 1083 | /** |
| 1084 | - * Checks whether the item has enabled dynamic pricing. |
|
| 1085 | - * |
|
| 1086 | - * @since 1.0.19 |
|
| 1087 | - * @return bool |
|
| 1088 | - */ |
|
| 1089 | - public function user_can_set_their_price() { |
|
| 1084 | + * Checks whether the item has enabled dynamic pricing. |
|
| 1085 | + * |
|
| 1086 | + * @since 1.0.19 |
|
| 1087 | + * @return bool |
|
| 1088 | + */ |
|
| 1089 | + public function user_can_set_their_price() { |
|
| 1090 | 1090 | return (bool) $this->get_is_dynamic_pricing(); |
| 1091 | - } |
|
| 1091 | + } |
|
| 1092 | 1092 | |
| 1093 | - /** |
|
| 1094 | - * Checks whether the item is recurring. |
|
| 1095 | - * |
|
| 1096 | - * @since 1.0.19 |
|
| 1097 | - * @return bool |
|
| 1098 | - */ |
|
| 1099 | - public function is_recurring() { |
|
| 1093 | + /** |
|
| 1094 | + * Checks whether the item is recurring. |
|
| 1095 | + * |
|
| 1096 | + * @since 1.0.19 |
|
| 1097 | + * @return bool |
|
| 1098 | + */ |
|
| 1099 | + public function is_recurring() { |
|
| 1100 | 1100 | return (bool) $this->get_is_recurring(); |
| 1101 | 1101 | } |
| 1102 | 1102 | |
| 1103 | 1103 | /** |
| 1104 | - * Checks whether the item has a free trial. |
|
| 1105 | - * |
|
| 1106 | - * @since 1.0.19 |
|
| 1107 | - * @return bool |
|
| 1108 | - */ |
|
| 1104 | + * Checks whether the item has a free trial. |
|
| 1105 | + * |
|
| 1106 | + * @since 1.0.19 |
|
| 1107 | + * @return bool |
|
| 1108 | + */ |
|
| 1109 | 1109 | public function has_free_trial() { |
| 1110 | 1110 | $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false; |
| 1111 | 1111 | return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this ); |
| 1112 | 1112 | } |
| 1113 | 1113 | |
| 1114 | 1114 | /** |
| 1115 | - * Checks whether the item is free. |
|
| 1116 | - * |
|
| 1117 | - * @since 1.0.19 |
|
| 1118 | - * @return bool |
|
| 1119 | - */ |
|
| 1115 | + * Checks whether the item is free. |
|
| 1116 | + * |
|
| 1117 | + * @since 1.0.19 |
|
| 1118 | + * @return bool |
|
| 1119 | + */ |
|
| 1120 | 1120 | public function is_free() { |
| 1121 | 1121 | $is_free = $this->get_price() == 0; |
| 1122 | 1122 | return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this ); |
| 1123 | 1123 | } |
| 1124 | 1124 | |
| 1125 | 1125 | /** |
| 1126 | - * Checks the item status against a passed in status. |
|
| 1127 | - * |
|
| 1128 | - * @param array|string $status Status to check. |
|
| 1129 | - * @return bool |
|
| 1130 | - */ |
|
| 1131 | - public function has_status( $status ) { |
|
| 1132 | - $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1133 | - return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1126 | + * Checks the item status against a passed in status. |
|
| 1127 | + * |
|
| 1128 | + * @param array|string $status Status to check. |
|
| 1129 | + * @return bool |
|
| 1130 | + */ |
|
| 1131 | + public function has_status( $status ) { |
|
| 1132 | + $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1133 | + return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1134 | 1134 | } |
| 1135 | 1135 | |
| 1136 | 1136 | /** |
| 1137 | - * Checks the item type against a passed in types. |
|
| 1138 | - * |
|
| 1139 | - * @param array|string $type Type to check. |
|
| 1140 | - * @return bool |
|
| 1141 | - */ |
|
| 1142 | - public function is_type( $type ) { |
|
| 1143 | - $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1144 | - return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1145 | - } |
|
| 1137 | + * Checks the item type against a passed in types. |
|
| 1138 | + * |
|
| 1139 | + * @param array|string $type Type to check. |
|
| 1140 | + * @return bool |
|
| 1141 | + */ |
|
| 1142 | + public function is_type( $type ) { |
|
| 1143 | + $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1144 | + return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1145 | + } |
|
| 1146 | 1146 | |
| 1147 | 1147 | /** |
| 1148 | - * Checks whether the item is editable. |
|
| 1149 | - * |
|
| 1150 | - * @since 1.0.19 |
|
| 1151 | - * @return bool |
|
| 1152 | - */ |
|
| 1148 | + * Checks whether the item is editable. |
|
| 1149 | + * |
|
| 1150 | + * @since 1.0.19 |
|
| 1151 | + * @return bool |
|
| 1152 | + */ |
|
| 1153 | 1153 | public function is_editable() { |
| 1154 | 1154 | $is_editable = $this->get_is_editable(); |
| 1155 | 1155 | return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this ); |
| 1156 | - } |
|
| 1156 | + } |
|
| 1157 | 1157 | |
| 1158 | - /** |
|
| 1159 | - * Returns an array of cart fees. |
|
| 1160 | - */ |
|
| 1161 | - public function get_fees() { |
|
| 1158 | + /** |
|
| 1159 | + * Returns an array of cart fees. |
|
| 1160 | + */ |
|
| 1161 | + public function get_fees() { |
|
| 1162 | 1162 | return array(); |
| 1163 | 1163 | } |
| 1164 | 1164 | |
| 1165 | 1165 | /** |
| 1166 | - * Checks whether the item is purchasable. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.19 |
|
| 1169 | - * @return bool |
|
| 1170 | - */ |
|
| 1166 | + * Checks whether the item is purchasable. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.19 |
|
| 1169 | + * @return bool |
|
| 1170 | + */ |
|
| 1171 | 1171 | public function can_purchase() { |
| 1172 | 1172 | $can_purchase = $this->exists(); |
| 1173 | 1173 | |
@@ -1179,11 +1179,11 @@ discard block |
||
| 1179 | 1179 | } |
| 1180 | 1180 | |
| 1181 | 1181 | /** |
| 1182 | - * Checks whether the item supports dynamic pricing. |
|
| 1183 | - * |
|
| 1184 | - * @since 1.0.19 |
|
| 1185 | - * @return bool |
|
| 1186 | - */ |
|
| 1182 | + * Checks whether the item supports dynamic pricing. |
|
| 1183 | + * |
|
| 1184 | + * @since 1.0.19 |
|
| 1185 | + * @return bool |
|
| 1186 | + */ |
|
| 1187 | 1187 | public function supports_dynamic_pricing() { |
| 1188 | 1188 | return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this ); |
| 1189 | 1189 | } |
@@ -12,276 +12,276 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Metaboxes { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Only save metaboxes once. |
|
| 17 | - * |
|
| 18 | - * @var boolean |
|
| 19 | - */ |
|
| 20 | - private static $saved_meta_boxes = false; |
|
| 21 | - |
|
| 22 | 15 | /** |
| 23 | - * Hook in methods. |
|
| 24 | - */ |
|
| 25 | - public static function init() { |
|
| 26 | - |
|
| 27 | - // Register metaboxes. |
|
| 28 | - add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 ); |
|
| 29 | - |
|
| 30 | - // Remove metaboxes. |
|
| 31 | - add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 ); |
|
| 32 | - |
|
| 33 | - // Rename metaboxes. |
|
| 34 | - add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 ); |
|
| 35 | - |
|
| 36 | - // Save metaboxes. |
|
| 37 | - add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 ); |
|
| 38 | - } |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Register core metaboxes. |
|
| 42 | - */ |
|
| 43 | - public static function add_meta_boxes( $post_type, $post ) { |
|
| 16 | + * Only save metaboxes once. |
|
| 17 | + * |
|
| 18 | + * @var boolean |
|
| 19 | + */ |
|
| 20 | + private static $saved_meta_boxes = false; |
|
| 44 | 21 | |
| 45 | - // For invoices... |
|
| 46 | - self::add_invoice_meta_boxes( $post_type, $post ); |
|
| 47 | - |
|
| 48 | - // For payment forms. |
|
| 49 | - self::add_payment_form_meta_boxes( $post_type ); |
|
| 50 | - |
|
| 51 | - // For invoice items. |
|
| 52 | - self::add_item_meta_boxes( $post_type ); |
|
| 53 | - |
|
| 54 | - // For invoice discounts. |
|
| 55 | - if ( $post_type == 'wpi_discount' ) { |
|
| 56 | - add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' ); |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - } |
|
| 22 | + /** |
|
| 23 | + * Hook in methods. |
|
| 24 | + */ |
|
| 25 | + public static function init() { |
|
| 60 | 26 | |
| 61 | - /** |
|
| 62 | - * Register core metaboxes. |
|
| 63 | - */ |
|
| 64 | - protected static function add_payment_form_meta_boxes( $post_type ) { |
|
| 27 | + // Register metaboxes. |
|
| 28 | + add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 ); |
|
| 65 | 29 | |
| 66 | - // For payment forms. |
|
| 67 | - if ( $post_type == 'wpi_payment_form' ) { |
|
| 30 | + // Remove metaboxes. |
|
| 31 | + add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 ); |
|
| 68 | 32 | |
| 69 | - // Design payment form. |
|
| 70 | - add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' ); |
|
| 33 | + // Rename metaboxes. |
|
| 34 | + add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 ); |
|
| 71 | 35 | |
| 72 | - // Payment form information. |
|
| 73 | - add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' ); |
|
| 36 | + // Save metaboxes. |
|
| 37 | + add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 ); |
|
| 38 | + } |
|
| 74 | 39 | |
| 75 | - } |
|
| 40 | + /** |
|
| 41 | + * Register core metaboxes. |
|
| 42 | + */ |
|
| 43 | + public static function add_meta_boxes( $post_type, $post ) { |
|
| 76 | 44 | |
| 77 | - } |
|
| 45 | + // For invoices... |
|
| 46 | + self::add_invoice_meta_boxes( $post_type, $post ); |
|
| 78 | 47 | |
| 79 | - /** |
|
| 80 | - * Register core metaboxes. |
|
| 81 | - */ |
|
| 82 | - protected static function add_item_meta_boxes( $post_type ) { |
|
| 48 | + // For payment forms. |
|
| 49 | + self::add_payment_form_meta_boxes( $post_type ); |
|
| 83 | 50 | |
| 84 | - if ( $post_type == 'wpi_item' ) { |
|
| 51 | + // For invoice items. |
|
| 52 | + self::add_item_meta_boxes( $post_type ); |
|
| 85 | 53 | |
| 86 | - // Item details. |
|
| 87 | - add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' ); |
|
| 54 | + // For invoice discounts. |
|
| 55 | + if ( $post_type == 'wpi_discount' ) { |
|
| 56 | + add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' ); |
|
| 57 | + } |
|
| 88 | 58 | |
| 89 | - // If taxes are enabled, register the tax metabox. |
|
| 90 | - if ( wpinv_use_taxes() ) { |
|
| 91 | - add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' ); |
|
| 92 | - } |
|
| 59 | + } |
|
| 93 | 60 | |
| 94 | - // Item info. |
|
| 95 | - add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' ); |
|
| 61 | + /** |
|
| 62 | + * Register core metaboxes. |
|
| 63 | + */ |
|
| 64 | + protected static function add_payment_form_meta_boxes( $post_type ) { |
|
| 96 | 65 | |
| 97 | - } |
|
| 66 | + // For payment forms. |
|
| 67 | + if ( $post_type == 'wpi_payment_form' ) { |
|
| 98 | 68 | |
| 99 | - } |
|
| 69 | + // Design payment form. |
|
| 70 | + add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' ); |
|
| 100 | 71 | |
| 101 | - /** |
|
| 102 | - * Register invoice metaboxes. |
|
| 103 | - */ |
|
| 104 | - protected static function add_invoice_meta_boxes( $post_type, $post ) { |
|
| 72 | + // Payment form information. |
|
| 73 | + add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' ); |
|
| 105 | 74 | |
| 106 | - // For invoices... |
|
| 107 | - if ( getpaid_is_invoice_post_type( $post_type ) ) { |
|
| 108 | - $invoice = new WPInv_Invoice( $post ); |
|
| 75 | + } |
|
| 109 | 76 | |
| 110 | - // Resend invoice. |
|
| 111 | - if ( ! $invoice->is_draft() ) { |
|
| 77 | + } |
|
| 112 | 78 | |
| 113 | - add_meta_box( |
|
| 114 | - 'wpinv-mb-resend-invoice', |
|
| 115 | - sprintf( |
|
| 116 | - __( 'Resend %s', 'invoicing' ), |
|
| 117 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 118 | - ), |
|
| 119 | - 'GetPaid_Meta_Box_Resend_Invoice::output', |
|
| 120 | - $post_type, |
|
| 121 | - 'side', |
|
| 122 | - 'low' |
|
| 123 | - ); |
|
| 79 | + /** |
|
| 80 | + * Register core metaboxes. |
|
| 81 | + */ |
|
| 82 | + protected static function add_item_meta_boxes( $post_type ) { |
|
| 124 | 83 | |
| 125 | - } |
|
| 84 | + if ( $post_type == 'wpi_item' ) { |
|
| 126 | 85 | |
| 127 | - // Subscriptions. |
|
| 128 | - $subscriptions = getpaid_get_invoice_subscriptions( $invoice ); |
|
| 129 | - if ( ! empty( $subscriptions ) ) { |
|
| 86 | + // Item details. |
|
| 87 | + add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' ); |
|
| 130 | 88 | |
| 131 | - if ( is_array( $subscriptions ) ) { |
|
| 132 | - add_meta_box( 'wpinv-mb-subscriptions', __( 'Related Subscriptions', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_related', $post_type, 'advanced' ); |
|
| 133 | - } else { |
|
| 134 | - add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' ); |
|
| 135 | - } |
|
| 89 | + // If taxes are enabled, register the tax metabox. |
|
| 90 | + if ( wpinv_use_taxes() ) { |
|
| 91 | + add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' ); |
|
| 92 | + } |
|
| 136 | 93 | |
| 137 | - if ( getpaid_count_subscription_invoices( $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id() ) > 1 ) { |
|
| 138 | - add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' ); |
|
| 139 | - } |
|
| 94 | + // Item info. |
|
| 95 | + add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' ); |
|
| 140 | 96 | |
| 141 | - } |
|
| 97 | + } |
|
| 142 | 98 | |
| 143 | - // Invoice details. |
|
| 144 | - add_meta_box( |
|
| 145 | - 'wpinv-details', |
|
| 146 | - sprintf( |
|
| 147 | - __( '%s Details', 'invoicing' ), |
|
| 148 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 149 | - ), |
|
| 150 | - 'GetPaid_Meta_Box_Invoice_Details::output', |
|
| 151 | - $post_type, |
|
| 152 | - 'side' |
|
| 153 | - ); |
|
| 154 | - |
|
| 155 | - // Payment details. |
|
| 156 | - if ( ! $invoice->is_draft() ) { |
|
| 157 | - add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' ); |
|
| 158 | - } |
|
| 99 | + } |
|
| 159 | 100 | |
| 160 | - // Billing details. |
|
| 161 | - add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' ); |
|
| 101 | + /** |
|
| 102 | + * Register invoice metaboxes. |
|
| 103 | + */ |
|
| 104 | + protected static function add_invoice_meta_boxes( $post_type, $post ) { |
|
| 105 | + |
|
| 106 | + // For invoices... |
|
| 107 | + if ( getpaid_is_invoice_post_type( $post_type ) ) { |
|
| 108 | + $invoice = new WPInv_Invoice( $post ); |
|
| 109 | + |
|
| 110 | + // Resend invoice. |
|
| 111 | + if ( ! $invoice->is_draft() ) { |
|
| 112 | + |
|
| 113 | + add_meta_box( |
|
| 114 | + 'wpinv-mb-resend-invoice', |
|
| 115 | + sprintf( |
|
| 116 | + __( 'Resend %s', 'invoicing' ), |
|
| 117 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 118 | + ), |
|
| 119 | + 'GetPaid_Meta_Box_Resend_Invoice::output', |
|
| 120 | + $post_type, |
|
| 121 | + 'side', |
|
| 122 | + 'low' |
|
| 123 | + ); |
|
| 124 | + |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + // Subscriptions. |
|
| 128 | + $subscriptions = getpaid_get_invoice_subscriptions( $invoice ); |
|
| 129 | + if ( ! empty( $subscriptions ) ) { |
|
| 130 | + |
|
| 131 | + if ( is_array( $subscriptions ) ) { |
|
| 132 | + add_meta_box( 'wpinv-mb-subscriptions', __( 'Related Subscriptions', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_related', $post_type, 'advanced' ); |
|
| 133 | + } else { |
|
| 134 | + add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' ); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + if ( getpaid_count_subscription_invoices( $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id() ) > 1 ) { |
|
| 138 | + add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' ); |
|
| 139 | + } |
|
| 140 | + |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + // Invoice details. |
|
| 144 | + add_meta_box( |
|
| 145 | + 'wpinv-details', |
|
| 146 | + sprintf( |
|
| 147 | + __( '%s Details', 'invoicing' ), |
|
| 148 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 149 | + ), |
|
| 150 | + 'GetPaid_Meta_Box_Invoice_Details::output', |
|
| 151 | + $post_type, |
|
| 152 | + 'side' |
|
| 153 | + ); |
|
| 154 | + |
|
| 155 | + // Payment details. |
|
| 156 | + if ( ! $invoice->is_draft() ) { |
|
| 157 | + add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' ); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + // Billing details. |
|
| 161 | + add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' ); |
|
| 162 | 162 | |
| 163 | - // Invoice items. |
|
| 164 | - add_meta_box( |
|
| 165 | - 'wpinv-items', |
|
| 166 | - sprintf( |
|
| 167 | - __( '%s Items', 'invoicing' ), |
|
| 168 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 169 | - ), |
|
| 170 | - 'GetPaid_Meta_Box_Invoice_Items::output', |
|
| 171 | - $post_type, |
|
| 172 | - 'normal', |
|
| 173 | - 'high' |
|
| 174 | - ); |
|
| 163 | + // Invoice items. |
|
| 164 | + add_meta_box( |
|
| 165 | + 'wpinv-items', |
|
| 166 | + sprintf( |
|
| 167 | + __( '%s Items', 'invoicing' ), |
|
| 168 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 169 | + ), |
|
| 170 | + 'GetPaid_Meta_Box_Invoice_Items::output', |
|
| 171 | + $post_type, |
|
| 172 | + 'normal', |
|
| 173 | + 'high' |
|
| 174 | + ); |
|
| 175 | 175 | |
| 176 | - // Invoice notes. |
|
| 177 | - add_meta_box( |
|
| 178 | - 'wpinv-notes', |
|
| 179 | - sprintf( |
|
| 180 | - __( '%s Notes', 'invoicing' ), |
|
| 181 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 182 | - ), |
|
| 183 | - 'WPInv_Meta_Box_Notes::output', |
|
| 184 | - $post_type, |
|
| 185 | - 'side', |
|
| 186 | - 'low' |
|
| 187 | - ); |
|
| 188 | - |
|
| 189 | - // Shipping Address. |
|
| 190 | - if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) { |
|
| 191 | - add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' ); |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - // Payment form information. |
|
| 195 | - if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) { |
|
| 196 | - add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' ); |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - /** |
|
| 204 | - * Remove some metaboxes. |
|
| 205 | - */ |
|
| 206 | - public static function remove_meta_boxes() { |
|
| 207 | - remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' ); |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - /** |
|
| 211 | - * Rename other metaboxes. |
|
| 212 | - */ |
|
| 213 | - public static function rename_meta_boxes() { |
|
| 176 | + // Invoice notes. |
|
| 177 | + add_meta_box( |
|
| 178 | + 'wpinv-notes', |
|
| 179 | + sprintf( |
|
| 180 | + __( '%s Notes', 'invoicing' ), |
|
| 181 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 182 | + ), |
|
| 183 | + 'WPInv_Meta_Box_Notes::output', |
|
| 184 | + $post_type, |
|
| 185 | + 'side', |
|
| 186 | + 'low' |
|
| 187 | + ); |
|
| 188 | + |
|
| 189 | + // Shipping Address. |
|
| 190 | + if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) { |
|
| 191 | + add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' ); |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + // Payment form information. |
|
| 195 | + if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) { |
|
| 196 | + add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' ); |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + /** |
|
| 204 | + * Remove some metaboxes. |
|
| 205 | + */ |
|
| 206 | + public static function remove_meta_boxes() { |
|
| 207 | + remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' ); |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + /** |
|
| 211 | + * Rename other metaboxes. |
|
| 212 | + */ |
|
| 213 | + public static function rename_meta_boxes() { |
|
| 214 | 214 | |
| 215 | - } |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * Check if we're saving, then trigger an action based on the post type. |
|
| 219 | - * |
|
| 220 | - * @param int $post_id Post ID. |
|
| 221 | - * @param object $post Post object. |
|
| 222 | - */ |
|
| 223 | - public static function save_meta_boxes( $post_id, $post ) { |
|
| 224 | - $post_id = absint( $post_id ); |
|
| 225 | - $data = wp_unslash( $_POST ); |
|
| 226 | - |
|
| 227 | - // Do not save for ajax requests. |
|
| 228 | - if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) { |
|
| 229 | - return; |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - // $post_id and $post are required |
|
| 233 | - if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) { |
|
| 234 | - return; |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - // Dont' save meta boxes for revisions or autosaves. |
|
| 238 | - if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) { |
|
| 239 | - return; |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - // Check the nonce. |
|
| 243 | - if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) { |
|
| 244 | - return; |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - // Check the post being saved == the $post_id to prevent triggering this call for other save_post events. |
|
| 248 | - if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) { |
|
| 249 | - return; |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - // Check user has permission to edit. |
|
| 253 | - if ( ! current_user_can( 'edit_post', $post_id ) ) { |
|
| 254 | - return; |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - if ( getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
| 258 | - |
|
| 259 | - // We need this save event to run once to avoid potential endless loops. |
|
| 260 | - self::$saved_meta_boxes = true; |
|
| 261 | - |
|
| 262 | - return GetPaid_Meta_Box_Invoice_Address::save( $post_id ); |
|
| 263 | - |
|
| 264 | - } |
|
| 265 | - |
|
| 266 | - // Ensure this is our post type. |
|
| 267 | - $post_types_map = array( |
|
| 268 | - 'wpi_item' => 'GetPaid_Meta_Box_Item_Details', |
|
| 269 | - 'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form', |
|
| 270 | - 'wpi_discount' => 'GetPaid_Meta_Box_Discount_Details', |
|
| 271 | - ); |
|
| 272 | - |
|
| 273 | - // Is this our post type? |
|
| 274 | - if ( ! isset( $post_types_map[ $post->post_type ] ) ) { |
|
| 275 | - return; |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - // We need this save event to run once to avoid potential endless loops. |
|
| 279 | - self::$saved_meta_boxes = true; |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * Check if we're saving, then trigger an action based on the post type. |
|
| 219 | + * |
|
| 220 | + * @param int $post_id Post ID. |
|
| 221 | + * @param object $post Post object. |
|
| 222 | + */ |
|
| 223 | + public static function save_meta_boxes( $post_id, $post ) { |
|
| 224 | + $post_id = absint( $post_id ); |
|
| 225 | + $data = wp_unslash( $_POST ); |
|
| 226 | + |
|
| 227 | + // Do not save for ajax requests. |
|
| 228 | + if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) { |
|
| 229 | + return; |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + // $post_id and $post are required |
|
| 233 | + if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) { |
|
| 234 | + return; |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + // Dont' save meta boxes for revisions or autosaves. |
|
| 238 | + if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) { |
|
| 239 | + return; |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + // Check the nonce. |
|
| 243 | + if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) { |
|
| 244 | + return; |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + // Check the post being saved == the $post_id to prevent triggering this call for other save_post events. |
|
| 248 | + if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) { |
|
| 249 | + return; |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + // Check user has permission to edit. |
|
| 253 | + if ( ! current_user_can( 'edit_post', $post_id ) ) { |
|
| 254 | + return; |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + if ( getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
| 258 | + |
|
| 259 | + // We need this save event to run once to avoid potential endless loops. |
|
| 260 | + self::$saved_meta_boxes = true; |
|
| 261 | + |
|
| 262 | + return GetPaid_Meta_Box_Invoice_Address::save( $post_id ); |
|
| 263 | + |
|
| 264 | + } |
|
| 265 | + |
|
| 266 | + // Ensure this is our post type. |
|
| 267 | + $post_types_map = array( |
|
| 268 | + 'wpi_item' => 'GetPaid_Meta_Box_Item_Details', |
|
| 269 | + 'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form', |
|
| 270 | + 'wpi_discount' => 'GetPaid_Meta_Box_Discount_Details', |
|
| 271 | + ); |
|
| 272 | + |
|
| 273 | + // Is this our post type? |
|
| 274 | + if ( ! isset( $post_types_map[ $post->post_type ] ) ) { |
|
| 275 | + return; |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + // We need this save event to run once to avoid potential endless loops. |
|
| 279 | + self::$saved_meta_boxes = true; |
|
| 280 | 280 | |
| 281 | - // Save the post. |
|
| 282 | - $class = $post_types_map[ $post->post_type ]; |
|
| 283 | - $class::save( $post_id, $_POST, $post ); |
|
| 281 | + // Save the post. |
|
| 282 | + $class = $post_types_map[ $post->post_type ]; |
|
| 283 | + $class::save( $post_id, $_POST, $post ); |
|
| 284 | 284 | |
| 285 | - } |
|
| 285 | + } |
|
| 286 | 286 | |
| 287 | 287 | } |