AyeCode / invoicing

includes/data/admin-settings.php

Spacing +143 added lines, -143 removed lines

@@ -8,201 +8,201 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
-$pages = wpinv_get_pages( true );
+$pages = wpinv_get_pages(true);
     
 $currencies = wpinv_get_currencies();
     
 $currency_code_options = array();
-foreach ( $currencies as $code => $name ) {
-    $currency_code_options[ $code ] = $code . ' - ' . $name . ' (' . wpinv_currency_symbol( $code ) . ')';
+foreach ($currencies as $code => $name) {
+    $currency_code_options[$code] = $code . ' - ' . $name . ' (' . wpinv_currency_symbol($code) . ')';
 }
     
 $due_payment_options       = array();
-$due_payment_options[0]    = __( 'Now', 'invoicing' );
-for ( $i = 1; $i <= 30; $i++ ) {
+$due_payment_options[0]    = __('Now', 'invoicing');
+for ($i = 1; $i <= 30; $i++) {
     $due_payment_options[$i] = $i;
 }
     
 $invoice_number_padd_options = array();
-for ( $i = 0; $i <= 20; $i++ ) {
+for ($i = 0; $i <= 20; $i++) {
     $invoice_number_padd_options[$i] = $i;
 }
     
 $currency_symbol = wpinv_currency_symbol();
     
 $last_number = $reset_number = '';
-if ( $last_invoice_number = get_option( 'wpinv_last_invoice_number' ) ) {
-    $last_invoice_number = preg_replace( '/[^0-9]/', '', $last_invoice_number );
+if ($last_invoice_number = get_option('wpinv_last_invoice_number')) {
+    $last_invoice_number = preg_replace('/[^0-9]/', '', $last_invoice_number);
 
-    if ( !empty( $last_invoice_number ) ) {
-        $last_number = ' ' . wp_sprintf( __( "( Last Invoice's sequential number: <b>%s</b> )", 'invoicing' ), $last_invoice_number );
+    if (!empty($last_invoice_number)) {
+        $last_number = ' ' . wp_sprintf(__("( Last Invoice's sequential number: <b>%s</b> )", 'invoicing'), $last_invoice_number);
     }
 
     $nonce = wp_create_nonce('reset_invoice_count');
-    $reset_number = '<a href="'.add_query_arg(array('reset_invoice_count' => 1, '_nonce' => $nonce)).'" class="btn button">'.__('Force Reset Sequence', 'invoicing' ). '</a>';
+    $reset_number = '<a href="' . add_query_arg(array('reset_invoice_count' => 1, '_nonce' => $nonce)) . '" class="btn button">' . __('Force Reset Sequence', 'invoicing') . '</a>';
 }
     
 $alert_wrapper_start = '<p style="color: #F00">';
 $alert_wrapper_close = '</p>';
 
 return array(
-    'general' => apply_filters( 'wpinv_settings_general',
+    'general' => apply_filters('wpinv_settings_general',
         array(
             'main' => array(
                 'location_settings' => array(
                     'id'   => 'location_settings',
-                    'name' => '<h3>' . __( 'Default Location', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Default Location', 'invoicing') . '</h3>',
                     'desc' => '',
                     'type' => 'header',
                 ),
                 'default_country' => array(
                     'id'      => 'default_country',
-                    'name'    => __( 'Default Country', 'invoicing' ),
-                    'desc'    => __( 'Where does your store operate from?', 'invoicing' ),
+                    'name'    => __('Default Country', 'invoicing'),
+                    'desc'    => __('Where does your store operate from?', 'invoicing'),
                     'type'    => 'select',
                     'options' => wpinv_get_country_list(),
                     'std'     => 'GB',
                     'class'   => 'wpi_select2',
-                    'placeholder' => __( 'Select a country', 'invoicing' ),
+                    'placeholder' => __('Select a country', 'invoicing'),
                 ),
                 'default_state' => array(
                     'id'      => 'default_state',
-                    'name'    => __( 'Default State / Province', 'invoicing' ),
-                    'desc'    => __( 'What state / province does your store operate from?', 'invoicing' ),
+                    'name'    => __('Default State / Province', 'invoicing'),
+                    'desc'    => __('What state / province does your store operate from?', 'invoicing'),
                     'type'    => 'country_states',
                     'class'   => 'wpi_select2',
-                    'placeholder' => __( 'Select a state', 'invoicing' ),
+                    'placeholder' => __('Select a state', 'invoicing'),
                 ),
                 'store_name' => array(
                     'id'   => 'store_name',
-                    'name' => __( 'Store Name', 'invoicing' ),
-                    'desc' => __( 'Store name to print on invoices.', 'invoicing' ),
+                    'name' => __('Store Name', 'invoicing'),
+                    'desc' => __('Store name to print on invoices.', 'invoicing'),
                     'std'     => get_option('blogname'),
                     'type' => 'text',
                 ),
                 'logo' => array(
                     'id'   => 'logo',
-                    'name' => __( 'Logo URL', 'invoicing' ),
-                    'desc' => __( 'Store logo to print on invoices.', 'invoicing' ),
+                    'name' => __('Logo URL', 'invoicing'),
+                    'desc' => __('Store logo to print on invoices.', 'invoicing'),
                     'type' => 'text',
                 ),
                 'store_address' => array(
                     'id'   => 'store_address',
-                    'name' => __( 'Store Address', 'invoicing' ),
-                    'desc' => __( 'Enter the store address to display on invoice', 'invoicing' ),
+                    'name' => __('Store Address', 'invoicing'),
+                    'desc' => __('Enter the store address to display on invoice', 'invoicing'),
                     'type' => 'textarea',
                 ),
                 'page_settings' => array(
                     'id'   => 'page_settings',
-                    'name' => '<h3>' . __( 'Page Settings', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Page Settings', 'invoicing') . '</h3>',
                     'desc' => '',
                     'type' => 'header',
                 ),
                 'checkout_page' => array(
                     'id'          => 'checkout_page',
-                    'name'        => __( 'Checkout Page', 'invoicing' ),
-                    'desc'        => __( 'This is the checkout page where buyers will complete their payments. The <b>[wpinv_checkout]</b> short code must be on this page.', 'invoicing' ),
+                    'name'        => __('Checkout Page', 'invoicing'),
+                    'desc'        => __('This is the checkout page where buyers will complete their payments. The <b>[wpinv_checkout]</b> short code must be on this page.', 'invoicing'),
                     'type'        => 'select',
                     'options'     => $pages,
                     'class'       => 'wpi_select2',
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
                 'tandc_page' => array(
                     'id'          => 'tandc_page',
-                    'name'        => __( 'Terms & Conditions', 'invoicing' ),
-                    'desc'        => __( 'If you select a "Terms & Conditions" page here the customer will be asked to accept them on checkout.', 'invoicing' ),
+                    'name'        => __('Terms & Conditions', 'invoicing'),
+                    'desc'        => __('If you select a "Terms & Conditions" page here the customer will be asked to accept them on checkout.', 'invoicing'),
                     'type'        => 'select',
-                    'options'     => wpinv_get_pages( true,  __( 'Select a page', 'invoicing' )),
+                    'options'     => wpinv_get_pages(true, __('Select a page', 'invoicing')),
                     'class'       => 'wpi_select2',
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
                 'success_page' => array(
                     'id'          => 'success_page',
-                    'name'        => __( 'Success Page', 'invoicing' ),
-                    'desc'        => __( 'This is the page buyers are sent to after completing their payments. The <b>[wpinv_receipt]</b> short code should be on this page.', 'invoicing' ),
+                    'name'        => __('Success Page', 'invoicing'),
+                    'desc'        => __('This is the page buyers are sent to after completing their payments. The <b>[wpinv_receipt]</b> short code should be on this page.', 'invoicing'),
                     'type'        => 'select',
                     'options'     => $pages,
                     'class'       => 'wpi_select2',
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
                 'failure_page' => array(
                     'id'          => 'failure_page',
-                    'name'        => __( 'Failed Transaction Page', 'invoicing' ),
-                    'desc'        => __( 'This is the page buyers are sent to if their transaction is cancelled or fails.', 'invoicing' ),
+                    'name'        => __('Failed Transaction Page', 'invoicing'),
+                    'desc'        => __('This is the page buyers are sent to if their transaction is cancelled or fails.', 'invoicing'),
                     'type'        => 'select',
                     'options'     => $pages,
                     'class'       => 'wpi_select2',
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
                 'invoice_history_page' => array(
                     'id'          => 'invoice_history_page',
-                    'name'        => __( 'Invoice History Page', 'invoicing' ),
-                    'desc'        => __( 'This page shows an invoice history for the current user. The <b>[wpinv_history]</b> short code should be on this page.', 'invoicing' ),
+                    'name'        => __('Invoice History Page', 'invoicing'),
+                    'desc'        => __('This page shows an invoice history for the current user. The <b>[wpinv_history]</b> short code should be on this page.', 'invoicing'),
                     'type'        => 'select',
                     'options'     => $pages,
                     'class'       => 'wpi_select2',
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
                 'invoice_subscription_page' => array(
                     'id'          => 'invoice_subscription_page',
-                    'name'        => __( 'Invoice Subscriptions Page', 'invoicing' ),
-                    'desc'        => __( 'This page shows subscriptions history for the current user. The <b>[wpinv_subscriptions]</b> short code should be on this page.', 'invoicing' ),
+                    'name'        => __('Invoice Subscriptions Page', 'invoicing'),
+                    'desc'        => __('This page shows subscriptions history for the current user. The <b>[wpinv_subscriptions]</b> short code should be on this page.', 'invoicing'),
                     'type'        => 'select',
                     'options'     => $pages,
                     'class'       => 'wpi_select2',
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
             ),
             'currency_section' => array(
                 'currency_settings' => array(
                     'id'   => 'currency_settings',
-                    'name' => '<h3>' . __( 'Currency Settings', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Currency Settings', 'invoicing') . '</h3>',
                     'desc' => '',
                     'type' => 'header',
                 ),
                 'currency' => array(
                     'id'      => 'currency',
-                    'name'    => __( 'Currency', 'invoicing' ),
-                    'desc'    => __( 'Choose your currency. Note that some payment gateways have currency restrictions.', 'invoicing' ),
+                    'name'    => __('Currency', 'invoicing'),
+                    'desc'    => __('Choose your currency. Note that some payment gateways have currency restrictions.', 'invoicing'),
                     'type'    => 'select',
                     'class'       => 'wpi_select2',
                     'options' => $currency_code_options,
                 ),
                 'currency_position' => array(
                     'id'      => 'currency_position',
-                    'name'    => __( 'Currency Position', 'invoicing' ),
-                    'desc'    => __( 'Choose the location of the currency sign.', 'invoicing' ),
+                    'name'    => __('Currency Position', 'invoicing'),
+                    'desc'    => __('Choose the location of the currency sign.', 'invoicing'),
                     'type'    => 'select',
                     'class'   => 'wpi_select2',
                     'options'  => array(
-                        'left'        => __( 'Left', 'invoicing' ) . ' (' . $currency_symbol . wpinv_format_amount( '99.99' ) . ')',
-                        'right'       => __( 'Right', 'invoicing' ) . ' ('. wpinv_format_amount( '99.99' ) . $currency_symbol . ')',
-                        'left_space'  => __( 'Left with space', 'invoicing' ) . ' (' . $currency_symbol . ' ' . wpinv_format_amount( '99.99' ) . ')',
-                        'right_space' => __( 'Right with space', 'invoicing' ) . ' (' . wpinv_format_amount( '99.99' ) . ' ' . $currency_symbol . ')'
+                        'left'        => __('Left', 'invoicing') . ' (' . $currency_symbol . wpinv_format_amount('99.99') . ')',
+                        'right'       => __('Right', 'invoicing') . ' (' . wpinv_format_amount('99.99') . $currency_symbol . ')',
+                        'left_space'  => __('Left with space', 'invoicing') . ' (' . $currency_symbol . ' ' . wpinv_format_amount('99.99') . ')',
+                        'right_space' => __('Right with space', 'invoicing') . ' (' . wpinv_format_amount('99.99') . ' ' . $currency_symbol . ')'
                     )
                 ),
                 'thousands_separator' => array(
                     'id'   => 'thousands_separator',
-                    'name' => __( 'Thousands Separator', 'invoicing' ),
-                    'desc' => __( 'The symbol (usually , or .) to separate thousands', 'invoicing' ),
+                    'name' => __('Thousands Separator', 'invoicing'),
+                    'desc' => __('The symbol (usually , or .) to separate thousands', 'invoicing'),
                     'type' => 'text',
                     'size' => 'small',
                     'std'  => ',',
                 ),
                 'decimal_separator' => array(
                     'id'   => 'decimal_separator',
-                    'name' => __( 'Decimal Separator', 'invoicing' ),
-                    'desc' => __( 'The symbol (usually , or .) to separate decimal points', 'invoicing' ),
+                    'name' => __('Decimal Separator', 'invoicing'),
+                    'desc' => __('The symbol (usually , or .) to separate decimal points', 'invoicing'),
                     'type' => 'text',
                     'size' => 'small',
                     'std'  => '.',
                 ),
                 'decimals' => array(
                     'id'   => 'decimals',
-                    'name' => __( 'Number of Decimals', 'invoicing' ),
-                    'desc' => __( 'This sets the number of decimal points shown in displayed prices.', 'invoicing' ),
+                    'name' => __('Number of Decimals', 'invoicing'),
+                    'desc' => __('This sets the number of decimal points shown in displayed prices.', 'invoicing'),
                     'type' => 'number',
                     'size' => 'small',
                     'std'  => '2',
@@ -214,29 +214,29 @@ 
             'labels' => array(
                 'labels' => array(
                     'id'   => 'labels_settings',
-                    'name' => '<h3>' . __( 'Invoice Labels', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Invoice Labels', 'invoicing') . '</h3>',
                     'desc' => '',
                     'type' => 'header',
                 ),
                 'vat_name' => array(
                     'id' => 'vat_name',
-                    'name' => __( 'VAT Name', 'invoicing' ),
-                    'desc' => __( 'Enter the VAT name', 'invoicing' ),
+                    'name' => __('VAT Name', 'invoicing'),
+                    'desc' => __('Enter the VAT name', 'invoicing'),
                     'type' => 'text',
                     'size' => 'regular',
-                    'std' => __( 'VAT', 'invoicing' ),
+                    'std' => __('VAT', 'invoicing'),
                 ),
                 'vat_invoice_notice_label' => array(
                     'id' => 'vat_invoice_notice_label',
-                    'name' => __( 'Invoice Notice Label', 'invoicing' ),
-                    'desc' => __( 'Use this to add an invoice notice section (label) to your invoices', 'invoicing' ),
+                    'name' => __('Invoice Notice Label', 'invoicing'),
+                    'desc' => __('Use this to add an invoice notice section (label) to your invoices', 'invoicing'),
                     'type' => 'text',
                     'size' => 'regular',
                 ),
                 'vat_invoice_notice' => array(
                     'id' => 'vat_invoice_notice',
-                    'name' => __( 'Invoice notice', 'invoicing' ),
-                    'desc' =>   __( 'Use this to add an invoice notice section (description) to your invoices', 'invoicing' ),
+                    'name' => __('Invoice notice', 'invoicing'),
+                    'desc' =>   __('Use this to add an invoice notice section (description) to your invoices', 'invoicing'),
                     'type' => 'text',
                     'size' => 'regular',
                 ),
@@ -248,22 +248,22 @@ 
             'main' => array(
                 'gateway_settings' => array(
                     'id'   => 'api_header',
-                    'name' => '<h3>' . __( 'Gateway Settings', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Gateway Settings', 'invoicing') . '</h3>',
                     'desc' => '',
                     'type' => 'header',
                 ),
                 'gateways' => array(
                     'id'      => 'gateways',
-                    'name'    => __( 'Payment Gateways', 'invoicing' ),
-                    'desc'    => __( 'Choose the payment gateways you want to enable.', 'invoicing' ),
+                    'name'    => __('Payment Gateways', 'invoicing'),
+                    'desc'    => __('Choose the payment gateways you want to enable.', 'invoicing'),
                     'type'    => 'gateways',
                     'std'     => array('manual'=>1),
                     'options' => wpinv_get_payment_gateways(),
                 ),
                 'default_gateway' => array(
                     'id'      => 'default_gateway',
-                    'name'    => __( 'Default Gateway', 'invoicing' ),
-                    'desc'    => __( 'This gateway will be loaded automatically with the checkout page.', 'invoicing' ),
+                    'name'    => __('Default Gateway', 'invoicing'),
+                    'desc'    => __('This gateway will be loaded automatically with the checkout page.', 'invoicing'),
                     'type'    => 'gateway_select',
                     'std'     => 'manual',
                     'class'   => 'wpi_select2',
@@ -278,19 +278,19 @@ 
             'main' => array(
                 'tax_settings' => array(
                     'id'   => 'tax_settings',
-                    'name' => '<h3>' . __( 'Tax Settings', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Tax Settings', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'enable_taxes' => array(
                     'id'   => 'enable_taxes',
-                    'name' => __( 'Enable Taxes', 'invoicing' ),
-                    'desc' => __( 'Check this to enable taxes on invoices.', 'invoicing' ),
+                    'name' => __('Enable Taxes', 'invoicing'),
+                    'desc' => __('Check this to enable taxes on invoices.', 'invoicing'),
                     'type' => 'checkbox',
                 ),
                 'tax_rate' => array(
                     'id'   => 'tax_rate',
-                    'name' => __( 'Fallback Tax Rate', 'invoicing' ),
-                    'desc' => __( 'Enter a percentage, such as 6.5. Customers not in a specific rate will be charged this rate.', 'invoicing' ),
+                    'name' => __('Fallback Tax Rate', 'invoicing'),
+                    'desc' => __('Enter a percentage, such as 6.5. Customers not in a specific rate will be charged this rate.', 'invoicing'),
                     'type' => 'number',
                     'size' => 'small',
                     'min'  => '0',
@@ -302,8 +302,8 @@ 
             'rates' => array(
                 'tax_rates' => array(
                     'id'   => 'tax_rates',
-                    'name' => '<h3>' . __( 'Tax Rates', 'invoicing' ) . '</h3>',
-                    'desc' => __( 'Enter tax rates for specific regions.', 'invoicing' ),
+                    'name' => '<h3>' . __('Tax Rates', 'invoicing') . '</h3>',
+                    'desc' => __('Enter tax rates for specific regions.', 'invoicing'),
                     'type' => 'tax_rates',
                 ),
             )
@@ -315,68 +315,68 @@ 
             'main' => array(
                 'email_settings_header' => array(
                     'id'   => 'email_settings_header',
-                    'name' => '<h3>' . __( 'Email Sender Options', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Email Sender Options', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'email_from_name' => array(
                     'id'   => 'email_from_name',
-                    'name' => __( 'From Name', 'invoicing' ),
-                    'desc' => __( 'Enter the sender\'s name appears in outgoing invoice emails. This should be your site name.', 'invoicing' ),
-                    'std' => esc_attr( get_bloginfo( 'name', 'display' ) ),
+                    'name' => __('From Name', 'invoicing'),
+                    'desc' => __('Enter the sender\'s name appears in outgoing invoice emails. This should be your site name.', 'invoicing'),
+                    'std' => esc_attr(get_bloginfo('name', 'display')),
                     'type' => 'text',
                 ),
                 'email_from' => array(
                     'id'   => 'email_from',
-                    'name' => __( 'From Email', 'invoicing' ),
-                    'desc' => sprintf (__( 'Email address to send invoice emails from. This will act as the "from" and "reply-to" address. %s If emails are not being sent it may be that your hosting prevents emails being sent if the email domains do not match.%s', 'invoicing' ), $alert_wrapper_start, $alert_wrapper_close),
-                    'std' => get_option( 'admin_email' ),
+                    'name' => __('From Email', 'invoicing'),
+                    'desc' => sprintf(__('Email address to send invoice emails from. This will act as the "from" and "reply-to" address. %s If emails are not being sent it may be that your hosting prevents emails being sent if the email domains do not match.%s', 'invoicing'), $alert_wrapper_start, $alert_wrapper_close),
+                    'std' => get_option('admin_email'),
                     'type' => 'text',
                 ),
                 'admin_email' => array(
                     'id'   => 'admin_email',
-                    'name' => __( 'Admin Email', 'invoicing' ),
-                    'desc' => __( 'Where should we send admin notifications?', 'invoicing' ),
-                    'std' => get_option( 'admin_email' ),
+                    'name' => __('Admin Email', 'invoicing'),
+                    'desc' => __('Where should we send admin notifications?', 'invoicing'),
+                    'std' => get_option('admin_email'),
                     'type' => 'text',
                 ),
                 'overdue_settings_header' => array(
                     'id'   => 'overdue_settings_header',
-                    'name' => '<h3>' . __( 'Due Date Settings', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Due Date Settings', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'overdue_active' => array(
                     'id'   => 'overdue_active',
-                    'name' => __( 'Enable Due Date', 'invoicing' ),
-                    'desc' => __( 'Check this to enable due date option for invoices.', 'invoicing' ),
+                    'name' => __('Enable Due Date', 'invoicing'),
+                    'desc' => __('Check this to enable due date option for invoices.', 'invoicing'),
                     'type' => 'checkbox',
                     'std'  => false,
                 ),
                 'overdue_days' => array(
                     'id'          => 'overdue_days',
-                    'name'        => __( 'Default Due Date', 'invoicing' ),
-                    'desc'        => __( 'Number of days each Invoice is due after the created date. This will automatically set the date in the "Due Date" field. Can be overridden on individual Invoices.', 'invoicing' ),
+                    'name'        => __('Default Due Date', 'invoicing'),
+                    'desc'        => __('Number of days each Invoice is due after the created date. This will automatically set the date in the "Due Date" field. Can be overridden on individual Invoices.', 'invoicing'),
                     'type'        => 'select',
                     'options'     => $due_payment_options,
                     'std'         => 0,
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
                 'email_template_header' => array(
                     'id'   => 'email_template_header',
-                    'name' => '<h3>' . __( 'Email Template', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Email Template', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'email_header_image' => array(
                     'id'   => 'email_header_image',
-                    'name' => __( 'Header Image', 'invoicing' ),
-                    'desc' => __( 'URL to an image you want to show in the email header. Upload images using the media uploader (Admin > Media).', 'invoicing' ),
+                    'name' => __('Header Image', 'invoicing'),
+                    'desc' => __('URL to an image you want to show in the email header. Upload images using the media uploader (Admin > Media).', 'invoicing'),
                     'std' => '',
                     'type' => 'text',
                 ),
                 'email_footer_text' => array(
                     'id'   => 'email_footer_text',
-                    'name' => __( 'Footer Text', 'invoicing' ),
-                    'desc' => __( 'The text to appear in the footer of all invoice emails.', 'invoicing' ),
-                    'std' => get_bloginfo( 'name', 'display' ) . ' - ' . __( 'Powered by GeoDirectory', 'invoicing' ),
+                    'name' => __('Footer Text', 'invoicing'),
+                    'desc' => __('The text to appear in the footer of all invoice emails.', 'invoicing'),
+                    'std' => get_bloginfo('name', 'display') . ' - ' . __('Powered by GeoDirectory', 'invoicing'),
                     'type' => 'textarea',
                     'class' => 'regular-text',
                     'rows' => 2,
@@ -384,29 +384,29 @@ 
                 ),
                 'email_base_color' => array(
                     'id'   => 'email_base_color',
-                    'name' => __( 'Base Color', 'invoicing' ),
-                    'desc' => __( 'The base color for invoice email template. Default <code>#557da2</code>.', 'invoicing' ),
+                    'name' => __('Base Color', 'invoicing'),
+                    'desc' => __('The base color for invoice email template. Default <code>#557da2</code>.', 'invoicing'),
                     'std' => '#557da2',
                     'type' => 'color',
                 ),
                 'email_background_color' => array(
                     'id'   => 'email_background_color',
-                    'name' => __( 'Background Color', 'invoicing' ),
-                    'desc' => __( 'The background color of email template. Default <code>#f5f5f5</code>.', 'invoicing' ),
+                    'name' => __('Background Color', 'invoicing'),
+                    'desc' => __('The background color of email template. Default <code>#f5f5f5</code>.', 'invoicing'),
                     'std' => '#f5f5f5',
                     'type' => 'color',
                 ),
                 'email_body_background_color' => array(
                     'id'   => 'email_body_background_color',
-                    'name' => __( 'Body Background Color', 'invoicing' ),
-                    'desc' => __( 'The main body background color of email template. Default <code>#fdfdfd</code>.', 'invoicing' ),
+                    'name' => __('Body Background Color', 'invoicing'),
+                    'desc' => __('The main body background color of email template. Default <code>#fdfdfd</code>.', 'invoicing'),
                     'std' => '#fdfdfd',
                     'type' => 'color',
                 ),
                 'email_text_color' => array(
                     'id'   => 'email_text_color',
-                    'name' => __( 'Body Text Color', 'invoicing' ),
-                    'desc' => __( 'The main body text color. Default <code>#505050</code>.', 'invoicing' ),
+                    'name' => __('Body Text Color', 'invoicing'),
+                    'desc' => __('The main body text color. Default <code>#505050</code>.', 'invoicing'),
                     'std' => '#505050',
                     'type' => 'color',
                 ),
@@ -425,17 +425,17 @@ 
             'main' => array(
                 'invoicing_privacy_policy_settings' => array(
                     'id'   => 'invoicing_privacy_policy_settings',
-                    'name' => '<h3>' . __( 'Privacy Policy', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Privacy Policy', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'privacy_page' => array(
                     'id'          => 'privacy_page',
-                    'name'        => __( 'Privacy Page', 'invoicing' ),
-                    'desc'        => __( 'If no privacy policy page set in Settings->Privacy default settings, this page will be used on checkout page.', 'invoicing' ),
+                    'name'        => __('Privacy Page', 'invoicing'),
+                    'desc'        => __('If no privacy policy page set in Settings->Privacy default settings, this page will be used on checkout page.', 'invoicing'),
                     'type'        => 'select',
-                    'options'     => wpinv_get_pages( true,  __( 'Select a page', 'invoicing' )),
+                    'options'     => wpinv_get_pages(true, __('Select a page', 'invoicing')),
                     'class'       => 'wpi_select2',
-                    'placeholder' => __( 'Select a page', 'invoicing' ),
+                    'placeholder' => __('Select a page', 'invoicing'),
                 ),
             ),
         )
@@ -446,19 +446,19 @@ 
             'main' => array(
                 'invoice_number_format_settings' => array(
                     'id'   => 'invoice_number_format_settings',
-                    'name' => '<h3>' . __( 'Invoice Number', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Invoice Number', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'sequential_invoice_number' => array(
                     'id'   => 'sequential_invoice_number',
-                    'name' => __( 'Sequential Invoice Numbers', 'invoicing' ),
-                    'desc' => __('Check this box to enable sequential invoice numbers.', 'invoicing' ) . $reset_number,
+                    'name' => __('Sequential Invoice Numbers', 'invoicing'),
+                    'desc' => __('Check this box to enable sequential invoice numbers.', 'invoicing') . $reset_number,
                     'type' => 'checkbox',
                 ),
                 'invoice_sequence_start' => array(
                     'id'   => 'invoice_sequence_start',
-                    'name' => __( 'Sequential Starting Number', 'invoicing' ),
-                    'desc' => __( 'The number at which the invoice number sequence should begin.', 'invoicing' ) . $last_number,
+                    'name' => __('Sequential Starting Number', 'invoicing'),
+                    'desc' => __('The number at which the invoice number sequence should begin.', 'invoicing') . $last_number,
                     'type' => 'number',
                     'size' => 'small',
                     'std'  => '1',
@@ -466,8 +466,8 @@ 
                 ),
                 'invoice_number_padd' => array(
                     'id'      => 'invoice_number_padd',
-                    'name'    => __( 'Minimum Digits', 'invoicing' ),
-                    'desc'    => __( 'If the invoice number has less digits than this number, it is left padded with 0s. Ex: invoice number 108 will padded to 00108 if digits set to 5. The default 0 means no padding.', 'invoicing' ),
+                    'name'    => __('Minimum Digits', 'invoicing'),
+                    'desc'    => __('If the invoice number has less digits than this number, it is left padded with 0s. Ex: invoice number 108 will padded to 00108 if digits set to 5. The default 0 means no padding.', 'invoicing'),
                     'type'    => 'select',
                     'options' => $invoice_number_padd_options,
                     'std'     => 5,
@@ -475,8 +475,8 @@ 
                 ),
                 'invoice_number_prefix' => array(
                     'id' => 'invoice_number_prefix',
-                    'name' => __( 'Invoice Number Prefix', 'invoicing' ),
-                    'desc' => __( 'Prefix for all invoice numbers. Ex: INV-', 'invoicing' ),
+                    'name' => __('Invoice Number Prefix', 'invoicing'),
+                    'desc' => __('Prefix for all invoice numbers. Ex: INV-', 'invoicing'),
                     'type' => 'text',
                     'size' => 'regular',
                     'std' => 'INV-',
@@ -484,32 +484,32 @@ 
                 ),
                 'invoice_number_postfix' => array(
                     'id' => 'invoice_number_postfix',
-                    'name' => __( 'Invoice Number Postfix', 'invoicing' ),
-                    'desc' => __( 'Postfix for all invoice numbers.', 'invoicing' ),
+                    'name' => __('Invoice Number Postfix', 'invoicing'),
+                    'desc' => __('Postfix for all invoice numbers.', 'invoicing'),
                     'type' => 'text',
                     'size' => 'regular',
                     'std' => ''
                 ),
                 'checkout_settings' => array(
                     'id'   => 'checkout_settings',
-                    'name' => '<h3>' . __( 'Checkout Settings', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Checkout Settings', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'login_to_checkout' => array(
                     'id'   => 'login_to_checkout',
-                    'name' => __( 'Require Login To Checkout', 'invoicing' ),
-                    'desc' => __( 'If ticked then user needs to be logged in to view or pay invoice, can only view or pay their own invoice. If unticked then anyone can view or pay the invoice.', 'invoicing' ),
+                    'name' => __('Require Login To Checkout', 'invoicing'),
+                    'desc' => __('If ticked then user needs to be logged in to view or pay invoice, can only view or pay their own invoice. If unticked then anyone can view or pay the invoice.', 'invoicing'),
                     'type' => 'checkbox',
                 ),
                 'uninstall_settings' => array(
                     'id'   => 'uninstall_settings',
-                    'name' => '<h3>' . __( 'Uninstall Settings', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Uninstall Settings', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'remove_data_on_unistall' => array(
                     'id'   => 'remove_data_on_unistall',
-                    'name' => __( 'Remove Data on Uninstall?', 'invoicing' ),
-                    'desc' => __( 'Check this box if you would like Invoicing plugin to completely remove all of its data when the plugin is deleted/uninstalled.', 'invoicing' ),
+                    'name' => __('Remove Data on Uninstall?', 'invoicing'),
+                    'desc' => __('Check this box if you would like Invoicing plugin to completely remove all of its data when the plugin is deleted/uninstalled.', 'invoicing'),
                     'type' => 'checkbox',
                     'std'  => ''
                 ),
@@ -517,20 +517,20 @@ 
             'fields' => array(
                 'address_autofill_settings' => array(
                     'id'   => 'address_autofill_settings',
-                    'name' => '<h3>' . __( 'Google Address Auto Complete', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Google Address Auto Complete', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'address_autofill_active' => array(
                     'id'   => 'address_autofill_active',
-                    'name' => __( 'Enable/Disable', 'invoicing' ),
-                    'desc' => __( 'Enable google address auto complete', 'invoicing' ),
+                    'name' => __('Enable/Disable', 'invoicing'),
+                    'desc' => __('Enable google address auto complete', 'invoicing'),
                     'type' => 'checkbox',
                     'std'  => 0
                 ),
                 'address_autofill_api' => array(
                     'id' => 'address_autofill_api',
-                    'name' => __( 'Google Place API Key', 'invoicing' ),
-                    'desc' => wp_sprintf(__( 'Enter google place API key. For more information go to google place API %sdocumenation%s', 'invoicing' ), '<a href="https://developers.google.com/maps/documentation/javascript/places-autocomplete" target="_blank">', '</a>' ),
+                    'name' => __('Google Place API Key', 'invoicing'),
+                    'desc' => wp_sprintf(__('Enter google place API key. For more information go to google place API %sdocumenation%s', 'invoicing'), '<a href="https://developers.google.com/maps/documentation/javascript/places-autocomplete" target="_blank">', '</a>'),
                     'type' => 'text',
                     'size' => 'regular',
                     'std' => ''
@@ -539,13 +539,13 @@ 
             'custom-css' => array(
                 'css_settings' => array(
                     'id'   => 'css_settings',
-                    'name' => '<h3>' . __( 'Custom CSS', 'invoicing' ) . '</h3>',
+                    'name' => '<h3>' . __('Custom CSS', 'invoicing') . '</h3>',
                     'type' => 'header',
                 ),
                 'template_custom_css' => array(
                     'id' => 'template_custom_css',
-                    'name' => __( 'Invoice Template CSS', 'invoicing' ),
-                    'desc' => __( 'Add CSS to modify appearance of the print invoice page.', 'invoicing' ),
+                    'name' => __('Invoice Template CSS', 'invoicing'),
+                    'desc' => __('Add CSS to modify appearance of the print invoice page.', 'invoicing'),
                     'type' => 'textarea',
                     'class'=> 'regular-text',
                     'rows' => 10,
@@ -559,8 +559,8 @@ 
             'main' => array(
                 'tool_settings' => array(
                     'id'   => 'tool_settings',
-                    'name' => '<h3>' . __( 'Diagnostic Tools', 'invoicing' ) . '</h3>',
-                    'desc' => __( 'Invoicing diagnostic tools', 'invoicing' ),
+                    'name' => '<h3>' . __('Diagnostic Tools', 'invoicing') . '</h3>',
+                    'desc' => __('Invoicing diagnostic tools', 'invoicing'),
                     'type' => 'tools',
                 ),
             ),

includes/data-stores/class-getpaid-invoice-data-store.php

Spacing +136 added lines, -136 removed lines

@@ -4,7 +4,7 @@ 
  * GetPaid_Invoice_Data_Store class file.
  *
  */
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -106,61 +106,61 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
 	 */
-	public function create( &$invoice ) {
-		$invoice->set_version( WPINV_VERSION );
-		$invoice->set_date_created( current_time('mysql') );
+	public function create(&$invoice) {
+		$invoice->set_version(WPINV_VERSION);
+		$invoice->set_date_created(current_time('mysql'));
 
 		// Create a new post.
 		$id = wp_insert_post(
 			apply_filters(
 				'getpaid_new_invoice_data',
 				array(
-					'post_date'     => $invoice->get_date_created( 'edit' ),
-					'post_type'     => $invoice->get_post_type( 'edit' ),
-					'post_status'   => $this->get_post_status( $invoice ),
+					'post_date'     => $invoice->get_date_created('edit'),
+					'post_type'     => $invoice->get_post_type('edit'),
+					'post_status'   => $this->get_post_status($invoice),
 					'ping_status'   => 'closed',
-					'post_author'   => $invoice->get_user_id( 'edit' ),
-					'post_title'    => $invoice->get_title( 'edit' ),
-					'post_excerpt'  => $invoice->get_description( 'edit' ),
-					'post_parent'   => $invoice->get_parent_id( 'edit' ),
+					'post_author'   => $invoice->get_user_id('edit'),
+					'post_title'    => $invoice->get_title('edit'),
+					'post_excerpt'  => $invoice->get_description('edit'),
+					'post_parent'   => $invoice->get_parent_id('edit'),
 				)
 			),
 			true
 		);
 
-		if ( $id && ! is_wp_error( $id ) ) {
+		if ($id && !is_wp_error($id)) {
 
 			// Update the new id and regenerate a title.
-			$invoice->set_id( $id );
+			$invoice->set_id($id);
 
 			$invoice->maybe_set_number();
 
 			wp_update_post(
 				array(
 					'ID'         => $invoice->get_id(),
-					'post_title' => $invoice->get_number( 'edit' ),
-					'post_name'  => $invoice->get_path( 'edit' )
+					'post_title' => $invoice->get_number('edit'),
+					'post_name'  => $invoice->get_path('edit')
 				)
 			);
 
 			// Save special fields and items.
-			$this->save_special_fields( $invoice );
-			$this->save_items( $invoice );
+			$this->save_special_fields($invoice);
+			$this->save_items($invoice);
 
 			// Update meta data.
-			$this->update_post_meta( $invoice );
+			$this->update_post_meta($invoice);
 			$invoice->save_meta_data();
 
 			// Apply changes.
 			$invoice->apply_changes();
-			$this->clear_caches( $invoice );
+			$this->clear_caches($invoice);
 
 			// Fires after a new invoice is created.
-			do_action( 'getpaid_new_' . $invoice->get_type(), $invoice );
+			do_action('getpaid_new_' . $invoice->get_type(), $invoice);
 			return true;
 		}
 
-		if ( is_wp_error( $id ) ) {
+		if (is_wp_error($id)) {
 			$invoice->last_error = $id->get_error_message();
 		}
 
@@ -173,14 +173,14 @@ 
 	 * @param WPInv_Invoice $invoice Invoice object.
 	 *
 	 */
-	public function read( &$invoice ) {
+	public function read(&$invoice) {
 
 		$invoice->set_defaults();
-		$invoice_object = get_post( $invoice->get_id() );
+		$invoice_object = get_post($invoice->get_id());
 
-		if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
-			$invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
-			$invoice->set_id( 0 );
+		if (!$invoice->get_id() || !$invoice_object || !getpaid_is_invoice_post_type($invoice_object->post_type)) {
+			$invoice->last_error = __('Invalid invoice.', 'invoicing');
+			$invoice->set_id(0);
 			return false;
 		}
 
@@ -198,14 +198,14 @@ 
 			)
 		);
 
-		$invoice->set_type( $invoice_object->post_type );
+		$invoice->set_type($invoice_object->post_type);
 
-		$this->read_object_data( $invoice, $invoice_object );
-		$this->add_special_fields( $invoice );
-		$this->add_items( $invoice );
+		$this->read_object_data($invoice, $invoice_object);
+		$this->add_special_fields($invoice);
+		$this->add_items($invoice);
 		$invoice->read_meta_data();
-		$invoice->set_object_read( true );
-		do_action( 'getpaid_read_' . $invoice->get_type(), $invoice );
+		$invoice->set_object_read(true);
+		do_action('getpaid_read_' . $invoice->get_type(), $invoice);
 
 	}
 
@@ -214,35 +214,35 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
 	 */
-	public function update( &$invoice ) {
+	public function update(&$invoice) {
 		$invoice->save_meta_data();
-		$invoice->set_version( WPINV_VERSION );
+		$invoice->set_version(WPINV_VERSION);
 
-		if ( null === $invoice->get_date_created( 'edit' ) ) {
-			$invoice->set_date_created(  current_time('mysql') );
+		if (null === $invoice->get_date_created('edit')) {
+			$invoice->set_date_created(current_time('mysql'));
 		}
 
 		// Ensure both the key and number are set.
 		$invoice->get_path();
 
 		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $invoice->get_id() );
+		$previous_status = get_post_status($invoice->get_id());
 
 		$changes = $invoice->get_changes();
 
 		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
+		if (array_intersect(array('date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path'), array_keys($changes))) {
 			$post_data = array(
-				'post_date'         => $invoice->get_date_created( 'edit' ),
-				'post_date_gmt'     => $invoice->get_date_created_gmt( 'edit' ),
-				'post_status'       => $invoice->get_status( 'edit' ),
-				'post_title'        => $invoice->get_name( 'edit' ),
-				'post_author'       => $invoice->get_user_id( 'edit' ),
-				'post_modified'     => $invoice->get_date_modified( 'edit' ),
-				'post_excerpt'      => $invoice->get_description( 'edit' ),
-				'post_parent'       => $invoice->get_parent_id( 'edit' ),
-				'post_name'         => $invoice->get_path( 'edit' ),
-				'post_type'         => $invoice->get_post_type( 'edit' ),
+				'post_date'         => $invoice->get_date_created('edit'),
+				'post_date_gmt'     => $invoice->get_date_created_gmt('edit'),
+				'post_status'       => $invoice->get_status('edit'),
+				'post_title'        => $invoice->get_name('edit'),
+				'post_author'       => $invoice->get_user_id('edit'),
+				'post_modified'     => $invoice->get_date_modified('edit'),
+				'post_excerpt'      => $invoice->get_description('edit'),
+				'post_parent'       => $invoice->get_parent_id('edit'),
+				'post_name'         => $invoice->get_path('edit'),
+				'post_type'         => $invoice->get_post_type('edit'),
 			);
 
 			/**
@@ -253,35 +253,35 @@ 
 			 * This ensures hooks are fired by either WP itself (admin screen save),
 			 * or an update purely from CRUD.
 			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
-				clean_post_cache( $invoice->get_id() );
+			if (doing_action('save_post')) {
+				$GLOBALS['wpdb']->update($GLOBALS['wpdb']->posts, $post_data, array('ID' => $invoice->get_id()));
+				clean_post_cache($invoice->get_id());
 			} else {
-				wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
+				wp_update_post(array_merge(array('ID' => $invoice->get_id()), $post_data));
 			}
-			$invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+			$invoice->read_meta_data(true); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
 		}
 
 		// Update meta data.
-		$this->update_post_meta( $invoice );
+		$this->update_post_meta($invoice);
 
 		// Save special fields and items.
-		$this->save_special_fields( $invoice );
-		$this->save_items( $invoice );
+		$this->save_special_fields($invoice);
+		$this->save_items($invoice);
 
 		// Apply the changes.
 		$invoice->apply_changes();
 
 		// Clear caches.
-		$this->clear_caches( $invoice );
+		$this->clear_caches($invoice);
 
 		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $invoice->get_status( 'edit' );
+		$new_status = $invoice->get_status('edit');
 
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_' . $invoice->get_type(), $invoice );
+		if ($new_status !== $previous_status && in_array($previous_status, array('new', 'auto-draft', 'draft'), true)) {
+			do_action('getpaid_new_' . $invoice->get_type(), $invoice);
 		} else {
-			do_action( 'getpaid_update_' . $invoice->get_type(), $invoice );
+			do_action('getpaid_update_' . $invoice->get_type(), $invoice);
 		}
 
 	}
@@ -297,45 +297,45 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
      */
-    public function add_special_fields( &$invoice ) {
+    public function add_special_fields(&$invoice) {
 		global $wpdb;
 
 		// Maybe retrieve from the cache.
-		$data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+		$data = wp_cache_get($invoice->get_id(), 'getpaid_invoice_special_fields');
 
 		// If not found, retrieve from the db.
-		if ( false === $data ) {
-			$table =  $wpdb->prefix . 'getpaid_invoices';
+		if (false === $data) {
+			$table = $wpdb->prefix . 'getpaid_invoices';
 
 			$data  = $wpdb->get_row(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
+				$wpdb->prepare("SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id()),
 				ARRAY_A
 			);
 
 			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
+			wp_cache_set($invoice->get_id(), $data, 'getpaid_invoice_special_fields');
 
 		}
 
 		// Abort if the data does not exist.
-		if ( empty( $data ) ) {
-			$invoice->set_object_read( true );
-			$invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) );
+		if (empty($data)) {
+			$invoice->set_object_read(true);
+			$invoice->set_props(wpinv_get_user_address($invoice->get_user_id()));
 			return;
 		}
 
 		$props = array();
 
-		foreach ( $this->database_fields_to_props as $db_field => $prop ) {
+		foreach ($this->database_fields_to_props as $db_field => $prop) {
 			
-			if ( $db_field == 'post_id' ) {
+			if ($db_field == 'post_id') {
 				continue;
 			}
 
-			$props[ $prop ] = $data[ $db_field ];
+			$props[$prop] = $data[$db_field];
 		}
 
-		$invoice->set_props( $props );
+		$invoice->set_props($props);
 
 	}
 
@@ -346,14 +346,14 @@ 
 	 * @param  WPInv_Invoice $invoice       The Invoice object.
 	 * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
 	 */
-	protected function get_special_fields_to_update( $invoice ) {
+	protected function get_special_fields_to_update($invoice) {
 		$fields_to_update = array();
-		$changed_props   = $invoice->get_changes();
+		$changed_props = $invoice->get_changes();
 
 		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) ) {
-				$fields_to_update[ $database_field ] = $prop;
+		foreach ($this->database_fields_to_props as $database_field => $prop) {
+			if (array_key_exists($prop, $changed_props)) {
+				$fields_to_update[$database_field] = $prop;
 			}
 		}
 
@@ -366,25 +366,25 @@ 
 	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
 	 * @since 1.0.19
 	 */
-	protected function update_special_fields( &$invoice ) {
+	protected function update_special_fields(&$invoice) {
 		global $wpdb;
 
 		$updated_props    = array();
-		$fields_to_update = $this->get_special_fields_to_update( $invoice );
+		$fields_to_update = $this->get_special_fields_to_update($invoice);
 
-		foreach ( $fields_to_update as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
+		foreach ($fields_to_update as $database_field => $prop) {
+			$value = $invoice->{"get_$prop"}('edit');
+			$value = is_string($value) ? wp_slash($value) : $value;
+			$value = is_bool($value) ? (int) $value : $value;
+			$updated_props[$database_field] = maybe_serialize($value);
 		}
 
-		if ( ! empty( $updated_props ) ) {
+		if (!empty($updated_props)) {
 
 			$table = $wpdb->prefix . 'getpaid_invoices';
-			$wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
-			wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-			do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
+			$wpdb->update($table, $updated_props, array('post_id' => $invoice->get_id()));
+			wp_cache_delete($invoice->get_id(), 'getpaid_invoice_special_fields');
+			do_action("getpaid_invoice_update_database_fields", $invoice, $updated_props);
 
 		}
 
@@ -396,22 +396,22 @@ 
 	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
 	 * @since 1.0.19
 	 */
-	protected function insert_special_fields( &$invoice ) {
+	protected function insert_special_fields(&$invoice) {
 		global $wpdb;
 
-		$updated_props   = array();
+		$updated_props = array();
 
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
+		foreach ($this->database_fields_to_props as $database_field => $prop) {
+			$value = $invoice->{"get_$prop"}('edit');
+			$value = is_string($value) ? wp_slash($value) : $value;
+			$value = is_bool($value) ? (int) $value : $value;
+			$updated_props[$database_field] = maybe_serialize($value);
 		}
 
 		$table = $wpdb->prefix . 'getpaid_invoices';
-		$wpdb->insert( $table, $updated_props );
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-		do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
+		$wpdb->insert($table, $updated_props);
+		wp_cache_delete($invoice->get_id(), 'getpaid_invoice_special_fields');
+		do_action("getpaid_invoice_insert_database_fields", $invoice, $updated_props);
 
 	}
 
@@ -420,7 +420,7 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
      */
-    public function save_special_fields( & $invoice ) {
+    public function save_special_fields(& $invoice) {
 		global $wpdb;
 
 		// The invoices table.
@@ -428,13 +428,13 @@ 
 		$id    = (int) $invoice->get_id();
 		$invoice->maybe_set_key();
 
-		if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
+		if ($wpdb->get_var("SELECT `post_id` FROM $table WHERE `post_id`= $id")) {
 
-			$this->update_special_fields( $invoice );
+			$this->update_special_fields($invoice);
 
 		} else {
 
-			$this->insert_special_fields( $invoice );
+			$this->insert_special_fields($invoice);
 
 		}
 
@@ -445,43 +445,43 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
      */
-    public function add_items( &$invoice ) {
+    public function add_items(&$invoice) {
 		global $wpdb;
 
 		// Maybe retrieve from the cache.
-		$items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+		$items = wp_cache_get($invoice->get_id(), 'getpaid_invoice_cart_details');
 
 		// If not found, retrieve from the db.
-		if ( false === $items ) {
-			$table =  $wpdb->prefix . 'getpaid_invoice_items';
+		if (false === $items) {
+			$table = $wpdb->prefix . 'getpaid_invoice_items';
 
 			$items = $wpdb->get_results(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
+				$wpdb->prepare("SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id())
 			);
 
 			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
+			wp_cache_set($invoice->get_id(), $items, 'getpaid_invoice_cart_details');
 
 		}
 
 		// Abort if no items found.
-        if ( empty( $items ) ) {
+        if (empty($items)) {
             return;
 		}
 
-		foreach ( $items as $item_data ) {
-			$item = new GetPaid_Form_Item( $item_data->item_id );
+		foreach ($items as $item_data) {
+			$item = new GetPaid_Form_Item($item_data->item_id);
 
 			// Set item data.
-			$item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
-			$item->item_discount = wpinv_sanitize_amount( $item_data->discount );
-			$item->set_name( $item_data->item_name );
-			$item->set_description( $item_data->item_description );
-			$item->set_price( $item_data->item_price );
-			$item->set_quantity( $item_data->quantity );
-			$item->set_item_meta( $item_data->meta );
-
-			$invoice->add_item( $item );
+			$item->item_tax      = wpinv_sanitize_amount($item_data->tax);
+			$item->item_discount = wpinv_sanitize_amount($item_data->discount);
+			$item->set_name($item_data->item_name);
+			$item->set_description($item_data->item_description);
+			$item->set_price($item_data->item_price);
+			$item->set_quantity($item_data->quantity);
+			$item->set_item_meta($item_data->meta);
+
+			$invoice->add_item($item);
 		}
 
 	}
@@ -491,20 +491,20 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
      */
-    public function save_items( $invoice ) {
+    public function save_items($invoice) {
 
 		// Delete previously existing items.
-		$this->delete_items( $invoice );
+		$this->delete_items($invoice);
 
-		$table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+		$table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
 
-		foreach ( $invoice->get_cart_details() as $item_data ) {
-			$item_data = array_map( 'maybe_serialize', $item_data );
-			$GLOBALS['wpdb']->insert( $table, $item_data );
+		foreach ($invoice->get_cart_details() as $item_data) {
+			$item_data = array_map('maybe_serialize', $item_data);
+			$GLOBALS['wpdb']->insert($table, $item_data);
 		}
 
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
-		do_action( "getpaid_invoice_save_items", $invoice );
+		wp_cache_delete($invoice->get_id(), 'getpaid_invoice_cart_details');
+		do_action("getpaid_invoice_save_items", $invoice);
 
 	}
 
@@ -513,9 +513,9 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
      */
-    public function delete_items( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    public function delete_items($invoice) {
+		$table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+		return $GLOBALS['wpdb']->delete($table, array('post_id' => $invoice->get_id()));
 	}
 
 	/**
@@ -523,9 +523,9 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice object.
      */
-    public function delete_special_fields( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    public function delete_special_fields($invoice) {
+		$table = $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
+		return $GLOBALS['wpdb']->delete($table, array('post_id' => $invoice->get_id()));
     }
 
 }

Indentation +449 added lines, -449 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,519 +15,519 @@ 
  */
 class GetPaid_Invoice_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_subscr_profile_id',
-		'_wpinv_subscription_id',
-		'_wpinv_taxes',
-		'_wpinv_fees',
-		'_wpinv_discounts',
-		'_wpinv_submission_id',
-		'_wpinv_payment_form',
-		'_wpinv_is_viewed',
-		'wpinv_email_cc',
-		'wpinv_template',
-		'wpinv_created_via'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_subscr_profile_id' => 'remote_subscription_id',
-		'_wpinv_subscription_id'   => 'subscription_id',
-		'_wpinv_taxes'             => 'taxes',
-		'_wpinv_fees'              => 'fees',
-		'_wpinv_discounts'         => 'discounts',
-		'_wpinv_submission_id'     => 'submission_id',
-		'_wpinv_payment_form'      => 'payment_form',
-		'_wpinv_is_viewed'         => 'is_viewed',
-		'wpinv_email_cc'           => 'email_cc',
-		'wpinv_template'           => 'template',
-		'wpinv_created_via'        => 'created_via',
-	);
-
-	/**
-	 * A map of database fields to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $database_fields_to_props = array(
-		'post_id'            => 'id',
-		'number'             => 'number',
-		'currency'           => 'currency',
-		'key'                => 'key',
-		'type'               => 'type',
-		'mode'               => 'mode',
-		'user_ip'            => 'user_ip',
-		'first_name'         => 'first_name',
-		'last_name'          => 'last_name',
-		'address'            => 'address',
-		'city'               => 'city',
-		'state'              => 'state',
-		'country'            => 'country',
-		'zip'                => 'zip',
-		'zip'                => 'zip',
-		'adddress_confirmed' => 'address_confirmed',
-		'gateway'            => 'gateway',
-		'transaction_id'     => 'transaction_id',
-		'currency'           => 'currency',
-		'subtotal'           => 'subtotal',
-		'tax'                => 'total_tax',
-		'fees_total'         => 'total_fees',
-		'discount'           => 'total_discount',
-		'total'              => 'total',
-		'discount_code'      => 'discount_code',
-		'disable_taxes'      => 'disable_taxes',
-		'due_date'           => 'due_date',
-		'completed_date'     => 'completed_date',
-		'company'            => 'company',
-		'vat_number'         => 'vat_number',
-		'vat_rate'           => 'vat_rate',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_subscr_profile_id',
+        '_wpinv_subscription_id',
+        '_wpinv_taxes',
+        '_wpinv_fees',
+        '_wpinv_discounts',
+        '_wpinv_submission_id',
+        '_wpinv_payment_form',
+        '_wpinv_is_viewed',
+        'wpinv_email_cc',
+        'wpinv_template',
+        'wpinv_created_via'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_subscr_profile_id' => 'remote_subscription_id',
+        '_wpinv_subscription_id'   => 'subscription_id',
+        '_wpinv_taxes'             => 'taxes',
+        '_wpinv_fees'              => 'fees',
+        '_wpinv_discounts'         => 'discounts',
+        '_wpinv_submission_id'     => 'submission_id',
+        '_wpinv_payment_form'      => 'payment_form',
+        '_wpinv_is_viewed'         => 'is_viewed',
+        'wpinv_email_cc'           => 'email_cc',
+        'wpinv_template'           => 'template',
+        'wpinv_created_via'        => 'created_via',
+    );
+
+    /**
+     * A map of database fields to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $database_fields_to_props = array(
+        'post_id'            => 'id',
+        'number'             => 'number',
+        'currency'           => 'currency',
+        'key'                => 'key',
+        'type'               => 'type',
+        'mode'               => 'mode',
+        'user_ip'            => 'user_ip',
+        'first_name'         => 'first_name',
+        'last_name'          => 'last_name',
+        'address'            => 'address',
+        'city'               => 'city',
+        'state'              => 'state',
+        'country'            => 'country',
+        'zip'                => 'zip',
+        'zip'                => 'zip',
+        'adddress_confirmed' => 'address_confirmed',
+        'gateway'            => 'gateway',
+        'transaction_id'     => 'transaction_id',
+        'currency'           => 'currency',
+        'subtotal'           => 'subtotal',
+        'tax'                => 'total_tax',
+        'fees_total'         => 'total_fees',
+        'discount'           => 'total_discount',
+        'total'              => 'total',
+        'discount_code'      => 'discount_code',
+        'disable_taxes'      => 'disable_taxes',
+        'due_date'           => 'due_date',
+        'completed_date'     => 'completed_date',
+        'company'            => 'company',
+        'vat_number'         => 'vat_number',
+        'vat_rate'           => 'vat_rate',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function create( &$invoice ) {
-		$invoice->set_version( WPINV_VERSION );
-		$invoice->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_invoice_data',
-				array(
-					'post_date'     => $invoice->get_date_created( 'edit' ),
-					'post_type'     => $invoice->get_post_type( 'edit' ),
-					'post_status'   => $this->get_post_status( $invoice ),
-					'ping_status'   => 'closed',
-					'post_author'   => $invoice->get_user_id( 'edit' ),
-					'post_title'    => $invoice->get_title( 'edit' ),
-					'post_excerpt'  => $invoice->get_description( 'edit' ),
-					'post_parent'   => $invoice->get_parent_id( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-
-			// Update the new id and regenerate a title.
-			$invoice->set_id( $id );
-
-			$invoice->maybe_set_number();
-
-			wp_update_post(
-				array(
-					'ID'         => $invoice->get_id(),
-					'post_title' => $invoice->get_number( 'edit' ),
-					'post_name'  => $invoice->get_path( 'edit' )
-				)
-			);
-
-			// Save special fields and items.
-			$this->save_special_fields( $invoice );
-			$this->save_items( $invoice );
-
-			// Update meta data.
-			$this->update_post_meta( $invoice );
-			$invoice->save_meta_data();
-
-			// Apply changes.
-			$invoice->apply_changes();
-			$this->clear_caches( $invoice );
-
-			// Fires after a new invoice is created.
-			do_action( 'getpaid_new_' . $invoice->get_type(), $invoice );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$invoice->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read an invoice from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 *
-	 */
-	public function read( &$invoice ) {
-
-		$invoice->set_defaults();
-		$invoice_object = get_post( $invoice->get_id() );
-
-		if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
-			$invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
-			$invoice->set_id( 0 );
-			return false;
-		}
-
-		$invoice->set_props(
-			array(
-				'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
-				'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
-				'status'        => $invoice_object->post_status,
-				'author'        => $invoice_object->post_author,
-				'description'   => $invoice_object->post_excerpt,
-				'parent_id'     => $invoice_object->post_parent,
-				'name'          => $invoice_object->post_title,
-				'path'          => $invoice_object->post_name,
-				'post_type'     => $invoice_object->post_type,
-			)
-		);
-
-		$invoice->set_type( $invoice_object->post_type );
-
-		$this->read_object_data( $invoice, $invoice_object );
-		$this->add_special_fields( $invoice );
-		$this->add_items( $invoice );
-		$invoice->read_meta_data();
-		$invoice->set_object_read( true );
-		do_action( 'getpaid_read_' . $invoice->get_type(), $invoice );
-
-	}
-
-	/**
-	 * Method to update an invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function update( &$invoice ) {
-		$invoice->save_meta_data();
-		$invoice->set_version( WPINV_VERSION );
-
-		if ( null === $invoice->get_date_created( 'edit' ) ) {
-			$invoice->set_date_created(  current_time('mysql') );
-		}
-
-		// Ensure both the key and number are set.
-		$invoice->get_path();
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $invoice->get_id() );
-
-		$changes = $invoice->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $invoice->get_date_created( 'edit' ),
-				'post_date_gmt'     => $invoice->get_date_created_gmt( 'edit' ),
-				'post_status'       => $invoice->get_status( 'edit' ),
-				'post_title'        => $invoice->get_name( 'edit' ),
-				'post_author'       => $invoice->get_user_id( 'edit' ),
-				'post_modified'     => $invoice->get_date_modified( 'edit' ),
-				'post_excerpt'      => $invoice->get_description( 'edit' ),
-				'post_parent'       => $invoice->get_parent_id( 'edit' ),
-				'post_name'         => $invoice->get_path( 'edit' ),
-				'post_type'         => $invoice->get_post_type( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
-				clean_post_cache( $invoice->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
-			}
-			$invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-
-		// Update meta data.
-		$this->update_post_meta( $invoice );
-
-		// Save special fields and items.
-		$this->save_special_fields( $invoice );
-		$this->save_items( $invoice );
-
-		// Apply the changes.
-		$invoice->apply_changes();
-
-		// Clear caches.
-		$this->clear_caches( $invoice );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $invoice->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_' . $invoice->get_type(), $invoice );
-		} else {
-			do_action( 'getpaid_update_' . $invoice->get_type(), $invoice );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function create( &$invoice ) {
+        $invoice->set_version( WPINV_VERSION );
+        $invoice->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_invoice_data',
+                array(
+                    'post_date'     => $invoice->get_date_created( 'edit' ),
+                    'post_type'     => $invoice->get_post_type( 'edit' ),
+                    'post_status'   => $this->get_post_status( $invoice ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $invoice->get_user_id( 'edit' ),
+                    'post_title'    => $invoice->get_title( 'edit' ),
+                    'post_excerpt'  => $invoice->get_description( 'edit' ),
+                    'post_parent'   => $invoice->get_parent_id( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+
+            // Update the new id and regenerate a title.
+            $invoice->set_id( $id );
+
+            $invoice->maybe_set_number();
+
+            wp_update_post(
+                array(
+                    'ID'         => $invoice->get_id(),
+                    'post_title' => $invoice->get_number( 'edit' ),
+                    'post_name'  => $invoice->get_path( 'edit' )
+                )
+            );
+
+            // Save special fields and items.
+            $this->save_special_fields( $invoice );
+            $this->save_items( $invoice );
+
+            // Update meta data.
+            $this->update_post_meta( $invoice );
+            $invoice->save_meta_data();
+
+            // Apply changes.
+            $invoice->apply_changes();
+            $this->clear_caches( $invoice );
+
+            // Fires after a new invoice is created.
+            do_action( 'getpaid_new_' . $invoice->get_type(), $invoice );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $invoice->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read an invoice from the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     *
+     */
+    public function read( &$invoice ) {
+
+        $invoice->set_defaults();
+        $invoice_object = get_post( $invoice->get_id() );
+
+        if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
+            $invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
+            $invoice->set_id( 0 );
+            return false;
+        }
+
+        $invoice->set_props(
+            array(
+                'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
+                'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
+                'status'        => $invoice_object->post_status,
+                'author'        => $invoice_object->post_author,
+                'description'   => $invoice_object->post_excerpt,
+                'parent_id'     => $invoice_object->post_parent,
+                'name'          => $invoice_object->post_title,
+                'path'          => $invoice_object->post_name,
+                'post_type'     => $invoice_object->post_type,
+            )
+        );
+
+        $invoice->set_type( $invoice_object->post_type );
+
+        $this->read_object_data( $invoice, $invoice_object );
+        $this->add_special_fields( $invoice );
+        $this->add_items( $invoice );
+        $invoice->read_meta_data();
+        $invoice->set_object_read( true );
+        do_action( 'getpaid_read_' . $invoice->get_type(), $invoice );
+
+    }
+
+    /**
+     * Method to update an invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function update( &$invoice ) {
+        $invoice->save_meta_data();
+        $invoice->set_version( WPINV_VERSION );
+
+        if ( null === $invoice->get_date_created( 'edit' ) ) {
+            $invoice->set_date_created(  current_time('mysql') );
+        }
+
+        // Ensure both the key and number are set.
+        $invoice->get_path();
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $invoice->get_id() );
+
+        $changes = $invoice->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $invoice->get_date_created( 'edit' ),
+                'post_date_gmt'     => $invoice->get_date_created_gmt( 'edit' ),
+                'post_status'       => $invoice->get_status( 'edit' ),
+                'post_title'        => $invoice->get_name( 'edit' ),
+                'post_author'       => $invoice->get_user_id( 'edit' ),
+                'post_modified'     => $invoice->get_date_modified( 'edit' ),
+                'post_excerpt'      => $invoice->get_description( 'edit' ),
+                'post_parent'       => $invoice->get_parent_id( 'edit' ),
+                'post_name'         => $invoice->get_path( 'edit' ),
+                'post_type'         => $invoice->get_post_type( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
+                clean_post_cache( $invoice->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
+            }
+            $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+
+        // Update meta data.
+        $this->update_post_meta( $invoice );
+
+        // Save special fields and items.
+        $this->save_special_fields( $invoice );
+        $this->save_items( $invoice );
+
+        // Apply the changes.
+        $invoice->apply_changes();
+
+        // Clear caches.
+        $this->clear_caches( $invoice );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $invoice->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_' . $invoice->get_type(), $invoice );
+        } else {
+            do_action( 'getpaid_update_' . $invoice->get_type(), $invoice );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
+    /**
      * Retrieves special fields and adds to the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_special_fields( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        // Maybe retrieve from the cache.
+        $data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
 
-		// If not found, retrieve from the db.
-		if ( false === $data ) {
-			$table =  $wpdb->prefix . 'getpaid_invoices';
+        // If not found, retrieve from the db.
+        if ( false === $data ) {
+            $table =  $wpdb->prefix . 'getpaid_invoices';
 
-			$data  = $wpdb->get_row(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
-				ARRAY_A
-			);
+            $data  = $wpdb->get_row(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
+                ARRAY_A
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
 
-		}
+        }
 
-		// Abort if the data does not exist.
-		if ( empty( $data ) ) {
-			$invoice->set_object_read( true );
-			$invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) );
-			return;
-		}
+        // Abort if the data does not exist.
+        if ( empty( $data ) ) {
+            $invoice->set_object_read( true );
+            $invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) );
+            return;
+        }
 
-		$props = array();
+        $props = array();
 
-		foreach ( $this->database_fields_to_props as $db_field => $prop ) {
+        foreach ( $this->database_fields_to_props as $db_field => $prop ) {
 			
-			if ( $db_field == 'post_id' ) {
-				continue;
-			}
-
-			$props[ $prop ] = $data[ $db_field ];
-		}
-
-		$invoice->set_props( $props );
-
-	}
-
-	/**
-	 * Gets a list of special fields that need updated based on change state
-	 * or if they are present in the database or not.
-	 *
-	 * @param  WPInv_Invoice $invoice       The Invoice object.
-	 * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
-	 */
-	protected function get_special_fields_to_update( $invoice ) {
-		$fields_to_update = array();
-		$changed_props   = $invoice->get_changes();
-
-		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) ) {
-				$fields_to_update[ $database_field ] = $prop;
-			}
-		}
-
-		return $fields_to_update;
-	}
-
-	/**
-	 * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function update_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props    = array();
-		$fields_to_update = $this->get_special_fields_to_update( $invoice );
-
-		foreach ( $fields_to_update as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		if ( ! empty( $updated_props ) ) {
-
-			$table = $wpdb->prefix . 'getpaid_invoices';
-			$wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
-			wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-			do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
-
-		}
-
-	}
-
-	/**
-	 * Helper method that inserts special fields to the database.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function insert_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props   = array();
-
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$wpdb->insert( $table, $updated_props );
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-		do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
-
-	}
-
-	/**
+            if ( $db_field == 'post_id' ) {
+                continue;
+            }
+
+            $props[ $prop ] = $data[ $db_field ];
+        }
+
+        $invoice->set_props( $props );
+
+    }
+
+    /**
+     * Gets a list of special fields that need updated based on change state
+     * or if they are present in the database or not.
+     *
+     * @param  WPInv_Invoice $invoice       The Invoice object.
+     * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
+     */
+    protected function get_special_fields_to_update( $invoice ) {
+        $fields_to_update = array();
+        $changed_props   = $invoice->get_changes();
+
+        // Props should be updated if they are a part of the $changed array or don't exist yet.
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            if ( array_key_exists( $prop, $changed_props ) ) {
+                $fields_to_update[ $database_field ] = $prop;
+            }
+        }
+
+        return $fields_to_update;
+    }
+
+    /**
+     * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function update_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props    = array();
+        $fields_to_update = $this->get_special_fields_to_update( $invoice );
+
+        foreach ( $fields_to_update as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        if ( ! empty( $updated_props ) ) {
+
+            $table = $wpdb->prefix . 'getpaid_invoices';
+            $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
+            wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+            do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
+
+        }
+
+    }
+
+    /**
+     * Helper method that inserts special fields to the database.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function insert_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props   = array();
+
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $wpdb->insert( $table, $updated_props );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
+
+    }
+
+    /**
      * Saves all special fields.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_special_fields( & $invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// The invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$id    = (int) $invoice->get_id();
-		$invoice->maybe_set_key();
+        // The invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $id    = (int) $invoice->get_id();
+        $invoice->maybe_set_key();
 
-		if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
+        if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
 
-			$this->update_special_fields( $invoice );
+            $this->update_special_fields( $invoice );
 
-		} else {
+        } else {
 
-			$this->insert_special_fields( $invoice );
+            $this->insert_special_fields( $invoice );
 
-		}
+        }
 
-	}
+    }
 
-	/**
+    /**
      * Set's up cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_items( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        // Maybe retrieve from the cache.
+        $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
 
-		// If not found, retrieve from the db.
-		if ( false === $items ) {
-			$table =  $wpdb->prefix . 'getpaid_invoice_items';
+        // If not found, retrieve from the db.
+        if ( false === $items ) {
+            $table =  $wpdb->prefix . 'getpaid_invoice_items';
 
-			$items = $wpdb->get_results(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
-			);
+            $items = $wpdb->get_results(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
 
-		}
+        }
 
-		// Abort if no items found.
+        // Abort if no items found.
         if ( empty( $items ) ) {
             return;
-		}
+        }
 
-		foreach ( $items as $item_data ) {
-			$item = new GetPaid_Form_Item( $item_data->item_id );
+        foreach ( $items as $item_data ) {
+            $item = new GetPaid_Form_Item( $item_data->item_id );
 
-			// Set item data.
-			$item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
-			$item->item_discount = wpinv_sanitize_amount( $item_data->discount );
-			$item->set_name( $item_data->item_name );
-			$item->set_description( $item_data->item_description );
-			$item->set_price( $item_data->item_price );
-			$item->set_quantity( $item_data->quantity );
-			$item->set_item_meta( $item_data->meta );
+            // Set item data.
+            $item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
+            $item->item_discount = wpinv_sanitize_amount( $item_data->discount );
+            $item->set_name( $item_data->item_name );
+            $item->set_description( $item_data->item_description );
+            $item->set_price( $item_data->item_price );
+            $item->set_quantity( $item_data->quantity );
+            $item->set_item_meta( $item_data->meta );
 
-			$invoice->add_item( $item );
-		}
+            $invoice->add_item( $item );
+        }
 
-	}
+    }
 
-	/**
+    /**
      * Saves cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_items( $invoice ) {
 
-		// Delete previously existing items.
-		$this->delete_items( $invoice );
+        // Delete previously existing items.
+        $this->delete_items( $invoice );
 
-		$table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        $table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
 
-		foreach ( $invoice->get_cart_details() as $item_data ) {
-			$item_data = array_map( 'maybe_serialize', $item_data );
-			$GLOBALS['wpdb']->insert( $table, $item_data );
-		}
+        foreach ( $invoice->get_cart_details() as $item_data ) {
+            $item_data = array_map( 'maybe_serialize', $item_data );
+            $GLOBALS['wpdb']->insert( $table, $item_data );
+        }
 
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
-		do_action( "getpaid_invoice_save_items", $invoice );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        do_action( "getpaid_invoice_save_items", $invoice );
 
-	}
+    }
 
-	/**
+    /**
      * Deletes an invoice's cart details from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_items( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
-	}
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    }
 
-	/**
+    /**
      * Deletes an invoice's special fields from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_special_fields( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
     }
 
 }

includes/data-stores/class-getpaid-data.php

Indentation +860 added lines, -860 removed lines

@@ -9,7 +9,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,356 +21,356 @@ 
  */
 abstract class GetPaid_Data {
 
-	/**
-	 * ID for this object.
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	protected $id = 0;
-
-	/**
-	 * Core data for this object. Name value pairs (name + default value).
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array();
-
-	/**
-	 * Core data changes for this object.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $changes = array();
-
-	/**
-	 * This is false until the object is read from the DB.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $object_read = false;
-
-	/**
-	 * This is the name of this object type.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $object_type = 'data';
-
-	/**
-	 * Extra data for this object. Name value pairs (name + default value).
-	 * Used as a standard way for sub classes (like item types) to add
-	 * additional information to an inherited class.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $extra_data = array();
-
-	/**
-	 * Set to _data on construct so we can track and reset data if needed.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $default_data = array();
-
-	/**
-	 * Contains a reference to the data store for this class.
-	 *
-	 * @since 1.0.19
-	 * @var GetPaid_Data_Store
-	 */
-	protected $data_store;
-
-	/**
-	 * Stores meta in cache for future reads.
-	 * A group must be set to to enable caching.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $cache_group = '';
-
-	/**
-	 * Stores the last error.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $last_error = '';
-
-	/**
-	 * Stores additional meta data.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $meta_data = null;
-
-	/**
-	 * Default constructor.
-	 *
-	 * @param int|object|array $read ID to load from the DB (optional) or already queried data.
-	 */
-	public function __construct( $read = 0 ) {
-		$this->data         = array_merge( $this->data, $this->extra_data );
-		$this->default_data = $this->data;
-	}
-
-	/**
-	 * Only store the object ID to avoid serializing the data object instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'id' );
-	}
-
-	/**
-	 * Re-run the constructor with the object ID.
-	 *
-	 * If the object no longer exists, remove the ID.
-	 */
-	public function __wakeup() {
-		$this->__construct( absint( $this->id ) );
-
-		if ( ! empty( $this->last_error ) ) {
-			$this->set_id( 0 );
-		}
-
-	}
-
-	/**
-	 * When the object is cloned, make sure meta is duplicated correctly.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __clone() {
-		$this->maybe_read_meta_data();
-		if ( ! empty( $this->meta_data ) ) {
-			foreach ( $this->meta_data as $array_key => $meta ) {
-				$this->meta_data[ $array_key ] = clone $meta;
-				if ( ! empty( $meta->id ) ) {
-					$this->meta_data[ $array_key ]->id = null;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get the data store.
-	 *
-	 * @since  1.0.19
-	 * @return object
-	 */
-	public function get_data_store() {
-		return $this->data_store;
-	}
-
-	/**
-	 * Get the object type.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Returns the unique ID for this object.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function get_id() {
-		return $this->id;
-	}
-
-	/**
-	 * Get form status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
-    }
-
-	/**
-	 * Delete an object, set the ID to 0, and return result.
-	 *
-	 * @since  1.0.19
-	 * @param  bool $force_delete Should the data be deleted permanently.
-	 * @return bool result
-	 */
-	public function delete( $force_delete = false ) {
-		if ( $this->data_store && $this->get_id() ) {
-			$this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
-			$this->set_id( 0 );
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Save should create or update based on object existence.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function save() {
-		if ( ! $this->data_store ) {
-			return $this->get_id();
-		}
-
-		/**
-		 * Trigger action before saving to the DB. Allows you to adjust object props before save.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		if ( $this->get_id() ) {
-			$this->data_store->update( $this );
-		} else {
-			$this->data_store->create( $this );
-		}
-
-		/**
-		 * Trigger action after saving to the DB.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		return $this->get_id();
-	}
-
-	/**
-	 * Change data to JSON format.
-	 *
-	 * @since  1.0.19
-	 * @return string Data in JSON format.
-	 */
-	public function __toString() {
-		return wp_json_encode( $this->get_data() );
-	}
-
-	/**
-	 * Returns all data for this object.
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
-	}
-
-	/**
-	 * Returns array of expected data keys for this object.
-	 *
-	 * @since   1.0.19
-	 * @return array
-	 */
-	public function get_data_keys() {
-		return array_keys( $this->data );
-	}
-
-	/**
-	 * Returns all "extra" data keys for an object (for sub objects like item types).
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_extra_data_keys() {
-		return array_keys( $this->extra_data );
-	}
-
-	/**
-	 * Filter null meta values from array.
-	 *
-	 * @since  1.0.19
-	 * @param mixed $meta Meta value to check.
-	 * @return bool
-	 */
-	protected function filter_null_meta( $meta ) {
-		return ! is_null( $meta->value );
-	}
-
-	/**
-	 * Get All Meta Data.
-	 *
-	 * @since 1.0.19
-	 * @return array of objects.
-	 */
-	public function get_meta_data() {
-		$this->maybe_read_meta_data();
-		return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
-	}
-
-	/**
-	 * Check if the key is an internal one.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Key to check.
-	 * @return bool   true if it's an internal key, false otherwise
-	 */
-	protected function is_internal_meta_key( $key ) {
-		$internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
-
-		if ( ! $internal_meta_key ) {
-			return false;
-		}
-
-		$has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
-
-		if ( ! $has_setter_or_getter ) {
-			return false;
-		}
-
-		/* translators: %s: $key Key to check */
-		getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
-
-		return true;
-	}
-
-	/**
-	 * Magic method for setting data fields.
-	 *
-	 * This method does not update custom fields in the database.
-	 *
-	 * @since 1.0.19
-	 * @access public
-	 *
-	 */
-	public function __set( $key, $value ) {
-
-		if ( 'id' == strtolower( $key ) ) {
-			return $this->set_id( $value );
-		}
-
-		if ( method_exists( $this, "set_$key") ) {
-
-			/* translators: %s: $key Key to set */
-			getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
-
-			call_user_func( array( $this, "set_$key" ), $value );
-		} else {
-			$this->set_prop( $key, $value );
-		}
-
-	}
-
-	/**
+    /**
+     * ID for this object.
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    protected $id = 0;
+
+    /**
+     * Core data for this object. Name value pairs (name + default value).
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array();
+
+    /**
+     * Core data changes for this object.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $changes = array();
+
+    /**
+     * This is false until the object is read from the DB.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $object_read = false;
+
+    /**
+     * This is the name of this object type.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $object_type = 'data';
+
+    /**
+     * Extra data for this object. Name value pairs (name + default value).
+     * Used as a standard way for sub classes (like item types) to add
+     * additional information to an inherited class.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $extra_data = array();
+
+    /**
+     * Set to _data on construct so we can track and reset data if needed.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $default_data = array();
+
+    /**
+     * Contains a reference to the data store for this class.
+     *
+     * @since 1.0.19
+     * @var GetPaid_Data_Store
+     */
+    protected $data_store;
+
+    /**
+     * Stores meta in cache for future reads.
+     * A group must be set to to enable caching.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $cache_group = '';
+
+    /**
+     * Stores the last error.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $last_error = '';
+
+    /**
+     * Stores additional meta data.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $meta_data = null;
+
+    /**
+     * Default constructor.
+     *
+     * @param int|object|array $read ID to load from the DB (optional) or already queried data.
+     */
+    public function __construct( $read = 0 ) {
+        $this->data         = array_merge( $this->data, $this->extra_data );
+        $this->default_data = $this->data;
+    }
+
+    /**
+     * Only store the object ID to avoid serializing the data object instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'id' );
+    }
+
+    /**
+     * Re-run the constructor with the object ID.
+     *
+     * If the object no longer exists, remove the ID.
+     */
+    public function __wakeup() {
+        $this->__construct( absint( $this->id ) );
+
+        if ( ! empty( $this->last_error ) ) {
+            $this->set_id( 0 );
+        }
+
+    }
+
+    /**
+     * When the object is cloned, make sure meta is duplicated correctly.
+     *
+     * @since 1.0.19
+     */
+    public function __clone() {
+        $this->maybe_read_meta_data();
+        if ( ! empty( $this->meta_data ) ) {
+            foreach ( $this->meta_data as $array_key => $meta ) {
+                $this->meta_data[ $array_key ] = clone $meta;
+                if ( ! empty( $meta->id ) ) {
+                    $this->meta_data[ $array_key ]->id = null;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get the data store.
+     *
+     * @since  1.0.19
+     * @return object
+     */
+    public function get_data_store() {
+        return $this->data_store;
+    }
+
+    /**
+     * Get the object type.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Returns the unique ID for this object.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function get_id() {
+        return $this->id;
+    }
+
+    /**
+     * Get form status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
+    }
+
+    /**
+     * Delete an object, set the ID to 0, and return result.
+     *
+     * @since  1.0.19
+     * @param  bool $force_delete Should the data be deleted permanently.
+     * @return bool result
+     */
+    public function delete( $force_delete = false ) {
+        if ( $this->data_store && $this->get_id() ) {
+            $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
+            $this->set_id( 0 );
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Save should create or update based on object existence.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function save() {
+        if ( ! $this->data_store ) {
+            return $this->get_id();
+        }
+
+        /**
+         * Trigger action before saving to the DB. Allows you to adjust object props before save.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        if ( $this->get_id() ) {
+            $this->data_store->update( $this );
+        } else {
+            $this->data_store->create( $this );
+        }
+
+        /**
+         * Trigger action after saving to the DB.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        return $this->get_id();
+    }
+
+    /**
+     * Change data to JSON format.
+     *
+     * @since  1.0.19
+     * @return string Data in JSON format.
+     */
+    public function __toString() {
+        return wp_json_encode( $this->get_data() );
+    }
+
+    /**
+     * Returns all data for this object.
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
+    }
+
+    /**
+     * Returns array of expected data keys for this object.
+     *
+     * @since   1.0.19
+     * @return array
+     */
+    public function get_data_keys() {
+        return array_keys( $this->data );
+    }
+
+    /**
+     * Returns all "extra" data keys for an object (for sub objects like item types).
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_extra_data_keys() {
+        return array_keys( $this->extra_data );
+    }
+
+    /**
+     * Filter null meta values from array.
+     *
+     * @since  1.0.19
+     * @param mixed $meta Meta value to check.
+     * @return bool
+     */
+    protected function filter_null_meta( $meta ) {
+        return ! is_null( $meta->value );
+    }
+
+    /**
+     * Get All Meta Data.
+     *
+     * @since 1.0.19
+     * @return array of objects.
+     */
+    public function get_meta_data() {
+        $this->maybe_read_meta_data();
+        return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
+    }
+
+    /**
+     * Check if the key is an internal one.
+     *
+     * @since  1.0.19
+     * @param  string $key Key to check.
+     * @return bool   true if it's an internal key, false otherwise
+     */
+    protected function is_internal_meta_key( $key ) {
+        $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
+
+        if ( ! $internal_meta_key ) {
+            return false;
+        }
+
+        $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
+
+        if ( ! $has_setter_or_getter ) {
+            return false;
+        }
+
+        /* translators: %s: $key Key to check */
+        getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
+
+        return true;
+    }
+
+    /**
+     * Magic method for setting data fields.
+     *
+     * This method does not update custom fields in the database.
+     *
+     * @since 1.0.19
+     * @access public
+     *
+     */
+    public function __set( $key, $value ) {
+
+        if ( 'id' == strtolower( $key ) ) {
+            return $this->set_id( $value );
+        }
+
+        if ( method_exists( $this, "set_$key") ) {
+
+            /* translators: %s: $key Key to set */
+            getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
+
+            call_user_func( array( $this, "set_$key" ), $value );
+        } else {
+            $this->set_prop( $key, $value );
+        }
+
+    }
+
+    /**
      * Margic method for retrieving a property.
      */
     public function __get( $key ) {
@@ -378,10 +378,10 @@ 
         // Check if we have a helper method for that.
         if ( method_exists( $this, 'get_' . $key ) ) {
 
-			if ( 'post_type' != $key ) {
-				/* translators: %s: $key Key to set */
-				getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
-			}
+            if ( 'post_type' != $key ) {
+                /* translators: %s: $key Key to set */
+                getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
+            }
 
             return call_user_func( array( $this, 'get_' . $key ) );
         }
@@ -391,512 +391,512 @@ 
             return $this->post->$key;
         }
 
-		return $this->get_prop( $key );
-
-    }
-
-	/**
-	 * Get Meta Data by Key.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @param  bool   $single return first found meta with key, or all with $key.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	public function get_meta( $key = '', $single = true, $context = 'view' ) {
-
-		// Check if this is an internal meta key.
-		$_key = str_replace( '_wpinv', '', $key );
-		$_key = str_replace( 'wpinv', '', $_key );
-		if ( $this->is_internal_meta_key( $_key ) ) {
-			$function = 'get_' . $_key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}();
-			}
-		}
-
-		// Read the meta data if not yet read.
-		$this->maybe_read_meta_data();
-		$meta_data  = $this->get_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
-		$value      = $single ? '' : array();
-
-		if ( ! empty( $array_keys ) ) {
-			// We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
-			if ( $single ) {
-				$value = $meta_data[ current( $array_keys ) ]->value;
-			} else {
-				$value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
-			}
-		}
-
-		if ( 'view' === $context ) {
-			$value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * See if meta data exists, since get_meta always returns a '' or array().
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @return boolean
-	 */
-	public function meta_exists( $key = '' ) {
-		$this->maybe_read_meta_data();
-		$array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
-		return in_array( $key, $array_keys, true );
-	}
-
-	/**
-	 * Set all meta data from array.
-	 *
-	 * @since 1.0.19
-	 * @param array $data Key/Value pairs.
-	 */
-	public function set_meta_data( $data ) {
-		if ( ! empty( $data ) && is_array( $data ) ) {
-			$this->maybe_read_meta_data();
-			foreach ( $data as $meta ) {
-				$meta = (array) $meta;
-				if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
-					$this->meta_data[] = new GetPaid_Meta_Data(
-						array(
-							'id'    => $meta['id'],
-							'key'   => $meta['key'],
-							'value' => $meta['value'],
-						)
-					);
-				}
-			}
-		}
-	}
-
-	/**
-	 * Add meta data.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string       $key Meta key.
-	 * @param string|array $value Meta value.
-	 * @param bool         $unique Should this be a unique key?.
-	 */
-	public function add_meta_data( $key, $value, $unique = false ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-		if ( $unique ) {
-			$this->delete_meta_data( $key );
-		}
-		$this->meta_data[] = new GetPaid_Meta_Data(
-			array(
-				'key'   => $key,
-				'value' => $value,
-			)
-		);
-	}
-
-	/**
-	 * Update meta data by key or ID, if provided.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param  string       $key Meta key.
-	 * @param  string|array $value Meta value.
-	 * @param  int          $meta_id Meta ID.
-	 */
-	public function update_meta_data( $key, $value, $meta_id = 0 ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-
-		$array_key = false;
-
-		if ( $meta_id ) {
-			$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
-			$array_key  = $array_keys ? current( $array_keys ) : false;
-		} else {
-			// Find matches by key.
-			$matches = array();
-			foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
-				if ( $meta->key === $key ) {
-					$matches[] = $meta_data_array_key;
-				}
-			}
-
-			if ( ! empty( $matches ) ) {
-				// Set matches to null so only one key gets the new value.
-				foreach ( $matches as $meta_data_array_key ) {
-					$this->meta_data[ $meta_data_array_key ]->value = null;
-				}
-				$array_key = current( $matches );
-			}
-		}
-
-		if ( false !== $array_key ) {
-			$meta        = $this->meta_data[ $array_key ];
-			$meta->key   = $key;
-			$meta->value = $value;
-		} else {
-			$this->add_meta_data( $key, $value, true );
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param string $key Meta key.
-	 */
-	public function delete_meta_data( $key ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param int $mid Meta ID.
-	 */
-	public function delete_meta_data_by_mid( $mid ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Read meta data if null.
-	 *
-	 * @since 1.0.19
-	 */
-	protected function maybe_read_meta_data() {
-		if ( is_null( $this->meta_data ) ) {
-			$this->read_meta_data();
-		}
-	}
-
-	/**
-	 * Read Meta Data from the database. Ignore any internal properties.
-	 * Uses it's own caches because get_metadata does not provide meta_ids.
-	 *
-	 * @since 1.0.19
-	 * @param bool $force_read True to force a new DB read (and update cache).
-	 */
-	public function read_meta_data( $force_read = false ) {
-
-		// Reset meta data.
-		$this->meta_data = array();
-
-		// Maybe abort early.
-		if ( ! $this->get_id() || ! $this->data_store ) {
-			return;
-		}
-
-		// Only read from cache if the cache key is set.
-		$cache_key = null;
-		if ( ! $force_read && ! empty( $this->cache_group ) ) {
-			$cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			$raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
-		}
-
-		// Should we force read?
-		if ( empty( $raw_meta_data ) ) {
-			$raw_meta_data = $this->data_store->read_meta( $this );
-
-			if ( ! empty( $cache_key ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
-			}
-
-		}
-
-		// Set meta data.
-		if ( is_array( $raw_meta_data ) ) {
-
-			foreach ( $raw_meta_data as $meta ) {
-				$this->meta_data[] = new GetPaid_Meta_Data(
-					array(
-						'id'    => (int) $meta->meta_id,
-						'key'   => $meta->meta_key,
-						'value' => maybe_unserialize( $meta->meta_value ),
-					)
-				);
-			}
-
-		}
-
-	}
-
-	/**
-	 * Update Meta Data in the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_meta_data() {
-		if ( ! $this->data_store || is_null( $this->meta_data ) ) {
-			return;
-		}
-		foreach ( $this->meta_data as $array_key => $meta ) {
-			if ( is_null( $meta->value ) ) {
-				if ( ! empty( $meta->id ) ) {
-					$this->data_store->delete_meta( $this, $meta );
-					unset( $this->meta_data[ $array_key ] );
-				}
-			} elseif ( empty( $meta->id ) ) {
-				$meta->id = $this->data_store->add_meta( $this, $meta );
-				$meta->apply_changes();
-			} else {
-				if ( $meta->get_changes() ) {
-					$this->data_store->update_meta( $this, $meta );
-					$meta->apply_changes();
-				}
-			}
-		}
-		if ( ! empty( $this->cache_group ) ) {
-			$cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			wp_cache_delete( $cache_key, $this->cache_group );
-		}
-	}
-
-	/**
-	 * Set ID.
-	 *
-	 * @since 1.0.19
-	 * @param int $id ID.
-	 */
-	public function set_id( $id ) {
-		$this->id = absint( $id );
-	}
-
-	/**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+        return $this->get_prop( $key );
+
+    }
+
+    /**
+     * Get Meta Data by Key.
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @param  bool   $single return first found meta with key, or all with $key.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    public function get_meta( $key = '', $single = true, $context = 'view' ) {
+
+        // Check if this is an internal meta key.
+        $_key = str_replace( '_wpinv', '', $key );
+        $_key = str_replace( 'wpinv', '', $_key );
+        if ( $this->is_internal_meta_key( $_key ) ) {
+            $function = 'get_' . $_key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}();
+            }
+        }
+
+        // Read the meta data if not yet read.
+        $this->maybe_read_meta_data();
+        $meta_data  = $this->get_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
+        $value      = $single ? '' : array();
+
+        if ( ! empty( $array_keys ) ) {
+            // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
+            if ( $single ) {
+                $value = $meta_data[ current( $array_keys ) ]->value;
+            } else {
+                $value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
+            }
+        }
+
+        if ( 'view' === $context ) {
+            $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
+        }
+
+        return $value;
+    }
+
+    /**
+     * See if meta data exists, since get_meta always returns a '' or array().
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @return boolean
+     */
+    public function meta_exists( $key = '' ) {
+        $this->maybe_read_meta_data();
+        $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
+        return in_array( $key, $array_keys, true );
+    }
+
+    /**
+     * Set all meta data from array.
+     *
+     * @since 1.0.19
+     * @param array $data Key/Value pairs.
+     */
+    public function set_meta_data( $data ) {
+        if ( ! empty( $data ) && is_array( $data ) ) {
+            $this->maybe_read_meta_data();
+            foreach ( $data as $meta ) {
+                $meta = (array) $meta;
+                if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
+                    $this->meta_data[] = new GetPaid_Meta_Data(
+                        array(
+                            'id'    => $meta['id'],
+                            'key'   => $meta['key'],
+                            'value' => $meta['value'],
+                        )
+                    );
+                }
+            }
+        }
+    }
+
+    /**
+     * Add meta data.
+     *
+     * @since 1.0.19
+     *
+     * @param string       $key Meta key.
+     * @param string|array $value Meta value.
+     * @param bool         $unique Should this be a unique key?.
+     */
+    public function add_meta_data( $key, $value, $unique = false ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+        if ( $unique ) {
+            $this->delete_meta_data( $key );
+        }
+        $this->meta_data[] = new GetPaid_Meta_Data(
+            array(
+                'key'   => $key,
+                'value' => $value,
+            )
+        );
+    }
+
+    /**
+     * Update meta data by key or ID, if provided.
+     *
+     * @since  1.0.19
+     *
+     * @param  string       $key Meta key.
+     * @param  string|array $value Meta value.
+     * @param  int          $meta_id Meta ID.
+     */
+    public function update_meta_data( $key, $value, $meta_id = 0 ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+
+        $array_key = false;
+
+        if ( $meta_id ) {
+            $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
+            $array_key  = $array_keys ? current( $array_keys ) : false;
+        } else {
+            // Find matches by key.
+            $matches = array();
+            foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
+                if ( $meta->key === $key ) {
+                    $matches[] = $meta_data_array_key;
+                }
+            }
+
+            if ( ! empty( $matches ) ) {
+                // Set matches to null so only one key gets the new value.
+                foreach ( $matches as $meta_data_array_key ) {
+                    $this->meta_data[ $meta_data_array_key ]->value = null;
+                }
+                $array_key = current( $matches );
+            }
+        }
+
+        if ( false !== $array_key ) {
+            $meta        = $this->meta_data[ $array_key ];
+            $meta->key   = $key;
+            $meta->value = $value;
+        } else {
+            $this->add_meta_data( $key, $value, true );
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param string $key Meta key.
+     */
+    public function delete_meta_data( $key ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param int $mid Meta ID.
+     */
+    public function delete_meta_data_by_mid( $mid ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Read meta data if null.
+     *
+     * @since 1.0.19
+     */
+    protected function maybe_read_meta_data() {
+        if ( is_null( $this->meta_data ) ) {
+            $this->read_meta_data();
+        }
+    }
+
+    /**
+     * Read Meta Data from the database. Ignore any internal properties.
+     * Uses it's own caches because get_metadata does not provide meta_ids.
+     *
+     * @since 1.0.19
+     * @param bool $force_read True to force a new DB read (and update cache).
+     */
+    public function read_meta_data( $force_read = false ) {
+
+        // Reset meta data.
+        $this->meta_data = array();
+
+        // Maybe abort early.
+        if ( ! $this->get_id() || ! $this->data_store ) {
+            return;
+        }
+
+        // Only read from cache if the cache key is set.
+        $cache_key = null;
+        if ( ! $force_read && ! empty( $this->cache_group ) ) {
+            $cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
+        }
+
+        // Should we force read?
+        if ( empty( $raw_meta_data ) ) {
+            $raw_meta_data = $this->data_store->read_meta( $this );
+
+            if ( ! empty( $cache_key ) ) {
+                wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+            }
+
+        }
+
+        // Set meta data.
+        if ( is_array( $raw_meta_data ) ) {
+
+            foreach ( $raw_meta_data as $meta ) {
+                $this->meta_data[] = new GetPaid_Meta_Data(
+                    array(
+                        'id'    => (int) $meta->meta_id,
+                        'key'   => $meta->meta_key,
+                        'value' => maybe_unserialize( $meta->meta_value ),
+                    )
+                );
+            }
+
+        }
+
+    }
+
+    /**
+     * Update Meta Data in the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_meta_data() {
+        if ( ! $this->data_store || is_null( $this->meta_data ) ) {
+            return;
+        }
+        foreach ( $this->meta_data as $array_key => $meta ) {
+            if ( is_null( $meta->value ) ) {
+                if ( ! empty( $meta->id ) ) {
+                    $this->data_store->delete_meta( $this, $meta );
+                    unset( $this->meta_data[ $array_key ] );
+                }
+            } elseif ( empty( $meta->id ) ) {
+                $meta->id = $this->data_store->add_meta( $this, $meta );
+                $meta->apply_changes();
+            } else {
+                if ( $meta->get_changes() ) {
+                    $this->data_store->update_meta( $this, $meta );
+                    $meta->apply_changes();
+                }
+            }
+        }
+        if ( ! empty( $this->cache_group ) ) {
+            $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            wp_cache_delete( $cache_key, $this->cache_group );
+        }
+    }
+
+    /**
+     * Set ID.
+     *
+     * @since 1.0.19
+     * @param int $id ID.
+     */
+    public function set_id( $id ) {
+        $this->id = absint( $id );
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
-		$this->set_prop( 'status', $status );
-
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
-    }
-
-	/**
-	 * Set all props to default values.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_defaults() {
-		$this->data    = $this->default_data;
-		$this->changes = array();
-		$this->set_object_read( false );
-	}
-
-	/**
-	 * Set object read property.
-	 *
-	 * @since 1.0.19
-	 * @param boolean $read Should read?.
-	 */
-	public function set_object_read( $read = true ) {
-		$this->object_read = (bool) $read;
-	}
-
-	/**
-	 * Get object read property.
-	 *
-	 * @since  1.0.19
-	 * @return boolean
-	 */
-	public function get_object_read() {
-		return (bool) $this->object_read;
-	}
-
-	/**
-	 * Set a collection of props in one go, collect any errors, and return the result.
-	 * Only sets using public methods.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
-	 * @param string $context In what context to run this.
-	 *
-	 * @return bool|WP_Error
-	 */
-	public function set_props( $props, $context = 'set' ) {
-		$errors = false;
-
-		foreach ( $props as $prop => $value ) {
-			try {
-				/**
-				 * Checks if the prop being set is allowed, and the value is not null.
-				 */
-				if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
-					continue;
-				}
-				$setter = "set_$prop";
-
-				if ( is_callable( array( $this, $setter ) ) ) {
-					$this->{$setter}( $value );
-				}
-			} catch ( Exception $e ) {
-				if ( ! $errors ) {
-					$errors = new WP_Error();
-				}
-				$errors->add( $e->getCode(), $e->getMessage() );
-				$this->last_error = $e->getMessage();
-			}
-		}
-
-		return $errors && count( $errors->get_error_codes() ) ? $errors : true;
-	}
-
-	/**
-	 * Sets a prop for a setter method.
-	 *
-	 * This stores changes in a special array so we can track what needs saving
-	 * the the DB later.
-	 *
-	 * @since 1.0.19
-	 * @param string $prop Name of prop to set.
-	 * @param mixed  $value Value of the prop.
-	 */
-	protected function set_prop( $prop, $value ) {
-		if ( array_key_exists( $prop, $this->data ) ) {
-			if ( true === $this->object_read ) {
-				if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
-					$this->changes[ $prop ] = $value;
-				}
-			} else {
-				$this->data[ $prop ] = $value;
-			}
-		}
-	}
-
-	/**
-	 * Return data changes only.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_changes() {
-		return $this->changes;
-	}
-
-	/**
-	 * Merge changes with data and clear.
-	 *
-	 * @since 1.0.19
-	 */
-	public function apply_changes() {
-		$this->data    = array_replace_recursive( $this->data, $this->changes );
-		$this->changes = array();
-	}
-
-	/**
-	 * Prefix for action and filter hooks on data.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	protected function get_hook_prefix() {
-		return 'wpinv_get_' . $this->object_type . '_';
-	}
-
-	/**
-	 * Gets a prop for a getter method.
-	 *
-	 * Gets the value from either current pending changes, or the data itself.
-	 * Context controls what happens to the value before it's returned.
-	 *
-	 * @since  1.0.19
-	 * @param  string $prop Name of prop to get.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	protected function get_prop( $prop, $context = 'view' ) {
-		$value = null;
-
-		if ( array_key_exists( $prop, $this->data ) ) {
-			$value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
-
-			if ( 'view' === $context ) {
-				$value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
-			}
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Sets a date prop whilst handling formatting and datetime objects.
-	 *
-	 * @since 1.0.19
-	 * @param string         $prop Name of prop to set.
-	 * @param string|integer $value Value of the prop.
-	 */
-	protected function set_date_prop( $prop, $value ) {
-
-		if ( empty( $value ) ) {
-			$this->set_prop( $prop, null );
-			return;
-		}
-		$this->set_prop( $prop, $value );
-
-	}
-
-	/**
-	 * When invalid data is found, throw an exception unless reading from the DB.
-	 *
-	 * @since 1.0.19
-	 * @param string $code             Error code.
-	 * @param string $message          Error message.
-	 */
-	protected function error( $code, $message ) {
-		$this->last_error = $message;
-	}
-
-	/**
-	 * Checks if the object is saved in the database
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function exists() {
-		$id = $this->get_id();
-		return ! empty( $id );
-	}
+        $this->set_prop( 'status', $status );
+
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
+    }
+
+    /**
+     * Set all props to default values.
+     *
+     * @since 1.0.19
+     */
+    public function set_defaults() {
+        $this->data    = $this->default_data;
+        $this->changes = array();
+        $this->set_object_read( false );
+    }
+
+    /**
+     * Set object read property.
+     *
+     * @since 1.0.19
+     * @param boolean $read Should read?.
+     */
+    public function set_object_read( $read = true ) {
+        $this->object_read = (bool) $read;
+    }
+
+    /**
+     * Get object read property.
+     *
+     * @since  1.0.19
+     * @return boolean
+     */
+    public function get_object_read() {
+        return (bool) $this->object_read;
+    }
+
+    /**
+     * Set a collection of props in one go, collect any errors, and return the result.
+     * Only sets using public methods.
+     *
+     * @since  1.0.19
+     *
+     * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
+     * @param string $context In what context to run this.
+     *
+     * @return bool|WP_Error
+     */
+    public function set_props( $props, $context = 'set' ) {
+        $errors = false;
+
+        foreach ( $props as $prop => $value ) {
+            try {
+                /**
+                 * Checks if the prop being set is allowed, and the value is not null.
+                 */
+                if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
+                    continue;
+                }
+                $setter = "set_$prop";
+
+                if ( is_callable( array( $this, $setter ) ) ) {
+                    $this->{$setter}( $value );
+                }
+            } catch ( Exception $e ) {
+                if ( ! $errors ) {
+                    $errors = new WP_Error();
+                }
+                $errors->add( $e->getCode(), $e->getMessage() );
+                $this->last_error = $e->getMessage();
+            }
+        }
+
+        return $errors && count( $errors->get_error_codes() ) ? $errors : true;
+    }
+
+    /**
+     * Sets a prop for a setter method.
+     *
+     * This stores changes in a special array so we can track what needs saving
+     * the the DB later.
+     *
+     * @since 1.0.19
+     * @param string $prop Name of prop to set.
+     * @param mixed  $value Value of the prop.
+     */
+    protected function set_prop( $prop, $value ) {
+        if ( array_key_exists( $prop, $this->data ) ) {
+            if ( true === $this->object_read ) {
+                if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
+                    $this->changes[ $prop ] = $value;
+                }
+            } else {
+                $this->data[ $prop ] = $value;
+            }
+        }
+    }
+
+    /**
+     * Return data changes only.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_changes() {
+        return $this->changes;
+    }
+
+    /**
+     * Merge changes with data and clear.
+     *
+     * @since 1.0.19
+     */
+    public function apply_changes() {
+        $this->data    = array_replace_recursive( $this->data, $this->changes );
+        $this->changes = array();
+    }
+
+    /**
+     * Prefix for action and filter hooks on data.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    protected function get_hook_prefix() {
+        return 'wpinv_get_' . $this->object_type . '_';
+    }
+
+    /**
+     * Gets a prop for a getter method.
+     *
+     * Gets the value from either current pending changes, or the data itself.
+     * Context controls what happens to the value before it's returned.
+     *
+     * @since  1.0.19
+     * @param  string $prop Name of prop to get.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    protected function get_prop( $prop, $context = 'view' ) {
+        $value = null;
+
+        if ( array_key_exists( $prop, $this->data ) ) {
+            $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
+
+            if ( 'view' === $context ) {
+                $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
+            }
+        }
+
+        return $value;
+    }
+
+    /**
+     * Sets a date prop whilst handling formatting and datetime objects.
+     *
+     * @since 1.0.19
+     * @param string         $prop Name of prop to set.
+     * @param string|integer $value Value of the prop.
+     */
+    protected function set_date_prop( $prop, $value ) {
+
+        if ( empty( $value ) ) {
+            $this->set_prop( $prop, null );
+            return;
+        }
+        $this->set_prop( $prop, $value );
+
+    }
+
+    /**
+     * When invalid data is found, throw an exception unless reading from the DB.
+     *
+     * @since 1.0.19
+     * @param string $code             Error code.
+     * @param string $message          Error message.
+     */
+    protected function error( $code, $message ) {
+        $this->last_error = $message;
+    }
+
+    /**
+     * Checks if the object is saved in the database
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function exists() {
+        $id = $this->get_id();
+        return ! empty( $id );
+    }
 
 }

Spacing +161 added lines, -161 removed lines

@@ -8,7 +8,7 @@ 
  *
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -117,8 +117,8 @@ 
 	 *
 	 * @param int|object|array $read ID to load from the DB (optional) or already queried data.
 	 */
-	public function __construct( $read = 0 ) {
-		$this->data         = array_merge( $this->data, $this->extra_data );
+	public function __construct($read = 0) {
+		$this->data         = array_merge($this->data, $this->extra_data);
 		$this->default_data = $this->data;
 	}
 
@@ -128,7 +128,7 @@ 
 	 * @return array
 	 */
 	public function __sleep() {
-		return array( 'id' );
+		return array('id');
 	}
 
 	/**
@@ -137,10 +137,10 @@ 
 	 * If the object no longer exists, remove the ID.
 	 */
 	public function __wakeup() {
-		$this->__construct( absint( $this->id ) );
+		$this->__construct(absint($this->id));
 
-		if ( ! empty( $this->last_error ) ) {
-			$this->set_id( 0 );
+		if (!empty($this->last_error)) {
+			$this->set_id(0);
 		}
 
 	}
@@ -152,11 +152,11 @@ 
 	 */
 	public function __clone() {
 		$this->maybe_read_meta_data();
-		if ( ! empty( $this->meta_data ) ) {
-			foreach ( $this->meta_data as $array_key => $meta ) {
-				$this->meta_data[ $array_key ] = clone $meta;
-				if ( ! empty( $meta->id ) ) {
-					$this->meta_data[ $array_key ]->id = null;
+		if (!empty($this->meta_data)) {
+			foreach ($this->meta_data as $array_key => $meta) {
+				$this->meta_data[$array_key] = clone $meta;
+				if (!empty($meta->id)) {
+					$this->meta_data[$array_key]->id = null;
 				}
 			}
 		}
@@ -199,8 +199,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
+	public function get_status($context = 'view') {
+		return $this->get_prop('status', $context);
     }
 
 	/**
@@ -210,10 +210,10 @@ 
 	 * @param  bool $force_delete Should the data be deleted permanently.
 	 * @return bool result
 	 */
-	public function delete( $force_delete = false ) {
-		if ( $this->data_store && $this->get_id() ) {
-			$this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
-			$this->set_id( 0 );
+	public function delete($force_delete = false) {
+		if ($this->data_store && $this->get_id()) {
+			$this->data_store->delete($this, array('force_delete' => $force_delete));
+			$this->set_id(0);
 			return true;
 		}
 		return false;
@@ -226,7 +226,7 @@ 
 	 * @return int
 	 */
 	public function save() {
-		if ( ! $this->data_store ) {
+		if (!$this->data_store) {
 			return $this->get_id();
 		}
 
@@ -236,12 +236,12 @@ 
 		 * @param GetPaid_Data          $this The object being saved.
 		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
 		 */
-		do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
+		do_action('getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store);
 
-		if ( $this->get_id() ) {
-			$this->data_store->update( $this );
+		if ($this->get_id()) {
+			$this->data_store->update($this);
 		} else {
-			$this->data_store->create( $this );
+			$this->data_store->create($this);
 		}
 
 		/**
@@ -250,7 +250,7 @@ 
 		 * @param GetPaid_Data          $this The object being saved.
 		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
 		 */
-		do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
+		do_action('getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store);
 
 		return $this->get_id();
 	}
@@ -262,7 +262,7 @@ 
 	 * @return string Data in JSON format.
 	 */
 	public function __toString() {
-		return wp_json_encode( $this->get_data() );
+		return wp_json_encode($this->get_data());
 	}
 
 	/**
@@ -272,7 +272,7 @@ 
 	 * @return array
 	 */
 	public function get_data() {
-		return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
+		return array_merge(array('id' => $this->get_id()), $this->data, array('meta_data' => $this->get_meta_data()));
 	}
 
 	/**
@@ -282,7 +282,7 @@ 
 	 * @return array
 	 */
 	public function get_data_keys() {
-		return array_keys( $this->data );
+		return array_keys($this->data);
 	}
 
 	/**
@@ -292,7 +292,7 @@ 
 	 * @return array
 	 */
 	public function get_extra_data_keys() {
-		return array_keys( $this->extra_data );
+		return array_keys($this->extra_data);
 	}
 
 	/**
@@ -302,8 +302,8 @@ 
 	 * @param mixed $meta Meta value to check.
 	 * @return bool
 	 */
-	protected function filter_null_meta( $meta ) {
-		return ! is_null( $meta->value );
+	protected function filter_null_meta($meta) {
+		return !is_null($meta->value);
 	}
 
 	/**
@@ -314,7 +314,7 @@ 
 	 */
 	public function get_meta_data() {
 		$this->maybe_read_meta_data();
-		return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
+		return array_values(array_filter($this->meta_data, array($this, 'filter_null_meta')));
 	}
 
 	/**
@@ -324,21 +324,21 @@ 
 	 * @param  string $key Key to check.
 	 * @return bool   true if it's an internal key, false otherwise
 	 */
-	protected function is_internal_meta_key( $key ) {
-		$internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
+	protected function is_internal_meta_key($key) {
+		$internal_meta_key = !empty($key) && $this->data_store && in_array($key, $this->data_store->get_internal_meta_keys(), true);
 
-		if ( ! $internal_meta_key ) {
+		if (!$internal_meta_key) {
 			return false;
 		}
 
-		$has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
+		$has_setter_or_getter = is_callable(array($this, 'set_' . $key)) || is_callable(array($this, 'get_' . $key));
 
-		if ( ! $has_setter_or_getter ) {
+		if (!$has_setter_or_getter) {
 			return false;
 		}
 
 		/* translators: %s: $key Key to check */
-		getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
+		getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid'), $key), '1.0.19');
 
 		return true;
 	}
@@ -352,20 +352,20 @@ 
 	 * @access public
 	 *
 	 */
-	public function __set( $key, $value ) {
+	public function __set($key, $value) {
 
-		if ( 'id' == strtolower( $key ) ) {
-			return $this->set_id( $value );
+		if ('id' == strtolower($key)) {
+			return $this->set_id($value);
 		}
 
-		if ( method_exists( $this, "set_$key") ) {
+		if (method_exists($this, "set_$key")) {
 
 			/* translators: %s: $key Key to set */
-			getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
+			getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid'), $key), '1.0.19');
 
-			call_user_func( array( $this, "set_$key" ), $value );
+			call_user_func(array($this, "set_$key"), $value);
 		} else {
-			$this->set_prop( $key, $value );
+			$this->set_prop($key, $value);
 		}
 
 	}
@@ -373,25 +373,25 @@ 
 	/**
      * Margic method for retrieving a property.
      */
-    public function __get( $key ) {
+    public function __get($key) {
 
         // Check if we have a helper method for that.
-        if ( method_exists( $this, 'get_' . $key ) ) {
+        if (method_exists($this, 'get_' . $key)) {
 
-			if ( 'post_type' != $key ) {
+			if ('post_type' != $key) {
 				/* translators: %s: $key Key to set */
-				getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
+				getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid'), $key), '1.0.19');
 			}
 
-            return call_user_func( array( $this, 'get_' . $key ) );
+            return call_user_func(array($this, 'get_' . $key));
         }
 
         // Check if the key is in the associated $post object.
-        if ( ! empty( $this->post ) && isset( $this->post->$key ) ) {
+        if (!empty($this->post) && isset($this->post->$key)) {
             return $this->post->$key;
         }
 
-		return $this->get_prop( $key );
+		return $this->get_prop($key);
 
     }
 
@@ -404,15 +404,15 @@ 
 	 * @param  string $context What the value is for. Valid values are view and edit.
 	 * @return mixed
 	 */
-	public function get_meta( $key = '', $single = true, $context = 'view' ) {
+	public function get_meta($key = '', $single = true, $context = 'view') {
 
 		// Check if this is an internal meta key.
-		$_key = str_replace( '_wpinv', '', $key );
-		$_key = str_replace( 'wpinv', '', $_key );
-		if ( $this->is_internal_meta_key( $_key ) ) {
+		$_key = str_replace('_wpinv', '', $key);
+		$_key = str_replace('wpinv', '', $_key);
+		if ($this->is_internal_meta_key($_key)) {
 			$function = 'get_' . $_key;
 
-			if ( is_callable( array( $this, $function ) ) ) {
+			if (is_callable(array($this, $function))) {
 				return $this->{$function}();
 			}
 		}
@@ -420,20 +420,20 @@ 
 		// Read the meta data if not yet read.
 		$this->maybe_read_meta_data();
 		$meta_data  = $this->get_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
+		$array_keys = array_keys(wp_list_pluck($meta_data, 'key'), $key, true);
 		$value      = $single ? '' : array();
 
-		if ( ! empty( $array_keys ) ) {
+		if (!empty($array_keys)) {
 			// We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
-			if ( $single ) {
-				$value = $meta_data[ current( $array_keys ) ]->value;
+			if ($single) {
+				$value = $meta_data[current($array_keys)]->value;
 			} else {
-				$value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
+				$value = array_intersect_key($meta_data, array_flip($array_keys));
 			}
 		}
 
-		if ( 'view' === $context ) {
-			$value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
+		if ('view' === $context) {
+			$value = apply_filters($this->get_hook_prefix() . $key, $value, $this);
 		}
 
 		return $value;
@@ -446,10 +446,10 @@ 
 	 * @param  string $key Meta Key.
 	 * @return boolean
 	 */
-	public function meta_exists( $key = '' ) {
+	public function meta_exists($key = '') {
 		$this->maybe_read_meta_data();
-		$array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
-		return in_array( $key, $array_keys, true );
+		$array_keys = wp_list_pluck($this->get_meta_data(), 'key');
+		return in_array($key, $array_keys, true);
 	}
 
 	/**
@@ -458,12 +458,12 @@ 
 	 * @since 1.0.19
 	 * @param array $data Key/Value pairs.
 	 */
-	public function set_meta_data( $data ) {
-		if ( ! empty( $data ) && is_array( $data ) ) {
+	public function set_meta_data($data) {
+		if (!empty($data) && is_array($data)) {
 			$this->maybe_read_meta_data();
-			foreach ( $data as $meta ) {
+			foreach ($data as $meta) {
 				$meta = (array) $meta;
-				if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
+				if (isset($meta['key'], $meta['value'], $meta['id'])) {
 					$this->meta_data[] = new GetPaid_Meta_Data(
 						array(
 							'id'    => $meta['id'],
@@ -485,18 +485,18 @@ 
 	 * @param string|array $value Meta value.
 	 * @param bool         $unique Should this be a unique key?.
 	 */
-	public function add_meta_data( $key, $value, $unique = false ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
+	public function add_meta_data($key, $value, $unique = false) {
+		if ($this->is_internal_meta_key($key)) {
 			$function = 'set_' . $key;
 
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
+			if (is_callable(array($this, $function))) {
+				return $this->{$function}($value);
 			}
 		}
 
 		$this->maybe_read_meta_data();
-		if ( $unique ) {
-			$this->delete_meta_data( $key );
+		if ($unique) {
+			$this->delete_meta_data($key);
 		}
 		$this->meta_data[] = new GetPaid_Meta_Data(
 			array(
@@ -515,12 +515,12 @@ 
 	 * @param  string|array $value Meta value.
 	 * @param  int          $meta_id Meta ID.
 	 */
-	public function update_meta_data( $key, $value, $meta_id = 0 ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
+	public function update_meta_data($key, $value, $meta_id = 0) {
+		if ($this->is_internal_meta_key($key)) {
 			$function = 'set_' . $key;
 
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
+			if (is_callable(array($this, $function))) {
+				return $this->{$function}($value);
 			}
 		}
 
@@ -528,33 +528,33 @@ 
 
 		$array_key = false;
 
-		if ( $meta_id ) {
-			$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
-			$array_key  = $array_keys ? current( $array_keys ) : false;
+		if ($meta_id) {
+			$array_keys = array_keys(wp_list_pluck($this->meta_data, 'id'), $meta_id, true);
+			$array_key  = $array_keys ? current($array_keys) : false;
 		} else {
 			// Find matches by key.
 			$matches = array();
-			foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
-				if ( $meta->key === $key ) {
+			foreach ($this->meta_data as $meta_data_array_key => $meta) {
+				if ($meta->key === $key) {
 					$matches[] = $meta_data_array_key;
 				}
 			}
 
-			if ( ! empty( $matches ) ) {
+			if (!empty($matches)) {
 				// Set matches to null so only one key gets the new value.
-				foreach ( $matches as $meta_data_array_key ) {
-					$this->meta_data[ $meta_data_array_key ]->value = null;
+				foreach ($matches as $meta_data_array_key) {
+					$this->meta_data[$meta_data_array_key]->value = null;
 				}
-				$array_key = current( $matches );
+				$array_key = current($matches);
 			}
 		}
 
-		if ( false !== $array_key ) {
-			$meta        = $this->meta_data[ $array_key ];
+		if (false !== $array_key) {
+			$meta        = $this->meta_data[$array_key];
 			$meta->key   = $key;
 			$meta->value = $value;
 		} else {
-			$this->add_meta_data( $key, $value, true );
+			$this->add_meta_data($key, $value, true);
 		}
 	}
 
@@ -564,13 +564,13 @@ 
 	 * @since 1.0.19
 	 * @param string $key Meta key.
 	 */
-	public function delete_meta_data( $key ) {
+	public function delete_meta_data($key) {
 		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
+		$array_keys = array_keys(wp_list_pluck($this->meta_data, 'key'), $key, true);
 
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
+		if ($array_keys) {
+			foreach ($array_keys as $array_key) {
+				$this->meta_data[$array_key]->value = null;
 			}
 		}
 	}
@@ -581,13 +581,13 @@ 
 	 * @since 1.0.19
 	 * @param int $mid Meta ID.
 	 */
-	public function delete_meta_data_by_mid( $mid ) {
+	public function delete_meta_data_by_mid($mid) {
 		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
+		$array_keys = array_keys(wp_list_pluck($this->meta_data, 'id'), (int) $mid, true);
 
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
+		if ($array_keys) {
+			foreach ($array_keys as $array_key) {
+				$this->meta_data[$array_key]->value = null;
 			}
 		}
 	}
@@ -598,7 +598,7 @@ 
 	 * @since 1.0.19
 	 */
 	protected function maybe_read_meta_data() {
-		if ( is_null( $this->meta_data ) ) {
+		if (is_null($this->meta_data)) {
 			$this->read_meta_data();
 		}
 	}
@@ -610,42 +610,42 @@ 
 	 * @since 1.0.19
 	 * @param bool $force_read True to force a new DB read (and update cache).
 	 */
-	public function read_meta_data( $force_read = false ) {
+	public function read_meta_data($force_read = false) {
 
 		// Reset meta data.
 		$this->meta_data = array();
 
 		// Maybe abort early.
-		if ( ! $this->get_id() || ! $this->data_store ) {
+		if (!$this->get_id() || !$this->data_store) {
 			return;
 		}
 
 		// Only read from cache if the cache key is set.
 		$cache_key = null;
-		if ( ! $force_read && ! empty( $this->cache_group ) ) {
-			$cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			$raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
+		if (!$force_read && !empty($this->cache_group)) {
+			$cache_key     = GetPaid_Cache_Helper::get_cache_prefix($this->cache_group) . GetPaid_Cache_Helper::get_cache_prefix('object_' . $this->get_id()) . 'object_meta_' . $this->get_id();
+			$raw_meta_data = wp_cache_get($cache_key, $this->cache_group);
 		}
 
 		// Should we force read?
-		if ( empty( $raw_meta_data ) ) {
-			$raw_meta_data = $this->data_store->read_meta( $this );
+		if (empty($raw_meta_data)) {
+			$raw_meta_data = $this->data_store->read_meta($this);
 
-			if ( ! empty( $cache_key ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+			if (!empty($cache_key)) {
+				wp_cache_set($cache_key, $raw_meta_data, $this->cache_group);
 			}
 
 		}
 
 		// Set meta data.
-		if ( is_array( $raw_meta_data ) ) {
+		if (is_array($raw_meta_data)) {
 
-			foreach ( $raw_meta_data as $meta ) {
+			foreach ($raw_meta_data as $meta) {
 				$this->meta_data[] = new GetPaid_Meta_Data(
 					array(
 						'id'    => (int) $meta->meta_id,
 						'key'   => $meta->meta_key,
-						'value' => maybe_unserialize( $meta->meta_value ),
+						'value' => maybe_unserialize($meta->meta_value),
 					)
 				);
 			}
@@ -660,28 +660,28 @@ 
 	 * @since 1.0.19
 	 */
 	public function save_meta_data() {
-		if ( ! $this->data_store || is_null( $this->meta_data ) ) {
+		if (!$this->data_store || is_null($this->meta_data)) {
 			return;
 		}
-		foreach ( $this->meta_data as $array_key => $meta ) {
-			if ( is_null( $meta->value ) ) {
-				if ( ! empty( $meta->id ) ) {
-					$this->data_store->delete_meta( $this, $meta );
-					unset( $this->meta_data[ $array_key ] );
+		foreach ($this->meta_data as $array_key => $meta) {
+			if (is_null($meta->value)) {
+				if (!empty($meta->id)) {
+					$this->data_store->delete_meta($this, $meta);
+					unset($this->meta_data[$array_key]);
 				}
-			} elseif ( empty( $meta->id ) ) {
-				$meta->id = $this->data_store->add_meta( $this, $meta );
+			} elseif (empty($meta->id)) {
+				$meta->id = $this->data_store->add_meta($this, $meta);
 				$meta->apply_changes();
 			} else {
-				if ( $meta->get_changes() ) {
-					$this->data_store->update_meta( $this, $meta );
+				if ($meta->get_changes()) {
+					$this->data_store->update_meta($this, $meta);
 					$meta->apply_changes();
 				}
 			}
 		}
-		if ( ! empty( $this->cache_group ) ) {
-			$cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			wp_cache_delete( $cache_key, $this->cache_group );
+		if (!empty($this->cache_group)) {
+			$cache_key = GetPaid_Cache_Helper::get_cache_prefix($this->cache_group) . GetPaid_Cache_Helper::get_cache_prefix('object_' . $this->get_id()) . 'object_meta_' . $this->get_id();
+			wp_cache_delete($cache_key, $this->cache_group);
 		}
 	}
 
@@ -691,8 +691,8 @@ 
 	 * @since 1.0.19
 	 * @param int $id ID.
 	 */
-	public function set_id( $id ) {
-		$this->id = absint( $id );
+	public function set_id($id) {
+		$this->id = absint($id);
 	}
 
 	/**
@@ -702,10 +702,10 @@ 
 	 * @param string $status New status.
 	 * @return array details of change.
 	 */
-	public function set_status( $status ) {
+	public function set_status($status) {
         $old_status = $this->get_status();
 
-		$this->set_prop( 'status', $status );
+		$this->set_prop('status', $status);
 
 		return array(
 			'from' => $old_status,
@@ -721,7 +721,7 @@ 
 	public function set_defaults() {
 		$this->data    = $this->default_data;
 		$this->changes = array();
-		$this->set_object_read( false );
+		$this->set_object_read(false);
 	}
 
 	/**
@@ -730,7 +730,7 @@ 
 	 * @since 1.0.19
 	 * @param boolean $read Should read?.
 	 */
-	public function set_object_read( $read = true ) {
+	public function set_object_read($read = true) {
 		$this->object_read = (bool) $read;
 	}
 
@@ -755,32 +755,32 @@ 
 	 *
 	 * @return bool|WP_Error
 	 */
-	public function set_props( $props, $context = 'set' ) {
+	public function set_props($props, $context = 'set') {
 		$errors = false;
 
-		foreach ( $props as $prop => $value ) {
+		foreach ($props as $prop => $value) {
 			try {
 				/**
 				 * Checks if the prop being set is allowed, and the value is not null.
 				 */
-				if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
+				if (is_null($value) || in_array($prop, array('prop', 'date_prop', 'meta_data'), true)) {
 					continue;
 				}
 				$setter = "set_$prop";
 
-				if ( is_callable( array( $this, $setter ) ) ) {
-					$this->{$setter}( $value );
+				if (is_callable(array($this, $setter))) {
+					$this->{$setter}($value);
 				}
-			} catch ( Exception $e ) {
-				if ( ! $errors ) {
+			} catch (Exception $e) {
+				if (!$errors) {
 					$errors = new WP_Error();
 				}
-				$errors->add( $e->getCode(), $e->getMessage() );
+				$errors->add($e->getCode(), $e->getMessage());
 				$this->last_error = $e->getMessage();
 			}
 		}
 
-		return $errors && count( $errors->get_error_codes() ) ? $errors : true;
+		return $errors && count($errors->get_error_codes()) ? $errors : true;
 	}
 
 	/**
@@ -793,14 +793,14 @@ 
 	 * @param string $prop Name of prop to set.
 	 * @param mixed  $value Value of the prop.
 	 */
-	protected function set_prop( $prop, $value ) {
-		if ( array_key_exists( $prop, $this->data ) ) {
-			if ( true === $this->object_read ) {
-				if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
-					$this->changes[ $prop ] = $value;
+	protected function set_prop($prop, $value) {
+		if (array_key_exists($prop, $this->data)) {
+			if (true === $this->object_read) {
+				if ($value !== $this->data[$prop] || array_key_exists($prop, $this->changes)) {
+					$this->changes[$prop] = $value;
 				}
 			} else {
-				$this->data[ $prop ] = $value;
+				$this->data[$prop] = $value;
 			}
 		}
 	}
@@ -821,7 +821,7 @@ 
 	 * @since 1.0.19
 	 */
 	public function apply_changes() {
-		$this->data    = array_replace_recursive( $this->data, $this->changes );
+		$this->data    = array_replace_recursive($this->data, $this->changes);
 		$this->changes = array();
 	}
 
@@ -846,14 +846,14 @@ 
 	 * @param  string $context What the value is for. Valid values are view and edit.
 	 * @return mixed
 	 */
-	protected function get_prop( $prop, $context = 'view' ) {
+	protected function get_prop($prop, $context = 'view') {
 		$value = null;
 
-		if ( array_key_exists( $prop, $this->data ) ) {
-			$value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
+		if (array_key_exists($prop, $this->data)) {
+			$value = array_key_exists($prop, $this->changes) ? $this->changes[$prop] : $this->data[$prop];
 
-			if ( 'view' === $context ) {
-				$value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
+			if ('view' === $context) {
+				$value = apply_filters($this->get_hook_prefix() . $prop, $value, $this);
 			}
 		}
 
@@ -867,13 +867,13 @@ 
 	 * @param string         $prop Name of prop to set.
 	 * @param string|integer $value Value of the prop.
 	 */
-	protected function set_date_prop( $prop, $value ) {
+	protected function set_date_prop($prop, $value) {
 
-		if ( empty( $value ) ) {
-			$this->set_prop( $prop, null );
+		if (empty($value)) {
+			$this->set_prop($prop, null);
 			return;
 		}
-		$this->set_prop( $prop, $value );
+		$this->set_prop($prop, $value);
 
 	}
 
@@ -884,7 +884,7 @@ 
 	 * @param string $code             Error code.
 	 * @param string $message          Error message.
 	 */
-	protected function error( $code, $message ) {
+	protected function error($code, $message) {
 		$this->last_error = $message;
 	}
 
@@ -896,7 +896,7 @@ 
 	 */
 	public function exists() {
 		$id = $this->get_id();
-		return ! empty( $id );
+		return !empty($id);
 	}
 
 }

includes/data-stores/class-getpaid-subscription-data-store.php

Indentation +180 added lines, -180 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,196 +15,196 @@ 
  */
 class GetPaid_Subscription_Data_Store {
 
-	/**
-	 * A map of database fields to data types.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $database_fields_to_data_type = array(
-		'id'                => '%d',
-		'customer_id'       => '%d',
-		'frequency'         => '%d',
-		'period'            => '%s',
-		'initial_amount'    => '%s',
-		'recurring_amount'  => '%s',
-		'bill_times'        => '%d',
-		'transaction_id'    => '%s',
-		'parent_payment_id' => '%d',
-		'product_id'        => '%d',
-		'created'           => '%s',
-		'expiration'        => '%s',
-		'trial_period'      => '%s',
-		'status'            => '%s',
-		'profile_id'        => '%s',
-	);
-
-	/*
+    /**
+     * A map of database fields to data types.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $database_fields_to_data_type = array(
+        'id'                => '%d',
+        'customer_id'       => '%d',
+        'frequency'         => '%d',
+        'period'            => '%s',
+        'initial_amount'    => '%s',
+        'recurring_amount'  => '%s',
+        'bill_times'        => '%d',
+        'transaction_id'    => '%s',
+        'parent_payment_id' => '%d',
+        'product_id'        => '%d',
+        'created'           => '%s',
+        'expiration'        => '%s',
+        'trial_period'      => '%s',
+        'status'            => '%s',
+        'profile_id'        => '%s',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new subscription in the database.
-	 *
-	 * @param WPInv_Subscription $subscription Subscription object.
-	 */
-	public function create( &$subscription ) {
-		global $wpdb;
-
-		$values  = array();
-		$formats = array();
-
-		$fields = $this->database_fields_to_data_type;
-		unset( $fields['id'] );
-
-		foreach ( $fields as $key => $format ) {
-			$method       = "get_$key";
-			$values[$key] = $subscription->$method( 'edit' );
-			$formats[]    = $format;
-		}
-
-		$result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats );
-
-		if ( $result ) {
-			$subscription->set_id( $wpdb->insert_id );
-			$subscription->apply_changes();
-			$subscription->clear_cache();
-			update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() );
-			do_action( 'getpaid_new_subscription', $subscription );
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a subscription from the database.
-	 *
-	 * @param WPInv_Subscription $subscription Subscription object.
-	 *
-	 */
-	public function read( &$subscription ) {
-		global $wpdb;
-
-		$subscription->set_defaults();
-
-		if ( ! $subscription->get_id() ) {
-			$subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
-			$subscription->set_id( 0 );
-			return false;
-		}
-
-		// Maybe retrieve from the cache.
-		$raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' );
-
-		// If not found, retrieve from the db.
-		if ( false === $raw_subscription ) {
-
-			$raw_subscription = $wpdb->get_row(
-				$wpdb->prepare(
-					"SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d",
-					$subscription->get_id()
-				)
-			);
-
-			// Update the cache with our data
-			wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' );
-
-		}
-
-		if ( ! $raw_subscription ) {
-			$subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
-			return false;
-		}
-
-		foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) {
-			$method     = "set_$key";
-			$subscription->$method( $raw_subscription->$key );
-		}
-
-		$subscription->set_object_read( true );
-		do_action( 'getpaid_read_subscription', $subscription );
-
-	}
-
-	/**
-	 * Method to update a subscription in the database.
-	 *
-	 * @param WPInv_Subscription $subscription Subscription object.
-	 */
-	public function update( &$subscription ) {
-		global $wpdb;
-
-		$changes = $subscription->get_changes();
-		$values  = array();
-		$format  = array();
-
-		foreach ( $this->database_fields_to_data_type as $key => $format ) {
-			if ( array_key_exists( $key, $changes ) ) {
-				$method       = "get_$key";
-				$values[$key] = $subscription->$method( 'edit' );
-				$formats[]    = $format;
-			}
-		}
-
-		if ( empty( $values ) ) {
-			return;
-		}
-
-		$wpdb->update(
-			$wpdb->prefix . 'wpinv_subscriptions',
-			$values,
-			array(
-				'id' => $subscription->get_id(),
-			),
-			$formats,
-			'%d'
-		);
-
-		// Apply the changes.
-		$subscription->apply_changes();
-
-		// Delete cache.
-		$subscription->clear_cache();
-
-		update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() );
-
-		// Fire a hook.
-		do_action( 'getpaid_update_subscription', $subscription );
-
-	}
-
-	/**
-	 * Method to delete a subscription from the database.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function delete( &$subscription ) {
-		global $wpdb;
-
-		$wpdb->query(
-			$wpdb->prepare(
-				"DELETE FROM {$wpdb->prefix}getpaid_subscriptions
+    /**
+     * Method to create a new subscription in the database.
+     *
+     * @param WPInv_Subscription $subscription Subscription object.
+     */
+    public function create( &$subscription ) {
+        global $wpdb;
+
+        $values  = array();
+        $formats = array();
+
+        $fields = $this->database_fields_to_data_type;
+        unset( $fields['id'] );
+
+        foreach ( $fields as $key => $format ) {
+            $method       = "get_$key";
+            $values[$key] = $subscription->$method( 'edit' );
+            $formats[]    = $format;
+        }
+
+        $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats );
+
+        if ( $result ) {
+            $subscription->set_id( $wpdb->insert_id );
+            $subscription->apply_changes();
+            $subscription->clear_cache();
+            update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() );
+            do_action( 'getpaid_new_subscription', $subscription );
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a subscription from the database.
+     *
+     * @param WPInv_Subscription $subscription Subscription object.
+     *
+     */
+    public function read( &$subscription ) {
+        global $wpdb;
+
+        $subscription->set_defaults();
+
+        if ( ! $subscription->get_id() ) {
+            $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
+            $subscription->set_id( 0 );
+            return false;
+        }
+
+        // Maybe retrieve from the cache.
+        $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' );
+
+        // If not found, retrieve from the db.
+        if ( false === $raw_subscription ) {
+
+            $raw_subscription = $wpdb->get_row(
+                $wpdb->prepare(
+                    "SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d",
+                    $subscription->get_id()
+                )
+            );
+
+            // Update the cache with our data
+            wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' );
+
+        }
+
+        if ( ! $raw_subscription ) {
+            $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
+            return false;
+        }
+
+        foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) {
+            $method     = "set_$key";
+            $subscription->$method( $raw_subscription->$key );
+        }
+
+        $subscription->set_object_read( true );
+        do_action( 'getpaid_read_subscription', $subscription );
+
+    }
+
+    /**
+     * Method to update a subscription in the database.
+     *
+     * @param WPInv_Subscription $subscription Subscription object.
+     */
+    public function update( &$subscription ) {
+        global $wpdb;
+
+        $changes = $subscription->get_changes();
+        $values  = array();
+        $format  = array();
+
+        foreach ( $this->database_fields_to_data_type as $key => $format ) {
+            if ( array_key_exists( $key, $changes ) ) {
+                $method       = "get_$key";
+                $values[$key] = $subscription->$method( 'edit' );
+                $formats[]    = $format;
+            }
+        }
+
+        if ( empty( $values ) ) {
+            return;
+        }
+
+        $wpdb->update(
+            $wpdb->prefix . 'wpinv_subscriptions',
+            $values,
+            array(
+                'id' => $subscription->get_id(),
+            ),
+            $formats,
+            '%d'
+        );
+
+        // Apply the changes.
+        $subscription->apply_changes();
+
+        // Delete cache.
+        $subscription->clear_cache();
+
+        update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() );
+
+        // Fire a hook.
+        do_action( 'getpaid_update_subscription', $subscription );
+
+    }
+
+    /**
+     * Method to delete a subscription from the database.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function delete( &$subscription ) {
+        global $wpdb;
+
+        $wpdb->query(
+            $wpdb->prepare(
+                "DELETE FROM {$wpdb->prefix}getpaid_subscriptions
 				WHERE id = %d",
-				$subscription->get_id()
-			)
-		);
+                $subscription->get_id()
+            )
+        );
 
-		delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' );
-		delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' );
+        delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' );
+        delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' );
 
-		// Delete cache.
-		$subscription->clear_cache();
+        // Delete cache.
+        $subscription->clear_cache();
 
-		// Fire a hook.
-		do_action( 'getpaid_delete_subscription', $subscription );
+        // Fire a hook.
+        do_action( 'getpaid_delete_subscription', $subscription );
 
-		$subscription->set_id( 0 );
-	}
+        $subscription->set_id( 0 );
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

Spacing +36 added lines, -36 removed lines

@@ -4,7 +4,7 @@ 
  * GetPaid_Subscription_Data_Store class file.
  *
  */
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -50,29 +50,29 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription Subscription object.
 	 */
-	public function create( &$subscription ) {
+	public function create(&$subscription) {
 		global $wpdb;
 
 		$values  = array();
 		$formats = array();
 
 		$fields = $this->database_fields_to_data_type;
-		unset( $fields['id'] );
+		unset($fields['id']);
 
-		foreach ( $fields as $key => $format ) {
+		foreach ($fields as $key => $format) {
 			$method       = "get_$key";
-			$values[$key] = $subscription->$method( 'edit' );
+			$values[$key] = $subscription->$method('edit');
 			$formats[]    = $format;
 		}
 
-		$result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats );
+		$result = $wpdb->insert($wpdb->prefix . 'wpinv_subscriptions', $values, $formats);
 
-		if ( $result ) {
-			$subscription->set_id( $wpdb->insert_id );
+		if ($result) {
+			$subscription->set_id($wpdb->insert_id);
 			$subscription->apply_changes();
 			$subscription->clear_cache();
-			update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() );
-			do_action( 'getpaid_new_subscription', $subscription );
+			update_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id());
+			do_action('getpaid_new_subscription', $subscription);
 			return true;
 		}
 
@@ -85,22 +85,22 @@ 
 	 * @param WPInv_Subscription $subscription Subscription object.
 	 *
 	 */
-	public function read( &$subscription ) {
+	public function read(&$subscription) {
 		global $wpdb;
 
 		$subscription->set_defaults();
 
-		if ( ! $subscription->get_id() ) {
-			$subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
-			$subscription->set_id( 0 );
+		if (!$subscription->get_id()) {
+			$subscription->last_error = __('Invalid subscription ID.', 'invoicing');
+			$subscription->set_id(0);
 			return false;
 		}
 
 		// Maybe retrieve from the cache.
-		$raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' );
+		$raw_subscription = wp_cache_get($subscription->get_id(), 'getpaid_subscriptions');
 
 		// If not found, retrieve from the db.
-		if ( false === $raw_subscription ) {
+		if (false === $raw_subscription) {
 
 			$raw_subscription = $wpdb->get_row(
 				$wpdb->prepare(
@@ -110,22 +110,22 @@ 
 			);
 
 			// Update the cache with our data
-			wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' );
+			wp_cache_set($subscription->get_id(), $raw_subscription, 'getpaid_subscriptions');
 
 		}
 
-		if ( ! $raw_subscription ) {
-			$subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
+		if (!$raw_subscription) {
+			$subscription->last_error = __('Invalid subscription ID.', 'invoicing');
 			return false;
 		}
 
-		foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) {
-			$method     = "set_$key";
-			$subscription->$method( $raw_subscription->$key );
+		foreach (array_keys($this->database_fields_to_data_type) as $key) {
+			$method = "set_$key";
+			$subscription->$method($raw_subscription->$key);
 		}
 
-		$subscription->set_object_read( true );
-		do_action( 'getpaid_read_subscription', $subscription );
+		$subscription->set_object_read(true);
+		do_action('getpaid_read_subscription', $subscription);
 
 	}
 
@@ -134,22 +134,22 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription Subscription object.
 	 */
-	public function update( &$subscription ) {
+	public function update(&$subscription) {
 		global $wpdb;
 
 		$changes = $subscription->get_changes();
 		$values  = array();
 		$format  = array();
 
-		foreach ( $this->database_fields_to_data_type as $key => $format ) {
-			if ( array_key_exists( $key, $changes ) ) {
+		foreach ($this->database_fields_to_data_type as $key => $format) {
+			if (array_key_exists($key, $changes)) {
 				$method       = "get_$key";
-				$values[$key] = $subscription->$method( 'edit' );
+				$values[$key] = $subscription->$method('edit');
 				$formats[]    = $format;
 			}
 		}
 
-		if ( empty( $values ) ) {
+		if (empty($values)) {
 			return;
 		}
 
@@ -169,10 +169,10 @@ 
 		// Delete cache.
 		$subscription->clear_cache();
 
-		update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() );
+		update_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id());
 
 		// Fire a hook.
-		do_action( 'getpaid_update_subscription', $subscription );
+		do_action('getpaid_update_subscription', $subscription);
 
 	}
 
@@ -181,7 +181,7 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription
 	 */
-	public function delete( &$subscription ) {
+	public function delete(&$subscription) {
 		global $wpdb;
 
 		$wpdb->query(
@@ -192,16 +192,16 @@ 
 			)
 		);
 
-		delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' );
-		delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' );
+		delete_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id');
+		delete_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscription_id');
 
 		// Delete cache.
 		$subscription->clear_cache();
 
 		// Fire a hook.
-		do_action( 'getpaid_delete_subscription', $subscription );
+		do_action('getpaid_delete_subscription', $subscription);
 
-		$subscription->set_id( 0 );
+		$subscription->set_id(0);
 	}
 
 	/*

includes/api/class-getpaid-rest-crud-controller.php

Indentation +471 added lines, -471 removed lines

@@ -17,476 +17,476 @@
  */
 class GetPaid_REST_CRUD_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * Contains this controller's class name.
-	 *
-	 * @var string
-	 */
-	public $crud_class;
-
-	/**
-	 * Contains the current CRUD object.
-	 *
-	 * @var GetPaid_Data
-	 */
-	protected $data_object;
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base,
-			array(
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_items' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-					'args'                => $this->get_collection_params(),
-				),
-				array(
-					'methods'             => WP_REST_Server::CREATABLE,
-					'callback'            => array( $this, 'create_item' ),
-					'permission_callback' => array( $this, 'create_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		);
-
-		$get_item_args = array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
-		);
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base . '/(?P<id>[\d]+)',
-			array(
-				'args'   => array(
-					'id' => array(
-						'description' => __( 'Unique identifier for the object.', 'invoicing' ),
-						'type'        => 'integer',
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_item' ),
-					'permission_callback' => array( $this, 'get_item_permissions_check' ),
-					'args'                => $get_item_args,
-				),
-				array(
-					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'update_item' ),
-					'permission_callback' => array( $this, 'update_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
-				),
-				array(
-					'methods'             => WP_REST_Server::DELETABLE,
-					'callback'            => array( $this, 'delete_item' ),
-					'permission_callback' => array( $this, 'delete_item_permissions_check' ),
-					'args'                => array(
-						'force' => array(
-							'type'        => 'boolean',
-							'default'     => false,
-							'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ),
-						),
-					),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Saves a single object.
-	 *
-	 * @param GetPaid_Data $object Object to save.
-	 * @return WP_Error|GetPaid_Data
-	 */
-	protected function save_object( $object ) {
-		$object->save();
-
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) );
-		}
-
-		return new $this->crud_class( $object->get_id() );
-	}
-
-	/**
-	 * Retrieves a single object.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @param int|WP_Post $object_id Supplied ID.
-	 * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise.
-	 */
-	protected function get_object( $object_id ) {
-
-		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
-		}
-
-		// Fetch the object.
-		$object = new $this->crud_class( $object_id );
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) );
-		}
-
-		$this->data_object = $object;
-		return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) );
-
-	}
-
-	/**
-	 * Get a single object.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_item( $request ) {
-
-		// Fetch the item.
-		$object = $this->get_object( $request['id'] );
-
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Generate a response.
-		return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) );
-
-	}
-
-	/**
-	 * Create a single object.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function create_item( $request ) {
-
-		// Can not create an existing item.
-		if ( ! empty( $request['id'] ) ) {
-			/* translators: %s: post type */
-			return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		// Generate a GetPaid_Data object from the request.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save the object.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save special fields.
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
-			$object->delete( true );
-			return $save_special;
-		}
-
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		$response = rest_ensure_response( $response );
-		$response->set_status( 201 );
-		$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) );
-
-		return $response;
-	}
-
-	/**
-	 * Update a single object.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function update_item( $request ) {
-
-		// Fetch the item.
-		$object = $this->get_object( $request['id'] );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Prepare the item for saving.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save the item.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save special fields (those added via hooks).
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
-			return $save_special;
-		}
-
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		return rest_ensure_response( $response );
-	}
-
-	/**
-	 * Prepare links for the request.
-	 *
-	 * @param GetPaid_Data    $object GetPaid_Data object.
-	 * @return array Links for the given object.
-	 */
-	protected function prepare_links( $object ) {
-
-		$links = array(
-			'self'       => array(
-				'href'   => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ),
-			),
-			'collection' => array(
-				'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-			),
-		);
-
-		return $links;
-	}
-
-	/**
-	 * Get the query params for collections of attachments.
-	 *
-	 * @return array
-	 */
-	public function get_collection_params() {
-		$params = parent::get_collection_params();
-		$params['context']['default'] = 'view';
-		return $params;
-	}
-
-	/**
-	 * Only return writable props from schema.
-	 *
-	 * @param  array $schema Schema.
-	 * @return bool
-	 */
-	public function filter_writable_props( $schema ) {
-		return empty( $schema['readonly'] );
-	}
-
-	/**
-	 * Prepare a single object for create or update.
-	 *
-	 * @since 1.0.19
-	 * @param  WP_REST_Request $request Request object.
-	 * @return GetPaid_Data|WP_Error Data object or WP_Error.
-	 */
-	protected function prepare_item_for_database( $request ) {
-
-		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
-		}
-
-		// Prepare the object.
-		$id        = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
-		$object    = new $this->crud_class( $id );
-
-		// Abort if an error exists.
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'invalid_item', $object->last_error );
-		}
-
-		$schema    = $this->get_item_schema();
-		$data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) );
-
-		// Handle all writable props.
-		foreach ( $data_keys as $key ) {
-			$value = $request[ $key ];
-
-			if ( ! is_null( $value ) ) {
-				switch ( $key ) {
-
-					case 'meta_data':
-						if ( is_array( $value ) ) {
-							foreach ( $value as $meta ) {
-								$object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
-							}
-						}
-						break;
-
-					default:
-						if ( is_callable( array( $object, "set_{$key}" ) ) ) {
-							$object->{"set_{$key}"}( $value );
-						}
-						break;
-				}
-			}
-
-		}
-
-		// Filters an object before it is inserted via the REST API..
-		return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request );
-	}
-
-	/**
-	 * Retrieves data from a GetPaid class.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Meta_Data[]    $meta_data  meta data objects.
-	 * @return array
-	 */
-	protected function prepare_object_meta_data( $meta_data ) {
-		$meta = array();
-
-		foreach( $meta_data as $object ) {
-			$meta[] = $object->get_data();
-		}
-
-		return $meta;
-	}
-
-	/**
-	 * Retrieves invoice items.
-	 *
-	 * @since  1.0.19
-	 * @param  WPInv_Invoice $invoice  Invoice items.
-	 * @param array            $fields Fields to include.
-	 * @return array
-	 */
-	protected function prepare_invoice_items( $invoice ) {
-		$items = array();
-
-		foreach( $invoice->get_items() as $item ) {
-
-			$item_data = $item->prepare_data_for_saving();
-
-			if ( 'amount' == $invoice->get_template() ) {
-				$item_data['quantity'] = 1;
-			}
-
-			$items[] = $item_data;
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves data from a GetPaid class.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data    $object  Data object.
-	 * @param array            $fields Fields to include.
-	 * @param string           $context either view or edit.
-	 * @return array
-	 */
-	protected function prepare_object_data( $object, $fields, $context = 'view' ) {
-
-		$data = array();
-
-		// Handle all writable props.
-		foreach ( array_keys( $this->get_schema_properties() ) as $key ) {
-
-			// Abort if it is not included.
-			if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) {
-				continue;
-			}
-
-			// Or this current object does not support the field.
-			if ( ! $this->object_supports_field( $object, $key ) ) {
-				continue;
-			}
-
-			// Handle meta data.
-			if ( $key == 'meta_data' ) {
-				$data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() );
-				continue;
-			}
-
-			// Handle items.
-			if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' )  ) {
-				$data['items'] = $this->prepare_invoice_items( $object );
-				continue;
-			}
-
-			// Booleans.
-			if ( is_callable( array( $object, $key ) ) ) {
-				$data[ $key ] = $object->$key( $context );
-				continue;
-			}
-
-			// Get object value.
-			if ( is_callable( array( $object, "get_{$key}" ) ) ) {
-				$value = $object->{"get_{$key}"}( $context );
-
-				// If the value is an instance of GetPaid_Data...
-				if ( is_a( $value, 'GetPaid_Data' ) ) {
-					$value = $value->get_data( $context );
-				}
-
-				// For objects, retrieves it's properties.
-				$data[ $key ] = is_object( $value ) ? get_object_vars( $value ) :  $value ;
-				continue;
-			}
-
-		}
-
-		return $data;
-	}
-
-	/**
-	 * Checks if a key should be included in a response.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data $object  Data object.
-	 * @param  string       $field_key The key to check for.
-	 * @return bool
-	 */
-	public function object_supports_field( $object, $field_key ) {
-		return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key );
-	}
-
-	/**
-	 * Prepare a single object output for response.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data    $object  Data object.
-	 * @param  WP_REST_Request $request Request object.
-	 * @return WP_REST_Response
-	 */
-	public function prepare_item_for_response( $object, $request ) {
-		remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
-
-		$this->data_object = $object;
-
-		// Fetch the fields to include in this response.
-		$fields = $this->get_fields_for_response( $request );
-
-		// Prepare object data.
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $this->prepare_object_data( $object, $fields, $context );
-		$data    = $this->add_additional_fields_to_object( $data, $request );
-		$data    = $this->limit_object_to_requested_fields( $data, $fields );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		// Prepare the response.
-		$response = rest_ensure_response( $data );
-		$response->add_links( $this->prepare_links( $object, $request ) );
-
-		// Filter item response.
-		return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request );
-	}
+    /**
+     * Contains this controller's class name.
+     *
+     * @var string
+     */
+    public $crud_class;
+
+    /**
+     * Contains the current CRUD object.
+     *
+     * @var GetPaid_Data
+     */
+    protected $data_object;
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 1.0.19
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base,
+            array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_items' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                    'args'                => $this->get_collection_params(),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::CREATABLE,
+                    'callback'            => array( $this, 'create_item' ),
+                    'permission_callback' => array( $this, 'create_item_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+        $get_item_args = array(
+            'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+        );
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base . '/(?P<id>[\d]+)',
+            array(
+                'args'   => array(
+                    'id' => array(
+                        'description' => __( 'Unique identifier for the object.', 'invoicing' ),
+                        'type'        => 'integer',
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_item' ),
+                    'permission_callback' => array( $this, 'get_item_permissions_check' ),
+                    'args'                => $get_item_args,
+                ),
+                array(
+                    'methods'             => WP_REST_Server::EDITABLE,
+                    'callback'            => array( $this, 'update_item' ),
+                    'permission_callback' => array( $this, 'update_item_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::DELETABLE,
+                    'callback'            => array( $this, 'delete_item' ),
+                    'permission_callback' => array( $this, 'delete_item_permissions_check' ),
+                    'args'                => array(
+                        'force' => array(
+                            'type'        => 'boolean',
+                            'default'     => false,
+                            'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ),
+                        ),
+                    ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+    }
+
+    /**
+     * Saves a single object.
+     *
+     * @param GetPaid_Data $object Object to save.
+     * @return WP_Error|GetPaid_Data
+     */
+    protected function save_object( $object ) {
+        $object->save();
+
+        if ( ! empty( $object->last_error ) ) {
+            return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) );
+        }
+
+        return new $this->crud_class( $object->get_id() );
+    }
+
+    /**
+     * Retrieves a single object.
+     *
+     * @since 1.0.13
+     *
+     * @param int|WP_Post $object_id Supplied ID.
+     * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise.
+     */
+    protected function get_object( $object_id ) {
+
+        // Do we have an object?
+        if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
+            return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+        }
+
+        // Fetch the object.
+        $object = new $this->crud_class( $object_id );
+        if ( ! empty( $object->last_error ) ) {
+            return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) );
+        }
+
+        $this->data_object = $object;
+        return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) );
+
+    }
+
+    /**
+     * Get a single object.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_item( $request ) {
+
+        // Fetch the item.
+        $object = $this->get_object( $request['id'] );
+
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Generate a response.
+        return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) );
+
+    }
+
+    /**
+     * Create a single object.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function create_item( $request ) {
+
+        // Can not create an existing item.
+        if ( ! empty( $request['id'] ) ) {
+            /* translators: %s: post type */
+            return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        // Generate a GetPaid_Data object from the request.
+        $object = $this->prepare_item_for_database( $request );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save the object.
+        $object = $this->save_object( $object );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save special fields.
+        $save_special = $this->update_additional_fields_for_object( $object, $request );
+        if ( is_wp_error( $save_special ) ) {
+            $object->delete( true );
+            return $save_special;
+        }
+
+        $request->set_param( 'context', 'edit' );
+        $response = $this->prepare_item_for_response( $object, $request );
+        $response = rest_ensure_response( $response );
+        $response->set_status( 201 );
+        $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) );
+
+        return $response;
+    }
+
+    /**
+     * Update a single object.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function update_item( $request ) {
+
+        // Fetch the item.
+        $object = $this->get_object( $request['id'] );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Prepare the item for saving.
+        $object = $this->prepare_item_for_database( $request );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save the item.
+        $object = $this->save_object( $object );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save special fields (those added via hooks).
+        $save_special = $this->update_additional_fields_for_object( $object, $request );
+        if ( is_wp_error( $save_special ) ) {
+            return $save_special;
+        }
+
+        $request->set_param( 'context', 'edit' );
+        $response = $this->prepare_item_for_response( $object, $request );
+        return rest_ensure_response( $response );
+    }
+
+    /**
+     * Prepare links for the request.
+     *
+     * @param GetPaid_Data    $object GetPaid_Data object.
+     * @return array Links for the given object.
+     */
+    protected function prepare_links( $object ) {
+
+        $links = array(
+            'self'       => array(
+                'href'   => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ),
+            ),
+            'collection' => array(
+                'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+            ),
+        );
+
+        return $links;
+    }
+
+    /**
+     * Get the query params for collections of attachments.
+     *
+     * @return array
+     */
+    public function get_collection_params() {
+        $params = parent::get_collection_params();
+        $params['context']['default'] = 'view';
+        return $params;
+    }
+
+    /**
+     * Only return writable props from schema.
+     *
+     * @param  array $schema Schema.
+     * @return bool
+     */
+    public function filter_writable_props( $schema ) {
+        return empty( $schema['readonly'] );
+    }
+
+    /**
+     * Prepare a single object for create or update.
+     *
+     * @since 1.0.19
+     * @param  WP_REST_Request $request Request object.
+     * @return GetPaid_Data|WP_Error Data object or WP_Error.
+     */
+    protected function prepare_item_for_database( $request ) {
+
+        // Do we have an object?
+        if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
+            return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+        }
+
+        // Prepare the object.
+        $id        = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
+        $object    = new $this->crud_class( $id );
+
+        // Abort if an error exists.
+        if ( ! empty( $object->last_error ) ) {
+            return new WP_Error( 'invalid_item', $object->last_error );
+        }
+
+        $schema    = $this->get_item_schema();
+        $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) );
+
+        // Handle all writable props.
+        foreach ( $data_keys as $key ) {
+            $value = $request[ $key ];
+
+            if ( ! is_null( $value ) ) {
+                switch ( $key ) {
+
+                    case 'meta_data':
+                        if ( is_array( $value ) ) {
+                            foreach ( $value as $meta ) {
+                                $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
+                            }
+                        }
+                        break;
+
+                    default:
+                        if ( is_callable( array( $object, "set_{$key}" ) ) ) {
+                            $object->{"set_{$key}"}( $value );
+                        }
+                        break;
+                }
+            }
+
+        }
+
+        // Filters an object before it is inserted via the REST API..
+        return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request );
+    }
+
+    /**
+     * Retrieves data from a GetPaid class.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Meta_Data[]    $meta_data  meta data objects.
+     * @return array
+     */
+    protected function prepare_object_meta_data( $meta_data ) {
+        $meta = array();
+
+        foreach( $meta_data as $object ) {
+            $meta[] = $object->get_data();
+        }
+
+        return $meta;
+    }
+
+    /**
+     * Retrieves invoice items.
+     *
+     * @since  1.0.19
+     * @param  WPInv_Invoice $invoice  Invoice items.
+     * @param array            $fields Fields to include.
+     * @return array
+     */
+    protected function prepare_invoice_items( $invoice ) {
+        $items = array();
+
+        foreach( $invoice->get_items() as $item ) {
+
+            $item_data = $item->prepare_data_for_saving();
+
+            if ( 'amount' == $invoice->get_template() ) {
+                $item_data['quantity'] = 1;
+            }
+
+            $items[] = $item_data;
+        }
+
+        return $items;
+    }
+
+    /**
+     * Retrieves data from a GetPaid class.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data    $object  Data object.
+     * @param array            $fields Fields to include.
+     * @param string           $context either view or edit.
+     * @return array
+     */
+    protected function prepare_object_data( $object, $fields, $context = 'view' ) {
+
+        $data = array();
+
+        // Handle all writable props.
+        foreach ( array_keys( $this->get_schema_properties() ) as $key ) {
+
+            // Abort if it is not included.
+            if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) {
+                continue;
+            }
+
+            // Or this current object does not support the field.
+            if ( ! $this->object_supports_field( $object, $key ) ) {
+                continue;
+            }
+
+            // Handle meta data.
+            if ( $key == 'meta_data' ) {
+                $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() );
+                continue;
+            }
+
+            // Handle items.
+            if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' )  ) {
+                $data['items'] = $this->prepare_invoice_items( $object );
+                continue;
+            }
+
+            // Booleans.
+            if ( is_callable( array( $object, $key ) ) ) {
+                $data[ $key ] = $object->$key( $context );
+                continue;
+            }
+
+            // Get object value.
+            if ( is_callable( array( $object, "get_{$key}" ) ) ) {
+                $value = $object->{"get_{$key}"}( $context );
+
+                // If the value is an instance of GetPaid_Data...
+                if ( is_a( $value, 'GetPaid_Data' ) ) {
+                    $value = $value->get_data( $context );
+                }
+
+                // For objects, retrieves it's properties.
+                $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) :  $value ;
+                continue;
+            }
+
+        }
+
+        return $data;
+    }
+
+    /**
+     * Checks if a key should be included in a response.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data $object  Data object.
+     * @param  string       $field_key The key to check for.
+     * @return bool
+     */
+    public function object_supports_field( $object, $field_key ) {
+        return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key );
+    }
+
+    /**
+     * Prepare a single object output for response.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data    $object  Data object.
+     * @param  WP_REST_Request $request Request object.
+     * @return WP_REST_Response
+     */
+    public function prepare_item_for_response( $object, $request ) {
+        remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
+
+        $this->data_object = $object;
+
+        // Fetch the fields to include in this response.
+        $fields = $this->get_fields_for_response( $request );
+
+        // Prepare object data.
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $this->prepare_object_data( $object, $fields, $context );
+        $data    = $this->add_additional_fields_to_object( $data, $request );
+        $data    = $this->limit_object_to_requested_fields( $data, $fields );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        // Prepare the response.
+        $response = rest_ensure_response( $data );
+        $response->add_links( $this->prepare_links( $object, $request ) );
+
+        // Filter item response.
+        return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request );
+    }
 
 }

Spacing +117 added lines, -117 removed lines

@@ -8,7 +8,7 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * GetPaid REST CRUD controller class.
@@ -38,7 +38,7 @@ 
 	 *
 	 * @see register_rest_route()
 	 */
-	public function register_namespace_routes( $namespace ) {
+	public function register_namespace_routes($namespace) {
 
 		register_rest_route(
 			$namespace,
@@ -46,22 +46,22 @@ 
 			array(
 				array(
 					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_items' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
+					'callback'            => array($this, 'get_items'),
+					'permission_callback' => array($this, 'get_items_permissions_check'),
 					'args'                => $this->get_collection_params(),
 				),
 				array(
 					'methods'             => WP_REST_Server::CREATABLE,
-					'callback'            => array( $this, 'create_item' ),
-					'permission_callback' => array( $this, 'create_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+					'callback'            => array($this, 'create_item'),
+					'permission_callback' => array($this, 'create_item_permissions_check'),
+					'args'                => $this->get_endpoint_args_for_item_schema(WP_REST_Server::CREATABLE),
 				),
-				'schema' => array( $this, 'get_public_item_schema' ),
+				'schema' => array($this, 'get_public_item_schema'),
 			)
 		);
 
 		$get_item_args = array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+			'context' => $this->get_context_param(array('default' => 'view')),
 		);
 
 		register_rest_route(
@@ -70,35 +70,35 @@ 
 			array(
 				'args'   => array(
 					'id' => array(
-						'description' => __( 'Unique identifier for the object.', 'invoicing' ),
+						'description' => __('Unique identifier for the object.', 'invoicing'),
 						'type'        => 'integer',
 					),
 				),
 				array(
 					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_item' ),
-					'permission_callback' => array( $this, 'get_item_permissions_check' ),
+					'callback'            => array($this, 'get_item'),
+					'permission_callback' => array($this, 'get_item_permissions_check'),
 					'args'                => $get_item_args,
 				),
 				array(
 					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'update_item' ),
-					'permission_callback' => array( $this, 'update_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+					'callback'            => array($this, 'update_item'),
+					'permission_callback' => array($this, 'update_item_permissions_check'),
+					'args'                => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE),
 				),
 				array(
 					'methods'             => WP_REST_Server::DELETABLE,
-					'callback'            => array( $this, 'delete_item' ),
-					'permission_callback' => array( $this, 'delete_item_permissions_check' ),
+					'callback'            => array($this, 'delete_item'),
+					'permission_callback' => array($this, 'delete_item_permissions_check'),
 					'args'                => array(
 						'force' => array(
 							'type'        => 'boolean',
 							'default'     => false,
-							'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ),
+							'description' => __('Whether to bypass Trash and force deletion.', 'invoicing'),
 						),
 					),
 				),
-				'schema' => array( $this, 'get_public_item_schema' ),
+				'schema' => array($this, 'get_public_item_schema'),
 			)
 		);
 
@@ -110,14 +110,14 @@ 
 	 * @param GetPaid_Data $object Object to save.
 	 * @return WP_Error|GetPaid_Data
 	 */
-	protected function save_object( $object ) {
+	protected function save_object($object) {
 		$object->save();
 
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) );
+		if (!empty($object->last_error)) {
+			return new WP_Error('rest_cannot_save', $object->last_error, array('status' => 400));
 		}
 
-		return new $this->crud_class( $object->get_id() );
+		return new $this->crud_class($object->get_id());
 	}
 
 	/**
@@ -128,21 +128,21 @@ 
 	 * @param int|WP_Post $object_id Supplied ID.
 	 * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise.
 	 */
-	protected function get_object( $object_id ) {
+	protected function get_object($object_id) {
 
 		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+		if (empty($this->crud_class) || !class_exists($this->crud_class)) {
+			return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing'));
 		}
 
 		// Fetch the object.
-		$object = new $this->crud_class( $object_id );
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) );
+		$object = new $this->crud_class($object_id);
+		if (!empty($object->last_error)) {
+			return new WP_Error('rest_object_invalid_id', $object->last_error, array('status' => 404));
 		}
 
 		$this->data_object = $object;
-		return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) );
+		return $object->get_id() ? $object : new WP_Error('rest_object_invalid_id', __('Invalid ID.', 'invoicing'), array('status' => 404));
 
 	}
 
@@ -152,17 +152,17 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function get_item( $request ) {
+	public function get_item($request) {
 
 		// Fetch the item.
-		$object = $this->get_object( $request['id'] );
+		$object = $this->get_object($request['id']);
 
-		if ( is_wp_error( $object ) ) {
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Generate a response.
-		return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) );
+		return rest_ensure_response($this->prepare_item_for_response($object, $request));
 
 	}
 
@@ -172,38 +172,38 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function create_item( $request ) {
+	public function create_item($request) {
 
 		// Can not create an existing item.
-		if ( ! empty( $request['id'] ) ) {
+		if (!empty($request['id'])) {
 			/* translators: %s: post type */
-			return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) );
+			return new WP_Error("getpaid_rest_{$this->rest_base}_exists", __('Cannot create existing resource.', 'invoicing'), array('status' => 400));
 		}
 
 		// Generate a GetPaid_Data object from the request.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->prepare_item_for_database($request);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save the object.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->save_object($object);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save special fields.
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
-			$object->delete( true );
+		$save_special = $this->update_additional_fields_for_object($object, $request);
+		if (is_wp_error($save_special)) {
+			$object->delete(true);
 			return $save_special;
 		}
 
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		$response = rest_ensure_response( $response );
-		$response->set_status( 201 );
-		$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) );
+		$request->set_param('context', 'edit');
+		$response = $this->prepare_item_for_response($object, $request);
+		$response = rest_ensure_response($response);
+		$response->set_status(201);
+		$response->header('Location', rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id())));
 
 		return $response;
 	}
@@ -214,35 +214,35 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function update_item( $request ) {
+	public function update_item($request) {
 
 		// Fetch the item.
-		$object = $this->get_object( $request['id'] );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->get_object($request['id']);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Prepare the item for saving.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->prepare_item_for_database($request);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save the item.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->save_object($object);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save special fields (those added via hooks).
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
+		$save_special = $this->update_additional_fields_for_object($object, $request);
+		if (is_wp_error($save_special)) {
 			return $save_special;
 		}
 
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		return rest_ensure_response( $response );
+		$request->set_param('context', 'edit');
+		$response = $this->prepare_item_for_response($object, $request);
+		return rest_ensure_response($response);
 	}
 
 	/**
@@ -251,14 +251,14 @@ 
 	 * @param GetPaid_Data    $object GetPaid_Data object.
 	 * @return array Links for the given object.
 	 */
-	protected function prepare_links( $object ) {
+	protected function prepare_links($object) {
 
 		$links = array(
 			'self'       => array(
-				'href'   => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ),
+				'href'   => rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id())),
 			),
 			'collection' => array(
-				'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+				'href'   => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)),
 			),
 		);
 
@@ -282,8 +282,8 @@ 
 	 * @param  array $schema Schema.
 	 * @return bool
 	 */
-	public function filter_writable_props( $schema ) {
-		return empty( $schema['readonly'] );
+	public function filter_writable_props($schema) {
+		return empty($schema['readonly']);
 	}
 
 	/**
@@ -293,43 +293,43 @@ 
 	 * @param  WP_REST_Request $request Request object.
 	 * @return GetPaid_Data|WP_Error Data object or WP_Error.
 	 */
-	protected function prepare_item_for_database( $request ) {
+	protected function prepare_item_for_database($request) {
 
 		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+		if (empty($this->crud_class) || !class_exists($this->crud_class)) {
+			return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing'));
 		}
 
 		// Prepare the object.
-		$id        = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
-		$object    = new $this->crud_class( $id );
+		$id        = isset($request['id']) ? absint($request['id']) : 0;
+		$object    = new $this->crud_class($id);
 
 		// Abort if an error exists.
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'invalid_item', $object->last_error );
+		if (!empty($object->last_error)) {
+			return new WP_Error('invalid_item', $object->last_error);
 		}
 
 		$schema    = $this->get_item_schema();
-		$data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) );
+		$data_keys = array_keys(array_filter($schema['properties'], array($this, 'filter_writable_props')));
 
 		// Handle all writable props.
-		foreach ( $data_keys as $key ) {
-			$value = $request[ $key ];
+		foreach ($data_keys as $key) {
+			$value = $request[$key];
 
-			if ( ! is_null( $value ) ) {
-				switch ( $key ) {
+			if (!is_null($value)) {
+				switch ($key) {
 
 					case 'meta_data':
-						if ( is_array( $value ) ) {
-							foreach ( $value as $meta ) {
-								$object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
+						if (is_array($value)) {
+							foreach ($value as $meta) {
+								$object->update_meta_data($meta['key'], $meta['value'], isset($meta['id']) ? $meta['id'] : '');
 							}
 						}
 						break;
 
 					default:
-						if ( is_callable( array( $object, "set_{$key}" ) ) ) {
-							$object->{"set_{$key}"}( $value );
+						if (is_callable(array($object, "set_{$key}"))) {
+							$object->{"set_{$key}"}($value);
 						}
 						break;
 				}
@@ -338,7 +338,7 @@ 
 		}
 
 		// Filters an object before it is inserted via the REST API..
-		return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request );
+		return apply_filters("getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request);
 	}
 
 	/**
@@ -348,10 +348,10 @@ 
 	 * @param  GetPaid_Meta_Data[]    $meta_data  meta data objects.
 	 * @return array
 	 */
-	protected function prepare_object_meta_data( $meta_data ) {
+	protected function prepare_object_meta_data($meta_data) {
 		$meta = array();
 
-		foreach( $meta_data as $object ) {
+		foreach ($meta_data as $object) {
 			$meta[] = $object->get_data();
 		}
 
@@ -366,14 +366,14 @@ 
 	 * @param array            $fields Fields to include.
 	 * @return array
 	 */
-	protected function prepare_invoice_items( $invoice ) {
+	protected function prepare_invoice_items($invoice) {
 		$items = array();
 
-		foreach( $invoice->get_items() as $item ) {
+		foreach ($invoice->get_items() as $item) {
 
 			$item_data = $item->prepare_data_for_saving();
 
-			if ( 'amount' == $invoice->get_template() ) {
+			if ('amount' == $invoice->get_template()) {
 				$item_data['quantity'] = 1;
 			}
 
@@ -392,52 +392,52 @@ 
 	 * @param string           $context either view or edit.
 	 * @return array
 	 */
-	protected function prepare_object_data( $object, $fields, $context = 'view' ) {
+	protected function prepare_object_data($object, $fields, $context = 'view') {
 
 		$data = array();
 
 		// Handle all writable props.
-		foreach ( array_keys( $this->get_schema_properties() ) as $key ) {
+		foreach (array_keys($this->get_schema_properties()) as $key) {
 
 			// Abort if it is not included.
-			if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) {
+			if (!empty($fields) && !$this->is_field_included($key, $fields)) {
 				continue;
 			}
 
 			// Or this current object does not support the field.
-			if ( ! $this->object_supports_field( $object, $key ) ) {
+			if (!$this->object_supports_field($object, $key)) {
 				continue;
 			}
 
 			// Handle meta data.
-			if ( $key == 'meta_data' ) {
-				$data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() );
+			if ($key == 'meta_data') {
+				$data['meta_data'] = $this->prepare_object_meta_data($object->get_meta_data());
 				continue;
 			}
 
 			// Handle items.
-			if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' )  ) {
-				$data['items'] = $this->prepare_invoice_items( $object );
+			if ($key == 'items' && is_a($object, 'WPInv_Invoice')) {
+				$data['items'] = $this->prepare_invoice_items($object);
 				continue;
 			}
 
 			// Booleans.
-			if ( is_callable( array( $object, $key ) ) ) {
-				$data[ $key ] = $object->$key( $context );
+			if (is_callable(array($object, $key))) {
+				$data[$key] = $object->$key($context);
 				continue;
 			}
 
 			// Get object value.
-			if ( is_callable( array( $object, "get_{$key}" ) ) ) {
-				$value = $object->{"get_{$key}"}( $context );
+			if (is_callable(array($object, "get_{$key}"))) {
+				$value = $object->{"get_{$key}"}($context);
 
 				// If the value is an instance of GetPaid_Data...
-				if ( is_a( $value, 'GetPaid_Data' ) ) {
-					$value = $value->get_data( $context );
+				if (is_a($value, 'GetPaid_Data')) {
+					$value = $value->get_data($context);
 				}
 
 				// For objects, retrieves it's properties.
-				$data[ $key ] = is_object( $value ) ? get_object_vars( $value ) :  $value ;
+				$data[$key] = is_object($value) ? get_object_vars($value) : $value;
 				continue;
 			}
 
@@ -454,8 +454,8 @@ 
 	 * @param  string       $field_key The key to check for.
 	 * @return bool
 	 */
-	public function object_supports_field( $object, $field_key ) {
-		return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key );
+	public function object_supports_field($object, $field_key) {
+		return apply_filters('getpaid_rest_object_supports_key', true, $object, $field_key);
 	}
 
 	/**
@@ -466,27 +466,27 @@ 
 	 * @param  WP_REST_Request $request Request object.
 	 * @return WP_REST_Response
 	 */
-	public function prepare_item_for_response( $object, $request ) {
-		remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
+	public function prepare_item_for_response($object, $request) {
+		remove_filter('rest_post_dispatch', 'rest_filter_response_fields', 10);
 
 		$this->data_object = $object;
 
 		// Fetch the fields to include in this response.
-		$fields = $this->get_fields_for_response( $request );
+		$fields = $this->get_fields_for_response($request);
 
 		// Prepare object data.
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $this->prepare_object_data( $object, $fields, $context );
-		$data    = $this->add_additional_fields_to_object( $data, $request );
-		$data    = $this->limit_object_to_requested_fields( $data, $fields );
-		$data    = $this->filter_response_by_context( $data, $context );
+		$context = !empty($request['context']) ? $request['context'] : 'view';
+		$data    = $this->prepare_object_data($object, $fields, $context);
+		$data    = $this->add_additional_fields_to_object($data, $request);
+		$data    = $this->limit_object_to_requested_fields($data, $fields);
+		$data    = $this->filter_response_by_context($data, $context);
 
 		// Prepare the response.
-		$response = rest_ensure_response( $data );
-		$response->add_links( $this->prepare_links( $object, $request ) );
+		$response = rest_ensure_response($data);
+		$response->add_links($this->prepare_links($object, $request));
 
 		// Filter item response.
-		return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request );
+		return apply_filters("getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request);
 	}
 
 }

includes/class-getpaid-subscriptions-query.php

Indentation +490 added lines, -490 removed lines

@@ -16,495 +16,495 @@
  */
 class GetPaid_Subscriptions_Query {
 
-	/**
-	 * Query vars, after parsing
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	public $query_vars = array();
-
-	/**
-	 * List of found subscriptions.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	private $results;
-
-	/**
-	 * Total number of found subscriptions for the current query
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	private $total_subscriptions = 0;
-
-	/**
-	 * The SQL query used to fetch matching subscriptions.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $request;
-
-	// SQL clauses
-
-	/**
-	 * Contains the 'FIELDS' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_fields;
-
-	/**
-	 * Contains the 'FROM' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_from;
-
-	/**
-	 * Contains the 'WHERE' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_where;
-
-	/**
-	 * Contains the 'ORDER BY' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_orderby;
-
-	/**
-	 * Contains the 'LIMIT' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_limit;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param null|string|array $query Optional. The query variables.
-	 */
-	public function __construct( $query = null ) {
-		if ( ! is_null( $query ) ) {
-			$this->prepare_query( $query );
-			$this->query();
-		}
-	}
-
-	/**
-	 * Fills in missing query variables with default values.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
-	 * @return array Complete query variables with undefined ones filled in with defaults.
-	 */
-	public static function fill_query_vars( $args ) {
-		$defaults = array(
-			'status'            => 'all',
-			'customer_in'       => array(),
-			'customer_not_in'   => array(),
-			'product_in'        => array(),
-			'product_not_in'    => array(),
-			'include'           => array(),
-			'exclude'           => array(),
-			'orderby'           => 'id',
-			'order'             => 'DESC',
-			'offset'            => '',
-			'number'            => 10,
-			'paged'             => 1,
-			'count_total'       => true,
-			'fields'            => 'all',
-		);
-
-		return wp_parse_args( $args, $defaults );
-	}
-
-	/**
-	 * Prepare the query variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 *
-	 * @param string|array $query {
-	 *     Optional. Array or string of Query parameters.
-	 *
-	 *     @type string|array $status              The subscription status to filter by. Can either be a single status or an array of statuses.
-	 *                                             Default is all.
-	 *     @type int[]        $customer_in         An array of customer ids to filter by.
-	 *     @type int[]        $customer_not_in     An array of customer ids whose subscriptions should be excluded.
-	 *     @type int[]        $invoice_in          An array of invoice ids to filter by.
-	 *     @type int[]        $invoice_not_in      An array of invoice ids whose subscriptions should be excluded.
-	 *     @type int[]        $product_in          An array of product ids to filter by.
-	 *     @type int[]        $product_not_in      An array of product ids whose subscriptions should be excluded.
-	 *     @type array        $date_created_query  A WP_Date_Query compatible array use to filter subscriptions by their date of creation.
-	 *     @type array        $date_expires_query  A WP_Date_Query compatible array use to filter subscriptions by their expiration date.
-	 *     @type array        $include             An array of subscription IDs to include. Default empty array.
-	 *     @type array        $exclude             An array of subscription IDs to exclude. Default empty array.
-	 *     @type string|array $orderby             Field(s) to sort the retrieved subscription by. May be a single value,
-	 *                                             an array of values, or a multi-dimensional array with fields as
-	 *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
-	 *                                             'id', 'customer_id', 'frequency', 'period', 'initial_amount,
-	 *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
-	 *                                             'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ).
-	 *     @type string       $order               Designates ascending or descending order of subscriptions. Order values
-	 *                                             passed as part of an `$orderby` array take precedence over this
-	 *                                             parameter. Accepts 'ASC', 'DESC'. Default 'DESC'.
-	 *     @type int          $offset              Number of subscriptions to offset in retrieved results. Can be used in
-	 *                                             conjunction with pagination. Default 0.
-	 *     @type int          $number              Number of subscriptions to limit the query for. Can be used in
-	 *                                             conjunction with pagination. Value -1 (all) is supported, but
-	 *                                             should be used with caution on larger sites.
-	 *                                             Default 10.
-	 *     @type int          $paged               When used with number, defines the page of results to return.
-	 *                                             Default 1.
-	 *     @type bool         $count_total         Whether to count the total number of subscriptions found. If pagination
-	 *                                             is not needed, setting this to false can improve performance.
-	 *                                             Default true.
-	 *     @type string|array $fields              Which fields to return. Single or all fields (string), or array
-	 *                                             of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount,
-	 *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
-	 *                                             'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'.
-	 *                                             Use 'all' for all fields. Default 'all'.
-	 * }
-	 */
-	public function prepare_query( $query = array() ) {
-		global $wpdb;
-
-		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
-			$this->query_limit = null;
-			$this->query_vars  = $this->fill_query_vars( $query );
-		}
-
-		if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
-			$this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
-		}
-
-		do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
-
-		// Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
-		$qv                =& $this->query_vars;
-		$qv                = $this->fill_query_vars( $qv );
-		$table             = $wpdb->prefix . 'wpinv_subscriptions';
-		$this->query_from  = "FROM $table";
-
-		// Prepare query fields.
-		$this->prepare_query_fields( $qv, $table );
-
-		// Prepare query where.
-		$this->prepare_query_where( $qv, $table );
-
-		// Prepare query order.
-		$this->prepare_query_order( $qv, $table );
-
-		// limit
-		if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
-			if ( $qv['offset'] ) {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
-			} else {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
-			}
-		}
-
-		do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
-	}
-
-	/**
-	 * Prepares the query fields.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_fields( &$qv, $table ) {
-
-		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields'] = array_unique( $qv['fields'] );
-
-			$query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				$field          = sanitize_key( $field );
-				$query_fields[] = "$table.`$field`";
-			}
-			$this->query_fields = implode( ',', $query_fields );
-		} else {
-			$this->query_fields = "$table.*";
-		}
-
-		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
-		}
-
-	}
-
-	/**
-	 * Prepares the query where.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_where( &$qv, $table ) {
-		global $wpdb;
-		$this->query_where = 'WHERE 1=1';
-
-		// Status.
-		if ( 'all' !== $qv['status'] ) {
-			$statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
-			$prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
-			$this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
-		}
-
-		if ( ! empty( $qv['customer_in'] ) ) {
-			$customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
-			$this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
-		} elseif ( ! empty( $qv['customer_not_in'] ) ) {
-			$customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
-			$this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
-		}
-
-		if ( ! empty( $qv['product_in'] ) ) {
-			$product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
-			$this->query_where .= " AND $table.`product_id` IN ($product_in)";
-		} elseif ( ! empty( $qv['product_not_in'] ) ) {
-			$product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
-			$this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
-		}
-
-		if ( ! empty( $qv['invoice_in'] ) ) {
-			$invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
-			$this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
-		} elseif ( ! empty( $qv['invoice_not_in'] ) ) {
-			$invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
-			$this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
-		}
-
-		if ( ! empty( $qv['include'] ) ) {
-			$include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
-			$this->query_where .= " AND $table.`id` IN ($include)";
-		} elseif ( ! empty( $qv['exclude'] ) ) {
-			$exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
-			$this->query_where .= " AND $table.`id` NOT IN ($exclude)";
-		}
-
-		// Date queries are allowed for the subscription creation date.
-		if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
-			$date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
-			$this->query_where .= $date_created_query->get_sql();
-		}
-
-		// Date queries are also allowed for the subscription expiration date.
-		if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
-			$date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
-			$this->query_where .= $date_expires_query->get_sql();
-		}
-
-	}
-
-	/**
-	 * Prepares the query order.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_order( &$qv, $table ) {
-
-		// sorting.
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-		$order       = $this->parse_order( $qv['order'] );
-
-		// Default order is by 'id' (latest subscriptions).
-		if ( empty( $qv['orderby'] ) ) {
-			$qv['orderby'] = array( 'id' );
-		}
-
-		// 'orderby' values may be an array, comma- or space-separated list.
-		$ordersby      = array_filter( wpinv_parse_list(  $qv['orderby'] ) );
-
-		$orderby_array = array();
-		foreach ( $ordersby as $_key => $_value ) {
-
-			if ( is_int( $_key ) ) {
-				// Integer key means this is a flat array of 'orderby' fields.
-				$_orderby = $_value;
-				$_order   = $order;
-			} else {
-				// Non-integer key means that the key is the field and the value is ASC/DESC.
-				$_orderby = $_key;
-				$_order   = $_value;
-			}
-
-			$parsed = $this->parse_orderby( $_orderby, $table );
-
-			if ( $parsed ) {
-				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
-			}
-
-		}
-
-		// If no valid clauses were found, order by id.
-		if ( empty( $orderby_array ) ) {
-			$orderby_array[] = "id $order";
-		}
-
-		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
-
-	}
-
-	/**
-	 * Execute the query, with the current variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 */
-	public function query() {
-		global $wpdb;
-
-		$qv =& $this->query_vars;
-
-		// Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
-		// total_subscriptions property.
-		$this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
-
-		if ( null === $this->results ) {
-			$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
-
-			if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
-				$this->results = $wpdb->get_results( $this->request );
-			} else {
-				$this->results = $wpdb->get_col( $this->request );
-			}
-
-			if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-				$found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
-				$this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
-			}
-		}
-
-		if ( 'all' == $qv['fields'] ) {
-			foreach ( $this->results as $key => $subscription ) {
-				wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' );
-				wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				$this->results[ $key ] = new WPInv_Subscription( $subscription );
-			}
-		}
-
-	}
-
-	/**
-	 * Retrieve query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @return mixed
-	 */
-	public function get( $query_var ) {
-		if ( isset( $this->query_vars[ $query_var ] ) ) {
-			return $this->query_vars[ $query_var ];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Set query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @param mixed $value Query variable value.
-	 */
-	public function set( $query_var, $value ) {
-		$this->query_vars[ $query_var ] = $value;
-	}
-
-	/**
-	 * Return the list of subscriptions.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return WPInv_Subscription[]|array Found subscriptions.
-	 */
-	public function get_results() {
-		return $this->results;
-	}
-
-	/**
-	 * Return the total number of subscriptions for the current query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return int Number of total subscriptions.
-	 */
-	public function get_total() {
-		return $this->total_subscriptions;
-	}
-
-	/**
-	 * Parse and sanitize 'orderby' keys passed to the subscriptions query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $orderby Alias for the field to order by.
-	 *  @param string $table The current table.
-	 * @return string Value to use in the ORDER clause, if `$orderby` is valid.
-	 */
-	protected function parse_orderby( $orderby, $table ) {
-
-		$_orderby = '';
-		if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
-			$_orderby = "$table.`$orderby`";
-		} elseif ( 'id' === strtolower( $orderby ) ) {
-			$_orderby = "$table.id";
-		} elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
-			$include     = wp_parse_id_list( $this->query_vars['include'] );
-			$include_sql = implode( ',', $include );
-			$_orderby    = "FIELD( $table.id, $include_sql )";
-		}
-
-		return $_orderby;
-	}
-
-	/**
-	 * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $order The 'order' query variable.
-	 * @return string The sanitized 'order' query variable.
-	 */
-	protected function parse_order( $order ) {
-		if ( ! is_string( $order ) || empty( $order ) ) {
-			return 'DESC';
-		}
-
-		if ( 'ASC' === strtoupper( $order ) ) {
-			return 'ASC';
-		} else {
-			return 'DESC';
-		}
-	}
+    /**
+     * Query vars, after parsing
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    public $query_vars = array();
+
+    /**
+     * List of found subscriptions.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    private $results;
+
+    /**
+     * Total number of found subscriptions for the current query
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    private $total_subscriptions = 0;
+
+    /**
+     * The SQL query used to fetch matching subscriptions.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $request;
+
+    // SQL clauses
+
+    /**
+     * Contains the 'FIELDS' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_fields;
+
+    /**
+     * Contains the 'FROM' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_from;
+
+    /**
+     * Contains the 'WHERE' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_where;
+
+    /**
+     * Contains the 'ORDER BY' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_orderby;
+
+    /**
+     * Contains the 'LIMIT' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_limit;
+
+    /**
+     * Class constructor.
+     *
+     * @since 1.0.19
+     *
+     * @param null|string|array $query Optional. The query variables.
+     */
+    public function __construct( $query = null ) {
+        if ( ! is_null( $query ) ) {
+            $this->prepare_query( $query );
+            $this->query();
+        }
+    }
+
+    /**
+     * Fills in missing query variables with default values.
+     *
+     * @since 1.0.19
+     *
+     * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
+     * @return array Complete query variables with undefined ones filled in with defaults.
+     */
+    public static function fill_query_vars( $args ) {
+        $defaults = array(
+            'status'            => 'all',
+            'customer_in'       => array(),
+            'customer_not_in'   => array(),
+            'product_in'        => array(),
+            'product_not_in'    => array(),
+            'include'           => array(),
+            'exclude'           => array(),
+            'orderby'           => 'id',
+            'order'             => 'DESC',
+            'offset'            => '',
+            'number'            => 10,
+            'paged'             => 1,
+            'count_total'       => true,
+            'fields'            => 'all',
+        );
+
+        return wp_parse_args( $args, $defaults );
+    }
+
+    /**
+     * Prepare the query variables.
+     *
+     * @since 1.0.19
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     *
+     * @param string|array $query {
+     *     Optional. Array or string of Query parameters.
+     *
+     *     @type string|array $status              The subscription status to filter by. Can either be a single status or an array of statuses.
+     *                                             Default is all.
+     *     @type int[]        $customer_in         An array of customer ids to filter by.
+     *     @type int[]        $customer_not_in     An array of customer ids whose subscriptions should be excluded.
+     *     @type int[]        $invoice_in          An array of invoice ids to filter by.
+     *     @type int[]        $invoice_not_in      An array of invoice ids whose subscriptions should be excluded.
+     *     @type int[]        $product_in          An array of product ids to filter by.
+     *     @type int[]        $product_not_in      An array of product ids whose subscriptions should be excluded.
+     *     @type array        $date_created_query  A WP_Date_Query compatible array use to filter subscriptions by their date of creation.
+     *     @type array        $date_expires_query  A WP_Date_Query compatible array use to filter subscriptions by their expiration date.
+     *     @type array        $include             An array of subscription IDs to include. Default empty array.
+     *     @type array        $exclude             An array of subscription IDs to exclude. Default empty array.
+     *     @type string|array $orderby             Field(s) to sort the retrieved subscription by. May be a single value,
+     *                                             an array of values, or a multi-dimensional array with fields as
+     *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
+     *                                             'id', 'customer_id', 'frequency', 'period', 'initial_amount,
+     *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
+     *                                             'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ).
+     *     @type string       $order               Designates ascending or descending order of subscriptions. Order values
+     *                                             passed as part of an `$orderby` array take precedence over this
+     *                                             parameter. Accepts 'ASC', 'DESC'. Default 'DESC'.
+     *     @type int          $offset              Number of subscriptions to offset in retrieved results. Can be used in
+     *                                             conjunction with pagination. Default 0.
+     *     @type int          $number              Number of subscriptions to limit the query for. Can be used in
+     *                                             conjunction with pagination. Value -1 (all) is supported, but
+     *                                             should be used with caution on larger sites.
+     *                                             Default 10.
+     *     @type int          $paged               When used with number, defines the page of results to return.
+     *                                             Default 1.
+     *     @type bool         $count_total         Whether to count the total number of subscriptions found. If pagination
+     *                                             is not needed, setting this to false can improve performance.
+     *                                             Default true.
+     *     @type string|array $fields              Which fields to return. Single or all fields (string), or array
+     *                                             of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount,
+     *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
+     *                                             'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'.
+     *                                             Use 'all' for all fields. Default 'all'.
+     * }
+     */
+    public function prepare_query( $query = array() ) {
+        global $wpdb;
+
+        if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+            $this->query_limit = null;
+            $this->query_vars  = $this->fill_query_vars( $query );
+        }
+
+        if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
+            $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
+        }
+
+        do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
+
+        // Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
+        $qv                =& $this->query_vars;
+        $qv                = $this->fill_query_vars( $qv );
+        $table             = $wpdb->prefix . 'wpinv_subscriptions';
+        $this->query_from  = "FROM $table";
+
+        // Prepare query fields.
+        $this->prepare_query_fields( $qv, $table );
+
+        // Prepare query where.
+        $this->prepare_query_where( $qv, $table );
+
+        // Prepare query order.
+        $this->prepare_query_order( $qv, $table );
+
+        // limit
+        if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
+            if ( $qv['offset'] ) {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
+            } else {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+            }
+        }
+
+        do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
+    }
+
+    /**
+     * Prepares the query fields.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_fields( &$qv, $table ) {
+
+        if ( is_array( $qv['fields'] ) ) {
+            $qv['fields'] = array_unique( $qv['fields'] );
+
+            $query_fields = array();
+            foreach ( $qv['fields'] as $field ) {
+                $field          = sanitize_key( $field );
+                $query_fields[] = "$table.`$field`";
+            }
+            $this->query_fields = implode( ',', $query_fields );
+        } else {
+            $this->query_fields = "$table.*";
+        }
+
+        if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+            $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
+        }
+
+    }
+
+    /**
+     * Prepares the query where.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_where( &$qv, $table ) {
+        global $wpdb;
+        $this->query_where = 'WHERE 1=1';
+
+        // Status.
+        if ( 'all' !== $qv['status'] ) {
+            $statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
+            $prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
+            $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
+        }
+
+        if ( ! empty( $qv['customer_in'] ) ) {
+            $customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
+            $this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
+        } elseif ( ! empty( $qv['customer_not_in'] ) ) {
+            $customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
+            $this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
+        }
+
+        if ( ! empty( $qv['product_in'] ) ) {
+            $product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
+            $this->query_where .= " AND $table.`product_id` IN ($product_in)";
+        } elseif ( ! empty( $qv['product_not_in'] ) ) {
+            $product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
+            $this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
+        }
+
+        if ( ! empty( $qv['invoice_in'] ) ) {
+            $invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
+            $this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
+        } elseif ( ! empty( $qv['invoice_not_in'] ) ) {
+            $invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
+            $this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
+        }
+
+        if ( ! empty( $qv['include'] ) ) {
+            $include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
+            $this->query_where .= " AND $table.`id` IN ($include)";
+        } elseif ( ! empty( $qv['exclude'] ) ) {
+            $exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
+            $this->query_where .= " AND $table.`id` NOT IN ($exclude)";
+        }
+
+        // Date queries are allowed for the subscription creation date.
+        if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
+            $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
+            $this->query_where .= $date_created_query->get_sql();
+        }
+
+        // Date queries are also allowed for the subscription expiration date.
+        if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
+            $date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
+            $this->query_where .= $date_expires_query->get_sql();
+        }
+
+    }
+
+    /**
+     * Prepares the query order.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_order( &$qv, $table ) {
+
+        // sorting.
+        $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
+        $order       = $this->parse_order( $qv['order'] );
+
+        // Default order is by 'id' (latest subscriptions).
+        if ( empty( $qv['orderby'] ) ) {
+            $qv['orderby'] = array( 'id' );
+        }
+
+        // 'orderby' values may be an array, comma- or space-separated list.
+        $ordersby      = array_filter( wpinv_parse_list(  $qv['orderby'] ) );
+
+        $orderby_array = array();
+        foreach ( $ordersby as $_key => $_value ) {
+
+            if ( is_int( $_key ) ) {
+                // Integer key means this is a flat array of 'orderby' fields.
+                $_orderby = $_value;
+                $_order   = $order;
+            } else {
+                // Non-integer key means that the key is the field and the value is ASC/DESC.
+                $_orderby = $_key;
+                $_order   = $_value;
+            }
+
+            $parsed = $this->parse_orderby( $_orderby, $table );
+
+            if ( $parsed ) {
+                $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+            }
+
+        }
+
+        // If no valid clauses were found, order by id.
+        if ( empty( $orderby_array ) ) {
+            $orderby_array[] = "id $order";
+        }
+
+        $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+
+    }
+
+    /**
+     * Execute the query, with the current variables.
+     *
+     * @since 1.0.19
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     */
+    public function query() {
+        global $wpdb;
+
+        $qv =& $this->query_vars;
+
+        // Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
+        // total_subscriptions property.
+        $this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
+
+        if ( null === $this->results ) {
+            $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+
+            if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
+                $this->results = $wpdb->get_results( $this->request );
+            } else {
+                $this->results = $wpdb->get_col( $this->request );
+            }
+
+            if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+                $found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
+                $this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
+            }
+        }
+
+        if ( 'all' == $qv['fields'] ) {
+            foreach ( $this->results as $key => $subscription ) {
+                wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' );
+                wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
+                wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+                wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+                $this->results[ $key ] = new WPInv_Subscription( $subscription );
+            }
+        }
+
+    }
+
+    /**
+     * Retrieve query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @return mixed
+     */
+    public function get( $query_var ) {
+        if ( isset( $this->query_vars[ $query_var ] ) ) {
+            return $this->query_vars[ $query_var ];
+        }
+
+        return null;
+    }
+
+    /**
+     * Set query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @param mixed $value Query variable value.
+     */
+    public function set( $query_var, $value ) {
+        $this->query_vars[ $query_var ] = $value;
+    }
+
+    /**
+     * Return the list of subscriptions.
+     *
+     * @since 1.0.19
+     *
+     * @return WPInv_Subscription[]|array Found subscriptions.
+     */
+    public function get_results() {
+        return $this->results;
+    }
+
+    /**
+     * Return the total number of subscriptions for the current query.
+     *
+     * @since 1.0.19
+     *
+     * @return int Number of total subscriptions.
+     */
+    public function get_total() {
+        return $this->total_subscriptions;
+    }
+
+    /**
+     * Parse and sanitize 'orderby' keys passed to the subscriptions query.
+     *
+     * @since 1.0.19
+     *
+     * @param string $orderby Alias for the field to order by.
+     *  @param string $table The current table.
+     * @return string Value to use in the ORDER clause, if `$orderby` is valid.
+     */
+    protected function parse_orderby( $orderby, $table ) {
+
+        $_orderby = '';
+        if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
+            $_orderby = "$table.`$orderby`";
+        } elseif ( 'id' === strtolower( $orderby ) ) {
+            $_orderby = "$table.id";
+        } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
+            $include     = wp_parse_id_list( $this->query_vars['include'] );
+            $include_sql = implode( ',', $include );
+            $_orderby    = "FIELD( $table.id, $include_sql )";
+        }
+
+        return $_orderby;
+    }
+
+    /**
+     * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
+     *
+     * @since 1.0.19
+     *
+     * @param string $order The 'order' query variable.
+     * @return string The sanitized 'order' query variable.
+     */
+    protected function parse_order( $order ) {
+        if ( ! is_string( $order ) || empty( $order ) ) {
+            return 'DESC';
+        }
+
+        if ( 'ASC' === strtoupper( $order ) ) {
+            return 'ASC';
+        } else {
+            return 'DESC';
+        }
+    }
 
 }

Spacing +96 added lines, -96 removed lines

@@ -97,9 +97,9 @@ 
 	 *
 	 * @param null|string|array $query Optional. The query variables.
 	 */
-	public function __construct( $query = null ) {
-		if ( ! is_null( $query ) ) {
-			$this->prepare_query( $query );
+	public function __construct($query = null) {
+		if (!is_null($query)) {
+			$this->prepare_query($query);
 			$this->query();
 		}
 	}
@@ -112,7 +112,7 @@ 
 	 * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
 	 * @return array Complete query variables with undefined ones filled in with defaults.
 	 */
-	public static function fill_query_vars( $args ) {
+	public static function fill_query_vars($args) {
 		$defaults = array(
 			'status'            => 'all',
 			'customer_in'       => array(),
@@ -130,7 +130,7 @@ 
 			'fields'            => 'all',
 		);
 
-		return wp_parse_args( $args, $defaults );
+		return wp_parse_args($args, $defaults);
 	}
 
 	/**
@@ -182,45 +182,45 @@ 
 	 *                                             Use 'all' for all fields. Default 'all'.
 	 * }
 	 */
-	public function prepare_query( $query = array() ) {
+	public function prepare_query($query = array()) {
 		global $wpdb;
 
-		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+		if (empty($this->query_vars) || !empty($query)) {
 			$this->query_limit = null;
-			$this->query_vars  = $this->fill_query_vars( $query );
+			$this->query_vars  = $this->fill_query_vars($query);
 		}
 
-		if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
-			$this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
+		if (!empty($this->query_vars['fields']) && 'all' !== $this->query_vars['fields']) {
+			$this->query_vars['fields'] = wpinv_parse_list($this->query_vars['fields']);
 		}
 
-		do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
+		do_action('getpaid_pre_get_subscriptions', array(&$this));
 
 		// Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
-		$qv                =& $this->query_vars;
-		$qv                = $this->fill_query_vars( $qv );
+		$qv                = & $this->query_vars;
+		$qv                = $this->fill_query_vars($qv);
 		$table             = $wpdb->prefix . 'wpinv_subscriptions';
 		$this->query_from  = "FROM $table";
 
 		// Prepare query fields.
-		$this->prepare_query_fields( $qv, $table );
+		$this->prepare_query_fields($qv, $table);
 
 		// Prepare query where.
-		$this->prepare_query_where( $qv, $table );
+		$this->prepare_query_where($qv, $table);
 
 		// Prepare query order.
-		$this->prepare_query_order( $qv, $table );
+		$this->prepare_query_order($qv, $table);
 
 		// limit
-		if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
-			if ( $qv['offset'] ) {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
+		if (isset($qv['number']) && $qv['number'] > 0) {
+			if ($qv['offset']) {
+				$this->query_limit = $wpdb->prepare('LIMIT %d, %d', $qv['offset'], $qv['number']);
 			} else {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+				$this->query_limit = $wpdb->prepare('LIMIT %d, %d', $qv['number'] * ($qv['paged'] - 1), $qv['number']);
 			}
 		}
 
-		do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
+		do_action_ref_array('getpaid_after_subscriptions_query', array(&$this));
 	}
 
 	/**
@@ -231,22 +231,22 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_fields( &$qv, $table ) {
+	protected function prepare_query_fields(&$qv, $table) {
 
-		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields'] = array_unique( $qv['fields'] );
+		if (is_array($qv['fields'])) {
+			$qv['fields'] = array_unique($qv['fields']);
 
 			$query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				$field          = sanitize_key( $field );
+			foreach ($qv['fields'] as $field) {
+				$field          = sanitize_key($field);
 				$query_fields[] = "$table.`$field`";
 			}
-			$this->query_fields = implode( ',', $query_fields );
+			$this->query_fields = implode(',', $query_fields);
 		} else {
 			$this->query_fields = "$table.*";
 		}
 
-		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+		if (isset($qv['count_total']) && $qv['count_total']) {
 			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
 		}
 
@@ -260,58 +260,58 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_where( &$qv, $table ) {
+	protected function prepare_query_where(&$qv, $table) {
 		global $wpdb;
 		$this->query_where = 'WHERE 1=1';
 
 		// Status.
-		if ( 'all' !== $qv['status'] ) {
-			$statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
-			$prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
-			$this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
+		if ('all' !== $qv['status']) {
+			$statuses           = wpinv_clean(wpinv_parse_list($qv['status']));
+			$prepared_statuses  = join(',', array_fill(0, count($statuses), '%s'));
+			$this->query_where .= $wpdb->prepare(" AND $table.`status` IN ( $prepared_statuses )", $statuses);
 		}
 
-		if ( ! empty( $qv['customer_in'] ) ) {
-			$customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
+		if (!empty($qv['customer_in'])) {
+			$customer_in        = implode(',', wp_parse_id_list($qv['customer_in']));
 			$this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
-		} elseif ( ! empty( $qv['customer_not_in'] ) ) {
-			$customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
+		} elseif (!empty($qv['customer_not_in'])) {
+			$customer_not_in    = implode(',', wp_parse_id_list($qv['customer_not_in']));
 			$this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
 		}
 
-		if ( ! empty( $qv['product_in'] ) ) {
-			$product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
+		if (!empty($qv['product_in'])) {
+			$product_in         = implode(',', wp_parse_id_list($qv['product_in']));
 			$this->query_where .= " AND $table.`product_id` IN ($product_in)";
-		} elseif ( ! empty( $qv['product_not_in'] ) ) {
-			$product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
+		} elseif (!empty($qv['product_not_in'])) {
+			$product_not_in     = implode(',', wp_parse_id_list($qv['product_not_in']));
 			$this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
 		}
 
-		if ( ! empty( $qv['invoice_in'] ) ) {
-			$invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
+		if (!empty($qv['invoice_in'])) {
+			$invoice_in         = implode(',', wp_parse_id_list($qv['invoice_in']));
 			$this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
-		} elseif ( ! empty( $qv['invoice_not_in'] ) ) {
-			$invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
+		} elseif (!empty($qv['invoice_not_in'])) {
+			$invoice_not_in     = implode(',', wp_parse_id_list($qv['invoice_not_in']));
 			$this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
 		}
 
-		if ( ! empty( $qv['include'] ) ) {
-			$include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
+		if (!empty($qv['include'])) {
+			$include            = implode(',', wp_parse_id_list($qv['include']));
 			$this->query_where .= " AND $table.`id` IN ($include)";
-		} elseif ( ! empty( $qv['exclude'] ) ) {
-			$exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
+		} elseif (!empty($qv['exclude'])) {
+			$exclude            = implode(',', wp_parse_id_list($qv['exclude']));
 			$this->query_where .= " AND $table.`id` NOT IN ($exclude)";
 		}
 
 		// Date queries are allowed for the subscription creation date.
-		if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
-			$date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
+		if (!empty($qv['date_created_query']) && is_array($qv['date_created_query'])) {
+			$date_created_query = new WP_Date_Query($qv['date_created_query'], "$table.created");
 			$this->query_where .= $date_created_query->get_sql();
 		}
 
 		// Date queries are also allowed for the subscription expiration date.
-		if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
-			$date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
+		if (!empty($qv['date_expires_query']) && is_array($qv['date_expires_query'])) {
+			$date_expires_query = new WP_Date_Query($qv['date_expires_query'], "$table.expiration");
 			$this->query_where .= $date_expires_query->get_sql();
 		}
 
@@ -325,24 +325,24 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_order( &$qv, $table ) {
+	protected function prepare_query_order(&$qv, $table) {
 
 		// sorting.
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-		$order       = $this->parse_order( $qv['order'] );
+		$qv['order'] = isset($qv['order']) ? strtoupper($qv['order']) : '';
+		$order       = $this->parse_order($qv['order']);
 
 		// Default order is by 'id' (latest subscriptions).
-		if ( empty( $qv['orderby'] ) ) {
-			$qv['orderby'] = array( 'id' );
+		if (empty($qv['orderby'])) {
+			$qv['orderby'] = array('id');
 		}
 
 		// 'orderby' values may be an array, comma- or space-separated list.
-		$ordersby      = array_filter( wpinv_parse_list(  $qv['orderby'] ) );
+		$ordersby      = array_filter(wpinv_parse_list($qv['orderby']));
 
 		$orderby_array = array();
-		foreach ( $ordersby as $_key => $_value ) {
+		foreach ($ordersby as $_key => $_value) {
 
-			if ( is_int( $_key ) ) {
+			if (is_int($_key)) {
 				// Integer key means this is a flat array of 'orderby' fields.
 				$_orderby = $_value;
 				$_order   = $order;
@@ -352,20 +352,20 @@ 
 				$_order   = $_value;
 			}
 
-			$parsed = $this->parse_orderby( $_orderby, $table );
+			$parsed = $this->parse_orderby($_orderby, $table);
 
-			if ( $parsed ) {
-				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+			if ($parsed) {
+				$orderby_array[] = $parsed . ' ' . $this->parse_order($_order);
 			}
 
 		}
 
 		// If no valid clauses were found, order by id.
-		if ( empty( $orderby_array ) ) {
+		if (empty($orderby_array)) {
 			$orderby_array[] = "id $order";
 		}
 
-		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+		$this->query_orderby = 'ORDER BY ' . implode(', ', $orderby_array);
 
 	}
 
@@ -379,34 +379,34 @@ 
 	public function query() {
 		global $wpdb;
 
-		$qv =& $this->query_vars;
+		$qv = & $this->query_vars;
 
 		// Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
 		// total_subscriptions property.
-		$this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
+		$this->results = apply_filters_ref_array('getpaid_subscriptions_pre_query', array(null, &$this));
 
-		if ( null === $this->results ) {
+		if (null === $this->results) {
 			$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
 
-			if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
-				$this->results = $wpdb->get_results( $this->request );
+			if ((is_array($qv['fields']) && 1 != count($qv['fields'])) || 'all' == $qv['fields']) {
+				$this->results = $wpdb->get_results($this->request);
 			} else {
-				$this->results = $wpdb->get_col( $this->request );
+				$this->results = $wpdb->get_col($this->request);
 			}
 
-			if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-				$found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
-				$this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
+			if (isset($qv['count_total']) && $qv['count_total']) {
+				$found_subscriptions_query = apply_filters('getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this);
+				$this->total_subscriptions = (int) $wpdb->get_var($found_subscriptions_query);
 			}
 		}
 
-		if ( 'all' == $qv['fields'] ) {
-			foreach ( $this->results as $key => $subscription ) {
-				wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' );
-				wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				$this->results[ $key ] = new WPInv_Subscription( $subscription );
+		if ('all' == $qv['fields']) {
+			foreach ($this->results as $key => $subscription) {
+				wp_cache_set($subscription->id, $subscription, 'getpaid_subscriptions');
+				wp_cache_set($subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids');
+				wp_cache_set($subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids');
+				wp_cache_set($subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids');
+				$this->results[$key] = new WPInv_Subscription($subscription);
 			}
 		}
 
@@ -420,9 +420,9 @@ 
 	 * @param string $query_var Query variable key.
 	 * @return mixed
 	 */
-	public function get( $query_var ) {
-		if ( isset( $this->query_vars[ $query_var ] ) ) {
-			return $this->query_vars[ $query_var ];
+	public function get($query_var) {
+		if (isset($this->query_vars[$query_var])) {
+			return $this->query_vars[$query_var];
 		}
 
 		return null;
@@ -436,8 +436,8 @@ 
 	 * @param string $query_var Query variable key.
 	 * @param mixed $value Query variable value.
 	 */
-	public function set( $query_var, $value ) {
-		$this->query_vars[ $query_var ] = $value;
+	public function set($query_var, $value) {
+		$this->query_vars[$query_var] = $value;
 	}
 
 	/**
@@ -471,16 +471,16 @@ 
 	 *  @param string $table The current table.
 	 * @return string Value to use in the ORDER clause, if `$orderby` is valid.
 	 */
-	protected function parse_orderby( $orderby, $table ) {
+	protected function parse_orderby($orderby, $table) {
 
 		$_orderby = '';
-		if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
+		if (in_array($orderby, array('customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id'))) {
 			$_orderby = "$table.`$orderby`";
-		} elseif ( 'id' === strtolower( $orderby ) ) {
+		} elseif ('id' === strtolower($orderby)) {
 			$_orderby = "$table.id";
-		} elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
-			$include     = wp_parse_id_list( $this->query_vars['include'] );
-			$include_sql = implode( ',', $include );
+		} elseif ('include' === $orderby && !empty($this->query_vars['include'])) {
+			$include     = wp_parse_id_list($this->query_vars['include']);
+			$include_sql = implode(',', $include);
 			$_orderby    = "FIELD( $table.id, $include_sql )";
 		}
 
@@ -495,12 +495,12 @@ 
 	 * @param string $order The 'order' query variable.
 	 * @return string The sanitized 'order' query variable.
 	 */
-	protected function parse_order( $order ) {
-		if ( ! is_string( $order ) || empty( $order ) ) {
+	protected function parse_order($order) {
+		if (!is_string($order) || empty($order)) {
 			return 'DESC';
 		}
 
-		if ( 'ASC' === strtoupper( $order ) ) {
+		if ('ASC' === strtoupper($order)) {
 			return 'ASC';
 		} else {
 			return 'DESC';

widgets/subscriptions.php

Indentation +331 added lines, -331 removed lines

@@ -14,144 +14,144 @@ 
  */
 class WPInv_Subscriptions_Widget extends WP_Super_Duper {
 
-	/**
-	 * Register the widget with WordPress.
-	 *
-	 */
-	public function __construct() {
-
-		$options = array(
-			'textdomain'    => 'invoicing',
-			'block-icon'    => 'controls-repeat',
-			'block-category'=> 'widgets',
-			'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
-			'class_name'     => __CLASS__,
-			'base_id'       => 'wpinv_subscriptions',
-			'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
-			'widget_ops'    => array(
-				'classname'   => 'getpaid-subscriptions bsui',
-				'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
-			),
-			'arguments'     => array(
-				'title'  => array(
-					'title'       => __( 'Widget title', 'invoicing' ),
-					'desc'        => __( 'Enter widget title.', 'invoicing' ),
-					'type'        => 'text',
-					'desc_tip'    => true,
-					'default'     => '',
-					'advanced'    => false
-				),
-			)
-
-		);
-
-
-		parent::__construct( $options );
-	}
-
-	/**
-	 * Retrieves current user's subscriptions.
-	 *
-	 * @return GetPaid_Subscriptions_Query
-	 */
-	public function get_subscriptions() {
-
-		// Prepare license args.
-		$args  = array(
-			'customer_in' => get_current_user_id(),
-			'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
-		);
-
-		return new GetPaid_Subscriptions_Query( $args );
-
-	}
-
-	/**
-	 * The Super block output function.
-	 *
-	 * @param array $args
-	 * @param array $widget_args
-	 * @param string $content
-	 *
-	 * @return mixed|string|bool
-	 */
-	public function output( $args = array(), $widget_args = array(), $content = '' ) {
-
-		// Ensure that the user is logged in.
-		if ( ! is_user_logged_in() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		// Are we displaying a single subscription?
-		if ( isset( $_GET['subscription'] ) ) {
-			return $this->display_single_subscription( trim( $_GET['subscription'] ) );
-		}
-
-		// Retrieve the user's subscriptions.
-		$subscriptions = $this->get_subscriptions();
-
-		// Start the output buffer.
-		ob_start();
-
-		// Backwards compatibility.
-		do_action( 'wpinv_before_user_subscriptions' );
-
-		// Display errors and notices.
-		wpinv_print_errors();
-
-		do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
-
-		// Print the table header.
-		$this->print_table_header();
-
-		// Print table body.
-		$this->print_table_body( $subscriptions->get_results() );
-
-		// Print table footer.
-		$this->print_table_footer();
-
-		// Print the navigation.
-		$this->print_navigation( $subscriptions->get_total() );
-
-		// Backwards compatibility.
-		do_action( 'wpinv_after_user_subscriptions' );
-
-		// Return the output.
-		return ob_get_clean();
-
-	}
-
-	/**
-	 * Retrieves the subscription columns.
-	 *
-	 * @return array
-	 */
-	public function get_subscriptions_table_columns() {
+    /**
+     * Register the widget with WordPress.
+     *
+     */
+    public function __construct() {
+
+        $options = array(
+            'textdomain'    => 'invoicing',
+            'block-icon'    => 'controls-repeat',
+            'block-category'=> 'widgets',
+            'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
+            'class_name'     => __CLASS__,
+            'base_id'       => 'wpinv_subscriptions',
+            'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
+            'widget_ops'    => array(
+                'classname'   => 'getpaid-subscriptions bsui',
+                'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
+            ),
+            'arguments'     => array(
+                'title'  => array(
+                    'title'       => __( 'Widget title', 'invoicing' ),
+                    'desc'        => __( 'Enter widget title.', 'invoicing' ),
+                    'type'        => 'text',
+                    'desc_tip'    => true,
+                    'default'     => '',
+                    'advanced'    => false
+                ),
+            )
+
+        );
+
+
+        parent::__construct( $options );
+    }
+
+    /**
+     * Retrieves current user's subscriptions.
+     *
+     * @return GetPaid_Subscriptions_Query
+     */
+    public function get_subscriptions() {
+
+        // Prepare license args.
+        $args  = array(
+            'customer_in' => get_current_user_id(),
+            'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
+        );
+
+        return new GetPaid_Subscriptions_Query( $args );
+
+    }
+
+    /**
+     * The Super block output function.
+     *
+     * @param array $args
+     * @param array $widget_args
+     * @param string $content
+     *
+     * @return mixed|string|bool
+     */
+    public function output( $args = array(), $widget_args = array(), $content = '' ) {
+
+        // Ensure that the user is logged in.
+        if ( ! is_user_logged_in() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        // Are we displaying a single subscription?
+        if ( isset( $_GET['subscription'] ) ) {
+            return $this->display_single_subscription( trim( $_GET['subscription'] ) );
+        }
+
+        // Retrieve the user's subscriptions.
+        $subscriptions = $this->get_subscriptions();
+
+        // Start the output buffer.
+        ob_start();
+
+        // Backwards compatibility.
+        do_action( 'wpinv_before_user_subscriptions' );
+
+        // Display errors and notices.
+        wpinv_print_errors();
+
+        do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
+
+        // Print the table header.
+        $this->print_table_header();
+
+        // Print table body.
+        $this->print_table_body( $subscriptions->get_results() );
+
+        // Print table footer.
+        $this->print_table_footer();
+
+        // Print the navigation.
+        $this->print_navigation( $subscriptions->get_total() );
+
+        // Backwards compatibility.
+        do_action( 'wpinv_after_user_subscriptions' );
+
+        // Return the output.
+        return ob_get_clean();
+
+    }
+
+    /**
+     * Retrieves the subscription columns.
+     *
+     * @return array
+     */
+    public function get_subscriptions_table_columns() {
 
-		$columns = array(
-			'subscription'   => __( 'Subscription', 'invoicing' ),
-			'amount'         => __( 'Amount', 'invoicing' ),
-			'renewal-date'   => __( 'Next payment', 'invoicing' ),
-			'status'         => __( 'Status', 'invoicing' ),
-		);
+        $columns = array(
+            'subscription'   => __( 'Subscription', 'invoicing' ),
+            'amount'         => __( 'Amount', 'invoicing' ),
+            'renewal-date'   => __( 'Next payment', 'invoicing' ),
+            'status'         => __( 'Status', 'invoicing' ),
+        );
 
-		return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
-	}
+        return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
+    }
 
-	/**
-	 * Displays the table header.
-	 *
-	 */
-	public function print_table_header() {
+    /**
+     * Displays the table header.
+     *
+     */
+    public function print_table_header() {
 
-		?>
+        ?>
 
 			<table class="table table-bordered table-striped">
 
@@ -167,120 +167,120 @@ 
 
 		<?php
 
-	}
+    }
 
-	/**
-	 * Displays the table body.
-	 *
-	 * @param WPInv_Subscription[] $subscriptions
-	 */
-	public function print_table_body( $subscriptions ) {
+    /**
+     * Displays the table body.
+     *
+     * @param WPInv_Subscription[] $subscriptions
+     */
+    public function print_table_body( $subscriptions ) {
 
-		if ( empty( $subscriptions ) ) {
-			$this->print_table_body_no_subscriptions();
-		} else {
-			$this->print_table_body_subscriptions( $subscriptions );
-		}
+        if ( empty( $subscriptions ) ) {
+            $this->print_table_body_no_subscriptions();
+        } else {
+            $this->print_table_body_subscriptions( $subscriptions );
+        }
 
-	}
+    }
 
-	/**
-	 * Displays the table body if no subscriptions were found.
-	 *
-	 */
-	public function print_table_body_no_subscriptions() {
+    /**
+     * Displays the table body if no subscriptions were found.
+     *
+     */
+    public function print_table_body_no_subscriptions() {
 
-		?>
+        ?>
 		<tbody>
 
 			<tr>
 				<td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>">
 
 					<?php
-						echo aui()->alert(
-							array(
-								'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
-								'type'    => 'warning',
-							)
-						);
-					?>
+                        echo aui()->alert(
+                            array(
+                                'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
+                                'type'    => 'warning',
+                            )
+                        );
+                    ?>
 
 				</td>
 			</tr>
 
 		</tbody>
 		<?php
-	}
+    }
 
-	/**
-	 * Displays the table body if subscriptions were found.
-	 *
-	 * @param WPInv_Subscription[] $subscriptions
-	 */
-	public function print_table_body_subscriptions( $subscriptions ) {
+    /**
+     * Displays the table body if subscriptions were found.
+     *
+     * @param WPInv_Subscription[] $subscriptions
+     */
+    public function print_table_body_subscriptions( $subscriptions ) {
 
-		?>
+        ?>
 		<tbody>
 
 			<?php foreach ( $subscriptions as $subscription ) : ?>
 				<tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>">
 					<?php
-						wpinv_get_template(
-							'subscriptions/subscriptions-table-row.php',
-							array(
-								'subscription' => $subscription,
-								'widget'       => $this
-							)
-						);
-					?>
+                        wpinv_get_template(
+                            'subscriptions/subscriptions-table-row.php',
+                            array(
+                                'subscription' => $subscription,
+                                'widget'       => $this
+                            )
+                        );
+                    ?>
 				</tr>
 			<?php endforeach; ?>
 
 		</tbody>
 		<?php
-	}
-
-	/**
-	 * Adds row actions to a column
-	 *
-	 * @param string $content column content
-	 * @param WPInv_Subscription $subscription
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function add_row_actions( $content, $subscription ) {
-
-		// Prepare row actions.
-		$actions = array();
-
-		// View subscription action.
-		$view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) );
-		$actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
-
-		// Filter the actions.
-		$actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
-
-		$sanitized  = array();
-		foreach ( $actions as $key => $action ) {
-			$key         = sanitize_html_class( $key );
-			$action      = wp_kses_post( $action );
-			$sanitized[] = "<span class='$key'>$action</span>";
-		}
-
-		$row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
-		$row_actions .= implode( ' | ', $sanitized );
-		$row_actions .= '</small>';
-
-		return $content . $row_actions;
-	}
-
-	/**
-	 * Displays the table footer.
-	 *
-	 */
-	public function print_table_footer() {
-
-		?>
+    }
+
+    /**
+     * Adds row actions to a column
+     *
+     * @param string $content column content
+     * @param WPInv_Subscription $subscription
+     * @since       1.0.0
+     * @return      string
+     */
+    public function add_row_actions( $content, $subscription ) {
+
+        // Prepare row actions.
+        $actions = array();
+
+        // View subscription action.
+        $view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) );
+        $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
+
+        // Filter the actions.
+        $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
+
+        $sanitized  = array();
+        foreach ( $actions as $key => $action ) {
+            $key         = sanitize_html_class( $key );
+            $action      = wp_kses_post( $action );
+            $sanitized[] = "<span class='$key'>$action</span>";
+        }
+
+        $row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
+        $row_actions .= implode( ' | ', $sanitized );
+        $row_actions .= '</small>';
+
+        return $content . $row_actions;
+    }
+
+    /**
+     * Displays the table footer.
+     *
+     */
+    public function print_table_footer() {
+
+        ?>
 
 				<tfoot>
 					<tr>
@@ -295,129 +295,129 @@ 
 			</table>
 		<?php
 
-	}
+    }
 
-	/**
-	 * Displays the navigation.
-	 *
-	 * @param int $total
-	 */
-	public function print_navigation( $total ) {
+    /**
+     * Displays the navigation.
+     *
+     * @param int $total
+     */
+    public function print_navigation( $total ) {
 
-		if ( $total < 1 ) {
+        if ( $total < 1 ) {
 
-			// Out-of-bounds, run the query again without LIMIT for total count.
-			$args  = array(
-				'customer_in' => get_current_user_id(),
-				'fields'      => 'id',
-			);
+            // Out-of-bounds, run the query again without LIMIT for total count.
+            $args  = array(
+                'customer_in' => get_current_user_id(),
+                'fields'      => 'id',
+            );
 
-			$count_query = new GetPaid_Subscriptions_Query( $args );
-			$total       = $count_query->get_total();
-		}
+            $count_query = new GetPaid_Subscriptions_Query( $args );
+            $total       = $count_query->get_total();
+        }
 
-		// Abort if we do not have pages.
-		if ( 2 > $total ) {
-			return;
-		}
+        // Abort if we do not have pages.
+        if ( 2 > $total ) {
+            return;
+        }
 
-		?>
+        ?>
 
 		<div class="getpaid-subscriptions-pagination">
 			<?php
-				$big = 999999;
-
-				echo getpaid_paginate_links(
-					array(
-						'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
-						'format'  => '?paged=%#%',
-						'total'   => (int) ceil( $total / 10 ),
-					)
-				);
-			?>
+                $big = 999999;
+
+                echo getpaid_paginate_links(
+                    array(
+                        'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+                        'format'  => '?paged=%#%',
+                        'total'   => (int) ceil( $total / 10 ),
+                    )
+                );
+            ?>
 		</div>
 
 		<?php
-	}
-
-	/**
-	 * Returns a single subscription's columns.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 *
-	 * @return array
-	 */
-	public function get_single_subscription_columns( $subscription ) {
-
-		// Prepare subscription detail columns.
-		$fields = apply_filters(
-			'getpaid_single_subscription_details_fields',
-			array(
-				'status'           => __( 'Status', 'invoicing' ),
-				'initial_amount'   => __( 'Initial amount', 'invoicing' ),
-				'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
-				'start_date'       => __( 'Start date', 'invoicing' ),
-				'expiry_date'      => __( 'Next payment', 'invoicing' ),
-				'payments'         => __( 'Payments', 'invoicing' ),
-				'item'             => __( 'Item', 'invoicing' ),
-			),
-			$subscription
-		);
-
-		if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
-			$fields['expiry_date'] = __( 'End date', 'invoicing' );
-		}
-
-		if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
-			unset( $fields['initial_amount'] );
-		}
-
-		return $fields;
-	}
-
-	/**
-	 * Displays a single subscription.
-	 *
-	 * @param string $subscription
-	 *
-	 * @return string
-	 */
-	public function display_single_subscription( $subscription ) {
-
-		// Fetch the subscription.
-		$subscription = new WPInv_Subscription( (int) $subscription );
-
-		if ( ! $subscription->get_id() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		// Ensure that the user owns this subscription key.
-		if ( get_current_user_id() != $subscription->get_customer_id() ) {
-
-			return aui()->alert(
-				array(
-					'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' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		return wpinv_get_template_html(
-			'subscriptions/subscription-details.php',
-			array(
-				'subscription' => $subscription,
-				'widget'       => $this
-			)
-		);
-
-	}
+    }
+
+    /**
+     * Returns a single subscription's columns.
+     *
+     * @param WPInv_Subscription $subscription
+     *
+     * @return array
+     */
+    public function get_single_subscription_columns( $subscription ) {
+
+        // Prepare subscription detail columns.
+        $fields = apply_filters(
+            'getpaid_single_subscription_details_fields',
+            array(
+                'status'           => __( 'Status', 'invoicing' ),
+                'initial_amount'   => __( 'Initial amount', 'invoicing' ),
+                'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
+                'start_date'       => __( 'Start date', 'invoicing' ),
+                'expiry_date'      => __( 'Next payment', 'invoicing' ),
+                'payments'         => __( 'Payments', 'invoicing' ),
+                'item'             => __( 'Item', 'invoicing' ),
+            ),
+            $subscription
+        );
+
+        if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
+            $fields['expiry_date'] = __( 'End date', 'invoicing' );
+        }
+
+        if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
+            unset( $fields['initial_amount'] );
+        }
+
+        return $fields;
+    }
+
+    /**
+     * Displays a single subscription.
+     *
+     * @param string $subscription
+     *
+     * @return string
+     */
+    public function display_single_subscription( $subscription ) {
+
+        // Fetch the subscription.
+        $subscription = new WPInv_Subscription( (int) $subscription );
+
+        if ( ! $subscription->get_id() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        // Ensure that the user owns this subscription key.
+        if ( get_current_user_id() != $subscription->get_customer_id() ) {
+
+            return aui()->alert(
+                array(
+                    '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' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        return wpinv_get_template_html(
+            'subscriptions/subscription-details.php',
+            array(
+                'subscription' => $subscription,
+                'widget'       => $this
+            )
+        );
+
+    }
 
 }

Spacing +71 added lines, -71 removed lines

@@ -5,7 +5,7 @@ 
  * @version 1.0.0
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Contains the subscriptions widget.
@@ -27,15 +27,15 @@ 
 			'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
 			'class_name'     => __CLASS__,
 			'base_id'       => 'wpinv_subscriptions',
-			'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
+			'name'          => __('GetPaid > Subscriptions', 'invoicing'),
 			'widget_ops'    => array(
 				'classname'   => 'getpaid-subscriptions bsui',
-				'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
+				'description' => esc_html__("Displays the current user's subscriptions.", 'invoicing'),
 			),
 			'arguments'     => array(
 				'title'  => array(
-					'title'       => __( 'Widget title', 'invoicing' ),
-					'desc'        => __( 'Enter widget title.', 'invoicing' ),
+					'title'       => __('Widget title', 'invoicing'),
+					'desc'        => __('Enter widget title.', 'invoicing'),
 					'type'        => 'text',
 					'desc_tip'    => true,
 					'default'     => '',
@@ -46,7 +46,7 @@ 
 		);
 
 
-		parent::__construct( $options );
+		parent::__construct($options);
 	}
 
 	/**
@@ -57,12 +57,12 @@ 
 	public function get_subscriptions() {
 
 		// Prepare license args.
-		$args  = array(
+		$args = array(
 			'customer_in' => get_current_user_id(),
-			'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
+			'paged'       => (get_query_var('paged')) ? absint(get_query_var('paged')) : 1,
 		);
 
-		return new GetPaid_Subscriptions_Query( $args );
+		return new GetPaid_Subscriptions_Query($args);
 
 	}
 
@@ -75,14 +75,14 @@ 
 	 *
 	 * @return mixed|string|bool
 	 */
-	public function output( $args = array(), $widget_args = array(), $content = '' ) {
+	public function output($args = array(), $widget_args = array(), $content = '') {
 
 		// Ensure that the user is logged in.
-		if ( ! is_user_logged_in() ) {
+		if (!is_user_logged_in()) {
 
 			return aui()->alert(
 				array(
-					'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
+					'content' => wp_kses_post(__('You need to log-in or create an account to view this section.', 'invoicing')),
 					'type'    => 'error',
 				)
 			);
@@ -90,8 +90,8 @@ 
 		}
 
 		// Are we displaying a single subscription?
-		if ( isset( $_GET['subscription'] ) ) {
-			return $this->display_single_subscription( trim( $_GET['subscription'] ) );
+		if (isset($_GET['subscription'])) {
+			return $this->display_single_subscription(trim($_GET['subscription']));
 		}
 
 		// Retrieve the user's subscriptions.
@@ -101,27 +101,27 @@ 
 		ob_start();
 
 		// Backwards compatibility.
-		do_action( 'wpinv_before_user_subscriptions' );
+		do_action('wpinv_before_user_subscriptions');
 
 		// Display errors and notices.
 		wpinv_print_errors();
 
-		do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
+		do_action('getpaid_license_manager_before_subscriptions', $subscriptions);
 
 		// Print the table header.
 		$this->print_table_header();
 
 		// Print table body.
-		$this->print_table_body( $subscriptions->get_results() );
+		$this->print_table_body($subscriptions->get_results());
 
 		// Print table footer.
 		$this->print_table_footer();
 
 		// Print the navigation.
-		$this->print_navigation( $subscriptions->get_total() );
+		$this->print_navigation($subscriptions->get_total());
 
 		// Backwards compatibility.
-		do_action( 'wpinv_after_user_subscriptions' );
+		do_action('wpinv_after_user_subscriptions');
 
 		// Return the output.
 		return ob_get_clean();
@@ -136,13 +136,13 @@ 
 	public function get_subscriptions_table_columns() {
 
 		$columns = array(
-			'subscription'   => __( 'Subscription', 'invoicing' ),
-			'amount'         => __( 'Amount', 'invoicing' ),
-			'renewal-date'   => __( 'Next payment', 'invoicing' ),
-			'status'         => __( 'Status', 'invoicing' ),
+			'subscription'   => __('Subscription', 'invoicing'),
+			'amount'         => __('Amount', 'invoicing'),
+			'renewal-date'   => __('Next payment', 'invoicing'),
+			'status'         => __('Status', 'invoicing'),
 		);
 
-		return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
+		return apply_filters('getpaid_frontend_subscriptions_table_columns', $columns);
 	}
 
 	/**
@@ -157,9 +157,9 @@ 
 
 				<thead>
 					<tr>
-						<?php foreach ( $this->get_subscriptions_table_columns() as $key => $label ) : ?>
-							<th scope="col" class="getpaid-subscriptions-table-<?php echo sanitize_html_class( $key ); ?>">
-								<?php echo sanitize_text_field( $label ); ?>
+						<?php foreach ($this->get_subscriptions_table_columns() as $key => $label) : ?>
+							<th scope="col" class="getpaid-subscriptions-table-<?php echo sanitize_html_class($key); ?>">
+								<?php echo sanitize_text_field($label); ?>
 							</th>
 						<?php endforeach; ?>
 					</tr>
@@ -174,12 +174,12 @@ 
 	 *
 	 * @param WPInv_Subscription[] $subscriptions
 	 */
-	public function print_table_body( $subscriptions ) {
+	public function print_table_body($subscriptions) {
 
-		if ( empty( $subscriptions ) ) {
+		if (empty($subscriptions)) {
 			$this->print_table_body_no_subscriptions();
 		} else {
-			$this->print_table_body_subscriptions( $subscriptions );
+			$this->print_table_body_subscriptions($subscriptions);
 		}
 
 	}
@@ -194,12 +194,12 @@ 
 		<tbody>
 
 			<tr>
-				<td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>">
+				<td colspan="<?php echo count($this->get_subscriptions_table_columns()); ?>">
 
 					<?php
 						echo aui()->alert(
 							array(
-								'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
+								'content' => wp_kses_post(__('No subscriptions found.', 'invoicing')),
 								'type'    => 'warning',
 							)
 						);
@@ -217,12 +217,12 @@ 
 	 *
 	 * @param WPInv_Subscription[] $subscriptions
 	 */
-	public function print_table_body_subscriptions( $subscriptions ) {
+	public function print_table_body_subscriptions($subscriptions) {
 
 		?>
 		<tbody>
 
-			<?php foreach ( $subscriptions as $subscription ) : ?>
+			<?php foreach ($subscriptions as $subscription) : ?>
 				<tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>">
 					<?php
 						wpinv_get_template(
@@ -248,27 +248,27 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function add_row_actions( $content, $subscription ) {
+	public function add_row_actions($content, $subscription) {
 
 		// Prepare row actions.
 		$actions = array();
 
 		// View subscription action.
-		$view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) );
-		$actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
+		$view_url        = esc_url(add_query_arg('subscription', (int) $subscription->get_id(), get_permalink((int) wpinv_get_option('invoice_subscription_page'))));
+		$actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __('Manage Subscription', 'invoicing') . '</a>';
 
 		// Filter the actions.
-		$actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
+		$actions = apply_filters('getpaid_subscriptions_table_subscription_actions', $actions, $subscription);
 
-		$sanitized  = array();
-		foreach ( $actions as $key => $action ) {
-			$key         = sanitize_html_class( $key );
-			$action      = wp_kses_post( $action );
+		$sanitized = array();
+		foreach ($actions as $key => $action) {
+			$key         = sanitize_html_class($key);
+			$action      = wp_kses_post($action);
 			$sanitized[] = "<span class='$key'>$action</span>";
 		}
 
 		$row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
-		$row_actions .= implode( ' | ', $sanitized );
+		$row_actions .= implode(' | ', $sanitized);
 		$row_actions .= '</small>';
 
 		return $content . $row_actions;
@@ -284,9 +284,9 @@ 
 
 				<tfoot>
 					<tr>
-						<?php foreach ( $this->get_subscriptions_table_columns() as $key => $label ) : ?>
-							<th class="getpaid-subscriptions-<?php echo sanitize_html_class( $key ); ?>">
-								<?php echo sanitize_text_field( $label ); ?>
+						<?php foreach ($this->get_subscriptions_table_columns() as $key => $label) : ?>
+							<th class="getpaid-subscriptions-<?php echo sanitize_html_class($key); ?>">
+								<?php echo sanitize_text_field($label); ?>
 							</th>
 						<?php endforeach; ?>
 					</tr>
@@ -302,22 +302,22 @@ 
 	 *
 	 * @param int $total
 	 */
-	public function print_navigation( $total ) {
+	public function print_navigation($total) {
 
-		if ( $total < 1 ) {
+		if ($total < 1) {
 
 			// Out-of-bounds, run the query again without LIMIT for total count.
-			$args  = array(
+			$args = array(
 				'customer_in' => get_current_user_id(),
 				'fields'      => 'id',
 			);
 
-			$count_query = new GetPaid_Subscriptions_Query( $args );
+			$count_query = new GetPaid_Subscriptions_Query($args);
 			$total       = $count_query->get_total();
 		}
 
 		// Abort if we do not have pages.
-		if ( 2 > $total ) {
+		if (2 > $total) {
 			return;
 		}
 
@@ -329,9 +329,9 @@ 
 
 				echo getpaid_paginate_links(
 					array(
-						'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+						'base'    => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
 						'format'  => '?paged=%#%',
-						'total'   => (int) ceil( $total / 10 ),
+						'total'   => (int) ceil($total / 10),
 					)
 				);
 			?>
@@ -347,29 +347,29 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_single_subscription_columns( $subscription ) {
+	public function get_single_subscription_columns($subscription) {
 
 		// Prepare subscription detail columns.
 		$fields = apply_filters(
 			'getpaid_single_subscription_details_fields',
 			array(
-				'status'           => __( 'Status', 'invoicing' ),
-				'initial_amount'   => __( 'Initial amount', 'invoicing' ),
-				'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
-				'start_date'       => __( 'Start date', 'invoicing' ),
-				'expiry_date'      => __( 'Next payment', 'invoicing' ),
-				'payments'         => __( 'Payments', 'invoicing' ),
-				'item'             => __( 'Item', 'invoicing' ),
+				'status'           => __('Status', 'invoicing'),
+				'initial_amount'   => __('Initial amount', 'invoicing'),
+				'recurring_amount' => __('Recurring amount', 'invoicing'),
+				'start_date'       => __('Start date', 'invoicing'),
+				'expiry_date'      => __('Next payment', 'invoicing'),
+				'payments'         => __('Payments', 'invoicing'),
+				'item'             => __('Item', 'invoicing'),
 			),
 			$subscription
 		);
 
-		if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
-			$fields['expiry_date'] = __( 'End date', 'invoicing' );
+		if (!$subscription->is_active() || $subscription->is_last_renewal()) {
+			$fields['expiry_date'] = __('End date', 'invoicing');
 		}
 
-		if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
-			unset( $fields['initial_amount'] );
+		if ($subscription->get_initial_amount() == $subscription->get_recurring_amount()) {
+			unset($fields['initial_amount']);
 		}
 
 		return $fields;
@@ -382,16 +382,16 @@ 
 	 *
 	 * @return string
 	 */
-	public function display_single_subscription( $subscription ) {
+	public function display_single_subscription($subscription) {
 
 		// Fetch the subscription.
-		$subscription = new WPInv_Subscription( (int) $subscription );
+		$subscription = new WPInv_Subscription((int) $subscription);
 
-		if ( ! $subscription->get_id() ) {
+		if (!$subscription->get_id()) {
 
 			return aui()->alert(
 				array(
-					'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
+					'content' => wp_kses_post(__('Subscription not found.', 'invoicing')),
 					'type'    => 'error',
 				)
 			);
@@ -399,11 +399,11 @@ 
 		}
 
 		// Ensure that the user owns this subscription key.
-		if ( get_current_user_id() != $subscription->get_customer_id() ) {
+		if (get_current_user_id() != $subscription->get_customer_id()) {
 
 			return aui()->alert(
 				array(
-					'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' ) ),
+					'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')),
 					'type'    => 'error',
 				)
 			);

includes/admin/meta-boxes/class-getpaid-meta-box-invoice-subscription.php

Indentation +9 added lines, -9 removed lines

@@ -6,7 +6,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -15,10 +15,10 @@ 
 class GetPaid_Meta_Box_Invoice_Subscription {
 
     /**
-	 * Output the subscription metabox.
-	 *
-	 * @param WP_Post $post
-	 */
+     * Output the subscription metabox.
+     *
+     * @param WP_Post $post
+     */
     public static function output( $post ) {
 
         // Fetch the invoice.
@@ -34,10 +34,10 @@ 
     }
 
     /**
-	 * Output the subscription invoices.
-	 *
-	 * @param WP_Post $post
-	 */
+     * Output the subscription invoices.
+     *
+     * @param WP_Post $post
+     */
     public static function output_invoices( $post ) {
 
         // Fetch the invoice.

Spacing +9 added lines, -9 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit; // Exit if accessed directly
 }
 
@@ -19,16 +19,16 @@ 
 	 *
 	 * @param WP_Post $post
 	 */
-    public static function output( $post ) {
+    public static function output($post) {
 
         // Fetch the invoice.
-        $invoice = new WPInv_Invoice( $post );
+        $invoice = new WPInv_Invoice($post);
 
         // Fetch the subscription.
-        $subscription = getpaid_get_invoice_subscription( $invoice );
+        $subscription = getpaid_get_invoice_subscription($invoice);
 
         echo '<div class="bsui">';
-        getpaid_admin_subscription_details_metabox( /** @scrutinizer ignore-type */$subscription );
+        getpaid_admin_subscription_details_metabox(/** @scrutinizer ignore-type */$subscription);
         echo '</div>';
 
     }
@@ -38,16 +38,16 @@ 
 	 *
 	 * @param WP_Post $post
 	 */
-    public static function output_invoices( $post ) {
+    public static function output_invoices($post) {
 
         // Fetch the invoice.
-        $invoice = new WPInv_Invoice( $post );
+        $invoice = new WPInv_Invoice($post);
 
         // Fetch the subscription.
-        $subscription = getpaid_get_invoice_subscription( $invoice );
+        $subscription = getpaid_get_invoice_subscription($invoice);
 
         echo '<div class="bsui">';
-        getpaid_admin_subscription_invoice_details_metabox( /** @scrutinizer ignore-type */$subscription );
+        getpaid_admin_subscription_invoice_details_metabox(/** @scrutinizer ignore-type */$subscription);
         echo '</div>';
 
     }

templates/invoice-history.php

Indentation +59 added lines, -59 removed lines

@@ -40,86 +40,86 @@ 
 				<tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>">
 					<?php
 
-						foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) :
+                        foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) :
 
-							$column_id = sanitize_html_class( $column_id );
-							$class     = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] );
+                            $column_id = sanitize_html_class( $column_id );
+                            $class     = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] );
 
-							echo "<td class='$column_id $class'>";
-							switch ( $column_id ) {
+                            echo "<td class='$column_id $class'>";
+                            switch ( $column_id ) {
 
-								case 'invoice-number':
-									echo wpinv_invoice_link( $invoice );
-									break;
+                                case 'invoice-number':
+                                    echo wpinv_invoice_link( $invoice );
+                                    break;
 
-								case 'created-date':
-									echo getpaid_format_date_value( $invoice->get_date_created() );
-									break;
+                                case 'created-date':
+                                    echo getpaid_format_date_value( $invoice->get_date_created() );
+                                    break;
 
-								case 'payment-date':
+                                case 'payment-date':
 
-									if ( $invoice->needs_payment() ) {
-										echo "&mdash;";
-									} else {
-										echo getpaid_format_date_value( $invoice->get_date_completed() );
-									}
+                                    if ( $invoice->needs_payment() ) {
+                                        echo "&mdash;";
+                                    } else {
+                                        echo getpaid_format_date_value( $invoice->get_date_completed() );
+                                    }
 									
-									break;
+                                    break;
 
-								case 'invoice-status':
-									echo $invoice->get_status_label_html();
+                                case 'invoice-status':
+                                    echo $invoice->get_status_label_html();
 									
-									break;
+                                    break;
 
-								case 'invoice-total':
-									echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) );
+                                case 'invoice-total':
+                                    echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) );
 									
-									break;
+                                    break;
 
-								case 'invoice-actions':
+                                case 'invoice-actions':
 
-									$actions = array(
+                                    $actions = array(
 
-										'pay'       => array(
-											'url'   => $invoice->get_checkout_payment_url(),
-											'name'  => __( 'Pay Now', 'invoicing' ),
+                                        'pay'       => array(
+                                            'url'   => $invoice->get_checkout_payment_url(),
+                                            'name'  => __( 'Pay Now', 'invoicing' ),
                                             'class' => 'btn-success'
-										),
+                                        ),
 
                                         'print'     => array(
-											'url'   => $invoice->get_view_url(),
-											'name'  => __( 'View Invoice', 'invoicing' ),
+                                            'url'   => $invoice->get_view_url(),
+                                            'name'  => __( 'View Invoice', 'invoicing' ),
                                             'class' => 'btn-secondary',
                                             'attrs' => 'target="_blank"'
-										)
-									);
+                                        )
+                                    );
 
-									if ( ! $invoice->needs_payment() ) {
-										unset( $actions['pay'] );
-									}
+                                    if ( ! $invoice->needs_payment() ) {
+                                        unset( $actions['pay'] );
+                                    }
 
-									$actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice );
+                                    $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice );
 
-									foreach ( $actions as $key => $action ) {
-										$class = !empty($action['class']) ? sanitize_html_class($action['class']) : '';
-										echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>';
-									}
+                                    foreach ( $actions as $key => $action ) {
+                                        $class = !empty($action['class']) ? sanitize_html_class($action['class']) : '';
+                                        echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>';
+                                    }
 									
-									break;
+                                    break;
 
-								default:
-									do_action( "wpinv_user_invoices_column_$column_id", $invoice );
-									break;
+                                default:
+                                    do_action( "wpinv_user_invoices_column_$column_id", $invoice );
+                                    break;
 
 								
-							}
+                            }
 
-							do_action( "wpinv_user_invoices_column_after_$column_id", $invoice );
+                            do_action( "wpinv_user_invoices_column_after_$column_id", $invoice );
 						
-							echo '</td>';
+                            echo '</td>';
 
-						endforeach;
-					?>
+                        endforeach;
+                    ?>
 				</tr>
 
 			<?php endforeach; ?>
@@ -132,14 +132,14 @@ 
 	<?php if ( 1 < $invoices->max_num_pages ) : ?>
 		<div class="invoicing-Pagination">
 			<?php
-			$big = 999999;
-
-			echo paginate_links( array(
-				'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
-				'format'  => '?paged=%#%',
-				'total'   => $invoices->max_num_pages,
-			) );
-			?>
+            $big = 999999;
+
+            echo paginate_links( array(
+                'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+                'format'  => '?paged=%#%',
+                'total'   => $invoices->max_num_pages,
+            ) );
+            ?>
 		</div>
 	<?php endif; ?>
 

Spacing +31 added lines, -31 removed lines

@@ -7,13 +7,13 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Current page.
-$current_page   = empty( $_GET[ 'page' ] ) ? 1 : absint( $_GET[ 'page' ] );
+$current_page = empty($_GET['page']) ? 1 : absint($_GET['page']);
 
 // Fires before displaying user invoices.
-do_action( 'wpinv_before_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages );
+do_action('wpinv_before_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages);
 
 ?>
 
@@ -23,9 +23,9 @@ 
 		<thead>
 			<tr>
 
-				<?php foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) : ?>
-					<th class="<?php echo sanitize_html_class( $column_id ); ?> <?php echo ( ! empty( $column_name['class'] ) ? sanitize_html_class( $column_name['class'] ) : '');?> border-bottom-0">
-						<span class="nobr"><?php echo esc_html( $column_name['title'] ); ?></span>
+				<?php foreach (wpinv_get_user_invoices_columns() as $column_id => $column_name) : ?>
+					<th class="<?php echo sanitize_html_class($column_id); ?> <?php echo (!empty($column_name['class']) ? sanitize_html_class($column_name['class']) : ''); ?> border-bottom-0">
+						<span class="nobr"><?php echo esc_html($column_name['title']); ?></span>
 					</th>
 				<?php endforeach; ?>
 
@@ -35,33 +35,33 @@ 
 
 		
 		<tbody>
-			<?php foreach ( $invoices->invoices as $invoice ) : ?>
+			<?php foreach ($invoices->invoices as $invoice) : ?>
 
 				<tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>">
 					<?php
 
-						foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) :
+						foreach (wpinv_get_user_invoices_columns() as $column_id => $column_name) :
 
-							$column_id = sanitize_html_class( $column_id );
-							$class     = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] );
+							$column_id = sanitize_html_class($column_id);
+							$class     = empty($column_name['class']) ? '' : sanitize_html_class($column_name['class']);
 
 							echo "<td class='$column_id $class'>";
-							switch ( $column_id ) {
+							switch ($column_id) {
 
 								case 'invoice-number':
-									echo wpinv_invoice_link( $invoice );
+									echo wpinv_invoice_link($invoice);
 									break;
 
 								case 'created-date':
-									echo getpaid_format_date_value( $invoice->get_date_created() );
+									echo getpaid_format_date_value($invoice->get_date_created());
 									break;
 
 								case 'payment-date':
 
-									if ( $invoice->needs_payment() ) {
+									if ($invoice->needs_payment()) {
 										echo "&mdash;";
 									} else {
-										echo getpaid_format_date_value( $invoice->get_date_completed() );
+										echo getpaid_format_date_value($invoice->get_date_completed());
 									}
 									
 									break;
@@ -72,7 +72,7 @@ 
 									break;
 
 								case 'invoice-total':
-									echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) );
+									echo wpinv_price(wpinv_format_amount($invoice->get_total()));
 									
 									break;
 
@@ -82,39 +82,39 @@ 
 
 										'pay'       => array(
 											'url'   => $invoice->get_checkout_payment_url(),
-											'name'  => __( 'Pay Now', 'invoicing' ),
+											'name'  => __('Pay Now', 'invoicing'),
                                             'class' => 'btn-success'
 										),
 
                                         'print'     => array(
 											'url'   => $invoice->get_view_url(),
-											'name'  => __( 'View Invoice', 'invoicing' ),
+											'name'  => __('View Invoice', 'invoicing'),
                                             'class' => 'btn-secondary',
                                             'attrs' => 'target="_blank"'
 										)
 									);
 
-									if ( ! $invoice->needs_payment() ) {
-										unset( $actions['pay'] );
+									if (!$invoice->needs_payment()) {
+										unset($actions['pay']);
 									}
 
-									$actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice );
+									$actions = apply_filters('wpinv_user_invoices_actions', $actions, $invoice);
 
-									foreach ( $actions as $key => $action ) {
+									foreach ($actions as $key => $action) {
 										$class = !empty($action['class']) ? sanitize_html_class($action['class']) : '';
-										echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>';
+										echo '<a href="' . esc_url($action['url']) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class($key) . '" ' . (!empty($action['attrs']) ? $action['attrs'] : '') . '>' . $action['name'] . '</a>';
 									}
 									
 									break;
 
 								default:
-									do_action( "wpinv_user_invoices_column_$column_id", $invoice );
+									do_action("wpinv_user_invoices_column_$column_id", $invoice);
 									break;
 
 								
 							}
 
-							do_action( "wpinv_user_invoices_column_after_$column_id", $invoice );
+							do_action("wpinv_user_invoices_column_after_$column_id", $invoice);
 						
 							echo '</td>';
 
@@ -127,20 +127,20 @@ 
 		</tbody>
 	</table>
 
-	<?php do_action( 'wpinv_before_user_invoices_pagination' ); ?>
+	<?php do_action('wpinv_before_user_invoices_pagination'); ?>
 
-	<?php if ( 1 < $invoices->max_num_pages ) : ?>
+	<?php if (1 < $invoices->max_num_pages) : ?>
 		<div class="invoicing-Pagination">
 			<?php
 			$big = 999999;
 
-			echo paginate_links( array(
-				'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+			echo paginate_links(array(
+				'base'    => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
 				'format'  => '?paged=%#%',
 				'total'   => $invoices->max_num_pages,
-			) );
+			));
 			?>
 		</div>
 	<?php endif; ?>
 
-<?php do_action( 'wpinv_after_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages  ); ?>
+<?php do_action('wpinv_after_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages); ?>