AyeCode / invoicing

includes/class-wpinv-privacy.php

Indentation +19 added lines, -19 removed lines

@@ -37,25 +37,25 @@
     public function get_privacy_message() {
 
         $content = '<div class="wp-suggested-text">' .
-                   '<h2>' . __( 'Invoices and checkout', 'invoicing' ) . '</h2>' .
-                   '<p class="privacy-policy-tutorial">' . __( 'Example privacy texts.', 'invoicing' ) . '</p>' .
-                   '<p>' . __( 'We collect information about you during the checkout process on our site. This information may include, but is not limited to, your name, email address, phone number, address, IP and any other details that might be requested from you for the purpose of processing your payment and retaining your invoice details for legal reasons.', 'invoicing' ) . '</p>' .
-                   '<p>' . __( 'Handling this data also allows us to:', 'invoicing' ) . '</p>' .
-                   '<ul>' .
-                   '<li>' . __( '- Send you important account/invoice/service information.', 'invoicing' ) . '</li>' .
-                   '<li>' . __( '- Estimate taxes based on your location.', 'invoicing' ) . '</li>' .
-                   '<li>' . __( '- Respond to your queries or complaints.', 'invoicing' ) . '</li>' .
-                   '<li>' . __( '- Process payments and to prevent fraudulent transactions. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' .
-                   '<li>' . __( '- Retain historical payment and invoice history. We do this on the basis of legal obligations.', 'invoicing' ) . '</li>' .
-                   '<li>' . __( '- Set up and administer your account, provide technical and/or customer support, and to verify your identity. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' .
-                   '</ul>' .
-                   '<p>' . __( 'In addition to collecting information at checkout we may also use and store your contact details when manually creating invoices for require payments relating to prior contractual agreements or agreed terms.', 'invoicing' ) . '</p>' .
-                   '<h2>' . __( 'What we share with others', 'invoicing' ) . '</h2>' .
-                   '<p>' . __( 'We share information with third parties who help us provide our payment and invoicing services to you; for example --', 'invoicing' ) . '</p>' .
-                   '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should list which third party payment processors you’re using to take payments since these may handle customer data. We’ve included PayPal as an example, but you should remove this if you’re not using PayPal.', 'invoicing' ) . '</p>' .
-                   '<p>' . __( 'We accept payments through PayPal. When processing payments, some of your data will be passed to PayPal, including information required to process or support the payment, such as the purchase total and billing information.', 'invoicing' ) . '</p>' .
-                   '<p>' . __( 'Please see the <a href="https://www.paypal.com/us/webapps/mpp/ua/privacy-full">PayPal Privacy Policy</a> for more details.', 'invoicing' ) . '</p>' .
-                   '</div>';
+                    '<h2>' . __( 'Invoices and checkout', 'invoicing' ) . '</h2>' .
+                    '<p class="privacy-policy-tutorial">' . __( 'Example privacy texts.', 'invoicing' ) . '</p>' .
+                    '<p>' . __( 'We collect information about you during the checkout process on our site. This information may include, but is not limited to, your name, email address, phone number, address, IP and any other details that might be requested from you for the purpose of processing your payment and retaining your invoice details for legal reasons.', 'invoicing' ) . '</p>' .
+                    '<p>' . __( 'Handling this data also allows us to:', 'invoicing' ) . '</p>' .
+                    '<ul>' .
+                    '<li>' . __( '- Send you important account/invoice/service information.', 'invoicing' ) . '</li>' .
+                    '<li>' . __( '- Estimate taxes based on your location.', 'invoicing' ) . '</li>' .
+                    '<li>' . __( '- Respond to your queries or complaints.', 'invoicing' ) . '</li>' .
+                    '<li>' . __( '- Process payments and to prevent fraudulent transactions. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' .
+                    '<li>' . __( '- Retain historical payment and invoice history. We do this on the basis of legal obligations.', 'invoicing' ) . '</li>' .
+                    '<li>' . __( '- Set up and administer your account, provide technical and/or customer support, and to verify your identity. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' .
+                    '</ul>' .
+                    '<p>' . __( 'In addition to collecting information at checkout we may also use and store your contact details when manually creating invoices for require payments relating to prior contractual agreements or agreed terms.', 'invoicing' ) . '</p>' .
+                    '<h2>' . __( 'What we share with others', 'invoicing' ) . '</h2>' .
+                    '<p>' . __( 'We share information with third parties who help us provide our payment and invoicing services to you; for example --', 'invoicing' ) . '</p>' .
+                    '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should list which third party payment processors you’re using to take payments since these may handle customer data. We’ve included PayPal as an example, but you should remove this if you’re not using PayPal.', 'invoicing' ) . '</p>' .
+                    '<p>' . __( 'We accept payments through PayPal. When processing payments, some of your data will be passed to PayPal, including information required to process or support the payment, such as the purchase total and billing information.', 'invoicing' ) . '</p>' .
+                    '<p>' . __( 'Please see the <a href="https://www.paypal.com/us/webapps/mpp/ua/privacy-full">PayPal Privacy Policy</a> for more details.', 'invoicing' ) . '</p>' .
+                    '</div>';
 
         return apply_filters( 'wpinv_privacy_policy_content', $content );
     }

includes/payments/class-getpaid-payment-form-submission-fees.php

Indentation +102 added lines, -102 removed lines

@@ -12,109 +12,109 @@
  */
 class GetPaid_Payment_Form_Submission_Fees {
 
-	/**
-	 * The fee validation error.
-	 * @var string
-	 */
-	public $fee_error;
-
-	/**
-	 * Submission fees.
-	 * @var array
-	 */
-	public $fees = array();
+    /**
+     * The fee validation error.
+     * @var string
+     */
+    public $fee_error;
+
+    /**
+     * Submission fees.
+     * @var array
+     */
+    public $fees = array();
+
+    /**
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        // Process any existing invoice fees.
+        if ( $submission->has_invoice() ) {
+            $this->fees = $submission->get_invoice()->get_fees();
+        }
+
+        // Process price fields.
+        $data         = $submission->get_data();
+        $payment_form = $submission->get_payment_form();
+
+        foreach ( $payment_form->get_elements() as $element ) {
+
+            if ( 'price_input' == $element['type'] ) {
+                $this->process_price_input( $element, $data, $submission );
+            }
+
+            if ( 'price_select' == $element['type'] ) {
+                $this->process_price_select( $element, $data );
+            }
+
+        }
+
+    }
+
+    /**
+     * Process a price input field.
+     *
+     * @param array $element
+     * @param array $data
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function process_price_input( $element, $data, $submission ) {
+
+        // Abort if not passed.
+        if ( empty( $data[ $element['id'] ] ) ) {
+            return;
+        }
+
+        $amount  = (float) wpinv_sanitize_amount( $data[ $element['id'] ] );
+        $minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] );
+
+        if ( $amount < $minimum ) {
+            throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_price( $minimum, $submission->get_currency() ) ) );
+        }
+
+        $this->fees[ $element['label'] ] = array(
+            'name'          => $element['label'],
+            'initial_fee'   => $amount,
+            'recurring_fee' => 0,
+        );
+
+    }
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		// Process any existing invoice fees.
-		if ( $submission->has_invoice() ) {
-			$this->fees = $submission->get_invoice()->get_fees();
-		}
-
-		// Process price fields.
-		$data         = $submission->get_data();
-		$payment_form = $submission->get_payment_form();
-
-		foreach ( $payment_form->get_elements() as $element ) {
-
-			if ( 'price_input' == $element['type'] ) {
-				$this->process_price_input( $element, $data, $submission );
-			}
-
-			if ( 'price_select' == $element['type'] ) {
-				$this->process_price_select( $element, $data );
-			}
-
-		}
-
-	}
-
-	/**
-	 * Process a price input field.
-	 *
-	 * @param array $element
-	 * @param array $data
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function process_price_input( $element, $data, $submission ) {
-
-		// Abort if not passed.
-		if ( empty( $data[ $element['id'] ] ) ) {
-			return;
-		}
-
-		$amount  = (float) wpinv_sanitize_amount( $data[ $element['id'] ] );
-		$minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] );
-
-		if ( $amount < $minimum ) {
-			throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_price( $minimum, $submission->get_currency() ) ) );
-		}
-
-		$this->fees[ $element['label'] ] = array(
-			'name'          => $element['label'],
-			'initial_fee'   => $amount,
-			'recurring_fee' => 0,
-		);
-
-	}
-
-	/**
-	 * Process a price select field.
-	 *
-	 * @param array $element
-	 * @param array $data
-	 */
-	public function process_price_select( $element, $data ) {
-
-		// Abort if not passed.
-		if ( empty( $data[ $element['id'] ] ) ) {
-			return;
-		}
-
-		$options  = getpaid_convert_price_string_to_options( $element['options'] );
-		$selected = wpinv_parse_list( $data[ $element['id'] ] );
-		$total    = 0;
-
-		foreach ( $selected as $price ) {
-
-			if ( ! isset( $options[ $price ] ) ) {
-				throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) );
-			}
-
-			$total += (float) wpinv_sanitize_amount( $price );
-		}
-
-		$this->fees[ $element['label'] ] = array(
-			'name'          => $element['label'],
-			'initial_fee'   => $total,
-			'recurring_fee' => 0,
-		);
-
-	}
+     * Process a price select field.
+     *
+     * @param array $element
+     * @param array $data
+     */
+    public function process_price_select( $element, $data ) {
+
+        // Abort if not passed.
+        if ( empty( $data[ $element['id'] ] ) ) {
+            return;
+        }
+
+        $options  = getpaid_convert_price_string_to_options( $element['options'] );
+        $selected = wpinv_parse_list( $data[ $element['id'] ] );
+        $total    = 0;
+
+        foreach ( $selected as $price ) {
+
+            if ( ! isset( $options[ $price ] ) ) {
+                throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) );
+            }
+
+            $total += (float) wpinv_sanitize_amount( $price );
+        }
+
+        $this->fees[ $element['label'] ] = array(
+            'name'          => $element['label'],
+            'initial_fee'   => $total,
+            'recurring_fee' => 0,
+        );
+
+    }
 
 }

templates/invoice-history.php

Indentation +63 added lines, -63 removed lines

