AyeCode / invoicing

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

Indentation +471 added lines, -471 removed lines

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

Spacing +117 added lines, -117 removed lines

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

includes/class-getpaid-subscriptions-query.php

Indentation +490 added lines, -490 removed lines

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

Spacing +96 added lines, -96 removed lines

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

widgets/subscriptions.php

Indentation +331 added lines, -331 removed lines

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

Spacing +71 added lines, -71 removed lines

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

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

Indentation +9 added lines, -9 removed lines

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

Spacing +9 added lines, -9 removed lines

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

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

Braces +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
 				foreach($args as $key => $val){
 					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
 				}
-			}else{
+			} else{
 				$output .= ' '.$args.' ';
 			}
 

Indentation +246 added lines, -246 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -11,250 +11,250 @@ 
  */
 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;
-	}
+    /**
+     * 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;
+    }
 
 }
\ No newline at end of file

Spacing +57 added lines, -57 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit; // Exit if accessed directly
 }
 
@@ -19,12 +19,12 @@ 
 	 *
 	 * @return string
 	 */
-	public static function name($text,$multiple = false){
+	public static function name($text, $multiple = false) {
 		$output = '';
 
-		if($text){
-			$is_multiple = strpos($text, '[') === false && $multiple  ? '[]' : '';
-			$output = ' name="'.esc_attr($text).$is_multiple.'" ';
+		if ($text) {
+			$is_multiple = strpos($text, '[') === false && $multiple ? '[]' : '';
+			$output = ' name="' . esc_attr($text) . $is_multiple . '" ';
 		}
 
 		return $output;
@@ -37,11 +37,11 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function id($text){
+	public static function id($text) {
 		$output = '';
 
-		if($text){
-			$output = ' id="'.sanitize_html_class($text).'" ';
+		if ($text) {
+			$output = ' id="' . sanitize_html_class($text) . '" ';
 		}
 
 		return $output;
@@ -54,11 +54,11 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function title($text){
+	public static function title($text) {
 		$output = '';
 
-		if($text){
-			$output = ' title="'.esc_attr($text).'" ';
+		if ($text) {
+			$output = ' title="' . esc_attr($text) . '" ';
 		}
 
 		return $output;
@@ -71,11 +71,11 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function value($text){
+	public static function value($text) {
 		$output = '';
 
-		if($text){
-			$output = ' value="'.sanitize_text_field($text).'" ';
+		if ($text) {
+			$output = ' value="' . sanitize_text_field($text) . '" ';
 		}
 
 		return $output;
@@ -88,13 +88,13 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function class_attr($text){
+	public static function class_attr($text) {
 		$output = '';
 
-		if($text){
+		if ($text) {
 			$classes = self::esc_classes($text);
-			if(!empty($classes)){
-				$output = ' class="'.$classes.'" ';
+			if (!empty($classes)) {
+				$output = ' class="' . $classes . '" ';
 			}
 		}
 
@@ -108,15 +108,15 @@ 
 	 *
 	 * @return string
 	 */
-	public static function esc_classes($text){
+	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);
+		if ($text) {
+			$classes = explode(" ", $text);
+			$classes = array_map("trim", $classes);
+			$classes = array_map("sanitize_html_class", $classes);
+			if (!empty($classes)) {
+				$output = implode(" ", $classes);
 			}
 		}
 
@@ -129,14 +129,14 @@ 
 	 *
 	 * @return string
 	 */
-	public static function data_attributes($args){
+	public static function data_attributes($args) {
 		$output = '';
 
-		if(!empty($args)){
+		if (!empty($args)) {
 
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "data-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+			foreach ($args as $key => $val) {
+				if (substr($key, 0, 5) === "data-") {
+					$output .= ' ' . sanitize_html_class($key) . '="' . esc_attr($val) . '" ';
 				}
 			}
 		}
@@ -149,14 +149,14 @@ 
 	 *
 	 * @return string
 	 */
-	public static function aria_attributes($args){
+	public static function aria_attributes($args) {
 		$output = '';
 
-		if(!empty($args)){
+		if (!empty($args)) {
 
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "aria-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+			foreach ($args as $key => $val) {
+				if (substr($key, 0, 5) === "aria-") {
+					$output .= ' ' . sanitize_html_class($key) . '="' . esc_attr($val) . '" ';
 				}
 			}
 		}
@@ -173,19 +173,19 @@ 
 	 *
 	 * @return string
 	 */
-	public static function icon($class,$space_after = false, $extra_attributes = array()){
+	public static function icon($class, $space_after = false, $extra_attributes = array()) {
 		$output = '';
 
-		if($class){
+		if ($class) {
 			$classes = self::esc_classes($class);
-			if(!empty($classes)){
-				$output = '<i class="'.$classes.'" ';
+			if (!empty($classes)) {
+				$output = '<i class="' . $classes . '" ';
 				// extra attributes
-				if(!empty($extra_attributes)){
+				if (!empty($extra_attributes)) {
 					$output .= AUI_Component_Helper::extra_attributes($extra_attributes);
 				}
 				$output .= '></i>';
-				if($space_after){
+				if ($space_after) {
 					$output .= " ";
 				}
 			}
@@ -199,17 +199,17 @@ 
 	 *
 	 * @return string
 	 */
-	public static function extra_attributes($args){
+	public static function extra_attributes($args) {
 		$output = '';
 
-		if(!empty($args)){
+		if (!empty($args)) {
 
-			if( is_array($args) ){
-				foreach($args as $key => $val){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+			if (is_array($args)) {
+				foreach ($args as $key => $val) {
+					$output .= ' ' . sanitize_html_class($key) . '="' . esc_attr($val) . '" ';
 				}
-			}else{
-				$output .= ' '.$args.' ';
+			} else {
+				$output .= ' ' . $args . ' ';
 			}
 
 		}
@@ -222,11 +222,11 @@ 
 	 *
 	 * @return string
 	 */
-	public static function help_text($text){
+	public static function help_text($text) {
 		$output = '';
 
-		if($text){
-			$output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>';
+		if ($text) {
+			$output .= '<small class="form-text text-muted">' . wp_kses_post($text) . '</small>';
 		}
 
 
@@ -240,18 +240,18 @@ 
 	 *
 	 * @return string|void
 	 */
-	public static function element_require( $input ) {
+	public static function element_require($input) {
 
-		$input = str_replace( "'", '"', $input );// we only want double quotes
+		$input = str_replace("'", '"', $input); // we only want double quotes
 
-		$output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
+		$output = esc_attr(str_replace(array("[%", "%]", "%:checked]"), array(
 			"jQuery(form).find('[data-argument=\"",
 			"\"]').find('input,select,textarea').val()",
 			"\"]').find('input:checked').val()",
-		), $input ) );
+		), $input));
 
-		if($output){
-			$output = ' data-element-require="'.$output.'" ';
+		if ($output) {
+			$output = ' data-element-require="' . $output . '" ';
 		}
 
 		return $output;

includes/subscription-functions.php

Indentation +146 added lines, -146 removed lines

@@ -17,28 +17,28 @@ 
  */
 function getpaid_get_subscriptions( $args = array(), $return = 'results' ) {
 
-	// Do not retrieve all fields if we just want the count.
-	if ( 'count' == $return ) {
-		$args['fields'] = 'id';
-		$args['number'] = 1;
-	}
+    // Do not retrieve all fields if we just want the count.
+    if ( 'count' == $return ) {
+        $args['fields'] = 'id';
+        $args['number'] = 1;
+    }
 
-	// Do not count all matches if we just want the results.
-	if ( 'results' == $return ) {
-		$args['count_total'] = false;
-	}
+    // Do not count all matches if we just want the results.
+    if ( 'results' == $return ) {
+        $args['count_total'] = false;
+    }
 
-	$query = new GetPaid_Subscriptions_Query( $args );
+    $query = new GetPaid_Subscriptions_Query( $args );
 
-	if ( 'results' == $return ) {
-		return $query->get_results();
-	}
+    if ( 'results' == $return ) {
+        return $query->get_results();
+    }
 
-	if ( 'count' == $return ) {
-		return $query->get_total();
-	}
+    if ( 'count' == $return ) {
+        return $query->get_total();
+    }
 
-	return $query;
+    return $query;
 }
 
 /**
@@ -48,18 +48,18 @@ 
  */
 function getpaid_get_subscription_statuses() {
 
-	return apply_filters(
-		'getpaid_get_subscription_statuses',
-		array(
-			'pending'    => __( 'Pending', 'invoicing' ),
-			'trialling'  => __( 'Trialing', 'invoicing' ),
-			'active'     => __( 'Active', 'invoicing' ),
-			'failing'    => __( 'Failing', 'invoicing' ),
-			'expired'    => __( 'Expired', 'invoicing' ),
-			'completed'  => __( 'Complete', 'invoicing' ),
-			'cancelled'  => __( 'Cancelled', 'invoicing' ),
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_statuses',
+        array(
+            'pending'    => __( 'Pending', 'invoicing' ),
+            'trialling'  => __( 'Trialing', 'invoicing' ),
+            'active'     => __( 'Active', 'invoicing' ),
+            'failing'    => __( 'Failing', 'invoicing' ),
+            'expired'    => __( 'Expired', 'invoicing' ),
+            'completed'  => __( 'Complete', 'invoicing' ),
+            'cancelled'  => __( 'Cancelled', 'invoicing' ),
+        )
+    );
 
 }
 
@@ -69,8 +69,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_status_label( $status ) {
-	$statuses = getpaid_get_subscription_statuses();
-	return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
+    $statuses = getpaid_get_subscription_statuses();
+    return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
 }
 
 /**
@@ -80,18 +80,18 @@ 
  */
 function getpaid_get_subscription_status_classes() {
 
-	return apply_filters(
-		'getpaid_get_subscription_status_classes',
-		array(
-			'pending'    => 'getpaid-item-status-pending',
-			'trialling'  => 'getpaid-item-status-trial',
-			'active'     => 'getpaid-item-status-info',
-			'failing'    => 'getpaid-item-status-failing',
-			'expired'    => 'getpaid-item-status-expired',
-			'completed'  => 'getpaid-item-status-success',
-			'cancelled'  => 'getpaid-item-status-canceled',
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_status_classes',
+        array(
+            'pending'    => 'getpaid-item-status-pending',
+            'trialling'  => 'getpaid-item-status-trial',
+            'active'     => 'getpaid-item-status-info',
+            'failing'    => 'getpaid-item-status-failing',
+            'expired'    => 'getpaid-item-status-expired',
+            'completed'  => 'getpaid-item-status-success',
+            'cancelled'  => 'getpaid-item-status-canceled',
+        )
+    );
 
 }
 
@@ -102,15 +102,15 @@ 
  */
 function getpaid_get_subscription_status_counts( $args = array() ) {
 
-	$statuses = array_keys( getpaid_get_subscription_statuses() );
-	$counts   = array();
+    $statuses = array_keys( getpaid_get_subscription_statuses() );
+    $counts   = array();
 
-	foreach ( $statuses as $status ) {
-		$_args             = wp_parse_args( "status=$status", $args );
-		$counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
-	}
+    foreach ( $statuses as $status ) {
+        $_args             = wp_parse_args( "status=$status", $args );
+        $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
+    }
 
-	return $counts;
+    return $counts;
 
 }
 
@@ -121,32 +121,32 @@ 
  */
 function getpaid_get_subscription_periods() {
 
-	return apply_filters(
-		'getpaid_get_subscription_periods',
-		array(
+    return apply_filters(
+        'getpaid_get_subscription_periods',
+        array(
 
-			'day'   => array(
-				'singular' => __( '%s day', 'invoicing' ),
-				'plural'   => __( '%d days', 'invoicing' ),
-			),
+            'day'   => array(
+                'singular' => __( '%s day', 'invoicing' ),
+                'plural'   => __( '%d days', 'invoicing' ),
+            ),
 
-			'week'   => array(
-				'singular' => __( '%s week', 'invoicing' ),
-				'plural'   => __( '%d weeks', 'invoicing' ),
-			),
+            'week'   => array(
+                'singular' => __( '%s week', 'invoicing' ),
+                'plural'   => __( '%d weeks', 'invoicing' ),
+            ),
 
-			'month'   => array(
-				'singular' => __( '%s month', 'invoicing' ),
-				'plural'   => __( '%d months', 'invoicing' ),
-			),
+            'month'   => array(
+                'singular' => __( '%s month', 'invoicing' ),
+                'plural'   => __( '%d months', 'invoicing' ),
+            ),
 
-			'year'   => array(
-				'singular' => __( '%s year', 'invoicing' ),
-				'plural'   => __( '%d years', 'invoicing' ),
-			),
+            'year'   => array(
+                'singular' => __( '%s year', 'invoicing' ),
+                'plural'   => __( '%d years', 'invoicing' ),
+            ),
 
-		)
-	);
+        )
+    );
 
 }
 
@@ -157,7 +157,7 @@ 
  * @return int
  */
 function getpaid_get_subscription_trial_period_interval( $trial_period ) {
-	return (int) preg_replace( '/[^0-9]/', '', $trial_period );
+    return (int) preg_replace( '/[^0-9]/', '', $trial_period );
 }
 
 /**
@@ -167,7 +167,7 @@ 
  * @return string
  */
 function getpaid_get_subscription_trial_period_period( $trial_period ) {
-	return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
+    return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
 }
 
 /**
@@ -178,8 +178,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) {
-	$label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label(  $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
-	return strtolower( sanitize_text_field( $label ) );
+    $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label(  $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
+    return strtolower( sanitize_text_field( $label ) );
 }
 
 /**
@@ -190,22 +190,22 @@ 
  */
 function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['singular'], $singular_prefix );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['singular'], $singular_prefix );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['singular'], $singular_prefix );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['singular'], $singular_prefix );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -217,22 +217,22 @@ 
  */
 function getpaid_get_plural_subscription_period_label( $period, $interval ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['plural'], $interval );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['plural'], $interval );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['plural'], $interval );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['plural'], $interval );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -243,50 +243,50 @@ 
  */
 function getpaid_get_formatted_subscription_amount( $subscription ) {
 
-	$initial   = wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() );
-	$recurring = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() );
-	$period    = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+    $initial   = wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() );
+    $recurring = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() );
+    $period    = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
 
-	// Trial periods.
-	if ( $subscription->has_trial_period() ) {
+    // Trial periods.
+    if ( $subscription->has_trial_period() ) {
 
-		$trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
-		$trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
-		return sprintf(
+        $trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
+        $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
+        return sprintf(
 
-			// translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
-			_x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
-			$initial,
-			getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
-			$recurring,
-			$period
+            // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
+            _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
+            $initial,
+            getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
+            $recurring,
+            $period
 
-		);
+        );
 
-	}
+    }
 
-	if ( $initial != $recurring ) {
+    if ( $initial != $recurring ) {
 
-		return sprintf(
+        return sprintf(
 
-			// translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
-			_x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
-			$initial,
-			$recurring,
-			$period
+            // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
+            _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
+            $initial,
+            $recurring,
+            $period
 
-		);
+        );
 
-	}
+    }
 
-	return sprintf(
+    return sprintf(
 
-		// translators: $1: is the recurring amount, $2: is the recurring period
-		_x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
-		$initial,
-		$period
+        // translators: $1: is the recurring amount, $2: is the recurring period
+        _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
+        $initial,
+        $period
 
-	);
+    );
 
 }
 
@@ -297,7 +297,7 @@ 
  * @return WPInv_Subscription|bool
  */
 function getpaid_get_invoice_subscription( $invoice ) {
-	return getpaid_subscriptions()->get_invoice_subscription( $invoice );
+    return getpaid_subscriptions()->get_invoice_subscription( $invoice );
 }
 
 /**
@@ -306,10 +306,10 @@ 
  * @param WPInv_Invoice $invoice
  */
 function getpaid_activate_invoice_subscription( $invoice ) {
-	$subscription = getpaid_get_invoice_subscription( $invoice );
-	if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
-		$subscription->activate();
-	}
+    $subscription = getpaid_get_invoice_subscription( $invoice );
+    if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
+        $subscription->activate();
+    }
 }
 
 /**
@@ -318,7 +318,7 @@ 
  * @return WPInv_Subscriptions
  */
 function getpaid_subscriptions() {
-	return getpaid()->get( 'subscriptions' );
+    return getpaid()->get( 'subscriptions' );
 }
 
 /**
@@ -336,14 +336,14 @@ 
         return false;
     }
 
-	// Fetch the invoiec subscription.
-	$subscription = getpaid_get_subscriptions(
-		array(
-			'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
-			'number'     => 1,
-		)
-	);
+    // Fetch the invoiec subscription.
+    $subscription = getpaid_get_subscriptions(
+        array(
+            'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
+            'number'     => 1,
+        )
+    );
 
-	return empty( $subscription ) ? false : $subscription[0];
+    return empty( $subscription ) ? false : $subscription[0];
 
 }

Spacing +71 added lines, -71 removed lines

@@ -15,26 +15,26 @@ 
  *
  * @return int|array|WPInv_Subscription[]|GetPaid_Subscriptions_Query
  */
-function getpaid_get_subscriptions( $args = array(), $return = 'results' ) {
+function getpaid_get_subscriptions($args = array(), $return = 'results') {
 
 	// Do not retrieve all fields if we just want the count.
-	if ( 'count' == $return ) {
+	if ('count' == $return) {
 		$args['fields'] = 'id';
 		$args['number'] = 1;
 	}
 
 	// Do not count all matches if we just want the results.
-	if ( 'results' == $return ) {
+	if ('results' == $return) {
 		$args['count_total'] = false;
 	}
 
-	$query = new GetPaid_Subscriptions_Query( $args );
+	$query = new GetPaid_Subscriptions_Query($args);
 
-	if ( 'results' == $return ) {
+	if ('results' == $return) {
 		return $query->get_results();
 	}
 
-	if ( 'count' == $return ) {
+	if ('count' == $return) {
 		return $query->get_total();
 	}
 
@@ -51,13 +51,13 @@ 
 	return apply_filters(
 		'getpaid_get_subscription_statuses',
 		array(
-			'pending'    => __( 'Pending', 'invoicing' ),
-			'trialling'  => __( 'Trialing', 'invoicing' ),
-			'active'     => __( 'Active', 'invoicing' ),
-			'failing'    => __( 'Failing', 'invoicing' ),
-			'expired'    => __( 'Expired', 'invoicing' ),
-			'completed'  => __( 'Complete', 'invoicing' ),
-			'cancelled'  => __( 'Cancelled', 'invoicing' ),
+			'pending'    => __('Pending', 'invoicing'),
+			'trialling'  => __('Trialing', 'invoicing'),
+			'active'     => __('Active', 'invoicing'),
+			'failing'    => __('Failing', 'invoicing'),
+			'expired'    => __('Expired', 'invoicing'),
+			'completed'  => __('Complete', 'invoicing'),
+			'cancelled'  => __('Cancelled', 'invoicing'),
 		)
 	);
 
@@ -68,9 +68,9 @@ 
  *
  * @return string
  */
-function getpaid_get_subscription_status_label( $status ) {
+function getpaid_get_subscription_status_label($status) {
 	$statuses = getpaid_get_subscription_statuses();
-	return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
+	return isset($statuses[$status]) ? $statuses[$status] : ucfirst(sanitize_text_field($status));
 }
 
 /**
@@ -100,14 +100,14 @@ 
  *
  * @return array
  */
-function getpaid_get_subscription_status_counts( $args = array() ) {
+function getpaid_get_subscription_status_counts($args = array()) {
 
-	$statuses = array_keys( getpaid_get_subscription_statuses() );
+	$statuses = array_keys(getpaid_get_subscription_statuses());
 	$counts   = array();
 
-	foreach ( $statuses as $status ) {
-		$_args             = wp_parse_args( "status=$status", $args );
-		$counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
+	foreach ($statuses as $status) {
+		$_args             = wp_parse_args("status=$status", $args);
+		$counts[$status] = getpaid_get_subscriptions($_args, 'count');
 	}
 
 	return $counts;
@@ -126,23 +126,23 @@ 
 		array(
 
 			'day'   => array(
-				'singular' => __( '%s day', 'invoicing' ),
-				'plural'   => __( '%d days', 'invoicing' ),
+				'singular' => __('%s day', 'invoicing'),
+				'plural'   => __('%d days', 'invoicing'),
 			),
 
 			'week'   => array(
-				'singular' => __( '%s week', 'invoicing' ),
-				'plural'   => __( '%d weeks', 'invoicing' ),
+				'singular' => __('%s week', 'invoicing'),
+				'plural'   => __('%d weeks', 'invoicing'),
 			),
 
 			'month'   => array(
-				'singular' => __( '%s month', 'invoicing' ),
-				'plural'   => __( '%d months', 'invoicing' ),
+				'singular' => __('%s month', 'invoicing'),
+				'plural'   => __('%d months', 'invoicing'),
 			),
 
 			'year'   => array(
-				'singular' => __( '%s year', 'invoicing' ),
-				'plural'   => __( '%d years', 'invoicing' ),
+				'singular' => __('%s year', 'invoicing'),
+				'plural'   => __('%d years', 'invoicing'),
 			),
 
 		)
@@ -156,8 +156,8 @@ 
  * @param string $trial_period
  * @return int
  */
-function getpaid_get_subscription_trial_period_interval( $trial_period ) {
-	return (int) preg_replace( '/[^0-9]/', '', $trial_period );
+function getpaid_get_subscription_trial_period_interval($trial_period) {
+	return (int) preg_replace('/[^0-9]/', '', $trial_period);
 }
 
 /**
@@ -166,8 +166,8 @@ 
  * @param string $trial_period
  * @return string
  */
-function getpaid_get_subscription_trial_period_period( $trial_period ) {
-	return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
+function getpaid_get_subscription_trial_period_period($trial_period) {
+	return preg_replace('/[^a-z]/', '', strtolower($trial_period));
 }
 
 /**
@@ -177,9 +177,9 @@ 
  * @param int $interval
  * @return string
  */
-function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) {
-	$label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label(  $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
-	return strtolower( sanitize_text_field( $label ) );
+function getpaid_get_subscription_period_label($period, $interval = 1, $singular_prefix = '1') {
+	$label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label($period, $interval) : getpaid_get_singular_subscription_period_label($period, $singular_prefix);
+	return strtolower(sanitize_text_field($label));
 }
 
 /**
@@ -188,19 +188,19 @@ 
  * @param string $period
  * @return string
  */
-function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) {
+function getpaid_get_singular_subscription_period_label($period, $singular_prefix = '1') {
 
 	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+	$period  = strtolower($period);
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['singular'], $singular_prefix );
+	if (isset($periods[$period])) {
+		return sprintf($periods[$period]['singular'], $singular_prefix);
 	}
 
 	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['singular'], $singular_prefix );
+	foreach ($periods as $key => $data) {
+		if (strpos($key, $period) === 0) {
+			return sprintf($data['singular'], $singular_prefix);
 		}
 	}
 
@@ -215,19 +215,19 @@ 
  * @param int $interval
  * @return string
  */
-function getpaid_get_plural_subscription_period_label( $period, $interval ) {
+function getpaid_get_plural_subscription_period_label($period, $interval) {
 
 	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+	$period  = strtolower($period);
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['plural'], $interval );
+	if (isset($periods[$period])) {
+		return sprintf($periods[$period]['plural'], $interval);
 	}
 
 	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['plural'], $interval );
+	foreach ($periods as $key => $data) {
+		if (strpos($key, $period) === 0) {
+			return sprintf($data['plural'], $interval);
 		}
 	}
 
@@ -241,23 +241,23 @@ 
  * @param WPInv_Subscription $subscription
  * @return string
  */
-function getpaid_get_formatted_subscription_amount( $subscription ) {
+function getpaid_get_formatted_subscription_amount($subscription) {
 
-	$initial   = wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() );
-	$recurring = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() );
-	$period    = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+	$initial   = wpinv_price(wpinv_format_amount($subscription->get_initial_amount()), $subscription->get_parent_payment()->get_currency());
+	$recurring = wpinv_price(wpinv_format_amount($subscription->get_recurring_amount()), $subscription->get_parent_payment()->get_currency());
+	$period    = getpaid_get_subscription_period_label($subscription->get_period(), $subscription->get_frequency(), '');
 
 	// Trial periods.
-	if ( $subscription->has_trial_period() ) {
+	if ($subscription->has_trial_period()) {
 
-		$trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
-		$trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
+		$trial_period   = getpaid_get_subscription_trial_period_period($subscription->get_trial_period());
+		$trial_interval = getpaid_get_subscription_trial_period_interval($subscription->get_trial_period());
 		return sprintf(
 
 			// translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
-			_x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
+			_x('%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing'),
 			$initial,
-			getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
+			getpaid_get_subscription_period_label($trial_period, $trial_interval),
 			$recurring,
 			$period
 
@@ -265,12 +265,12 @@ 
 
 	}
 
-	if ( $initial != $recurring ) {
+	if ($initial != $recurring) {
 
 		return sprintf(
 
 			// translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
-			_x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
+			_x('Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing'),
 			$initial,
 			$recurring,
 			$period
@@ -282,7 +282,7 @@ 
 	return sprintf(
 
 		// translators: $1: is the recurring amount, $2: is the recurring period
-		_x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
+		_x('%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing'),
 		$initial,
 		$period
 
@@ -296,8 +296,8 @@ 
  * @param WPInv_Invoice $invoice
  * @return WPInv_Subscription|bool
  */
-function getpaid_get_invoice_subscription( $invoice ) {
-	return getpaid_subscriptions()->get_invoice_subscription( $invoice );
+function getpaid_get_invoice_subscription($invoice) {
+	return getpaid_subscriptions()->get_invoice_subscription($invoice);
 }
 
 /**
@@ -305,9 +305,9 @@ 
  *
  * @param WPInv_Invoice $invoice
  */
-function getpaid_activate_invoice_subscription( $invoice ) {
-	$subscription = getpaid_get_invoice_subscription( $invoice );
-	if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
+function getpaid_activate_invoice_subscription($invoice) {
+	$subscription = getpaid_get_invoice_subscription($invoice);
+	if (is_a($subscription, 'WPInv_Subscription')) {
 		$subscription->activate();
 	}
 }
@@ -318,7 +318,7 @@ 
  * @return WPInv_Subscriptions
  */
 function getpaid_subscriptions() {
-	return getpaid()->get( 'subscriptions' );
+	return getpaid()->get('subscriptions');
 }
 
 /**
@@ -326,13 +326,13 @@ 
  *
  * @return WPInv_Subscription|bool
  */
-function wpinv_get_subscription( $invoice ) {
+function wpinv_get_subscription($invoice) {
 
     // Retrieve the invoice.
-    $invoice = new WPInv_Invoice( $invoice );
+    $invoice = new WPInv_Invoice($invoice);
 
     // Ensure it is a recurring invoice.
-    if ( ! $invoice->is_recurring() ) {
+    if (!$invoice->is_recurring()) {
         return false;
     }
 
@@ -344,6 +344,6 @@ 
 		)
 	);
 
-	return empty( $subscription ) ? false : $subscription[0];
+	return empty($subscription) ? false : $subscription[0];
 
 }

includes/gateways/class-getpaid-manual-gateway.php

Indentation +31 added lines, -31 removed lines

@@ -13,30 +13,30 @@ 
 class GetPaid_Manual_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'manual';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 11;
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 11;
     
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
 
         $this->title        = __( 'Manual Payment', 'invoicing' );
@@ -46,15 +46,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Mark it as paid.
         $invoice->mark_paid();
@@ -68,13 +68,13 @@ 
     }
 
     /**
-	 * (Maybe) renews a manual subscription profile.
-	 *
-	 *
-	 * @param bool $should_expire
+     * (Maybe) renews a manual subscription profile.
+     *
+     *
+     * @param bool $should_expire
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $should_expire, $subscription ) {
+     */
+    public function maybe_renew_subscription( $should_expire, $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( 'manual' != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) {

Spacing +11 added lines, -11 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Manual Payment Gateway class.
@@ -24,7 +24,7 @@ 
 	 *
 	 * @var array
 	 */
-    protected $supports = array( 'subscription' );
+    protected $supports = array('subscription');
 
     /**
 	 * Payment method order.
@@ -39,10 +39,10 @@ 
 	public function __construct() {
         parent::__construct();
 
-        $this->title        = __( 'Manual Payment', 'invoicing' );
-        $this->method_title = __( 'Manual Payment', 'invoicing' );
+        $this->title        = __('Manual Payment', 'invoicing');
+        $this->method_title = __('Manual Payment', 'invoicing');
 
-        add_filter( 'getpaid_daily_maintenance_should_expire_subscription', array( $this, 'maybe_renew_subscription' ), 10, 2 );
+        add_filter('getpaid_daily_maintenance_should_expire_subscription', array($this, 'maybe_renew_subscription'), 10, 2);
     }
 
     /**
@@ -54,16 +54,16 @@ 
 	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
 	 * @return array
 	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+	public function process_payment($invoice, $submission_data, $submission) {
 
         // Mark it as paid.
         $invoice->mark_paid();
 
         // (Maybe) activate subscription.
-        getpaid_activate_invoice_subscription( $invoice );
+        getpaid_activate_invoice_subscription($invoice);
 
         // Send to the success page.
-        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        wpinv_send_to_success_page(array('invoice_key' => $invoice->get_key()));
 
     }
 
@@ -74,15 +74,15 @@ 
 	 * @param bool $should_expire
      * @param WPInv_Subscription $subscription
 	 */
-	public function maybe_renew_subscription( $should_expire, $subscription ) {
+	public function maybe_renew_subscription($should_expire, $subscription) {
 
         // Ensure its our subscription && it's active.
-        if ( 'manual' != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) {
+        if ('manual' != $subscription->get_gateway() || !$subscription->has_status('active trialling')) {
             return $should_expire;
         }
 
         // If this is the last renewal, complete the subscription.
-        if ( $subscription->is_last_renewal() ) {
+        if ($subscription->is_last_renewal()) {
             $subscription->complete();
             return false;
         }

includes/class-getpaid-notification-email.php

Indentation +56 added lines, -56 removed lines

@@ -13,36 +13,36 @@ 
 class GetPaid_Notification_Email {
 
     /**
-	 * Contains the type of this notification email.
-	 *
-	 * @var string
-	 */
+     * Contains the type of this notification email.
+     *
+     * @var string
+     */
     public $id;
 
     /**
-	 * Contains any object to use in filters.
-	 *
-	 * @var false|WPInv_Invoice|WPInv_Item|WPInv_Subscription
-	 */
+     * Contains any object to use in filters.
+     *
+     * @var false|WPInv_Invoice|WPInv_Item|WPInv_Subscription
+     */
     public $object;
 
     /**
-	 * Class constructor.
-	 *
+     * Class constructor.
+     *
      * @param string $id Email Type.
      * @param mixed $object Optional. Associated object.
-	 */
-	public function __construct( $id, $object = false ) {
+     */
+    public function __construct( $id, $object = false ) {
         $this->id     = $id;
         $this->object = $object;
     }
 
     /**
-	 * Retrieves an option
-	 *
+     * Retrieves an option
+     *
      * @return mixed
-	 */
-	public function get_option( $key ) {
+     */
+    public function get_option( $key ) {
 
         $key   = "email_{$this->id}_$key";
         $value = wpinv_get_option( $key, null );
@@ -60,80 +60,80 @@ 
     }
 
     /**
-	 * Retrieves the email body.
-	 *
+     * Retrieves the email body.
+     *
      * @return string
-	 */
-	public function get_body() {
+     */
+    public function get_body() {
         $body = $this->get_option( 'body' );
         return apply_filters( 'getpaid_get_email_body', $body, $this->id, $this->object );
     }
 
     /**
-	 * Retrieves the email subject.
-	 *
+     * Retrieves the email subject.
+     *
      * @return string
-	 */
-	public function get_subject() {
+     */
+    public function get_subject() {
         $subject = $this->get_option( 'subject' );
         return apply_filters( 'getpaid_get_email_subject', $subject, $this->id, $this->object );
     }
 
     /**
-	 * Retrieves the email heading.
-	 *
+     * Retrieves the email heading.
+     *
      * @return string
-	 */
-	public function get_heading() {
+     */
+    public function get_heading() {
         $heading = $this->get_option( 'heading' );
         return apply_filters( 'getpaid_get_email_heading', $heading, $this->id, $this->object );
     }
 
     /**
-	 * Checks if an email is active.
-	 *
+     * Checks if an email is active.
+     *
      * @return bool
-	 */
-	public function is_active() {
+     */
+    public function is_active() {
         $is_active = ! empty( $this->get_option( 'active' ) );
         return apply_filters( 'getpaid_email_type_is_active', $is_active, $this->id, $this->object );
     }
 
     /**
-	 * Checks if the site's admin should receive email notifications.
-	 *
+     * Checks if the site's admin should receive email notifications.
+     *
      * @return bool
-	 */
-	public function include_admin_bcc() {
+     */
+    public function include_admin_bcc() {
         $include_admin_bcc = ! empty( $this->get_option( 'admin_bcc' ) );
         return apply_filters( 'getpaid_email_type_include_admin_bcc', $include_admin_bcc, $this->id, $this->object );
     }
 
     /**
-	 * Checks whether this email should be sent to the customer or admin.
-	 *
+     * Checks whether this email should be sent to the customer or admin.
+     *
      * @return bool
-	 */
-	public function is_admin_email() {
+     */
+    public function is_admin_email() {
         $is_admin_email = in_array( $this->id, array( 'new_invoice', 'cancelled_invoice', 'failed_invoice' ) );
         return apply_filters( 'getpaid_email_type_is_admin_email', $is_admin_email, $this->id, $this->object );
     }
 
     /**
-	 * Returns email attachments.
-	 *
+     * Returns email attachments.
+     *
      * @return array
-	 */
-	public function get_attachments() {
+     */
+    public function get_attachments() {
         return apply_filters( 'getpaid_get_email_attachments', array(), $this->id, $this->object );
     }
 
     /**
-	 * Returns an array of merge tags.
-	 *
+     * Returns an array of merge tags.
+     *
      * @return array
-	 */
-	public function get_merge_tags() {
+     */
+    public function get_merge_tags() {
 
         $merge_tags = array(
             '{site_title}' => wpinv_get_blogname(),
@@ -144,13 +144,13 @@ 
     }
 
     /**
-	 * Adds merge tags to a text.
-	 *
+     * Adds merge tags to a text.
+     *
      * @param string string $text
      * @param array $merge_tags
      * @return string
-	 */
-	public function add_merge_tags( $text, $merge_tags = array() ) {
+     */
+    public function add_merge_tags( $text, $merge_tags = array() ) {
 
         foreach ( $merge_tags as $key => $value ) {
             $text = str_replace( $key, $value, $text );
@@ -160,13 +160,13 @@ 
     }
 
     /**
-	 * Returns the email content
-	 *
+     * Returns the email content
+     *
      * @param array $merge_tags
      * @param array $extra_args Extra template args
      * @return string
-	 */
-	public function get_content( $merge_tags = array(), $extra_args = array() ) {
+     */
+    public function get_content( $merge_tags = array(), $extra_args = array() ) {
 
         $content = wpinv_get_template_html(
             "emails/wpinv-email-{$this->id}.php",

Spacing +30 added lines, -30 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Represents a single email type.
@@ -32,7 +32,7 @@ 
      * @param string $id Email Type.
      * @param mixed $object Optional. Associated object.
 	 */
-	public function __construct( $id, $object = false ) {
+	public function __construct($id, $object = false) {
         $this->id     = $id;
         $this->object = $object;
     }
@@ -42,18 +42,18 @@ 
 	 *
      * @return mixed
 	 */
-	public function get_option( $key ) {
+	public function get_option($key) {
 
         $key   = "email_{$this->id}_$key";
-        $value = wpinv_get_option( $key, null );
-        if ( is_null( $value ) ) {
+        $value = wpinv_get_option($key, null);
+        if (is_null($value)) {
             $options = wpinv_get_emails();
 
-            if ( ! isset( $options[ $this->id ] ) || ! isset( $options[ $this->id ][ $key ] ) ) {
+            if (!isset($options[$this->id]) || !isset($options[$this->id][$key])) {
                 return '';
             }
 
-            $value = isset( $options[ $this->id ][ $key ]['std'] ) ? $options[ $this->id ][ $key ]['std'] : '';
+            $value = isset($options[$this->id][$key]['std']) ? $options[$this->id][$key]['std'] : '';
         }
 
         return $value;
@@ -65,8 +65,8 @@ 
      * @return string
 	 */
 	public function get_body() {
-        $body = $this->get_option( 'body' );
-        return apply_filters( 'getpaid_get_email_body', $body, $this->id, $this->object );
+        $body = $this->get_option('body');
+        return apply_filters('getpaid_get_email_body', $body, $this->id, $this->object);
     }
 
     /**
@@ -75,8 +75,8 @@ 
      * @return string
 	 */
 	public function get_subject() {
-        $subject = $this->get_option( 'subject' );
-        return apply_filters( 'getpaid_get_email_subject', $subject, $this->id, $this->object );
+        $subject = $this->get_option('subject');
+        return apply_filters('getpaid_get_email_subject', $subject, $this->id, $this->object);
     }
 
     /**
@@ -85,8 +85,8 @@ 
      * @return string
 	 */
 	public function get_heading() {
-        $heading = $this->get_option( 'heading' );
-        return apply_filters( 'getpaid_get_email_heading', $heading, $this->id, $this->object );
+        $heading = $this->get_option('heading');
+        return apply_filters('getpaid_get_email_heading', $heading, $this->id, $this->object);
     }
 
     /**
@@ -95,8 +95,8 @@ 
      * @return bool
 	 */
 	public function is_active() {
-        $is_active = ! empty( $this->get_option( 'active' ) );
-        return apply_filters( 'getpaid_email_type_is_active', $is_active, $this->id, $this->object );
+        $is_active = !empty($this->get_option('active'));
+        return apply_filters('getpaid_email_type_is_active', $is_active, $this->id, $this->object);
     }
 
     /**
@@ -105,8 +105,8 @@ 
      * @return bool
 	 */
 	public function include_admin_bcc() {
-        $include_admin_bcc = ! empty( $this->get_option( 'admin_bcc' ) );
-        return apply_filters( 'getpaid_email_type_include_admin_bcc', $include_admin_bcc, $this->id, $this->object );
+        $include_admin_bcc = !empty($this->get_option('admin_bcc'));
+        return apply_filters('getpaid_email_type_include_admin_bcc', $include_admin_bcc, $this->id, $this->object);
     }
 
     /**
@@ -115,8 +115,8 @@ 
      * @return bool
 	 */
 	public function is_admin_email() {
-        $is_admin_email = in_array( $this->id, array( 'new_invoice', 'cancelled_invoice', 'failed_invoice' ) );
-        return apply_filters( 'getpaid_email_type_is_admin_email', $is_admin_email, $this->id, $this->object );
+        $is_admin_email = in_array($this->id, array('new_invoice', 'cancelled_invoice', 'failed_invoice'));
+        return apply_filters('getpaid_email_type_is_admin_email', $is_admin_email, $this->id, $this->object);
     }
 
     /**
@@ -125,7 +125,7 @@ 
      * @return array
 	 */
 	public function get_attachments() {
-        return apply_filters( 'getpaid_get_email_attachments', array(), $this->id, $this->object );
+        return apply_filters('getpaid_get_email_attachments', array(), $this->id, $this->object);
     }
 
     /**
@@ -137,10 +137,10 @@ 
 
         $merge_tags = array(
             '{site_title}' => wpinv_get_blogname(),
-            '{date}'       => getpaid_format_date_value( current_time( 'mysql' ) ),
+            '{date}'       => getpaid_format_date_value(current_time('mysql')),
         );
 
-        return apply_filters( 'getpaid_get_email_merge_tags', $merge_tags, $this->object, $this->id );
+        return apply_filters('getpaid_get_email_merge_tags', $merge_tags, $this->object, $this->id);
     }
 
     /**
@@ -150,13 +150,13 @@ 
      * @param array $merge_tags
      * @return string
 	 */
-	public function add_merge_tags( $text, $merge_tags = array() ) {
+	public function add_merge_tags($text, $merge_tags = array()) {
 
-        foreach ( $merge_tags as $key => $value ) {
-            $text = str_replace( $key, $value, $text );
+        foreach ($merge_tags as $key => $value) {
+            $text = str_replace($key, $value, $text);
         }
 
-        return wptexturize( $text );
+        return wptexturize($text);
     }
 
     /**
@@ -166,7 +166,7 @@ 
      * @param array $extra_args Extra template args
      * @return string
 	 */
-	public function get_content( $merge_tags = array(), $extra_args = array() ) {
+	public function get_content($merge_tags = array(), $extra_args = array()) {
 
         $content = wpinv_get_template_html(
             "emails/wpinv-email-{$this->id}.php",
@@ -176,15 +176,15 @@ 
                     'invoice'       => $this->object, // Backwards compat.
                     'object'        => $this->object,
                     'email_type'    => $this->id,
-                    'email_heading' => $this->add_merge_tags( $this->get_heading(), $merge_tags ),
+                    'email_heading' => $this->add_merge_tags($this->get_heading(), $merge_tags),
                     'sent_to_admin' => $this->is_admin_email(),
                     'plain_text'    => false,
-                    'message_body'  => wpautop( $this->add_merge_tags( $this->get_body(), $merge_tags ) ),
+                    'message_body'  => wpautop($this->add_merge_tags($this->get_body(), $merge_tags)),
                 )
             )
         );
 
-        return wpinv_email_style_body( $content );
+        return wpinv_email_style_body($content);
     }
 
 }

includes/data/email-settings.php

Spacing +236 added lines, -236 removed lines

@@ -8,24 +8,24 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Prepare the due date reminder options.
 $overdue_days_options       = array();
-$overdue_days_options['0']  = __( 'On the Due Date', 'invoicing' );
-$overdue_days_options['1']  = __( '1 day after Due Date', 'invoicing' );
+$overdue_days_options['0']  = __('On the Due Date', 'invoicing');
+$overdue_days_options['1']  = __('1 day after Due Date', 'invoicing');
 
-for ( $i = 2; $i <= 10; $i++ ) {
-    $overdue_days_options["$i"] = wp_sprintf( __( '%d days after Due Date', 'invoicing' ), $i );
+for ($i = 2; $i <= 10; $i++) {
+    $overdue_days_options["$i"] = wp_sprintf(__('%d days after Due Date', 'invoicing'), $i);
 }
 
 // Prepare up coming renewal reminder options.
 $renewal_days_options       = array();
-$renewal_days_options['0']  = __( 'On the renewal date', 'invoicing' );
-$renewal_days_options['1']  = __( '1 day before the renewal date', 'invoicing' );
+$renewal_days_options['0']  = __('On the renewal date', 'invoicing');
+$renewal_days_options['1']  = __('1 day before the renewal date', 'invoicing');
 
-for ( $i = 2; $i <= 10; $i++ ) {
-    $renewal_days_options["$i"]   = wp_sprintf( __( '%d days before the renewal date', 'invoicing' ), $i );
+for ($i = 2; $i <= 10; $i++) {
+    $renewal_days_options["$i"] = wp_sprintf(__('%d days before the renewal date', 'invoicing'), $i);
 }
 
 // Default, built-in gateways
@@ -34,45 +34,45 @@ 
 
         'email_new_invoice_header' => array(
             'id'       => 'email_new_invoice_header',
-            'name'     => '<h3>' . __( 'New Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to the site admin whenever there is a new invoice.', 'invoicing' ),
+            'name'     => '<h3>' . __('New Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to the site admin whenever there is a new invoice.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_new_invoice_active' => array(
             'id'       => 'email_new_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_new_invoice_subject' => array(
             'id'       => 'email_new_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] We sent your invoice ({invoice_number}) for {invoice_total} {invoice_currency}', 'invoicing' ),
+            'std'      => __('[{site_title}] We sent your invoice ({invoice_number}) for {invoice_total} {invoice_currency}', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_new_invoice_heading' => array(
             'id'       => 'email_new_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Invoice sent', 'invoicing' ),
+            'std'      => __('Invoice sent', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_new_invoice_body' => array(
             'id'       => 'email_new_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>We sent your invoice <a href="{invoice_link}">({invoice_number})</a> to {name} for {invoice_total} {invoice_currency}.</p>', 'invoicing' ),
+            'std'      => __('<p>We sent your invoice <a href="{invoice_link}">({invoice_number})</a> to {name} for {invoice_total} {invoice_currency}.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -82,45 +82,45 @@ 
 
         'email_cancelled_invoice_header' => array(
             'id'       => 'email_cancelled_invoice_header',
-            'name'     => '<h3>' . __( 'Cancelled Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to the site admin whenever invoices are cancelled.', 'invoicing' ),
+            'name'     => '<h3>' . __('Cancelled Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to the site admin whenever invoices are cancelled.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_cancelled_invoice_active' => array(
             'id'       => 'email_cancelled_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_cancelled_invoice_subject' => array(
             'id'       => 'email_cancelled_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Cancelled invoice ({invoice_number})', 'invoicing' ),
+            'std'      => __('[{site_title}] Cancelled invoice ({invoice_number})', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_cancelled_invoice_heading' => array(
             'id'       => 'email_cancelled_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Cancelled Invoice', 'invoicing' ),
+            'std'      => __('Cancelled Invoice', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_cancelled_invoice_body' => array(
             'id'       => 'email_cancelled_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>The invoice <a href="{invoice_link}">#{invoice_number}</a> created for {name} on {site_title} has been cancelled.</p>', 'invoicing' ),
+            'std'      => __('<p>The invoice <a href="{invoice_link}">#{invoice_number}</a> created for {name} on {site_title} has been cancelled.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -131,45 +131,45 @@ 
 
         'email_failed_invoice_header' => array(
             'id'       => 'email_failed_invoice_header',
-            'name'     => '<h3>' . __( 'Failed Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'Failed invoice emails are sent to the site admin when invoice payments fail.', 'invoicing' ),
+            'name'     => '<h3>' . __('Failed Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('Failed invoice emails are sent to the site admin when invoice payments fail.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_failed_invoice_active' => array(
             'id'       => 'email_failed_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_failed_invoice_subject' => array(
             'id'       => 'email_failed_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Failed invoice ({invoice_number})', 'invoicing' ),
+            'std'      => __('[{site_title}] Failed invoice ({invoice_number})', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_failed_invoice_heading' => array(
             'id'       => 'email_failed_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Failed invoice', 'invoicing' ),
+            'std'      => __('Failed invoice', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_failed_invoice_body' => array(
             'id'       => 'email_failed_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Payment for the invoice <a href="{invoice_link}">#{invoice_number}</a> on {site_title} has failed to go through.</p>', 'invoicing' ),
+            'std'      => __('<p>Payment for the invoice <a href="{invoice_link}">#{invoice_number}</a> on {site_title} has failed to go through.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -179,53 +179,53 @@ 
 
         'email_onhold_invoice_header' => array(
             'id'       => 'email_onhold_invoice_header',
-            'name'     => '<h3>' . __( 'On Hold Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to customers whenever their invoices are held.', 'invoicing' ),
+            'name'     => '<h3>' . __('On Hold Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to customers whenever their invoices are held.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_onhold_invoice_active' => array(
             'id'       => 'email_onhold_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_onhold_invoice_admin_bcc' => array(
             'id'       => 'email_onhold_invoice_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send this notification email to site Admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send this notification email to site Admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_onhold_invoice_subject' => array(
             'id'       => 'email_onhold_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Your invoice receipt from {invoice_date}', 'invoicing' ),
+            'std'      => __('[{site_title}] Your invoice receipt from {invoice_date}', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_onhold_invoice_heading' => array(
             'id'       => 'email_onhold_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Thank you for your invoice', 'invoicing' ),
+            'std'      => __('Thank you for your invoice', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_onhold_invoice_body' => array(
             'id'       => 'email_onhold_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {name},</p><p>Your invoice is on-hold and will be processed when we receive your payment.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {name},</p><p>Your invoice is on-hold and will be processed when we receive your payment.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -236,53 +236,53 @@ 
 
         'email_processing_invoice_header' => array(
             'id'       => 'email_processing_invoice_header',
-            'name'     => '<h3>' . __( 'Processing Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to users whenever payments for their invoices are processing.', 'invoicing' ),
+            'name'     => '<h3>' . __('Processing Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to users whenever payments for their invoices are processing.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_processing_invoice_active' => array(
             'id'       => 'email_processing_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_processing_invoice_admin_bcc' => array(
             'id'       => 'email_processing_invoice_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_processing_invoice_subject' => array(
             'id'       => 'email_processing_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Your invoice receipt from {invoice_date}', 'invoicing' ),
+            'std'      => __('[{site_title}] Your invoice receipt from {invoice_date}', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_processing_invoice_heading' => array(
             'id'       => 'email_processing_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Thank you for your invoice', 'invoicing' ),
+            'std'      => __('Thank you for your invoice', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_processing_invoice_body' => array(
             'id'       => 'email_processing_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {name},</p><p>I would like to let you know that we have received and are currently processing your payment for the invoice <a href="{invoice_link}">#{invoice_number}</a> on {site_title}.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {name},</p><p>I would like to let you know that we have received and are currently processing your payment for the invoice <a href="{invoice_link}">#{invoice_number}</a> on {site_title}.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -293,61 +293,61 @@ 
 
         'email_completed_invoice_header' => array(
             'id'       => 'email_completed_invoice_header',
-            'name'     => '<h3>' . __( 'Paid Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to customers when their invoices are marked as paid.', 'invoicing' ),
+            'name'     => '<h3>' . __('Paid Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to customers when their invoices are marked as paid.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_completed_invoice_active' => array(
             'id'       => 'email_completed_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_completed_invoice_renewal_active' => array(
             'id'       => 'email_completed_invoice_renewal_active',
-            'name'     => __( 'Enable renewal notification', 'invoicing' ),
-            'desc'     => __( 'Should this email be sent for renewals too?', 'invoicing' ),
+            'name'     => __('Enable renewal notification', 'invoicing'),
+            'desc'     => __('Should this email be sent for renewals too?', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_completed_invoice_admin_bcc' => array(
             'id'       => 'email_completed_invoice_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1,
         ),
 
         'email_completed_invoice_subject' => array(
             'id'       => 'email_completed_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Your invoice from {invoice_date} has been paid', 'invoicing' ),
+            'std'      => __('[{site_title}] Your invoice from {invoice_date} has been paid', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_completed_invoice_heading' => array(
             'id'       => 'email_completed_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Your invoice has been paid', 'invoicing' ),
+            'std'      => __('Your invoice has been paid', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_completed_invoice_body' => array(
             'id'       => 'email_completed_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {name},</p><p>Your recent invoice on {site_title} has been paid.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {name},</p><p>Your recent invoice on {site_title} has been paid.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -358,53 +358,53 @@ 
 
         'email_refunded_invoice_header' => array(
             'id'       => 'email_refunded_invoice_header',
-            'name'     => '<h3>' . __( 'Refunded Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to users when their invoices are marked as refunded.', 'invoicing' ),
+            'name'     => '<h3>' . __('Refunded Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to users when their invoices are marked as refunded.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_refunded_invoice_active' => array(
             'id'       => 'email_refunded_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_refunded_invoice_admin_bcc' => array(
             'id'       => 'email_refunded_invoice_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_refunded_invoice_subject' => array(
             'id'       => 'email_refunded_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Your invoice from {invoice_date} has been refunded', 'invoicing' ),
+            'std'      => __('[{site_title}] Your invoice from {invoice_date} has been refunded', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_refunded_invoice_heading' => array(
             'id'       => 'email_refunded_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Your invoice has been refunded', 'invoicing' ),
+            'std'      => __('Your invoice has been refunded', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_refunded_invoice_body' => array(
             'id'       => 'email_refunded_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {name},</p><p>Your invoice on {site_title} has been refunded.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {name},</p><p>Your invoice on {site_title} has been refunded.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -415,53 +415,53 @@ 
 
         'email_user_invoice_header' => array(
             'id'       => 'email_user_invoice_header',
-            'name'     => '<h3>' . __( 'Customer Invoice', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to customers containing their invoice information and payment links.', 'invoicing' ),
+            'name'     => '<h3>' . __('Customer Invoice', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to customers containing their invoice information and payment links.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_user_invoice_active' => array(
             'id'       => 'email_user_invoice_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_user_invoice_admin_bcc' => array(
             'id'       => 'email_user_invoice_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 0
         ),
 
         'email_user_invoice_subject' => array(
             'id'       => 'email_user_invoice_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Your invoice from {invoice_date}', 'invoicing' ),
+            'std'      => __('[{site_title}] Your invoice from {invoice_date}', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_user_invoice_heading' => array(
             'id'       => 'email_user_invoice_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Your invoice {invoice_number} details', 'invoicing' ),
+            'std'      => __('Your invoice {invoice_number} details', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_user_invoice_body' => array(
             'id'       => 'email_user_invoice_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {name},</p><p>An invoice of {invoice_total} has been created for you on {site_title}. You can <a href="{invoice_link}">view</a> or <a href="{invoice_pay_link}">pay</a> the invoice. Please reply to this email if you have any questions about the invoice.', 'invoicing' ),
+            'std'      => __('<p>Hi {name},</p><p>An invoice of {invoice_total} has been created for you on {site_title}. You can <a href="{invoice_link}">view</a> or <a href="{invoice_pay_link}">pay</a> the invoice. Please reply to this email if you have any questions about the invoice.', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -471,53 +471,53 @@ 
 
         'email_user_note_header' => array(
             'id'       => 'email_user_note_header',
-            'name'     => '<h3>' . __( 'Customer Note', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent when you add a customer note to an invoice/quote.', 'invoicing' ),
+            'name'     => '<h3>' . __('Customer Note', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent when you add a customer note to an invoice/quote.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_user_note_active' => array(
             'id'       => 'email_user_note_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_user_note_admin_bcc' => array(
             'id'       => 'email_user_note_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 0
         ),
 
         'email_user_note_subject' => array(
             'id'       => 'email_user_note_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Note added to your {invoice_label} #{invoice_number} from {invoice_date}', 'invoicing' ),
+            'std'      => __('[{site_title}] Note added to your {invoice_label} #{invoice_number} from {invoice_date}', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_user_note_heading' => array(
             'id'       => 'email_user_note_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'A note has been added to your {invoice_label}', 'invoicing' ),
+            'std'      => __('A note has been added to your {invoice_label}', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_user_note_body' => array(
             'id'       => 'email_user_note_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email (wildcards and HTML are allowed).', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email (wildcards and HTML are allowed).', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {name},</p><p>Following note has been added to your {invoice_label}:</p><blockquote class="wpinv-note">{customer_note}</blockquote>', 'invoicing' ),
+            'std'      => __('<p>Hi {name},</p><p>Following note has been added to your {invoice_label}:</p><blockquote class="wpinv-note">{customer_note}</blockquote>', 'invoicing'),
             'class'    => 'large',
             'size'     => '10'
         ),
@@ -528,63 +528,63 @@ 
 
         'email_overdue_header' => array(
             'id'       => 'email_overdue_header',
-            'name'     => '<h3>' . __( 'Payment Reminder', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'Payment reminder emails are sent to customers whenever their invoices are due.', 'invoicing' ),
+            'name'     => '<h3>' . __('Payment Reminder', 'invoicing') . '</h3>',
+            'desc'     => __('Payment reminder emails are sent to customers whenever their invoices are due.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_overdue_active' => array(
             'id'       => 'email_overdue_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_overdue_admin_bcc' => array(
             'id'       => 'email_overdue_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 0
         ),
 
         'email_overdue_days' => array(
             'id'       => 'email_overdue_days',
-            'name'     => __( 'When to Send', 'invoicing' ),
-            'desc'     => __( 'Check when you would like payment reminders sent out.', 'invoicing' ),
+            'name'     => __('When to Send', 'invoicing'),
+            'desc'     => __('Check when you would like payment reminders sent out.', 'invoicing'),
             'help-tip' => true,
-            'std'      => array( '1' ),
+            'std'      => array('1'),
             'type'     => 'multicheck',
             'options'  => $overdue_days_options,
         ),
 
         'email_overdue_subject' => array(
             'id'       => 'email_overdue_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the invoice receipt email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the invoice receipt email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Payment Reminder', 'invoicing' ),
+            'std'      => __('[{site_title}] Payment Reminder', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_overdue_heading' => array(
             'id'       => 'email_overdue_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Payment reminder for your invoice', 'invoicing' ),
+            'std'      => __('Payment reminder for your invoice', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_overdue_body' => array(
             'id'       => 'email_overdue_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email.', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email.', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {full_name},</p><p>This is just a friendly reminder that your invoice <a href="{invoice_link}">#{invoice_number}</a> {is_was} due on {invoice_due_date}.</p><p>The total of this invoice is {invoice_total}</p><p>To view / pay now for this invoice please use the following link: <a class="btn btn-success" href="{invoice_link}">View / Pay</a></p>', 'invoicing' ),
+            'std'      => __('<p>Hi {full_name},</p><p>This is just a friendly reminder that your invoice <a href="{invoice_link}">#{invoice_number}</a> {is_was} due on {invoice_due_date}.</p><p>The total of this invoice is {invoice_total}</p><p>To view / pay now for this invoice please use the following link: <a class="btn btn-success" href="{invoice_link}">View / Pay</a></p>', 'invoicing'),
             'class'    => 'large',
             'size'     => 10,
         ),
@@ -595,63 +595,63 @@ 
 
         'email_renewal_reminder_header' => array(
             'id'       => 'email_renewal_reminder_header',
-            'name'     => '<h3>' . __( 'Renewal Reminder', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent to customers whenever their subscription is about to expire.', 'invoicing' ),
+            'name'     => '<h3>' . __('Renewal Reminder', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent to customers whenever their subscription is about to expire.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_renewal_reminder_active' => array(
             'id'       => 'email_renewal_reminder_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 0
         ),
 
         'email_renewal_reminder_admin_bcc' => array(
             'id'       => 'email_renewal_reminder_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 0
         ),
 
         'email_renewal_reminder_days' => array(
             'id'       => 'email_renewal_reminder_days',
-            'name'     => __( 'When to Send', 'invoicing' ),
-            'desc'     => __( 'Check when you would like renewal reminders sent out.', 'invoicing' ),
+            'name'     => __('When to Send', 'invoicing'),
+            'desc'     => __('Check when you would like renewal reminders sent out.', 'invoicing'),
             'help-tip' => true,
-            'std'      => array( '1', '5', '10' ),
+            'std'      => array('1', '5', '10'),
             'type'     => 'multicheck',
             'options'  => $renewal_days_options,
         ),
 
         'email_renewal_reminder_subject' => array(
             'id'       => 'email_renewal_reminder_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Renewal Reminder', 'invoicing' ),
+            'std'      => __('[{site_title}] Renewal Reminder', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_renewal_reminder_heading' => array(
             'id'       => 'email_renewal_reminder_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading contained within the email notification.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading contained within the email notification.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Upcoming renewal reminder', 'invoicing' ),
+            'std'      => __('Upcoming renewal reminder', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_renewal_reminder_body' => array(
             'id'       => 'email_renewal_reminder_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email.', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email.', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {full_name},</p><p>This is just a friendly reminder that your subscription for invoice <a href="{invoice_link}">#{invoice_number}</a> will renew on {subscription_renewal_date}.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {full_name},</p><p>This is just a friendly reminder that your subscription for invoice <a href="{invoice_link}">#{invoice_number}</a> will renew on {subscription_renewal_date}.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => 10,
         ),
@@ -662,53 +662,53 @@ 
 
         'email_subscription_trial_header' => array(
             'id'       => 'email_subscription_trial_header',
-            'name'     => '<h3>' . __( 'Trial Started', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent when a customer starts a subscription trial.', 'invoicing' ),
+            'name'     => '<h3>' . __('Trial Started', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent when a customer starts a subscription trial.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_subscription_trial_active' => array(
             'id'       => 'email_subscription_trial_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 0
         ),
 
         'email_subscription_trial_bcc' => array(
             'id'       => 'email_subscription_trial_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 0
         ),
 
         'email_subscription_trial_subject' => array(
             'id'       => 'email_subscription_trial_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the subscription trial email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the subscription trial email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Trial Started', 'invoicing' ),
+            'std'      => __('[{site_title}] Trial Started', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_subscription_trial_heading' => array(
             'id'       => 'email_subscription_trial_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading of this email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading of this email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Trial Started', 'invoicing' ),
+            'std'      => __('Trial Started', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_subscription_trial_body' => array(
             'id'       => 'email_trial_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email.', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email.', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {first_name},</p><p>Your trial for {subscription_name} is now active and will renew on {subscription_renewal_date}.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {first_name},</p><p>Your trial for {subscription_name} is now active and will renew on {subscription_renewal_date}.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => 10,
         ),
@@ -718,53 +718,53 @@ 
 
         'email_subscription_cancelled_header' => array(
             'id'       => 'email_subscription_cancelled_header',
-            'name'     => '<h3>' . __( 'Subscription Cancelled', 'invoicing' ) . '</h3>',
-            'desc'     => __( 'These emails are sent when a customer cancels their subscription.', 'invoicing' ),
+            'name'     => '<h3>' . __('Subscription Cancelled', 'invoicing') . '</h3>',
+            'desc'     => __('These emails are sent when a customer cancels their subscription.', 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_subscription_cancelled_active' => array(
             'id'       => 'email_subscription_cancelled_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_subscription_cancelled_bcc' => array(
             'id'       => 'email_subscription_cancelled_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_subscription_cancelled_subject' => array(
             'id'       => 'email_subscription_cancelled_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the subscription cancelled email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the subscription cancelled email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Subscription Cancelled', 'invoicing' ),
+            'std'      => __('[{site_title}] Subscription Cancelled', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_subscription_cancelled_heading' => array(
             'id'       => 'email_subscription_complete_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading of this email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading of this email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Subscription Cancelled', 'invoicing' ),
+            'std'      => __('Subscription Cancelled', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_subscription_cancelled_body' => array(
             'id'       => 'email_cancelled_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email.', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email.', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {first_name},</p><p>Your subscription for {subscription_name} has been cancelled and will no longer renew.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {first_name},</p><p>Your subscription for {subscription_name} has been cancelled and will no longer renew.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => 10,
         ),
@@ -774,53 +774,53 @@ 
 
         'email_subscription_expired_header' => array(
             'id'       => 'email_subscription_expired_header',
-            'name'     => '<h3>' . __( 'Subscription Expired', 'invoicing' ) . '</h3>',
-            'desc'     => __( "These emails are sent when a customer's subscription expires and automatic renewal fails.", 'invoicing' ),
+            'name'     => '<h3>' . __('Subscription Expired', 'invoicing') . '</h3>',
+            'desc'     => __("These emails are sent when a customer's subscription expires and automatic renewal fails.", 'invoicing'),
             'type'     => 'header',
         ),
 
         'email_subscription_expired_active' => array(
             'id'       => 'email_subscription_expired_active',
-            'name'     => __( 'Enable/Disable', 'invoicing' ),
-            'desc'     => __( 'Enable this email notification', 'invoicing' ),
+            'name'     => __('Enable/Disable', 'invoicing'),
+            'desc'     => __('Enable this email notification', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_subscription_expired_bcc' => array(
             'id'       => 'email_subscription_expired_admin_bcc',
-            'name'     => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'     => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'     => __('Enable Admin BCC', 'invoicing'),
+            'desc'     => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'     => 'checkbox',
             'std'      => 1
         ),
 
         'email_subscription_expired_subject' => array(
             'id'       => 'email_subscription_expired_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the subscription expired email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the subscription expired email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Subscription Expired', 'invoicing' ),
+            'std'      => __('[{site_title}] Subscription Expired', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_subscription_expired_heading' => array(
             'id'       => 'email_subscription_expired_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading of this email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading of this email.', 'invoicing'),
             'type'     => 'text',
-            'std'      => __( 'Subscription Expired', 'invoicing' ),
+            'std'      => __('Subscription Expired', 'invoicing'),
             'help-tip' => true,
             'size'     => 'large'
         ),
 
         'email_subscription_expired_body' => array(
             'id'       => 'email_expired_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email.', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email.', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {first_name},</p><p>Your subscription for {subscription_name} has expired.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {first_name},</p><p>Your subscription for {subscription_name} has expired.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => 10,
         ),
@@ -830,53 +830,53 @@ 
 
         'email_subscription_complete_header' => array(
             'id'     => 'email_subscription_complete_header',
-            'name'   => '<h3>' . __( 'Subscription Complete', 'invoicing' ) . '</h3>',
-            'desc'   => __( 'These emails are sent when a customer completes their subscription.', 'invoicing' ),
+            'name'   => '<h3>' . __('Subscription Complete', 'invoicing') . '</h3>',
+            'desc'   => __('These emails are sent when a customer completes their subscription.', 'invoicing'),
             'type'   => 'header',
         ),
 
         'email_subscription_complete_active' => array(
             'id'      => 'email_subscription_complete_active',
-            'name'    => __( 'Enable/Disable', 'invoicing' ),
-            'desc'    => __( 'Enable this email notification', 'invoicing' ),
+            'name'    => __('Enable/Disable', 'invoicing'),
+            'desc'    => __('Enable this email notification', 'invoicing'),
             'type'    => 'checkbox',
             'std'     => 1
         ),
 
         'email_subscription_complete_bcc' => array(
             'id'      => 'email_subscription_complete_admin_bcc',
-            'name'    => __( 'Enable Admin BCC', 'invoicing' ),
-            'desc'    => __( 'Check if you want to send a copy of this notification email to the site admin.', 'invoicing' ),
+            'name'    => __('Enable Admin BCC', 'invoicing'),
+            'desc'    => __('Check if you want to send a copy of this notification email to the site admin.', 'invoicing'),
             'type'    => 'checkbox',
             'std'     => 1
         ),
 
         'email_subscription_complete_subject' => array(
             'id'       => 'email_subscription_complete_subject',
-            'name'     => __( 'Subject', 'invoicing' ),
-            'desc'     => __( 'Enter the subject line for the subscription complete email.', 'invoicing' ),
+            'name'     => __('Subject', 'invoicing'),
+            'desc'     => __('Enter the subject line for the subscription complete email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( '[{site_title}] Subscription Complete', 'invoicing' ),
+            'std'      => __('[{site_title}] Subscription Complete', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_subscription_complete_heading' => array(
             'id'       => 'email_subscription_complete_heading',
-            'name'     => __( 'Email Heading', 'invoicing' ),
-            'desc'     => __( 'Enter the main heading of this email.', 'invoicing' ),
+            'name'     => __('Email Heading', 'invoicing'),
+            'desc'     => __('Enter the main heading of this email.', 'invoicing'),
             'help-tip' => true,
             'type'     => 'text',
-            'std'      => __( 'Subscription Complete', 'invoicing' ),
+            'std'      => __('Subscription Complete', 'invoicing'),
             'size'     => 'large'
         ),
 
         'email_subscription_complete_body' => array(
             'id'       => 'email_complete_body',
-            'name'     => __( 'Email Content', 'invoicing' ),
-            'desc'     => __( 'The content of the email.', 'invoicing' ),
+            'name'     => __('Email Content', 'invoicing'),
+            'desc'     => __('The content of the email.', 'invoicing'),
             'type'     => 'rich_editor',
-            'std'      => __( '<p>Hi {first_name},</p><p>Your subscription for {subscription_name} is now complete.</p>', 'invoicing' ),
+            'std'      => __('<p>Hi {first_name},</p><p>Your subscription for {subscription_name} is now complete.</p>', 'invoicing'),
             'class'    => 'large',
             'size'     => 10,
         ),