@@ -42,86 +42,86 @@ 
 					<tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>">
 						<?php
 
-							foreach ( wpinv_get_user_invoices_columns( $post_type ) as $column_id => $column_name ) :
+                            foreach ( wpinv_get_user_invoices_columns( $post_type ) 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( $invoice->get_total(), $invoice->get_currency() );
+                                    case 'invoice-total':
+                                        echo wpinv_price( $invoice->get_total(), $invoice->get_currency() );
 
-										break;
+                                        break;
 
-									case 'invoice-actions':
+                                    case 'invoice-actions':
 
-										$actions = array(
+                                        $actions = array(
 
-											'pay'       => array(
-												'url'   => $invoice->get_checkout_payment_url(),
-												'name'  => __( 'Pay Now', 'invoicing' ),
-												'class' => 'btn-success'
-											),
+                                            'pay'       => array(
+                                                'url'   => $invoice->get_checkout_payment_url(),
+                                                'name'  => __( 'Pay Now', 'invoicing' ),
+                                                'class' => 'btn-success'
+                                            ),
 
-											'print'     => array(
-												'url'   => $invoice->get_view_url(),
-												'name'  => __( 'View', 'invoicing' ),
-												'class' => 'btn-secondary',
-												'attrs' => 'target="_blank"'
-											)
-										);
+                                            'print'     => array(
+                                                'url'   => $invoice->get_view_url(),
+                                                'name'  => __( 'View', '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, $post_type );
+                                        $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice, $post_type );
 
-										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; ?>
@@ -135,14 +135,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; ?>
 

includes/api/class-getpaid-rest-report-top-sellers-controller.php

Indentation +175 added lines, -175 removed lines

@@ -18,179 +18,179 @@
  */
 class GetPaid_REST_Report_Top_Sellers_Controller extends GetPaid_REST_Report_Sales_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/top_sellers';
-
-	/**
-	 * Get top sellers report.
-	 *
-	 * @param WP_REST_Request $request
-	 * @return array|WP_Error
-	 */
-	public function get_items( $request ) {
-
-		// Prepare items.
-		$this->report_range = $this->get_date_range( $request );
-		$report_data        = $this->get_report_data();
-
-		$top_sellers = array();
-
-		foreach ( $report_data as $item ) {
-
-			$item_obj  = new WPInv_Item( $item );
-			$item_name = $item->invoice_item_name;
-			$item_qty  = floatval( $item->invoice_item_qty );
-			$item_id   = absint( $item->invoice_item_id );
-			$price     = sanitize_text_field( wpinv_price( $item->invoice_item_price ) );
-
-			$item_obj  = new WPInv_Item( $item_id );
-
-			if ( $item_obj->exists() ) {
-				$item_name = $item_obj->get_name();
-			} else {
-				$item_id   = 0; 
-			}
-
-			$top_sellers[] = array(
-				'name'               =>sanitize_text_field( $item_name ),
-				'item_id'            => $item_id,
-				'quantity'           => $item_qty,
-				'earnings'           => wpinv_round_amount( $item->invoice_item_price ),
-				'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ),
-			);
-
-		}
-
-		$data = array();
-		foreach ( $top_sellers as $top_seller ) {
-			$item   = $this->prepare_item_for_response( (object) $top_seller, $request );
-			$data[] = $this->prepare_response_for_collection( $item );
-		}
-
-		return rest_ensure_response( $data );
-
-	}
-
-	/**
-	 * Prepare a report sales object for serialization.
-	 *
-	 * @param stdClass $top_seller
-	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $top_seller, $request ) {
-		$data    = (array) $top_seller;
-
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $this->add_additional_fields_to_object( $data, $request );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		// Wrap the data in a response object.
-		$response = rest_ensure_response( $data );
-		$links = array(
-			'about' => array(
-				'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
-			),
-		);
-
-		if ( ! empty( $top_seller->item_id ) ) {
-			$links['item']   = array(
-				'href'       => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ),
-				'embeddable' => true,
-			);
-		}
-
-		$response->add_links( $links );
-		return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request );
-	}
-
-	/**
-	 * Get all data needed for this report and store in the class.
-	 */
-	protected function query_report_data() {
-
-		$this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'              => array(
-					'quantity'      => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_qty',
-					),
-					'item_id'             => array(
-						'type'            => 'invoice_item',
-						'function'        => '',
-						'name'            => 'invoice_item_id',
-					),
-					'item_name'           => array(
-						'type'            => 'invoice_item',
-						'function'        => '',
-						'name'            => 'invoice_item_name',
-					),
-					'price'               => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_price',
-					),
-				),
-				'group_by'       => 'invoice_item_id',
-				'order_by'       => 'invoice_item_qty DESC',
-				'query_type'     => 'get_results',
-				'limit'          => 10,
-				'filter_range'   => $this->report_range,
-			)
-		);
-
-	}
-
-	/**
-	 * Get the Report's schema, conforming to JSON Schema.
-	 *
-	 * @return array
-	 */
-	public function get_item_schema() {
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => $this->rest_base,
-			'type'       => 'object',
-			'properties' => array(
-				'name' => array(
-					'description' => __( 'Item name.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'item_id'         => array(
-					'description' => __( 'Item ID.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'quantity' => array(
-					'description' => __( 'Total number of purchases.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'earnings' => array(
-					'description' => __( 'Total earnings for the item.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'earnings_formatted"' => array(
-					'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		return $this->add_additional_fields_schema( $schema );
-	}
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/top_sellers';
+
+    /**
+     * Get top sellers report.
+     *
+     * @param WP_REST_Request $request
+     * @return array|WP_Error
+     */
+    public function get_items( $request ) {
+
+        // Prepare items.
+        $this->report_range = $this->get_date_range( $request );
+        $report_data        = $this->get_report_data();
+
+        $top_sellers = array();
+
+        foreach ( $report_data as $item ) {
+
+            $item_obj  = new WPInv_Item( $item );
+            $item_name = $item->invoice_item_name;
+            $item_qty  = floatval( $item->invoice_item_qty );
+            $item_id   = absint( $item->invoice_item_id );
+            $price     = sanitize_text_field( wpinv_price( $item->invoice_item_price ) );
+
+            $item_obj  = new WPInv_Item( $item_id );
+
+            if ( $item_obj->exists() ) {
+                $item_name = $item_obj->get_name();
+            } else {
+                $item_id   = 0; 
+            }
+
+            $top_sellers[] = array(
+                'name'               =>sanitize_text_field( $item_name ),
+                'item_id'            => $item_id,
+                'quantity'           => $item_qty,
+                'earnings'           => wpinv_round_amount( $item->invoice_item_price ),
+                'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ),
+            );
+
+        }
+
+        $data = array();
+        foreach ( $top_sellers as $top_seller ) {
+            $item   = $this->prepare_item_for_response( (object) $top_seller, $request );
+            $data[] = $this->prepare_response_for_collection( $item );
+        }
+
+        return rest_ensure_response( $data );
+
+    }
+
+    /**
+     * Prepare a report sales object for serialization.
+     *
+     * @param stdClass $top_seller
+     * @param WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $top_seller, $request ) {
+        $data    = (array) $top_seller;
+
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $this->add_additional_fields_to_object( $data, $request );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        // Wrap the data in a response object.
+        $response = rest_ensure_response( $data );
+        $links = array(
+            'about' => array(
+                'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
+            ),
+        );
+
+        if ( ! empty( $top_seller->item_id ) ) {
+            $links['item']   = array(
+                'href'       => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ),
+                'embeddable' => true,
+            );
+        }
+
+        $response->add_links( $links );
+        return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request );
+    }
+
+    /**
+     * Get all data needed for this report and store in the class.
+     */
+    protected function query_report_data() {
+
+        $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'              => array(
+                    'quantity'      => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_qty',
+                    ),
+                    'item_id'             => array(
+                        'type'            => 'invoice_item',
+                        'function'        => '',
+                        'name'            => 'invoice_item_id',
+                    ),
+                    'item_name'           => array(
+                        'type'            => 'invoice_item',
+                        'function'        => '',
+                        'name'            => 'invoice_item_name',
+                    ),
+                    'price'               => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_price',
+                    ),
+                ),
+                'group_by'       => 'invoice_item_id',
+                'order_by'       => 'invoice_item_qty DESC',
+                'query_type'     => 'get_results',
+                'limit'          => 10,
+                'filter_range'   => $this->report_range,
+            )
+        );
+
+    }
+
+    /**
+     * Get the Report's schema, conforming to JSON Schema.
+     *
+     * @return array
+     */
+    public function get_item_schema() {
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => $this->rest_base,
+            'type'       => 'object',
+            'properties' => array(
+                'name' => array(
+                    'description' => __( 'Item name.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'item_id'         => array(
+                    'description' => __( 'Item ID.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'quantity' => array(
+                    'description' => __( 'Total number of purchases.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'earnings' => array(
+                    'description' => __( 'Total earnings for the item.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'earnings_formatted"' => array(
+                    'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+    }
 }

includes/data/invoice-schema.php

Indentation +621 added lines, -621 removed lines

@@ -13,629 +13,629 @@
 
 return array(
 
-	'id'              => array(
-		'description' => __( 'Unique identifier for the invoice.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'parent_id'       => array(
-		'description' => __( 'Parent invoice ID.', 'invoicing' ),
-		'type'        => 'integer',
-		'minimum'     => 0,
-		'default'     => 0,
-		'context'     => array( 'view', 'edit' ),
-	),
-
-	'key'			  => array(
-		'description' => __( 'A unique key for the invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'number'		  => array(
-		'description' => __( 'A unique number for the invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'type'			  => array(
-		'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'post_type'		  => array(
-		'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'version'         => array(
-		'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'template'        => array(
-		'description' => __( 'The invoice template.', 'invoicing' ),
-		'type'        => 'string',
-		'default'     => 'quantity',
-		'enum'        => array( 'quantity', 'hours', 'amount' ),
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'status'          => array(
-		'description' => __( 'Invoice status.', 'invoicing' ),
-		'type'        => 'string',
-		'default'     => 'wpi-pending',
-		'enum'        => array_keys( wpinv_get_invoice_statuses( true ) ),
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'status_nicename' => array(
-		'description' => __( 'A human readable name for the invoice status.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'currency'        => array(
-		'description' => __( 'The invoice currency in ISO format.', 'invoicing' ),
-		'type'        => 'string',
-		'default'     => wpinv_get_currency(),
-		'enum'        => array_keys( wpinv_get_currencies() ),
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'date_created'    => array(
-		'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'date_created_gmt'    => array(
-		'description' => __( 'The GMT date the invoice was created.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'date_modified'   => array(
-		'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'date_modified_gmt'    => array(
-		'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'due_date'        => array(
-		'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'due_date_gmt'    => array(
-		'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'completed_date'  => array(
-		'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'completed_date_gmt'    => array(
-		'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total_discount'   => array(
-		'description' => __( 'Total discount amount for the invoice.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total_tax'       => array(
-		'description' => __( 'Total tax amount for the invoice.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total_fees'      => array(
-		'description' => __( 'Total fees amount for the invoice.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'subtotal'        => array(
-		'description' => __( 'Invoice subtotal.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total'           => array(
-		'description' => __( 'Grand total.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'initial_total'   => array(
-		'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'recurring_total'  => array(
-		'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'totals'          => array(
-		'description' => __( 'Invoice totals.', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'fees'            => array(
-		'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'amount' ),
-			'properties'          => array(
-				'amount'          => array(
-					'description' => __( 'Fee amount.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'recurring'       => array(
-					'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ),
-					'type'        => array( 'boolean', 'integer' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'discounts'       => array(
-		'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'amount' ),
-			'properties'          => array(
-				'amount'          => array(
-					'description' => __( 'Fee amount.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'recurring'       => array(
-					'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ),
-					'type'        => array( 'boolean', 'integer' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'taxes'           => array(
-		'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'amount' ),
-			'properties'          => array(
-				'amount'          => array(
-					'description' => __( 'Fee amount.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'recurring'       => array(
-					'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ),
-					'type'        => array( 'boolean', 'integer' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'items'           => array(
-		'description' => __( 'Invoice items.', 'invoicing' ),
-		'type'        => 'array',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'item_id' ),
-			'properties'          => array(
-				'item_id'         => array(
-					'description' => __( 'Item ID.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'item_name'       => array(
-					'description' => __( 'Item Name.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'item_description' => array(
-					'description'  => __( 'Item Description.', 'invoicing' ),
-					'type'         => 'string',
-					'context'      => array( 'view', 'edit', 'embed' ),
-				),
-				'item_price'      => array(
-					'description' => __( 'Item Price.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'quantity'        => array(
-					'description' => __( 'Item Quantity.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'subtotal'        => array(
-					'description' => __( 'Item Subtotal.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view', 'edit', 'embed' ),
-					'readonly'    => true,
-				),
-				'meta'            => array(
-					'description' => __( 'Item Meta.', 'invoicing' ),
-					'type'        => 'object',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'mode'			  => array(
-		'description' => __( 'The invoice transaction mode.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'enum'        => array( 'live', 'test' ),
-		'readonly'    => true,
-	),
+    'id'              => array(
+        'description' => __( 'Unique identifier for the invoice.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'parent_id'       => array(
+        'description' => __( 'Parent invoice ID.', 'invoicing' ),
+        'type'        => 'integer',
+        'minimum'     => 0,
+        'default'     => 0,
+        'context'     => array( 'view', 'edit' ),
+    ),
+
+    'key'			  => array(
+        'description' => __( 'A unique key for the invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'number'		  => array(
+        'description' => __( 'A unique number for the invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'type'			  => array(
+        'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'post_type'		  => array(
+        'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'version'         => array(
+        'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'template'        => array(
+        'description' => __( 'The invoice template.', 'invoicing' ),
+        'type'        => 'string',
+        'default'     => 'quantity',
+        'enum'        => array( 'quantity', 'hours', 'amount' ),
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'status'          => array(
+        'description' => __( 'Invoice status.', 'invoicing' ),
+        'type'        => 'string',
+        'default'     => 'wpi-pending',
+        'enum'        => array_keys( wpinv_get_invoice_statuses( true ) ),
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'status_nicename' => array(
+        'description' => __( 'A human readable name for the invoice status.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'currency'        => array(
+        'description' => __( 'The invoice currency in ISO format.', 'invoicing' ),
+        'type'        => 'string',
+        'default'     => wpinv_get_currency(),
+        'enum'        => array_keys( wpinv_get_currencies() ),
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'date_created'    => array(
+        'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'date_created_gmt'    => array(
+        'description' => __( 'The GMT date the invoice was created.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'date_modified'   => array(
+        'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'date_modified_gmt'    => array(
+        'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'due_date'        => array(
+        'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'due_date_gmt'    => array(
+        'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'completed_date'  => array(
+        'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'completed_date_gmt'    => array(
+        'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total_discount'   => array(
+        'description' => __( 'Total discount amount for the invoice.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total_tax'       => array(
+        'description' => __( 'Total tax amount for the invoice.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total_fees'      => array(
+        'description' => __( 'Total fees amount for the invoice.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'subtotal'        => array(
+        'description' => __( 'Invoice subtotal.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total'           => array(
+        'description' => __( 'Grand total.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'initial_total'   => array(
+        'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'recurring_total'  => array(
+        'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'totals'          => array(
+        'description' => __( 'Invoice totals.', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'fees'            => array(
+        'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'amount' ),
+            'properties'          => array(
+                'amount'          => array(
+                    'description' => __( 'Fee amount.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'recurring'       => array(
+                    'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ),
+                    'type'        => array( 'boolean', 'integer' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'discounts'       => array(
+        'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'amount' ),
+            'properties'          => array(
+                'amount'          => array(
+                    'description' => __( 'Fee amount.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'recurring'       => array(
+                    'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ),
+                    'type'        => array( 'boolean', 'integer' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'taxes'           => array(
+        'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'amount' ),
+            'properties'          => array(
+                'amount'          => array(
+                    'description' => __( 'Fee amount.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'recurring'       => array(
+                    'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ),
+                    'type'        => array( 'boolean', 'integer' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'items'           => array(
+        'description' => __( 'Invoice items.', 'invoicing' ),
+        'type'        => 'array',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'item_id' ),
+            'properties'          => array(
+                'item_id'         => array(
+                    'description' => __( 'Item ID.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'item_name'       => array(
+                    'description' => __( 'Item Name.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'item_description' => array(
+                    'description'  => __( 'Item Description.', 'invoicing' ),
+                    'type'         => 'string',
+                    'context'      => array( 'view', 'edit', 'embed' ),
+                ),
+                'item_price'      => array(
+                    'description' => __( 'Item Price.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'quantity'        => array(
+                    'description' => __( 'Item Quantity.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'subtotal'        => array(
+                    'description' => __( 'Item Subtotal.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                    'readonly'    => true,
+                ),
+                'meta'            => array(
+                    'description' => __( 'Item Meta.', 'invoicing' ),
+                    'type'        => 'object',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'mode'			  => array(
+        'description' => __( 'The invoice transaction mode.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'enum'        => array( 'live', 'test' ),
+        'readonly'    => true,
+    ),
 	
-	'discount_code'   => array(
-		'description' => __( 'The discount code used on this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'gateway'         => array(
-		'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'gateway_title'   => array(
-		'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'transaction_id'  => array(
-		'description' => __( 'The transaction id for this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
+    'discount_code'   => array(
+        'description' => __( 'The discount code used on this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'gateway'         => array(
+        'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'gateway_title'   => array(
+        'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'transaction_id'  => array(
+        'description' => __( 'The transaction id for this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
 	
-	'disable_taxes'   => array(
-		'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ),
-		'type'        => 'boolean ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'is_viewed'       => array(
-		'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ),
-		'type'        => 'boolean ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'email_cc'        => array(
-		'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit' ),
-	),
-
-	'subscription_id' => array(
-		'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'subscription_name' => array(
-		'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'subscription_name' => array(
-		'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_parent'		  => array(
-		'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_renewal'      => array(
-		'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_recurring'    => array(
-		'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_free'         => array(
-		'description' => __( 'Whether or not this invoice is free.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_paid'         => array(
-		'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'needs_payment'   => array(
-		'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_refunded'     => array(
-		'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_due'          => array(
-		'description' => __( 'Whether or not this invoice is due.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_held'         => array(
-		'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_draft'        => array(
-		'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'path'			  => array(
-		'description' => __( 'The invoice path/slug/name.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'description'     => array(
-		'description' => __( 'The invoice description.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'payment_form'    => array(
-		'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'submission_id'   => array(
-		'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'customer_id'     => array(
-		'description' => __( 'The customer id.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_ip'     => array(
-		'description' => __( "The customer's ip address.", 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'ip',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'first_name'     => array(
-		'description' => __( "The customer's first name.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'last_name'       => array(
-		'description' => __( "The customer's last name.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
+    'disable_taxes'   => array(
+        'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ),
+        'type'        => 'boolean ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'is_viewed'       => array(
+        'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ),
+        'type'        => 'boolean ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'email_cc'        => array(
+        'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit' ),
+    ),
+
+    'subscription_id' => array(
+        'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'subscription_name' => array(
+        'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'subscription_name' => array(
+        'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_parent'		  => array(
+        'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_renewal'      => array(
+        'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_recurring'    => array(
+        'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_free'         => array(
+        'description' => __( 'Whether or not this invoice is free.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_paid'         => array(
+        'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'needs_payment'   => array(
+        'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_refunded'     => array(
+        'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_due'          => array(
+        'description' => __( 'Whether or not this invoice is due.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_held'         => array(
+        'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_draft'        => array(
+        'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'path'			  => array(
+        'description' => __( 'The invoice path/slug/name.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'description'     => array(
+        'description' => __( 'The invoice description.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'payment_form'    => array(
+        'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'submission_id'   => array(
+        'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'customer_id'     => array(
+        'description' => __( 'The customer id.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_ip'     => array(
+        'description' => __( "The customer's ip address.", 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'ip',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'first_name'     => array(
+        'description' => __( "The customer's first name.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'last_name'       => array(
+        'description' => __( "The customer's last name.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
 	
-	'full_name'       => array(
-		'description' => __( "The customer's full name.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'phone_number'    => array(
-		'description' => __( "The customer's phone number.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'email_address'   => array(
-		'description' => __( "The customer's email address.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'customer_country'   => array(
-		'description'    => __( "The customer's country.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-		'default'        => wpinv_get_default_country(),
-	),
-
-	'customer_state'     => array(
-		'description'    => __( "The customer's state.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_city'      => array(
-		'description'    => __( "The customer's city.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_zip'       => array(
-		'description'    => __( "The customer's zip/postal code.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_company'   => array(
-		'description'    => __( "The customer's company name.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'vat_number'         => array(
-		'description'    => __( "The customer's VAT number.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'vat_rate'           => array(
-		'description'    => __( "The customer's VAT rate.", 'invoicing' ),
-		'type'           => 'number',
-		'context'        => array( 'view', 'edit', 'embed' ),
-		'readonly'       => true,
-	),
-
-	'customer_address'   => array(
-		'description'    => __( "The customer's address.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'address_confirmed'  => array(
-		'description'    => __( "Whether or not the customer's address is confirmed.", 'invoicing' ),
-		'type'           => 'boolean',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'meta_data'       => array(
-		'description' => __( 'Invoice meta data.', 'invoicing' ),
-		'type'        => 'array',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'properties'          => array(
-				'id'              => array(
-					'description' => __( 'Meta ID.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'key'             => array(
-					'description' => __( 'Meta key.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'value'           => array(
-					'description' => __( 'Meta Value.', 'invoicing' ),
-					'type'        => array( 'string', 'array', 'object', 'integer', 'null' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'view_url'        => array(
-		'description' => __( 'URL to the invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'uri',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'checkout_payment_url'         => array(
-		'description' => __( 'URL to the invoice checkout page.', 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'uri',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'receipt_url'     => array(
-		'description' => __( 'URL to the invoice receipt page.', 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'uri',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
+    'full_name'       => array(
+        'description' => __( "The customer's full name.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'phone_number'    => array(
+        'description' => __( "The customer's phone number.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'email_address'   => array(
+        'description' => __( "The customer's email address.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'customer_country'   => array(
+        'description'    => __( "The customer's country.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+        'default'        => wpinv_get_default_country(),
+    ),
+
+    'customer_state'     => array(
+        'description'    => __( "The customer's state.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_city'      => array(
+        'description'    => __( "The customer's city.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_zip'       => array(
+        'description'    => __( "The customer's zip/postal code.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_company'   => array(
+        'description'    => __( "The customer's company name.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'vat_number'         => array(
+        'description'    => __( "The customer's VAT number.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'vat_rate'           => array(
+        'description'    => __( "The customer's VAT rate.", 'invoicing' ),
+        'type'           => 'number',
+        'context'        => array( 'view', 'edit', 'embed' ),
+        'readonly'       => true,
+    ),
+
+    'customer_address'   => array(
+        'description'    => __( "The customer's address.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'address_confirmed'  => array(
+        'description'    => __( "Whether or not the customer's address is confirmed.", 'invoicing' ),
+        'type'           => 'boolean',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'meta_data'       => array(
+        'description' => __( 'Invoice meta data.', 'invoicing' ),
+        'type'        => 'array',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'properties'          => array(
+                'id'              => array(
+                    'description' => __( 'Meta ID.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'key'             => array(
+                    'description' => __( 'Meta key.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'value'           => array(
+                    'description' => __( 'Meta Value.', 'invoicing' ),
+                    'type'        => array( 'string', 'array', 'object', 'integer', 'null' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'view_url'        => array(
+        'description' => __( 'URL to the invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'uri',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'checkout_payment_url'         => array(
+        'description' => __( 'URL to the invoice checkout page.', 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'uri',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'receipt_url'     => array(
+        'description' => __( 'URL to the invoice receipt page.', 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'uri',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
 
 );

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

Indentation +209 added lines, -209 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,228 +14,228 @@ 
  */
 class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an item.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_price',
-		'_wpinv_vat_rule',
-		'_wpinv_vat_class',
-		'_wpinv_type',
-		'_wpinv_custom_id',
-		'_wpinv_custom_name',
-		'_wpinv_custom_singular_name',
-		'_wpinv_editable',
-		'_wpinv_dynamic_pricing',
-		'_minimum_price',
-		'_wpinv_is_recurring',
-		'_wpinv_recurring_period',
-		'_wpinv_recurring_interval',
-		'_wpinv_recurring_limit',
-		'_wpinv_free_trial',
-		'_wpinv_trial_period',
-		'_wpinv_trial_interval'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_price'                => 'price',
-		'_wpinv_vat_rule'             => 'vat_rule',
-		'_wpinv_vat_class'            => 'vat_class',
-		'_wpinv_type'                 => 'type',
-		'_wpinv_custom_id'            => 'custom_id',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_custom_singular_name' => 'custom_singular_name',
-		'_wpinv_editable'             => 'is_editable',
-		'_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
-		'_minimum_price'              => 'minimum_price',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_is_recurring'         => 'is_recurring',
-		'_wpinv_recurring_period'     => 'recurring_period',
-		'_wpinv_recurring_interval'   => 'recurring_interval',
-		'_wpinv_recurring_limit'      => 'recurring_limit',
-		'_wpinv_free_trial'           => 'is_free_trial',
-		'_wpinv_trial_period'         => 'trial_period',
-		'_wpinv_trial_interval'       => 'trial_interval',
-		'_wpinv_version'              => 'version',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for an item.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_price',
+        '_wpinv_vat_rule',
+        '_wpinv_vat_class',
+        '_wpinv_type',
+        '_wpinv_custom_id',
+        '_wpinv_custom_name',
+        '_wpinv_custom_singular_name',
+        '_wpinv_editable',
+        '_wpinv_dynamic_pricing',
+        '_minimum_price',
+        '_wpinv_is_recurring',
+        '_wpinv_recurring_period',
+        '_wpinv_recurring_interval',
+        '_wpinv_recurring_limit',
+        '_wpinv_free_trial',
+        '_wpinv_trial_period',
+        '_wpinv_trial_interval'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_price'                => 'price',
+        '_wpinv_vat_rule'             => 'vat_rule',
+        '_wpinv_vat_class'            => 'vat_class',
+        '_wpinv_type'                 => 'type',
+        '_wpinv_custom_id'            => 'custom_id',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_custom_singular_name' => 'custom_singular_name',
+        '_wpinv_editable'             => 'is_editable',
+        '_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
+        '_minimum_price'              => 'minimum_price',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_is_recurring'         => 'is_recurring',
+        '_wpinv_recurring_period'     => 'recurring_period',
+        '_wpinv_recurring_interval'   => 'recurring_interval',
+        '_wpinv_recurring_limit'      => 'recurring_limit',
+        '_wpinv_free_trial'           => 'is_free_trial',
+        '_wpinv_trial_period'         => 'trial_period',
+        '_wpinv_trial_interval'       => 'trial_interval',
+        '_wpinv_version'              => 'version',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function create( &$item ) {
-		$item->set_version( WPINV_VERSION );
-		$item->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_item_data',
-				array(
-					'post_date'     => $item->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_item',
-					'post_status'   => $this->get_post_status( $item ),
-					'ping_status'   => 'closed',
-					'post_author'   => $item->get_author( 'edit' ),
-					'post_title'    => $item->get_name( 'edit' ),
-					'post_parent'   => 0,
-					'post_excerpt'  => $item->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$item->set_id( $id );
-			$this->update_post_meta( $item );
-			$item->save_meta_data();
-			$item->apply_changes();
-			$this->clear_caches( $item );
-			do_action( 'getpaid_new_item', $item );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$item->last_error = $id->get_error_message();
-		}
+    /**
+     * Method to create a new item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function create( &$item ) {
+        $item->set_version( WPINV_VERSION );
+        $item->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_item_data',
+                array(
+                    'post_date'     => $item->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_item',
+                    'post_status'   => $this->get_post_status( $item ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $item->get_author( 'edit' ),
+                    'post_title'    => $item->get_name( 'edit' ),
+                    'post_parent'   => 0,
+                    'post_excerpt'  => $item->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $item->set_id( $id );
+            $this->update_post_meta( $item );
+            $item->save_meta_data();
+            $item->apply_changes();
+            $this->clear_caches( $item );
+            do_action( 'getpaid_new_item', $item );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $item->last_error = $id->get_error_message();
+        }
 		
-		return false;
-	}
-
-	/**
-	 * Method to read an item from the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 *
-	 */
-	public function read( &$item ) {
-
-		$item->set_defaults();
-		$item_object = get_post( $item->get_id() );
-
-		if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
-			$item->last_error = __( 'Invalid item.', 'invoicing' );
-			$item->set_id( 0 );
-			return false;
-		}
-
-		$item->set_props(
-			array(
-				'parent_id'     => $item_object->post_parent,
-				'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
-				'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
-				'status'        => $item_object->post_status,
-				'name'          => $item_object->post_title,
-				'description'   => $item_object->post_excerpt,
-				'author'        => $item_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $item, $item_object );
-		$item->read_meta_data();
-		$item->set_object_read( true );
-		do_action( 'getpaid_read_item', $item );
-
-	}
-
-	/**
-	 * Method to update an item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function update( &$item ) {
-		$item->save_meta_data();
-		$item->set_version( WPINV_VERSION );
-
-		if ( null === $item->get_date_created( 'edit' ) ) {
-			$item->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $item->get_id() );
-
-		$changes = $item->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $item->get_date_created( 'edit' ),
-				'post_status'       => $item->get_status( 'edit' ),
-				'post_parent'       => $item->get_parent_id( 'edit' ),
-				'post_excerpt'      => $item->get_description( 'edit' ),
-				'post_modified'     => $item->get_date_modified( 'edit' ),
-				'post_title'        => $item->get_name( 'edit' ),
-				'post_author'       => $item->get_author( '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' => $item->get_id() ) );
-				clean_post_cache( $item->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
-			}
-			$item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $item );
-		$item->apply_changes();
-		$this->clear_caches( $item );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $item->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_item', $item );
-		} else {
-			do_action( 'getpaid_update_item', $item );
-		}
-
-	}
-
-	/*
+        return false;
+    }
+
+    /**
+     * Method to read an item from the database.
+     *
+     * @param WPInv_Item $item Item object.
+     *
+     */
+    public function read( &$item ) {
+
+        $item->set_defaults();
+        $item_object = get_post( $item->get_id() );
+
+        if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
+            $item->last_error = __( 'Invalid item.', 'invoicing' );
+            $item->set_id( 0 );
+            return false;
+        }
+
+        $item->set_props(
+            array(
+                'parent_id'     => $item_object->post_parent,
+                'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
+                'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
+                'status'        => $item_object->post_status,
+                'name'          => $item_object->post_title,
+                'description'   => $item_object->post_excerpt,
+                'author'        => $item_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $item, $item_object );
+        $item->read_meta_data();
+        $item->set_object_read( true );
+        do_action( 'getpaid_read_item', $item );
+
+    }
+
+    /**
+     * Method to update an item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function update( &$item ) {
+        $item->save_meta_data();
+        $item->set_version( WPINV_VERSION );
+
+        if ( null === $item->get_date_created( 'edit' ) ) {
+            $item->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $item->get_id() );
+
+        $changes = $item->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $item->get_date_created( 'edit' ),
+                'post_status'       => $item->get_status( 'edit' ),
+                'post_parent'       => $item->get_parent_id( 'edit' ),
+                'post_excerpt'      => $item->get_description( 'edit' ),
+                'post_modified'     => $item->get_date_modified( 'edit' ),
+                'post_title'        => $item->get_name( 'edit' ),
+                'post_author'       => $item->get_author( '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' => $item->get_id() ) );
+                clean_post_cache( $item->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
+            }
+            $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $item );
+        $item->apply_changes();
+        $this->clear_caches( $item );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $item->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_item', $item );
+        } else {
+            do_action( 'getpaid_update_item', $item );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
-	 *
-	 * @param WPInv_Item $item WPInv_Item object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$item ) {
+    /**
+     * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
+     *
+     * @param WPInv_Item $item WPInv_Item object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$item ) {
 
-		// Ensure that we have a custom id.
+        // Ensure that we have a custom id.
         if ( ! $item->get_custom_id() ) {
             $item->set_custom_id( $item->get_id() );
-		}
+        }
 
-		parent::update_post_meta( $item );
-	}
+        parent::update_post_meta( $item );
+    }
 
 }

includes/payments/class-getpaid-payment-form.php

Indentation +533 added lines, -533 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,55 +10,55 @@ 
 class GetPaid_Payment_Form extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'payment_form';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'payment_form';
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'payment_form';
 
     /**
-	 * Form Data array. This is the core form data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * Form Data array. This is the core form data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => '',
         'author'               => 1,
         'elements'             => null,
-		'items'                => null,
-		'earned'               => 0,
-		'refunded'             => 0,
-		'cancelled'            => 0,
-		'failed'               => 0,
-	);
-
-    /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_forms';
-
-	/**
-	 * Stores a reference to the invoice if the form is for an invoice..
-	 *
-	 * @var WPInv_Invoice
-	 */
-	public $invoice = 0;
+        'items'                => null,
+        'earned'               => 0,
+        'refunded'             => 0,
+        'cancelled'            => 0,
+        'failed'               => 0,
+    );
+
+    /**
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_forms';
+
+    /**
+     * Stores a reference to the invoice if the form is for an invoice..
+     *
+     * @var WPInv_Invoice
+     */
+    public $invoice = 0;
 
     /**
      * Stores a reference to the original WP_Post object
@@ -68,35 +68,35 @@ 
     protected $post = null;
 
     /**
-	 * Get the form if ID is passed, otherwise the form is new and empty.
-	 *
-	 * @param  int|object|GetPaid_Payment_Form|WP_Post $form Form to read.
-	 */
-	public function __construct( $form = 0 ) {
-		parent::__construct( $form );
+     * Get the form if ID is passed, otherwise the form is new and empty.
+     *
+     * @param  int|object|GetPaid_Payment_Form|WP_Post $form Form to read.
+     */
+    public function __construct( $form = 0 ) {
+        parent::__construct( $form );
 
-		if ( is_numeric( $form ) && $form > 0 ) {
-			$this->set_id( $form );
-		} elseif ( $form instanceof self ) {
+        if ( is_numeric( $form ) && $form > 0 ) {
+            $this->set_id( $form );
+        } elseif ( $form instanceof self ) {
 
-			$this->set_id( $form->get_id() );
-			$this->invoice = $form->invoice;
+            $this->set_id( $form->get_id() );
+            $this->invoice = $form->invoice;
 
-		} elseif ( ! empty( $form->ID ) ) {
-			$this->set_id( $form->ID );
-		} else {
-			$this->set_object_read( true );
-		}
+        } elseif ( ! empty( $form->ID ) ) {
+            $this->set_id( $form->ID );
+        } else {
+            $this->set_object_read( true );
+        }
 
         // Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
 
-		if ( $this->get_id() > 0 ) {
+        if ( $this->get_id() > 0 ) {
             $this->post = get_post( $this->get_id() );
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
         }
 
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -114,358 +114,358 @@ 
     */
 
     /**
-	 * Get plugin version when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_version( $context = 'view' ) {
-		return $this->get_prop( 'version', $context );
+     * Get plugin version when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_version( $context = 'view' ) {
+        return $this->get_prop( 'version', $context );
     }
 
     /**
-	 * Get date when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_prop( 'date_created', $context );
+     * Get date when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_prop( 'date_created', $context );
     }
 
     /**
-	 * Get GMT date when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+     * Get GMT date when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
         $date = $this->get_date_created( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get date when the form was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified( $context = 'view' ) {
-		return $this->get_prop( 'date_modified', $context );
+     * Get date when the form was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified( $context = 'view' ) {
+        return $this->get_prop( 'date_modified', $context );
     }
 
     /**
-	 * Get GMT date when the form was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified_gmt( $context = 'view' ) {
+     * Get GMT date when the form was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified_gmt( $context = 'view' ) {
         $date = $this->get_date_modified( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get the form name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		return $this->get_prop( 'name', $context );
+     * Get the form name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        return $this->get_prop( 'name', $context );
     }
 
     /**
-	 * Alias of self::get_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_title( $context = 'view' ) {
-		return $this->get_name( $context );
-	}
+     * Alias of self::get_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_title( $context = 'view' ) {
+        return $this->get_name( $context );
+    }
 
     /**
-	 * Get the owner of the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_author( $context = 'view' ) {
-		return (int) $this->get_prop( 'author', $context );
+     * Get the owner of the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_author( $context = 'view' ) {
+        return (int) $this->get_prop( 'author', $context );
     }
 
     /**
-	 * Get the elements that make up the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_elements( $context = 'view' ) {
-		$elements = $this->get_prop( 'elements', $context );
+     * Get the elements that make up the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_elements( $context = 'view' ) {
+        $elements = $this->get_prop( 'elements', $context );
 
-		if ( empty( $elements ) || ! is_array( $elements ) ) {
+        if ( empty( $elements ) || ! is_array( $elements ) ) {
             return wpinv_get_data( 'sample-payment-form' );
-		}
+        }
 
-		// Ensure that all required elements exist.
-		$_elements = array();
-		foreach ( $elements as $element ) {
+        // Ensure that all required elements exist.
+        $_elements = array();
+        foreach ( $elements as $element ) {
 
-			if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) {
+            if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) {
 
-				$_elements[] = array(
-					'text'        => __( 'Select Payment Method', 'invoicing' ),
-					'id'          => 'gtscicd',
-					'name'        => 'gtscicd',
-					'type'        => 'gateway_select',
-					'premade'     => true
+                $_elements[] = array(
+                    'text'        => __( 'Select Payment Method', 'invoicing' ),
+                    'id'          => 'gtscicd',
+                    'name'        => 'gtscicd',
+                    'type'        => 'gateway_select',
+                    'premade'     => true
 			
-				);
+                );
 
-			}
+            }
 
-			$_elements[] = $element;
+            $_elements[] = $element;
 
-		}
+        }
 
         return $_elements;
-	}
-
-	/**
-	 * Get the items sold via the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @param  string $return objects or arrays.
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items( $context = 'view', $return = 'objects' ) {
-		$items = $this->get_prop( 'items', $context );
-
-		if ( empty( $items ) || ! is_array( $items ) ) {
+    }
+
+    /**
+     * Get the items sold via the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @param  string $return objects or arrays.
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items( $context = 'view', $return = 'objects' ) {
+        $items = $this->get_prop( 'items', $context );
+
+        if ( empty( $items ) || ! is_array( $items ) ) {
             $items = wpinv_get_data( 'sample-payment-form-items' );
-		}
+        }
+
+        // Convert the items.
+        $prepared = array();
 
-		// Convert the items.
-		$prepared = array();
+        foreach ( $items as $key => $value ) {
 
-		foreach ( $items as $key => $value ) {
+            // Form items.
+            if ( $value instanceof GetPaid_Form_Item ) {
 
-			// Form items.
-			if ( $value instanceof GetPaid_Form_Item ) {
+                if ( $value->can_purchase() ) {
+                    $prepared[] = $value;
+                }
 
-				if ( $value->can_purchase() ) {
-					$prepared[] = $value;
-				}
+                continue;
 
-				continue;
+            }
 
-			}
+            // $item_id => $quantity (buy buttons)
+            if ( is_numeric( $key ) && is_numeric( $value ) ) {
+                $item = new GetPaid_Form_Item( $key );
 
-			// $item_id => $quantity (buy buttons)
-			if ( is_numeric( $key ) && is_numeric( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
+                if ( $item->can_purchase() ) {
 
-				if ( $item->can_purchase() ) {
+                    $value = (float) $value;
+                    $item->set_quantity( $value );
+                    if ( 0 == $value ) {
+                        $item->set_quantity( 1 );
+                        $item->set_allow_quantities( true );
+                    }
 
-					$value = (float) $value;
-					$item->set_quantity( $value );
-					if ( 0 == $value ) {
-						$item->set_quantity( 1 );
-						$item->set_allow_quantities( true );
-					}
+                    $prepared[] = $item;
+                }
 
-					$prepared[] = $item;
-				}
+                continue;
+            }
 
-				continue;
-			}
+            // Items saved via payment forms editor.
+            if ( is_array( $value ) && isset( $value['id'] ) ) {
 
-			// Items saved via payment forms editor.
-			if ( is_array( $value ) && isset( $value['id'] ) ) {
+                $item = new GetPaid_Form_Item( $value['id'] );
 
-				$item = new GetPaid_Form_Item( $value['id'] );
+                if ( ! $item->can_purchase() ) {
+                    continue;
+                }
 
-				if ( ! $item->can_purchase() ) {
-					continue;
-				}
+                // Sub-total (Cart items).
+                if ( isset( $value['subtotal'] ) ) {
+                    $item->set_price( $value['subtotal'] );
+                }
 
-				// Sub-total (Cart items).
-				if ( isset( $value['subtotal'] ) ) {
-					$item->set_price( $value['subtotal'] );
-				}
+                if ( isset( $value['quantity'] ) ) {
+                    $item->set_quantity( $value['quantity'] );
+                }
 
-				if ( isset( $value['quantity'] ) ) {
-					$item->set_quantity( $value['quantity'] );
-				}
+                if ( isset( $value['allow_quantities'] ) ) {
+                    $item->set_allow_quantities( $value['allow_quantities'] );
+                }
 
-				if ( isset( $value['allow_quantities'] ) ) {
-					$item->set_allow_quantities( $value['allow_quantities'] );
-				}
+                if ( isset( $value['required'] ) ) {
+                    $item->set_is_required( $value['required'] );
+                }
 
-				if ( isset( $value['required'] ) ) {
-					$item->set_is_required( $value['required'] );
-				}
+                if ( isset( $value['description'] ) ) {
+                    $item->set_custom_description( $value['description'] );
+                }
 
-				if ( isset( $value['description'] ) ) {
-					$item->set_custom_description( $value['description'] );
-				}
+                $prepared[] = $item;
+                continue;
 
-				$prepared[] = $item;
-				continue;
+            }
+
+            // $item_id => array( 'price' => 10 ) (item variations)
+            if ( is_numeric( $key ) && is_array( $value ) ) {
+                $item = new GetPaid_Form_Item( $key );
+
+                if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) {
+                    $item->set_price( $value['price'] );
+                }
+
+                if ( $item->can_purchase() ) {
+                    $prepared[] = $item;
+                }
+
+                continue;
+            }
+
+        }
+
+        if ( 'objects' == $return && 'view' == $context ) {
+            return $prepared;
+        }
+
+        $items = array();
+        foreach ( $prepared as $item ) {
+            $items[] = $item->prepare_data_for_use();
+        }
+
+        return $items;
+    }
+
+    /**
+     * Get a single item belonging to the form.
+     *
+     * @since 1.0.19
+     * @param  int $item_id The item id to return.
+     * @return GetPaid_Form_Item|bool
+     */
+    public function get_item( $item_id ) {
+
+        if ( empty( $item_id ) || ! is_numeric( $item_id ) ) {
+            return false;
+        }
+
+        foreach( $this->get_items() as $item ) {
+            if ( $item->get_id() == (int) $item_id ) {
+                return $item;
+            }
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Gets a single element.
+     *
+     * @since 1.0.19
+     * @param  string $element_type The element type to return.
+     * @return array|bool
+     */
+    public function get_element_type( $element_type ) {
+
+        if ( empty( $element_type ) || ! is_scalar( $element_type ) ) {
+            return false;
+        }
+
+        foreach ( $this->get_prop( 'elements' ) as $element ) {
+
+            if ( $element['type'] == $element_type ) {
+                return $element;
+            }
+
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Get the total amount earned via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_earned( $context = 'view' ) {
+        return $this->get_prop( 'earned', $context );
+    }
+
+    /**
+     * Get the total amount refunded via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_refunded( $context = 'view' ) {
+        return $this->get_prop( 'refunded', $context );
+    }
 
-			}
+    /**
+     * Get the total amount cancelled via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_cancelled( $context = 'view' ) {
+        return $this->get_prop( 'cancelled', $context );
+    }
 
-			// $item_id => array( 'price' => 10 ) (item variations)
-			if ( is_numeric( $key ) && is_array( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
+    /**
+     * Get the total amount failed via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_failed( $context = 'view' ) {
+        return $this->get_prop( 'failed', $context );
+    }
 
-				if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) {
-					$item->set_price( $value['price'] );
-				}
-
-				if ( $item->can_purchase() ) {
-					$prepared[] = $item;
-				}
-
-				continue;
-			}
-
-		}
-
-		if ( 'objects' == $return && 'view' == $context ) {
-			return $prepared;
-		}
-
-		$items = array();
-		foreach ( $prepared as $item ) {
-			$items[] = $item->prepare_data_for_use();
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Get a single item belonging to the form.
-	 *
-	 * @since 1.0.19
-	 * @param  int $item_id The item id to return.
-	 * @return GetPaid_Form_Item|bool
-	 */
-	public function get_item( $item_id ) {
-
-		if ( empty( $item_id ) || ! is_numeric( $item_id ) ) {
-			return false;
-		}
-
-		foreach( $this->get_items() as $item ) {
-			if ( $item->get_id() == (int) $item_id ) {
-				return $item;
-			}
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Gets a single element.
-	 *
-	 * @since 1.0.19
-	 * @param  string $element_type The element type to return.
-	 * @return array|bool
-	 */
-	public function get_element_type( $element_type ) {
-
-		if ( empty( $element_type ) || ! is_scalar( $element_type ) ) {
-			return false;
-		}
-
-		foreach ( $this->get_prop( 'elements' ) as $element ) {
-
-			if ( $element['type'] == $element_type ) {
-				return $element;
-			}
-
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Get the total amount earned via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_earned( $context = 'view' ) {
-		return $this->get_prop( 'earned', $context );
-	}
-
-	/**
-	 * Get the total amount refunded via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_refunded( $context = 'view' ) {
-		return $this->get_prop( 'refunded', $context );
-	}
-
-	/**
-	 * Get the total amount cancelled via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_cancelled( $context = 'view' ) {
-		return $this->get_prop( 'cancelled', $context );
-	}
-
-	/**
-	 * Get the total amount failed via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_failed( $context = 'view' ) {
-		return $this->get_prop( 'failed', $context );
-	}
-
-	/**
-	 * Get the currency.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_currency() {
-		$currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency();
-		return apply_filters( 'getpaid-payment-form-currency', $currency, $this );
-	}
+    /**
+     * Get the currency.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_currency() {
+        $currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency();
+        return apply_filters( 'getpaid-payment-form-currency', $currency, $this );
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -478,22 +478,22 @@ 
     */
 
     /**
-	 * Set plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
+     * Set plugin version when the item was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
     }
 
     /**
-	 * Set date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was created.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_created( $value ) {
+     */
+    public function set_date_created( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -506,13 +506,13 @@ 
     }
 
     /**
-	 * Set date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_modified( $value ) {
+     */
+    public function set_date_modified( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -525,118 +525,118 @@ 
     }
 
     /**
-	 * Set the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
-		$this->set_prop( 'name', sanitize_text_field( $value ) );
-    }
-
-    /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $value );
-    }
-
-    /**
-	 * Set the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$this->set_prop( 'author', (int) $value );
-	}
-
-	/**
-	 * Set the form elements.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value Form elements.
-	 */
-	public function set_elements( $value ) {
-		if ( is_array( $value ) ) {
-			$this->set_prop( 'elements', $value );
-		}
-	}
-
-	/**
-	 * Set the form items.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value Form elements.
-	 */
-	public function set_items( $value ) {
-		if ( is_array( $value ) ) {
-			$this->set_prop( 'items', $value );
-		}
-	}
-
-	/**
-	 * Set the total amount earned via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount earned.
-	 */
-	public function set_earned( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'earned', $value );
-	}
-
-	/**
-	 * Set the total amount refunded via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount refunded.
-	 */
-	public function set_refunded( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'refunded', $value );
-	}
-
-	/**
-	 * Set the total amount cancelled via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount cancelled.
-	 */
-	public function set_cancelled( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'cancelled', $value );
-	}
-
-	/**
-	 * Set the total amount failed via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount cancelled.
-	 */
-	public function set_failed( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'failed', $value );
-	}
+     * Set the item name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
+        $this->set_prop( 'name', sanitize_text_field( $value ) );
+    }
+
+    /**
+     * Alias of self::set_name().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_title( $value ) {
+        $this->set_name( $value );
+    }
+
+    /**
+     * Set the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
+
+    /**
+     * Set the form elements.
+     *
+     * @since 1.0.19
+     * @param  array $value Form elements.
+     */
+    public function set_elements( $value ) {
+        if ( is_array( $value ) ) {
+            $this->set_prop( 'elements', $value );
+        }
+    }
+
+    /**
+     * Set the form items.
+     *
+     * @since 1.0.19
+     * @param  array $value Form elements.
+     */
+    public function set_items( $value ) {
+        if ( is_array( $value ) ) {
+            $this->set_prop( 'items', $value );
+        }
+    }
+
+    /**
+     * Set the total amount earned via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount earned.
+     */
+    public function set_earned( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'earned', $value );
+    }
+
+    /**
+     * Set the total amount refunded via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount refunded.
+     */
+    public function set_refunded( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'refunded', $value );
+    }
+
+    /**
+     * Set the total amount cancelled via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount cancelled.
+     */
+    public function set_cancelled( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'cancelled', $value );
+    }
+
+    /**
+     * Set the total amount failed via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount cancelled.
+     */
+    public function set_failed( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'failed', $value );
+    }
 
     /**
      * Create an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
     }
 
@@ -644,7 +644,7 @@ 
      * Updates an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -660,22 +660,22 @@ 
 	*/
 
     /**
-	 * Checks whether this is the default payment form.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether this is the default payment form.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_default() {
         $is_default = $this->get_id() == wpinv_get_default_payment_form();
         return (bool) apply_filters( 'wpinv_is_default_payment_form', $is_default, $this->get_id(), $this );
-	}
+    }
 
     /**
-	 * Checks whether the form is active.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the form is active.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_active() {
         $is_active = 0 !== (int) $this->get_id();
 
@@ -684,76 +684,76 @@ 
         }
 
         return (bool) apply_filters( 'wpinv_is_payment_form_active', $is_active, $this );
-	}
-
-	/**
-	 * Checks whether the form has a given item.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether the form has a given item.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_item( $item_id ) {
         return false !== $this->get_item( $item_id );
-	}
-
-	/**
-	 * Checks whether the form has a given element.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether the form has a given element.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_element_type( $element_type ) {
         return false !== $this->get_element_type( $element_type );
-	}
-
-	/**
-	 * Checks whether this form is recurring or not.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether this form is recurring or not.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_recurring() {
 
-		if ( ! empty( $this->invoice ) ) {
-			return $this->invoice->is_recurring();
-		}
+        if ( ! empty( $this->invoice ) ) {
+            return $this->invoice->is_recurring();
+        }
 
-		foreach ( $this->get_items() as $item ) {
+        foreach ( $this->get_items() as $item ) {
 
-			if ( $item->is_recurring() ) {
-				return true;
-			}
+            if ( $item->is_recurring() ) {
+                return true;
+            }
 
-		}
+        }
 
         return false;
-	}
+    }
 
-	/**
-	 * Retrieves the form's html.
-	 *
-	 * @since 1.0.19
-	 */
+    /**
+     * Retrieves the form's html.
+     *
+     * @since 1.0.19
+     */
     public function get_html( $extra_markup = '' ) {
 
-		// Return the HTML.
-		return wpinv_get_template_html(
-			'payment-forms/form.php',
-			array(
-				'form'         => $this,
-				'extra_markup' => $extra_markup,
-			)
-		);
-
-	}
-
-	/**
-	 * Displays the payment form.
-	 *
-	 * @since 1.0.19
-	 */
+        // Return the HTML.
+        return wpinv_get_template_html(
+            'payment-forms/form.php',
+            array(
+                'form'         => $this,
+                'extra_markup' => $extra_markup,
+            )
+        );
+
+    }
+
+    /**
+     * Displays the payment form.
+     *
+     * @since 1.0.19
+     */
     public function display( $extra_markup = '' ) {
-		echo $this->get_html( $extra_markup );
+        echo $this->get_html( $extra_markup );
     }
 
 }

vendor/composer/installers/src/Composer/Installers/OxidInstaller.php

Indentation +41 added lines, -41 removed lines

@@ -5,7 +5,7 @@ 
 
 class OxidInstaller extends BaseInstaller
 {
-	const VENDOR_PATTERN = '/^modules\/(?P<vendor>.+)\/.+/';
+    const VENDOR_PATTERN = '/^modules\/(?P<vendor>.+)\/.+/';
 
     protected $locations = array(
         'module'    => 'modules/{$name}/',
@@ -13,47 +13,47 @@ 
         'out'    => 'out/{$name}/',
     );
 
-	/**
-	 * getInstallPath
-	 *
-	 * @param PackageInterface $package
-	 * @param string $frameworkType
-	 * @return string
-	 */
-	public function getInstallPath(PackageInterface $package, $frameworkType = '')
-	{
-		$installPath = parent::getInstallPath($package, $frameworkType);
-		$type = $this->package->getType();
-		if ($type === 'oxid-module') {
-			$this->prepareVendorDirectory($installPath);
-		}
-		return $installPath;
-	}
+    /**
+     * getInstallPath
+     *
+     * @param PackageInterface $package
+     * @param string $frameworkType
+     * @return string
+     */
+    public function getInstallPath(PackageInterface $package, $frameworkType = '')
+    {
+        $installPath = parent::getInstallPath($package, $frameworkType);
+        $type = $this->package->getType();
+        if ($type === 'oxid-module') {
+            $this->prepareVendorDirectory($installPath);
+        }
+        return $installPath;
+    }
 
-	/**
-	 * prepareVendorDirectory
-	 *
-	 * Makes sure there is a vendormetadata.php file inside
-	 * the vendor folder if there is a vendor folder.
-	 *
-	 * @param string $installPath
-	 * @return void
-	 */
-	protected function prepareVendorDirectory($installPath)
-	{
-		$matches = '';
-		$hasVendorDirectory = preg_match(self::VENDOR_PATTERN, $installPath, $matches);
-		if (!$hasVendorDirectory) {
-			return;
-		}
+    /**
+     * prepareVendorDirectory
+     *
+     * Makes sure there is a vendormetadata.php file inside
+     * the vendor folder if there is a vendor folder.
+     *
+     * @param string $installPath
+     * @return void
+     */
+    protected function prepareVendorDirectory($installPath)
+    {
+        $matches = '';
+        $hasVendorDirectory = preg_match(self::VENDOR_PATTERN, $installPath, $matches);
+        if (!$hasVendorDirectory) {
+            return;
+        }
 
-		$vendorDirectory = $matches['vendor'];
-		$vendorPath = getcwd() . '/modules/' . $vendorDirectory;
-		if (!file_exists($vendorPath)) {
-			mkdir($vendorPath, 0755, true);
-		}
+        $vendorDirectory = $matches['vendor'];
+        $vendorPath = getcwd() . '/modules/' . $vendorDirectory;
+        if (!file_exists($vendorPath)) {
+            mkdir($vendorPath, 0755, true);
+        }
 
-		$vendorMetaDataPath = $vendorPath . '/vendormetadata.php';
-		touch($vendorMetaDataPath);
-	}
+        $vendorMetaDataPath = $vendorPath . '/vendormetadata.php';
+        touch($vendorMetaDataPath);
+    }
 }

vendor/ayecode/wp-ayecode-ui/includes/components/class-aui-component-helper.php

Indentation +369 added lines, -369 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -11,372 +11,372 @@ 
  */
 class AUI_Component_Helper {
 
-	/**
-	 * A component helper for generating a input name.
-	 *
-	 * @param $text
-	 * @param $multiple bool If the name is set to be multiple but no brackets found then we add some.
-	 *
-	 * @return string
-	 */
-	public static function name($text,$multiple = false){
-		$output = '';
-
-		if($text){
-			$is_multiple = strpos($text, '[') === false && $multiple  ? '[]' : '';
-			$output = ' name="'.esc_attr($text).$is_multiple.'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item id.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function id($text){
-		$output = '';
-
-		if($text){
-			$output = ' id="'.sanitize_html_class($text).'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item title.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function title($text){
-		$output = '';
-
-		if($text){
-			$output = ' title="'.esc_attr($text).'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item value.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function value($text){
-		$output = '';
-
-		if($text){
-			$output = ' value="'.sanitize_text_field($text).'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item class attribute.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function class_attr($text){
-		$output = '';
-
-		if($text){
-			$classes = self::esc_classes($text);
-			if(!empty($classes)){
-				$output = ' class="'.$classes.'" ';
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Escape a string of classes.
-	 *
-	 * @param $text
-	 *
-	 * @return string
-	 */
-	public static function esc_classes($text){
-		$output = '';
-
-		if($text){
-			$classes = explode(" ",$text);
-			$classes = array_map("trim",$classes);
-			$classes = array_map("sanitize_html_class",$classes);
-			if(!empty($classes)){
-				$output = implode(" ",$classes);
-			}
-		}
-
-		return $output;
-
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function data_attributes($args){
-		$output = '';
-
-		if(!empty($args)){
-
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "data-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function aria_attributes($args){
-		$output = '';
-
-		if(!empty($args)){
-
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "aria-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Build a font awesome icon from a class.
-	 *
-	 * @param $class
-	 * @param bool $space_after
-	 * @param array $extra_attributes An array of extra attributes.
-	 *
-	 * @return string
-	 */
-	public static function icon($class,$space_after = false, $extra_attributes = array()){
-		$output = '';
-
-		if($class){
-			$classes = self::esc_classes($class);
-			if(!empty($classes)){
-				$output = '<i class="'.$classes.'" ';
-				// extra attributes
-				if(!empty($extra_attributes)){
-					$output .= AUI_Component_Helper::extra_attributes($extra_attributes);
-				}
-				$output .= '></i>';
-				if($space_after){
-					$output .= " ";
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function extra_attributes($args){
-		$output = '';
-
-		if(!empty($args)){
-
-			if( is_array($args) ){
-				foreach($args as $key => $val){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
-				}
-			}else{
-				$output .= ' '.$args.' ';
-			}
-
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function help_text($text){
-		$output = '';
-
-		if($text){
-			$output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>';
-		}
-
-
-		return $output;
-	}
-
-	/**
-	 * Replace element require context with JS.
-	 *
-	 * @param $input
-	 *
-	 * @return string|void
-	 */
-	public static function element_require( $input ) {
-
-		$input = str_replace( "'", '"', $input );// we only want double quotes
-
-		$output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
-			"jQuery(form).find('[data-argument=\"",
-			"\"]').find('input,select,textarea').val()",
-			"\"]').find('input:checked').val()",
-		), $input ) );
-
-		if($output){
-			$output = ' data-element-require="'.$output.'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Returns an array of allowed HTML tags and attributes for a given context.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param string|array $context The context for which to retrieve tags. Allowed values are 'post',
-	 *                              'strip', 'data', 'entities', or the name of a field filter such as
-	 *                              'pre_user_description'.
-	 * @param array $input Input.
-	 * @return array Array of allowed HTML tags and their allowed attributes.
-	 */
-	public static function kses_allowed_html( $context = 'post', $input = array() ) {
-		$allowed_html = wp_kses_allowed_html( $context );
-
-		if ( is_array( $allowed_html ) ) {
-			// <iframe>
-			if ( ! isset( $allowed_html['iframe'] ) && $context == 'post' ) {
-				$allowed_html['iframe']     = array(
-					'class'        => true,
-					'id'           => true,
-					'src'          => true,
-					'width'        => true,
-					'height'       => true,
-					'frameborder'  => true,
-					'marginwidth'  => true,
-					'marginheight' => true,
-					'scrolling'    => true,
-					'style'        => true,
-					'title'        => true,
-					'allow'        => true,
-					'allowfullscreen' => true,
-					'data-*'       => true,
-				);
-			}
-		}
-
-		/**
-		 * Filters the allowed html tags.
-		 *
-		 * @since 0.1.41
-		 *
-		 * @param array[]|string $allowed_html Allowed html tags.
-		 * @param @param string|array $context The context for which to retrieve tags.
-		 * @param array $input Input field.
-		 */
-		return apply_filters( 'ayecode_ui_kses_allowed_html', $allowed_html, $context, $input );
-	}
-
-	/**
-	 * Filters content and keeps only allowable HTML elements.
-	 *
-	 * This function makes sure that only the allowed HTML element names, attribute
-	 * names and attribute values plus only sane HTML entities will occur in
-	 * $string. You have to remove any slashes from PHP's magic quotes before you
-	 * call this function.
-	 *
-	 * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news',
-	 * 'irc', 'gopher', 'nntp', 'feed', 'telnet, 'mms', 'rtsp' and 'svn'. This
-	 * covers all common link protocols, except for 'javascript' which should not
-	 * be allowed for untrusted users.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param string|array $value Content to filter through kses.
-	 * @param array  $input       Input Field.
-	 * @return string Filtered content with only allowed HTML elements.
-	 */
-	public static function _sanitize_html_field( $value, $input = array() ) {
-		if ( $value === '' ) {
-			return $value;
-		}
-
-		$allowed_html = self::kses_allowed_html( 'post', $input );
-
-		if ( ! is_array( $allowed_html ) ) {
-			$allowed_html = wp_kses_allowed_html( 'post' );
-		}
-
-		$filtered = trim( wp_unslash( $value ) );
-		$filtered = wp_kses( $filtered, $allowed_html );
-		$filtered = balanceTags( $filtered ); // Balances tags
-
-		return $filtered;
-	}
-
-	/**
-	 * Navigates through an array, object, or scalar, and removes slashes from the values.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param mixed $value The value to be stripped.
-	 * @param array  $input Input Field.
-	 * @return mixed Stripped value.
-	 */
-	public static function sanitize_html_field( $value, $input = array() ) {
-		$original = $value;
-
-		if ( is_array( $value ) ) {
-			foreach ( $value as $index => $item ) {
-				$value[ $index ] = self::_sanitize_html_field( $value, $input );
-			}
-		} elseif ( is_object( $value ) ) {
-			$object_vars = get_object_vars( $value );
-
-			foreach ( $object_vars as $property_name => $property_value ) {
-				$value->$property_name = self::_sanitize_html_field( $property_value, $input );
-			}
-		} else {
-			$value = self::_sanitize_html_field( $value, $input );
-		}
-
-		/**
-		 * Filters content and keeps only allowable HTML elements.
-		 *
-		 * @since 0.1.41
-		 *
-		 * @param string|array $value Content to filter through kses.
-		 * @param string|array $value Original content without filter.
-		 * @param array  $input       Input Field.
-		 */
-		return apply_filters( 'ayecode_ui_sanitize_html_field', $value, $original, $input );
-	}
+    /**
+     * A component helper for generating a input name.
+     *
+     * @param $text
+     * @param $multiple bool If the name is set to be multiple but no brackets found then we add some.
+     *
+     * @return string
+     */
+    public static function name($text,$multiple = false){
+        $output = '';
+
+        if($text){
+            $is_multiple = strpos($text, '[') === false && $multiple  ? '[]' : '';
+            $output = ' name="'.esc_attr($text).$is_multiple.'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item id.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function id($text){
+        $output = '';
+
+        if($text){
+            $output = ' id="'.sanitize_html_class($text).'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item title.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function title($text){
+        $output = '';
+
+        if($text){
+            $output = ' title="'.esc_attr($text).'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item value.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function value($text){
+        $output = '';
+
+        if($text){
+            $output = ' value="'.sanitize_text_field($text).'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item class attribute.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function class_attr($text){
+        $output = '';
+
+        if($text){
+            $classes = self::esc_classes($text);
+            if(!empty($classes)){
+                $output = ' class="'.$classes.'" ';
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Escape a string of classes.
+     *
+     * @param $text
+     *
+     * @return string
+     */
+    public static function esc_classes($text){
+        $output = '';
+
+        if($text){
+            $classes = explode(" ",$text);
+            $classes = array_map("trim",$classes);
+            $classes = array_map("sanitize_html_class",$classes);
+            if(!empty($classes)){
+                $output = implode(" ",$classes);
+            }
+        }
+
+        return $output;
+
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function data_attributes($args){
+        $output = '';
+
+        if(!empty($args)){
+
+            foreach($args as $key => $val){
+                if(substr( $key, 0, 5 ) === "data-"){
+                    $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function aria_attributes($args){
+        $output = '';
+
+        if(!empty($args)){
+
+            foreach($args as $key => $val){
+                if(substr( $key, 0, 5 ) === "aria-"){
+                    $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Build a font awesome icon from a class.
+     *
+     * @param $class
+     * @param bool $space_after
+     * @param array $extra_attributes An array of extra attributes.
+     *
+     * @return string
+     */
+    public static function icon($class,$space_after = false, $extra_attributes = array()){
+        $output = '';
+
+        if($class){
+            $classes = self::esc_classes($class);
+            if(!empty($classes)){
+                $output = '<i class="'.$classes.'" ';
+                // extra attributes
+                if(!empty($extra_attributes)){
+                    $output .= AUI_Component_Helper::extra_attributes($extra_attributes);
+                }
+                $output .= '></i>';
+                if($space_after){
+                    $output .= " ";
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function extra_attributes($args){
+        $output = '';
+
+        if(!empty($args)){
+
+            if( is_array($args) ){
+                foreach($args as $key => $val){
+                    $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+                }
+            }else{
+                $output .= ' '.$args.' ';
+            }
+
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function help_text($text){
+        $output = '';
+
+        if($text){
+            $output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>';
+        }
+
+
+        return $output;
+    }
+
+    /**
+     * Replace element require context with JS.
+     *
+     * @param $input
+     *
+     * @return string|void
+     */
+    public static function element_require( $input ) {
+
+        $input = str_replace( "'", '"', $input );// we only want double quotes
+
+        $output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
+            "jQuery(form).find('[data-argument=\"",
+            "\"]').find('input,select,textarea').val()",
+            "\"]').find('input:checked').val()",
+        ), $input ) );
+
+        if($output){
+            $output = ' data-element-require="'.$output.'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * Returns an array of allowed HTML tags and attributes for a given context.
+     *
+     * @since 0.1.41
+     *
+     * @param string|array $context The context for which to retrieve tags. Allowed values are 'post',
+     *                              'strip', 'data', 'entities', or the name of a field filter such as
+     *                              'pre_user_description'.
+     * @param array $input Input.
+     * @return array Array of allowed HTML tags and their allowed attributes.
+     */
+    public static function kses_allowed_html( $context = 'post', $input = array() ) {
+        $allowed_html = wp_kses_allowed_html( $context );
+
+        if ( is_array( $allowed_html ) ) {
+            // <iframe>
+            if ( ! isset( $allowed_html['iframe'] ) && $context == 'post' ) {
+                $allowed_html['iframe']     = array(
+                    'class'        => true,
+                    'id'           => true,
+                    'src'          => true,
+                    'width'        => true,
+                    'height'       => true,
+                    'frameborder'  => true,
+                    'marginwidth'  => true,
+                    'marginheight' => true,
+                    'scrolling'    => true,
+                    'style'        => true,
+                    'title'        => true,
+                    'allow'        => true,
+                    'allowfullscreen' => true,
+                    'data-*'       => true,
+                );
+            }
+        }
+
+        /**
+         * Filters the allowed html tags.
+         *
+         * @since 0.1.41
+         *
+         * @param array[]|string $allowed_html Allowed html tags.
+         * @param @param string|array $context The context for which to retrieve tags.
+         * @param array $input Input field.
+         */
+        return apply_filters( 'ayecode_ui_kses_allowed_html', $allowed_html, $context, $input );
+    }
+
+    /**
+     * Filters content and keeps only allowable HTML elements.
+     *
+     * This function makes sure that only the allowed HTML element names, attribute
+     * names and attribute values plus only sane HTML entities will occur in
+     * $string. You have to remove any slashes from PHP's magic quotes before you
+     * call this function.
+     *
+     * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news',
+     * 'irc', 'gopher', 'nntp', 'feed', 'telnet, 'mms', 'rtsp' and 'svn'. This
+     * covers all common link protocols, except for 'javascript' which should not
+     * be allowed for untrusted users.
+     *
+     * @since 0.1.41
+     *
+     * @param string|array $value Content to filter through kses.
+     * @param array  $input       Input Field.
+     * @return string Filtered content with only allowed HTML elements.
+     */
+    public static function _sanitize_html_field( $value, $input = array() ) {
+        if ( $value === '' ) {
+            return $value;
+        }
+
+        $allowed_html = self::kses_allowed_html( 'post', $input );
+
+        if ( ! is_array( $allowed_html ) ) {
+            $allowed_html = wp_kses_allowed_html( 'post' );
+        }
+
+        $filtered = trim( wp_unslash( $value ) );
+        $filtered = wp_kses( $filtered, $allowed_html );
+        $filtered = balanceTags( $filtered ); // Balances tags
+
+        return $filtered;
+    }
+
+    /**
+     * Navigates through an array, object, or scalar, and removes slashes from the values.
+     *
+     * @since 0.1.41
+     *
+     * @param mixed $value The value to be stripped.
+     * @param array  $input Input Field.
+     * @return mixed Stripped value.
+     */
+    public static function sanitize_html_field( $value, $input = array() ) {
+        $original = $value;
+
+        if ( is_array( $value ) ) {
+            foreach ( $value as $index => $item ) {
+                $value[ $index ] = self::_sanitize_html_field( $value, $input );
+            }
+        } elseif ( is_object( $value ) ) {
+            $object_vars = get_object_vars( $value );
+
+            foreach ( $object_vars as $property_name => $property_value ) {
+                $value->$property_name = self::_sanitize_html_field( $property_value, $input );
+            }
+        } else {
+            $value = self::_sanitize_html_field( $value, $input );
+        }
+
+        /**
+         * Filters content and keeps only allowable HTML elements.
+         *
+         * @since 0.1.41
+         *
+         * @param string|array $value Content to filter through kses.
+         * @param string|array $value Original content without filter.
+         * @param array  $input       Input Field.
+         */
+        return apply_filters( 'ayecode_ui_sanitize_html_field', $value, $original, $input );
+    }
 }
\ No newline at end of file