AyeCode / invoicing

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

Indentation +619 added lines, -619 removed lines

@@ -18,628 +18,628 @@
 class GetPaid_REST_Posts_Controller extends GetPaid_REST_CRUD_Controller {
 
     /**
-	 * Post type.
-	 *
-	 * @var string
-	 */
-	protected $post_type;
-
-	/**
-	 * Controls visibility on frontend.
-	 *
-	 * @var string
-	 */
-	public $public = false;
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		parent::register_namespace_routes( $namespace );
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base . '/batch',
-			array(
-				array(
-					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'batch_items' ),
-					'permission_callback' => array( $this, 'batch_items_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
-				),
-				'schema' => array( $this, 'get_public_batch_schema' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Check permissions of items on REST API.
-	 *
-	 * @since 1.0.19
-	 * @param string $context   Request context.
-	 * @param int    $object_id Post ID.
-	 * @return bool
-	 */
-	public function check_post_permissions( $context = 'read', $object_id = 0 ) {
-
-		$contexts = array(
-			'read'   => 'read_private_posts',
-			'create' => 'publish_posts',
-			'edit'   => 'edit_post',
-			'delete' => 'delete_post',
-			'batch'  => 'edit_others_posts',
-		);
-
-		$cap              = $contexts[ $context ];
-		$post_type_object = get_post_type_object( $this->post_type );
-		$permission       = current_user_can( $post_type_object->cap->$cap, $object_id );
-
-		return apply_filters( 'getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type );
-	}
-
-	/**
-	 * Check if a given request has access to read items.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_items_permissions_check( $request ) {
-		return $this->check_post_permissions() ? true : new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * Check if a given request has access to create an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function create_item_permissions_check( $request ) {
-		return $this->check_post_permissions( 'create' ) ? true : new WP_Error( 'rest_cannot_create', __( 'Sorry, you are not allowed to create resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * Check if a given request has access to read an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_item_permissions_check( $request ) {
-		$post = get_post( (int) $request['id'] );
-
-		if ( $post && ! $this->check_post_permissions( 'read', $post->ID ) ) {
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a given request has access to update an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function update_item_permissions_check( $request ) {
-		$post = get_post( (int) $request['id'] );
-
-		if ( $post && ! $this->check_post_permissions( 'edit', $post->ID ) ) {
-			return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a given request has access to delete an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return bool|WP_Error
-	 */
-	public function delete_item_permissions_check( $request ) {
-		$post = get_post( (int) $request['id'] );
-
-		if ( $post && ! $this->check_post_permissions( 'delete', $post->ID ) ) {
-			return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a given request has access batch create, update and delete items.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 *
-	 * @return boolean|WP_Error
-	 */
-	public function batch_items_permissions_check( $request ) {
-		return $this->check_post_permissions( 'batch' ) ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * @deprecated
-	 */
-	public function get_post( $object_id ) {
-		return $this->get_object( $object_id );
+     * Post type.
+     *
+     * @var string
+     */
+    protected $post_type;
+
+    /**
+     * Controls visibility on frontend.
+     *
+     * @var string
+     */
+    public $public = false;
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 1.0.19
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        parent::register_namespace_routes( $namespace );
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base . '/batch',
+            array(
+                array(
+                    'methods'             => WP_REST_Server::EDITABLE,
+                    'callback'            => array( $this, 'batch_items' ),
+                    'permission_callback' => array( $this, 'batch_items_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                ),
+                'schema' => array( $this, 'get_public_batch_schema' ),
+            )
+        );
+
+    }
+
+    /**
+     * Check permissions of items on REST API.
+     *
+     * @since 1.0.19
+     * @param string $context   Request context.
+     * @param int    $object_id Post ID.
+     * @return bool
+     */
+    public function check_post_permissions( $context = 'read', $object_id = 0 ) {
+
+        $contexts = array(
+            'read'   => 'read_private_posts',
+            'create' => 'publish_posts',
+            'edit'   => 'edit_post',
+            'delete' => 'delete_post',
+            'batch'  => 'edit_others_posts',
+        );
+
+        $cap              = $contexts[ $context ];
+        $post_type_object = get_post_type_object( $this->post_type );
+        $permission       = current_user_can( $post_type_object->cap->$cap, $object_id );
+
+        return apply_filters( 'getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type );
+    }
+
+    /**
+     * Check if a given request has access to read items.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+        return $this->check_post_permissions() ? true : new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * Check if a given request has access to create an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function create_item_permissions_check( $request ) {
+        return $this->check_post_permissions( 'create' ) ? true : new WP_Error( 'rest_cannot_create', __( 'Sorry, you are not allowed to create resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * Check if a given request has access to read an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_item_permissions_check( $request ) {
+        $post = get_post( (int) $request['id'] );
+
+        if ( $post && ! $this->check_post_permissions( 'read', $post->ID ) ) {
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access to update an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function update_item_permissions_check( $request ) {
+        $post = get_post( (int) $request['id'] );
+
+        if ( $post && ! $this->check_post_permissions( 'edit', $post->ID ) ) {
+            return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access to delete an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return bool|WP_Error
+     */
+    public function delete_item_permissions_check( $request ) {
+        $post = get_post( (int) $request['id'] );
+
+        if ( $post && ! $this->check_post_permissions( 'delete', $post->ID ) ) {
+            return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access batch create, update and delete items.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     *
+     * @return boolean|WP_Error
+     */
+    public function batch_items_permissions_check( $request ) {
+        return $this->check_post_permissions( 'batch' ) ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * @deprecated
+     */
+    public function get_post( $object_id ) {
+        return $this->get_object( $object_id );
+    }
+
+    /**
+     * 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 item.
+        $response = parent::get_item( $request );
+
+        // (Maybe) add a link to the html pagee.
+        if ( $this->public && ! is_wp_error( $response ) ) {
+            $response->link_header( 'alternate', get_permalink( $this->data_object->get_id() ), array( 'type' => 'text/html' ) );
+        }
+
+        return $response;
+    }
+
+    /**
+     * 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 ) {
+
+        // Create item.
+        $response = parent::create_item( $request );
+
+        // Fire a hook after an item is created.
+        if ( ! is_wp_error( $response ) ) {
+
+            /**
+             * Fires after a single item is created or updated via the REST API.
+             *
+             * @param WP_Post         $post      Post object.
+             * @param WP_REST_Request $request   Request object.
+             * @param boolean         $creating  True when creating item, false when updating.
+             */
+            do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true );
+
+        }
+
+        return $response;
+
     }
 
-	/**
-	 * 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 item.
-		$response = parent::get_item( $request );
-
-		// (Maybe) add a link to the html pagee.
-		if ( $this->public && ! is_wp_error( $response ) ) {
-			$response->link_header( 'alternate', get_permalink( $this->data_object->get_id() ), array( 'type' => 'text/html' ) );
-		}
-
-		return $response;
-	}
-
-	/**
-	 * 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 ) {
-
-		// Create item.
-		$response = parent::create_item( $request );
-
-		// Fire a hook after an item is created.
-		if ( ! is_wp_error( $response ) ) {
-
-			/**
-			 * Fires after a single item is created or updated via the REST API.
-			 *
-			 * @param WP_Post         $post      Post object.
-			 * @param WP_REST_Request $request   Request object.
-			 * @param boolean         $creating  True when creating item, false when updating.
-			 */
-			do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true );
-
-		}
-
-		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 ) {
-
-		// Create item.
-		$response = parent::update_item( $request );
-
-		// Fire a hook after an item is created.
-		if ( ! is_wp_error( $response ) ) {
-
-			/**
-			 * Fires after a single item is created or updated via the REST API.
-			 *
-			 * @param WP_Post         $post      Post object.
-			 * @param WP_REST_Request $request   Request object.
-			 * @param boolean         $creating  True when creating item, false when updating.
-			 */
-			do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false );
-
-		}
-
-		return $response;
-
-	}
-
-	/**
-	 * Get a collection of objects.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_items( $request ) {
-
-		$args                         = array();
-		$args['offset']               = $request['offset'];
-		$args['order']                = $request['order'];
-		$args['orderby']              = $request['orderby'];
-		$args['paged']                = $request['page'];
-		$args['post__in']             = $request['include'];
-		$args['post__not_in']         = $request['exclude'];
-		$args['posts_per_page']       = $request['per_page'];
-		$args['name']                 = $request['slug'];
-		$args['post_parent__in']      = $request['parent'];
-		$args['post_parent__not_in']  = $request['parent_exclude'];
-		$args['s']                    = $request['search'];
-		$args['post_status']          = wpinv_parse_list( $request['status'] );
-
-		$args['date_query'] = array();
-
-		// Set before into date query. Date query must be specified as an array of an array.
-		if ( isset( $request['before'] ) ) {
-			$args['date_query'][0]['before'] = $request['before'];
-		}
-
-		// Set after into date query. Date query must be specified as an array of an array.
-		if ( isset( $request['after'] ) ) {
-			$args['date_query'][0]['after'] = $request['after'];
-		}
-
-		// Force the post_type & fields arguments, since they're not a user input variable.
-		$args['post_type'] = $this->post_type;
-		$args['fields']    = 'ids';
-
-		// Filter the query arguments for a request.
-		$args       = apply_filters( "getpaid_rest_{$this->post_type}_query", $args, $request );
-		$query_args = $this->prepare_items_query( $args, $request );
-
-		$posts_query = new WP_Query();
-		$query_result = $posts_query->query( $query_args );
-
-		$posts = array();
-		foreach ( $query_result as $post_id ) {
-			if ( ! $this->check_post_permissions( 'read', $post_id ) ) {
-				continue;
-			}
-
-			$data    = $this->prepare_item_for_response( $this->get_object( $post_id ), $request );
-			$posts[] = $this->prepare_response_for_collection( $data );
-		}
-
-		$page        = (int) $query_args['paged'];
-		$total_posts = $posts_query->found_posts;
-
-		if ( $total_posts < 1 ) {
-			// Out-of-bounds, run the query again without LIMIT for total count.
-			unset( $query_args['paged'] );
-			$count_query = new WP_Query();
-			$count_query->query( $query_args );
-			$total_posts = $count_query->found_posts;
-		}
-
-		$max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] );
-
-		$response = rest_ensure_response( $posts );
-		$response->header( 'X-WP-Total', (int) $total_posts );
-		$response->header( 'X-WP-TotalPages', (int) $max_pages );
-
-		$request_params = $request->get_query_params();
-		$base = add_query_arg( $request_params, rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );
-
-		if ( $page > 1 ) {
-			$prev_page = $page - 1;
-			if ( $prev_page > $max_pages ) {
-				$prev_page = $max_pages;
-			}
-			$prev_link = add_query_arg( 'page', $prev_page, $base );
-			$response->link_header( 'prev', $prev_link );
-		}
-		if ( $max_pages > $page ) {
-			$next_page = $page + 1;
-			$next_link = add_query_arg( 'page', $next_page, $base );
-			$response->link_header( 'next', $next_link );
-		}
-
-		return $response;
-	}
-
-	/**
-	 * Delete a single item.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_REST_Response|WP_Error
-	 */
-	public function delete_item( $request ) {
-
-		// Fetch the item.
-		$item = $this->get_object( $request['id'] );
-		if ( is_wp_error( $item ) ) {
-			return $item;
-		}
-
-		$supports_trash = EMPTY_TRASH_DAYS > 0;
-		$force          = $supports_trash && (bool) $request['force'];
-
-		if ( ! $this->check_post_permissions( 'delete', $item->ID ) ) {
-			return new WP_Error( "cannot_delete", __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $item, $request );
-
-		if ( ! wp_delete_post( $item->ID, $force ) ) {
-			return new WP_Error( 'rest_cannot_delete', sprintf( __( 'The resource cannot be deleted.', 'invoicing' ), $this->post_type ), array( 'status' => 500 ) );
-		}
-
-		return $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 = parent::prepare_links( $object );
-
-		if ( is_callable( array( $object, 'get_user_id' ) ) ) {
-			$links['user'] = array(
-				'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_user_id' )  ) ),
-				'embeddable' => true,
-			);
-		}
-
-		if ( is_callable( array( $object, 'get_owner' ) ) ) {
-			$links['owner']  = array(
-				'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_owner' )  ) ),
-				'embeddable' => true,
-			);
-		}
-
-		if ( is_callable( array( $object, 'get_parent_id' ) ) && call_user_func(  array( $object, 'get_parent_id' )  ) ) {
-			$links['parent']  = array(
-				'href'       => rest_url( "$this->namespace/$this->rest_base/" . call_user_func(  array( $object, 'get_parent_id' )  ) ),
-				'embeddable' => true,
-			);
-		}
-
-		return $links;
-	}
-
-	/**
-	 * Determine the allowed query_vars for a get_items() response and
-	 * prepare for WP_Query.
-	 *
-	 * @param array           $prepared_args Prepared arguments.
-	 * @param WP_REST_Request $request Request object.
-	 * @return array          $query_args
-	 */
-	protected function prepare_items_query( $prepared_args = array(), $request = null ) {
-
-		$valid_vars = array_flip( $this->get_allowed_query_vars() );
-		$query_args = array();
-		foreach ( $valid_vars as $var => $index ) {
-			if ( isset( $prepared_args[ $var ] ) ) {
-				$query_args[ $var ] = apply_filters( "getpaid_rest_query_var-{$var}", $prepared_args[ $var ], $index );
-			}
-		}
-
-		$query_args['ignore_sticky_posts'] = true;
-
-		if ( 'include' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'post__in';
-		} elseif ( 'id' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'ID'; // ID must be capitalized.
-		} elseif ( 'slug' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'name';
-		}
-
-		return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this );
-
-	}
-
-	/**
-	 * Get all the WP Query vars that are allowed for the API request.
-	 *
-	 * @return array
-	 */
-	protected function get_allowed_query_vars() {
-		global $wp;
-
-		/**
-		 * Filter the publicly allowed query vars.
-		 *
-		 * Allows adjusting of the default query vars that are made public.
-		 *
-		 * @param array  Array of allowed WP_Query query vars.
-		 */
-		$valid_vars = apply_filters( 'query_vars', $wp->public_query_vars );
-
-		$post_type_obj = get_post_type_object( $this->post_type );
-		if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
-			$private = apply_filters( 'getpaid_rest_private_query_vars', $wp->private_query_vars );
-			$valid_vars = array_merge( $valid_vars, $private );
-		}
-
-		// Define our own in addition to WP's normal vars.
-		$rest_valid = array(
-			'post_status',
-			'date_query',
-			'ignore_sticky_posts',
-			'offset',
-			'post__in',
-			'post__not_in',
-			'post_parent',
-			'post_parent__in',
-			'post_parent__not_in',
-			'posts_per_page',
-			'meta_query',
-			'tax_query',
-			'meta_key',
-			'meta_value',
-			'meta_compare',
-			'meta_value_num',
-		);
-		$valid_vars = array_merge( $valid_vars, $rest_valid );
-
-		// Filter allowed query vars for the REST API.
-		$valid_vars = apply_filters( 'getpaid_rest_query_vars', $valid_vars, $this );
-
-		return $valid_vars;
-	}
-
-	/**
-	 * Get the query params for collections of attachments.
-	 *
-	 * @return array
-	 */
-	public function get_collection_params() {
-
-		return array_merge(
-
-			parent::get_collection_params(),
-
-			array(
-				'status' => array(
-					'default'           => $this->get_post_statuses(),
-					'description'       => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ),
-					'type'              => array( 'array', 'string' ),
-					'items'             => array(
-						'enum'          => $this->get_post_statuses(),
-						'type'          => 'string',
-					),
-					'validate_callback' => 'rest_validate_request_arg',
-					'sanitize_callback' => array( $this, 'sanitize_post_statuses' ),
-				),
-				'after' => array(
-					'description'        => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ),
-					'type'               => 'string',
-					'format'             => 'string',
-					'validate_callback'  => 'rest_validate_request_arg',
-					'sanitize_callback'  => 'sanitize_text_field',
-				),
-				'before' => array(
-					'description'        => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ),
-					'type'               => 'string',
-					'format'             => 'string',
-					'validate_callback'  => 'rest_validate_request_arg',
-					'sanitize_callback'  => 'sanitize_text_field',
-				),
-				'exclude' => array(
-					'description'       => __( 'Ensure result set excludes specific IDs.', 'invoicing' ),
-					'type'              => 'array',
-					'items'             => array(
-						'type'          => 'integer',
-					),
-					'default'           => array(),
-					'sanitize_callback' => 'wp_parse_id_list',
-					'validate_callback' => 'rest_validate_request_arg',
-				),
-				'include' => array(
-					'description'       => __( 'Limit result set to specific ids.', 'invoicing' ),
-					'type'              => 'array',
-					'items'             => array(
-						'type'          => 'integer',
-					),
-					'default'           => array(),
-					'sanitize_callback' => 'wp_parse_id_list',
-					'validate_callback' => 'rest_validate_request_arg',
-				),
-				'offset' => array(
-					'description'        => __( 'Offset the result set by a specific number of items.', 'invoicing' ),
-					'type'               => 'integer',
-					'sanitize_callback'  => 'absint',
-					'validate_callback'  => 'rest_validate_request_arg',
-				),
-				'order' => array(
-					'description'        => __( 'Order sort attribute ascending or descending.', 'invoicing' ),
-					'type'               => 'string',
-					'default'            => 'desc',
-					'enum'               => array( 'asc', 'desc' ),
-					'validate_callback'  => 'rest_validate_request_arg',
-				),
-				'orderby' => array(
-					'description'        => __( 'Sort collection by object attribute.', 'invoicing' ),
-					'type'               => 'string',
-					'default'            => 'date',
-					'enum'               => array(
-						'date',
-						'id',
-						'include',
-						'title',
-						'slug',
-						'modified',
-					),
-					'validate_callback'  => 'rest_validate_request_arg',
-				),
-			)
-		);
-	}
-
-	/**
-	 * Retrieves the items's schema, conforming to JSON Schema.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return array Item schema data.
-	 */
-	public function get_item_schema() {
-
-		// Maybe retrieve the schema from cache.
-		if ( ! empty( $this->schema ) ) {
-			return $this->add_additional_fields_schema( $this->schema );
-		}
-
-		$type   = str_replace( 'wpi_', '', $this->post_type );
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => $this->post_type,
-			'type'       => 'object',
-			'properties' => wpinv_get_data( "$type-schema" ),
-		);
-
-		// Filters the invoice schema for the REST API.
+    /**
+     * 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 ) {
+
+        // Create item.
+        $response = parent::update_item( $request );
+
+        // Fire a hook after an item is created.
+        if ( ! is_wp_error( $response ) ) {
+
+            /**
+             * Fires after a single item is created or updated via the REST API.
+             *
+             * @param WP_Post         $post      Post object.
+             * @param WP_REST_Request $request   Request object.
+             * @param boolean         $creating  True when creating item, false when updating.
+             */
+            do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false );
+
+        }
+
+        return $response;
+
+    }
+
+    /**
+     * Get a collection of objects.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_items( $request ) {
+
+        $args                         = array();
+        $args['offset']               = $request['offset'];
+        $args['order']                = $request['order'];
+        $args['orderby']              = $request['orderby'];
+        $args['paged']                = $request['page'];
+        $args['post__in']             = $request['include'];
+        $args['post__not_in']         = $request['exclude'];
+        $args['posts_per_page']       = $request['per_page'];
+        $args['name']                 = $request['slug'];
+        $args['post_parent__in']      = $request['parent'];
+        $args['post_parent__not_in']  = $request['parent_exclude'];
+        $args['s']                    = $request['search'];
+        $args['post_status']          = wpinv_parse_list( $request['status'] );
+
+        $args['date_query'] = array();
+
+        // Set before into date query. Date query must be specified as an array of an array.
+        if ( isset( $request['before'] ) ) {
+            $args['date_query'][0]['before'] = $request['before'];
+        }
+
+        // Set after into date query. Date query must be specified as an array of an array.
+        if ( isset( $request['after'] ) ) {
+            $args['date_query'][0]['after'] = $request['after'];
+        }
+
+        // Force the post_type & fields arguments, since they're not a user input variable.
+        $args['post_type'] = $this->post_type;
+        $args['fields']    = 'ids';
+
+        // Filter the query arguments for a request.
+        $args       = apply_filters( "getpaid_rest_{$this->post_type}_query", $args, $request );
+        $query_args = $this->prepare_items_query( $args, $request );
+
+        $posts_query = new WP_Query();
+        $query_result = $posts_query->query( $query_args );
+
+        $posts = array();
+        foreach ( $query_result as $post_id ) {
+            if ( ! $this->check_post_permissions( 'read', $post_id ) ) {
+                continue;
+            }
+
+            $data    = $this->prepare_item_for_response( $this->get_object( $post_id ), $request );
+            $posts[] = $this->prepare_response_for_collection( $data );
+        }
+
+        $page        = (int) $query_args['paged'];
+        $total_posts = $posts_query->found_posts;
+
+        if ( $total_posts < 1 ) {
+            // Out-of-bounds, run the query again without LIMIT for total count.
+            unset( $query_args['paged'] );
+            $count_query = new WP_Query();
+            $count_query->query( $query_args );
+            $total_posts = $count_query->found_posts;
+        }
+
+        $max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] );
+
+        $response = rest_ensure_response( $posts );
+        $response->header( 'X-WP-Total', (int) $total_posts );
+        $response->header( 'X-WP-TotalPages', (int) $max_pages );
+
+        $request_params = $request->get_query_params();
+        $base = add_query_arg( $request_params, rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );
+
+        if ( $page > 1 ) {
+            $prev_page = $page - 1;
+            if ( $prev_page > $max_pages ) {
+                $prev_page = $max_pages;
+            }
+            $prev_link = add_query_arg( 'page', $prev_page, $base );
+            $response->link_header( 'prev', $prev_link );
+        }
+        if ( $max_pages > $page ) {
+            $next_page = $page + 1;
+            $next_link = add_query_arg( 'page', $next_page, $base );
+            $response->link_header( 'next', $next_link );
+        }
+
+        return $response;
+    }
+
+    /**
+     * Delete a single item.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_REST_Response|WP_Error
+     */
+    public function delete_item( $request ) {
+
+        // Fetch the item.
+        $item = $this->get_object( $request['id'] );
+        if ( is_wp_error( $item ) ) {
+            return $item;
+        }
+
+        $supports_trash = EMPTY_TRASH_DAYS > 0;
+        $force          = $supports_trash && (bool) $request['force'];
+
+        if ( ! $this->check_post_permissions( 'delete', $item->ID ) ) {
+            return new WP_Error( "cannot_delete", __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        $request->set_param( 'context', 'edit' );
+        $response = $this->prepare_item_for_response( $item, $request );
+
+        if ( ! wp_delete_post( $item->ID, $force ) ) {
+            return new WP_Error( 'rest_cannot_delete', sprintf( __( 'The resource cannot be deleted.', 'invoicing' ), $this->post_type ), array( 'status' => 500 ) );
+        }
+
+        return $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 = parent::prepare_links( $object );
+
+        if ( is_callable( array( $object, 'get_user_id' ) ) ) {
+            $links['user'] = array(
+                'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_user_id' )  ) ),
+                'embeddable' => true,
+            );
+        }
+
+        if ( is_callable( array( $object, 'get_owner' ) ) ) {
+            $links['owner']  = array(
+                'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_owner' )  ) ),
+                'embeddable' => true,
+            );
+        }
+
+        if ( is_callable( array( $object, 'get_parent_id' ) ) && call_user_func(  array( $object, 'get_parent_id' )  ) ) {
+            $links['parent']  = array(
+                'href'       => rest_url( "$this->namespace/$this->rest_base/" . call_user_func(  array( $object, 'get_parent_id' )  ) ),
+                'embeddable' => true,
+            );
+        }
+
+        return $links;
+    }
+
+    /**
+     * Determine the allowed query_vars for a get_items() response and
+     * prepare for WP_Query.
+     *
+     * @param array           $prepared_args Prepared arguments.
+     * @param WP_REST_Request $request Request object.
+     * @return array          $query_args
+     */
+    protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+
+        $valid_vars = array_flip( $this->get_allowed_query_vars() );
+        $query_args = array();
+        foreach ( $valid_vars as $var => $index ) {
+            if ( isset( $prepared_args[ $var ] ) ) {
+                $query_args[ $var ] = apply_filters( "getpaid_rest_query_var-{$var}", $prepared_args[ $var ], $index );
+            }
+        }
+
+        $query_args['ignore_sticky_posts'] = true;
+
+        if ( 'include' === $query_args['orderby'] ) {
+            $query_args['orderby'] = 'post__in';
+        } elseif ( 'id' === $query_args['orderby'] ) {
+            $query_args['orderby'] = 'ID'; // ID must be capitalized.
+        } elseif ( 'slug' === $query_args['orderby'] ) {
+            $query_args['orderby'] = 'name';
+        }
+
+        return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this );
+
+    }
+
+    /**
+     * Get all the WP Query vars that are allowed for the API request.
+     *
+     * @return array
+     */
+    protected function get_allowed_query_vars() {
+        global $wp;
+
+        /**
+         * Filter the publicly allowed query vars.
+         *
+         * Allows adjusting of the default query vars that are made public.
+         *
+         * @param array  Array of allowed WP_Query query vars.
+         */
+        $valid_vars = apply_filters( 'query_vars', $wp->public_query_vars );
+
+        $post_type_obj = get_post_type_object( $this->post_type );
+        if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
+            $private = apply_filters( 'getpaid_rest_private_query_vars', $wp->private_query_vars );
+            $valid_vars = array_merge( $valid_vars, $private );
+        }
+
+        // Define our own in addition to WP's normal vars.
+        $rest_valid = array(
+            'post_status',
+            'date_query',
+            'ignore_sticky_posts',
+            'offset',
+            'post__in',
+            'post__not_in',
+            'post_parent',
+            'post_parent__in',
+            'post_parent__not_in',
+            'posts_per_page',
+            'meta_query',
+            'tax_query',
+            'meta_key',
+            'meta_value',
+            'meta_compare',
+            'meta_value_num',
+        );
+        $valid_vars = array_merge( $valid_vars, $rest_valid );
+
+        // Filter allowed query vars for the REST API.
+        $valid_vars = apply_filters( 'getpaid_rest_query_vars', $valid_vars, $this );
+
+        return $valid_vars;
+    }
+
+    /**
+     * Get the query params for collections of attachments.
+     *
+     * @return array
+     */
+    public function get_collection_params() {
+
+        return array_merge(
+
+            parent::get_collection_params(),
+
+            array(
+                'status' => array(
+                    'default'           => $this->get_post_statuses(),
+                    'description'       => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ),
+                    'type'              => array( 'array', 'string' ),
+                    'items'             => array(
+                        'enum'          => $this->get_post_statuses(),
+                        'type'          => 'string',
+                    ),
+                    'validate_callback' => 'rest_validate_request_arg',
+                    'sanitize_callback' => array( $this, 'sanitize_post_statuses' ),
+                ),
+                'after' => array(
+                    'description'        => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ),
+                    'type'               => 'string',
+                    'format'             => 'string',
+                    'validate_callback'  => 'rest_validate_request_arg',
+                    'sanitize_callback'  => 'sanitize_text_field',
+                ),
+                'before' => array(
+                    'description'        => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ),
+                    'type'               => 'string',
+                    'format'             => 'string',
+                    'validate_callback'  => 'rest_validate_request_arg',
+                    'sanitize_callback'  => 'sanitize_text_field',
+                ),
+                'exclude' => array(
+                    'description'       => __( 'Ensure result set excludes specific IDs.', 'invoicing' ),
+                    'type'              => 'array',
+                    'items'             => array(
+                        'type'          => 'integer',
+                    ),
+                    'default'           => array(),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                    'validate_callback' => 'rest_validate_request_arg',
+                ),
+                'include' => array(
+                    'description'       => __( 'Limit result set to specific ids.', 'invoicing' ),
+                    'type'              => 'array',
+                    'items'             => array(
+                        'type'          => 'integer',
+                    ),
+                    'default'           => array(),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                    'validate_callback' => 'rest_validate_request_arg',
+                ),
+                'offset' => array(
+                    'description'        => __( 'Offset the result set by a specific number of items.', 'invoicing' ),
+                    'type'               => 'integer',
+                    'sanitize_callback'  => 'absint',
+                    'validate_callback'  => 'rest_validate_request_arg',
+                ),
+                'order' => array(
+                    'description'        => __( 'Order sort attribute ascending or descending.', 'invoicing' ),
+                    'type'               => 'string',
+                    'default'            => 'desc',
+                    'enum'               => array( 'asc', 'desc' ),
+                    'validate_callback'  => 'rest_validate_request_arg',
+                ),
+                'orderby' => array(
+                    'description'        => __( 'Sort collection by object attribute.', 'invoicing' ),
+                    'type'               => 'string',
+                    'default'            => 'date',
+                    'enum'               => array(
+                        'date',
+                        'id',
+                        'include',
+                        'title',
+                        'slug',
+                        'modified',
+                    ),
+                    'validate_callback'  => 'rest_validate_request_arg',
+                ),
+            )
+        );
+    }
+
+    /**
+     * Retrieves the items's schema, conforming to JSON Schema.
+     *
+     * @since 1.0.19
+     *
+     * @return array Item schema data.
+     */
+    public function get_item_schema() {
+
+        // Maybe retrieve the schema from cache.
+        if ( ! empty( $this->schema ) ) {
+            return $this->add_additional_fields_schema( $this->schema );
+        }
+
+        $type   = str_replace( 'wpi_', '', $this->post_type );
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => $this->post_type,
+            'type'       => 'object',
+            'properties' => wpinv_get_data( "$type-schema" ),
+        );
+
+        // Filters the invoice schema for the REST API.
         $schema = apply_filters( "wpinv_rest_{$type}_schema", $schema );
 
-		// Cache the invoice schema.
-		$this->schema = $schema;
-
-		return $this->add_additional_fields_schema( $this->schema );
-	}
-
-	/**
-	 * Sanitizes and validates the list of post statuses.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @param string|array    $statuses  One or more post statuses.
-	 * @param WP_REST_Request $request   Full details about the request.
-	 * @param string          $parameter Additional parameter to pass to validation.
-	 * @return array|WP_Error A list of valid statuses, otherwise WP_Error object.
-	 */
-	public function sanitize_post_statuses( $statuses, $request, $parameter ) {
-		return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() );
-	}
-
-	/**
-	 * Retrieves a valid list of post statuses.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return array A list of registered item statuses.
-	 */
-	public function get_post_statuses() {
-		return get_post_stati();
-	}
-
-	/**
-	 * 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 ) {
-		$supports = parent::object_supports_field( $object, $field_key );
-		return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key );
-	}
+        // Cache the invoice schema.
+        $this->schema = $schema;
+
+        return $this->add_additional_fields_schema( $this->schema );
+    }
+
+    /**
+     * Sanitizes and validates the list of post statuses.
+     *
+     * @since 1.0.13
+     *
+     * @param string|array    $statuses  One or more post statuses.
+     * @param WP_REST_Request $request   Full details about the request.
+     * @param string          $parameter Additional parameter to pass to validation.
+     * @return array|WP_Error A list of valid statuses, otherwise WP_Error object.
+     */
+    public function sanitize_post_statuses( $statuses, $request, $parameter ) {
+        return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() );
+    }
+
+    /**
+     * Retrieves a valid list of post statuses.
+     *
+     * @since 1.0.19
+     *
+     * @return array A list of registered item statuses.
+     */
+    public function get_post_statuses() {
+        return get_post_stati();
+    }
+
+    /**
+     * 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 ) {
+        $supports = parent::object_supports_field( $object, $field_key );
+        return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key );
+    }
 
 }

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

Indentation +181 added lines, -181 removed lines

@@ -11,186 +11,186 @@
  */
 class GetPaid_Data_Store {
 
-	/**
-	 * Contains an instance of the data store class that we are working with.
-	 *
-	 * @var GetPaid_Data_Store
-	 */
-	private $instance = null;
-
-	/**
-	 * Contains an array of default supported data stores.
-	 * Format of object name => class name.
-	 * Example: 'item' => 'GetPaid_Item_Data_Store'
-	 * You can also pass something like item-<type> for item stores and
-	 * that type will be used first when available, if a store is requested like
-	 * this and doesn't exist, then the store would fall back to 'item'.
-	 * Ran through `getpaid_data_stores`.
-	 *
-	 * @var array
-	 */
-	private $stores = array(
-		'item'         => 'GetPaid_Item_Data_Store',
-		'payment_form' => 'GetPaid_Payment_Form_Data_Store',
-		'discount'     => 'GetPaid_Discount_Data_Store',
-		'invoice'      => 'GetPaid_Invoice_Data_Store',
-		'subscription' => 'GetPaid_Subscription_Data_Store',
-	);
-
-	/**
-	 * Contains the name of the current data store's class name.
-	 *
-	 * @var string
-	 */
-	private $current_class_name = '';
-
-	/**
-	 * The object type this store works with.
-	 *
-	 * @var string
-	 */
-	private $object_type = '';
-
-	/**
-	 * Tells GetPaid_Data_Store which object
-	 * store we want to work with.
-	 *
-	 * @param string $object_type Name of object.
-	 */
-	public function __construct( $object_type ) {
-		$this->object_type = $object_type;
-		$this->stores      = apply_filters( 'getpaid_data_stores', $this->stores );
-
-		// If this object type can't be found, check to see if we can load one
-		// level up (so if item-type isn't found, we try item).
-		if ( ! array_key_exists( $object_type, $this->stores ) ) {
-			$pieces      = explode( '-', $object_type );
-			$object_type = $pieces[0];
-		}
-
-		if ( array_key_exists( $object_type, $this->stores ) ) {
-			$store = apply_filters( 'getpaid_' . $object_type . '_data_store', $this->stores[ $object_type ] );
-			if ( is_object( $store ) ) {
-				$this->current_class_name = get_class( $store );
-				$this->instance           = $store;
-			} else {
-				if ( ! class_exists( $store ) ) {
-					throw new Exception( __( 'Data store class does not exist.', 'invoicing' ) );
-				}
-				$this->current_class_name = $store;
-				$this->instance           = new $store();
-			}
-		} else {
-			throw new Exception( __( 'Invalid data store.', 'invoicing' ) );
-		}
-	}
-
-	/**
-	 * Only store the object type to avoid serializing the data store instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'object_type' );
-	}
-
-	/**
-	 * Re-run the constructor with the object type.
-	 *
-	 * @throws Exception When validation fails.
-	 */
-	public function __wakeup() {
-		$this->__construct( $this->object_type );
-	}
-
-	/**
-	 * Loads a data store.
-	 *
-	 * @param string $object_type Name of object.
-	 *
-	 * @since 1.0.19
-	 * @throws Exception When validation fails.
-	 * @return GetPaid_Data_Store
-	 */
-	public static function load( $object_type ) {
-		return new GetPaid_Data_Store( $object_type );
-	}
-
-	/**
-	 * Returns the class name of the current data store.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_current_class_name() {
-		return $this->current_class_name;
-	}
-
-	/**
-	 * Returns the object type of the current data store.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Reads an object from the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function read( &$data ) {
-		$this->instance->read( $data );
-	}
-
-	/**
-	 * Create an object in the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function create( &$data ) {
-		$this->instance->create( $data );
-	}
-
-	/**
-	 * Update an object in the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function update( &$data ) {
-		$this->instance->update( $data );
-	}
-
-	/**
-	 * Delete an object from the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 * @param array   $args Array of args to pass to the delete method.
-	 */
-	public function delete( &$data, $args = array() ) {
-		$this->instance->delete( $data, $args );
-	}
-
-	/**
-	 * Data stores can define additional function. This passes
-	 * through to the instance if that function exists.
-	 *
-	 * @since 1.0.19
-	 * @param string $method     Method.
-	 * @return mixed
-	 */
-	public function __call( $method, $parameters ) {
-		if ( is_callable( array( $this->instance, $method ) ) ) {
-			$object     = array_shift( $parameters );
-			$parameters = array_merge( array( &$object ), $parameters );
-			return call_user_func_array( array( $this->instance, $method ), $parameters );
-		}
-	}
+    /**
+     * Contains an instance of the data store class that we are working with.
+     *
+     * @var GetPaid_Data_Store
+     */
+    private $instance = null;
+
+    /**
+     * Contains an array of default supported data stores.
+     * Format of object name => class name.
+     * Example: 'item' => 'GetPaid_Item_Data_Store'
+     * You can also pass something like item-<type> for item stores and
+     * that type will be used first when available, if a store is requested like
+     * this and doesn't exist, then the store would fall back to 'item'.
+     * Ran through `getpaid_data_stores`.
+     *
+     * @var array
+     */
+    private $stores = array(
+        'item'         => 'GetPaid_Item_Data_Store',
+        'payment_form' => 'GetPaid_Payment_Form_Data_Store',
+        'discount'     => 'GetPaid_Discount_Data_Store',
+        'invoice'      => 'GetPaid_Invoice_Data_Store',
+        'subscription' => 'GetPaid_Subscription_Data_Store',
+    );
+
+    /**
+     * Contains the name of the current data store's class name.
+     *
+     * @var string
+     */
+    private $current_class_name = '';
+
+    /**
+     * The object type this store works with.
+     *
+     * @var string
+     */
+    private $object_type = '';
+
+    /**
+     * Tells GetPaid_Data_Store which object
+     * store we want to work with.
+     *
+     * @param string $object_type Name of object.
+     */
+    public function __construct( $object_type ) {
+        $this->object_type = $object_type;
+        $this->stores      = apply_filters( 'getpaid_data_stores', $this->stores );
+
+        // If this object type can't be found, check to see if we can load one
+        // level up (so if item-type isn't found, we try item).
+        if ( ! array_key_exists( $object_type, $this->stores ) ) {
+            $pieces      = explode( '-', $object_type );
+            $object_type = $pieces[0];
+        }
+
+        if ( array_key_exists( $object_type, $this->stores ) ) {
+            $store = apply_filters( 'getpaid_' . $object_type . '_data_store', $this->stores[ $object_type ] );
+            if ( is_object( $store ) ) {
+                $this->current_class_name = get_class( $store );
+                $this->instance           = $store;
+            } else {
+                if ( ! class_exists( $store ) ) {
+                    throw new Exception( __( 'Data store class does not exist.', 'invoicing' ) );
+                }
+                $this->current_class_name = $store;
+                $this->instance           = new $store();
+            }
+        } else {
+            throw new Exception( __( 'Invalid data store.', 'invoicing' ) );
+        }
+    }
+
+    /**
+     * Only store the object type to avoid serializing the data store instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'object_type' );
+    }
+
+    /**
+     * Re-run the constructor with the object type.
+     *
+     * @throws Exception When validation fails.
+     */
+    public function __wakeup() {
+        $this->__construct( $this->object_type );
+    }
+
+    /**
+     * Loads a data store.
+     *
+     * @param string $object_type Name of object.
+     *
+     * @since 1.0.19
+     * @throws Exception When validation fails.
+     * @return GetPaid_Data_Store
+     */
+    public static function load( $object_type ) {
+        return new GetPaid_Data_Store( $object_type );
+    }
+
+    /**
+     * Returns the class name of the current data store.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_current_class_name() {
+        return $this->current_class_name;
+    }
+
+    /**
+     * Returns the object type of the current data store.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Reads an object from the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function read( &$data ) {
+        $this->instance->read( $data );
+    }
+
+    /**
+     * Create an object in the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function create( &$data ) {
+        $this->instance->create( $data );
+    }
+
+    /**
+     * Update an object in the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function update( &$data ) {
+        $this->instance->update( $data );
+    }
+
+    /**
+     * Delete an object from the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     * @param array   $args Array of args to pass to the delete method.
+     */
+    public function delete( &$data, $args = array() ) {
+        $this->instance->delete( $data, $args );
+    }
+
+    /**
+     * Data stores can define additional function. This passes
+     * through to the instance if that function exists.
+     *
+     * @since 1.0.19
+     * @param string $method     Method.
+     * @return mixed
+     */
+    public function __call( $method, $parameters ) {
+        if ( is_callable( array( $this->instance, $method ) ) ) {
+            $object     = array_shift( $parameters );
+            $parameters = array_merge( array( &$object ), $parameters );
+            return call_user_func_array( array( $this->instance, $method ), $parameters );
+        }
+    }
 
 }

includes/class-wpinv-subscriptions.php

Indentation +4 added lines, -4 removed lines

@@ -12,8 +12,8 @@ 
 class WPInv_Subscriptions {
 
     /**
-	 * Class constructor.
-	 */
+     * Class constructor.
+     */
     public function __construct(){
 
         // Fire gateway specific hooks when a subscription changes.
@@ -33,12 +33,12 @@ 
     }
 
     /**
-	 * Processes subscription status changes.
+     * Processes subscription status changes.
      * 
      * @param WPInv_Subscription $subscription
      * @param string $from
      * @param string $to
-	 */
+     */
     public function process_subscription_status_change( $subscription, $from, $to ) {
 
         $gateway = $subscription->get_gateway();

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

Indentation +209 added lines, -209 removed lines

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

includes/data-stores/class-getpaid-payment-form-data-store.php

Indentation +169 added lines, -169 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,179 +14,179 @@ 
  */
 class GetPaid_Payment_Form_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a form.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'wpinv_form_elements',
-		'wpinv_form_items',
-		'wpinv_form_earned',
-		'wpinv_form_refunded',
-		'wpinv_form_cancelled',
-		'wpinv_form_failed'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'wpinv_form_elements'  => 'elements',
-		'wpinv_form_items'     => 'items',
-		'wpinv_form_earned'    => 'earned',
-		'wpinv_form_refunded'  => 'refunded',
-		'wpinv_form_cancelled' => 'cancelled',
-		'wpinv_form_failed'    => 'failed',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a form.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        'wpinv_form_elements',
+        'wpinv_form_items',
+        'wpinv_form_earned',
+        'wpinv_form_refunded',
+        'wpinv_form_cancelled',
+        'wpinv_form_failed'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        'wpinv_form_elements'  => 'elements',
+        'wpinv_form_items'     => 'items',
+        'wpinv_form_earned'    => 'earned',
+        'wpinv_form_refunded'  => 'refunded',
+        'wpinv_form_cancelled' => 'cancelled',
+        'wpinv_form_failed'    => 'failed',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function create( &$form ) {
-		$form->set_version( WPINV_VERSION );
-		$form->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_payment_form_data',
-				array(
-					'post_date'     => $form->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_payment_form',
-					'post_status'   => $this->get_post_status( $form ),
-					'ping_status'   => 'closed',
-					'post_author'   => $form->get_author( 'edit' ),
-					'post_title'    => $form->get_name( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$form->set_id( $id );
-			$this->update_post_meta( $form );
-			$form->save_meta_data();
-			$form->apply_changes();
-			$this->clear_caches( $form );
-			do_action( 'getpaid_create_payment_form', $form );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$form->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a form from the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 *
-	 */
-	public function read( &$form ) {
-
-		$form->set_defaults();
-		$form_object = get_post( $form->get_id() );
-
-		if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
-			$form->last_error = __( 'Invalid form.', 'invoicing' );
-			$form->set_id( 0 );
-			return false;
-		}
-
-		$form->set_props(
-			array(
-				'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
-				'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
-				'status'        => $form_object->post_status,
-				'name'          => $form_object->post_title,
-				'author'        => $form_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $form, $form_object );
-		$form->read_meta_data();
-		$form->set_object_read( true );
-		do_action( 'getpaid_read_payment_form', $form );
-
-	}
-
-	/**
-	 * Method to update a form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function update( &$form ) {
-		$form->save_meta_data();
-		$form->set_version( WPINV_VERSION );
-
-		if ( null === $form->get_date_created( 'edit' ) ) {
-			$form->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $form->get_id() );
-
-		$changes = $form->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $form->get_date_created( 'edit' ),
-				'post_status'       => $form->get_status( 'edit' ),
-				'post_title'        => $form->get_name( 'edit' ),
-				'post_author'       => $form->get_author( 'edit' ),
-				'post_modified'     => $form->get_date_modified( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
-				clean_post_cache( $form->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
-			}
-			$form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $form );
-		$form->apply_changes();
-		$this->clear_caches( $form );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $form->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_payment_form', $form );
-		} else {
-			do_action( 'getpaid_update_payment_form', $form );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function create( &$form ) {
+        $form->set_version( WPINV_VERSION );
+        $form->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_payment_form_data',
+                array(
+                    'post_date'     => $form->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_payment_form',
+                    'post_status'   => $this->get_post_status( $form ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $form->get_author( 'edit' ),
+                    'post_title'    => $form->get_name( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $form->set_id( $id );
+            $this->update_post_meta( $form );
+            $form->save_meta_data();
+            $form->apply_changes();
+            $this->clear_caches( $form );
+            do_action( 'getpaid_create_payment_form', $form );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $form->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a form from the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     *
+     */
+    public function read( &$form ) {
+
+        $form->set_defaults();
+        $form_object = get_post( $form->get_id() );
+
+        if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
+            $form->last_error = __( 'Invalid form.', 'invoicing' );
+            $form->set_id( 0 );
+            return false;
+        }
+
+        $form->set_props(
+            array(
+                'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
+                'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
+                'status'        => $form_object->post_status,
+                'name'          => $form_object->post_title,
+                'author'        => $form_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $form, $form_object );
+        $form->read_meta_data();
+        $form->set_object_read( true );
+        do_action( 'getpaid_read_payment_form', $form );
+
+    }
+
+    /**
+     * Method to update a form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function update( &$form ) {
+        $form->save_meta_data();
+        $form->set_version( WPINV_VERSION );
+
+        if ( null === $form->get_date_created( 'edit' ) ) {
+            $form->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $form->get_id() );
+
+        $changes = $form->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $form->get_date_created( 'edit' ),
+                'post_status'       => $form->get_status( 'edit' ),
+                'post_title'        => $form->get_name( 'edit' ),
+                'post_author'       => $form->get_author( 'edit' ),
+                'post_modified'     => $form->get_date_modified( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
+                clean_post_cache( $form->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
+            }
+            $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $form );
+        $form->apply_changes();
+        $this->clear_caches( $form );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $form->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_payment_form', $form );
+        } else {
+            do_action( 'getpaid_update_payment_form', $form );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

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

Indentation +186 added lines, -186 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,196 +15,196 @@ 
  */
 class GetPaid_Discount_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpi_discount_code',
-		'_wpi_discount_amount',
-		'_wpi_discount_start',
-		'_wpi_discount_expiration',
-		'_wpi_discount_type',
-		'_wpi_discount_uses',
-		'_wpi_discount_is_single_use',
-		'_wpi_discount_items',
-		'_wpi_discount_excluded_items',
-		'_wpi_discount_max_uses',
-		'_wpi_discount_is_recurring',
-		'_wpi_discount_min_total',
-		'_wpi_discount_max_total',
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpi_discount_code'           => 'code',
-		'_wpi_discount_amount'         => 'amount',
-		'_wpi_discount_start'          => 'start',
-		'_wpi_discount_expiration'     => 'expiration',
-		'_wpi_discount_type'           => 'type',
-		'_wpi_discount_uses'           => 'uses',
-		'_wpi_discount_is_single_use'  => 'is_single_use',
-		'_wpi_discount_items'          => 'items',
-		'_wpi_discount_excluded_items' => 'excluded_items',
-		'_wpi_discount_max_uses'       => 'max_uses',
-		'_wpi_discount_is_recurring'   => 'is_recurring',
-		'_wpi_discount_min_total'      => 'min_total',
-		'_wpi_discount_max_total'      => 'max_total',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpi_discount_code',
+        '_wpi_discount_amount',
+        '_wpi_discount_start',
+        '_wpi_discount_expiration',
+        '_wpi_discount_type',
+        '_wpi_discount_uses',
+        '_wpi_discount_is_single_use',
+        '_wpi_discount_items',
+        '_wpi_discount_excluded_items',
+        '_wpi_discount_max_uses',
+        '_wpi_discount_is_recurring',
+        '_wpi_discount_min_total',
+        '_wpi_discount_max_total',
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpi_discount_code'           => 'code',
+        '_wpi_discount_amount'         => 'amount',
+        '_wpi_discount_start'          => 'start',
+        '_wpi_discount_expiration'     => 'expiration',
+        '_wpi_discount_type'           => 'type',
+        '_wpi_discount_uses'           => 'uses',
+        '_wpi_discount_is_single_use'  => 'is_single_use',
+        '_wpi_discount_items'          => 'items',
+        '_wpi_discount_excluded_items' => 'excluded_items',
+        '_wpi_discount_max_uses'       => 'max_uses',
+        '_wpi_discount_is_recurring'   => 'is_recurring',
+        '_wpi_discount_min_total'      => 'min_total',
+        '_wpi_discount_max_total'      => 'max_total',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function create( &$discount ) {
-		$discount->set_version( WPINV_VERSION );
-		$discount->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_discount_data',
-				array(
-					'post_date'     => $discount->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_discount',
-					'post_status'   => $this->get_post_status( $discount ),
-					'ping_status'   => 'closed',
-					'post_author'   => $discount->get_author( 'edit' ),
-					'post_title'    => $discount->get_name( 'edit' ),
-					'post_excerpt'  => $discount->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$discount->set_id( $id );
-			$this->update_post_meta( $discount );
-			$discount->save_meta_data();
-			$discount->apply_changes();
-			$this->clear_caches( $discount );
-			do_action( 'getpaid_new_discount', $discount );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$discount->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a discount from the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 *
-	 */
-	public function read( &$discount ) {
-
-		$discount->set_defaults();
-		$discount_object = get_post( $discount->get_id() );
-
-		if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
-			$discount->last_error = __( 'Invalid discount.', 'invoicing' );
-			$discount->set_id( 0 );
-			return false;
-		}
-
-		$discount->set_props(
-			array(
-				'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
-				'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
-				'status'        => $discount_object->post_status,
-				'name'          => $discount_object->post_title,
-				'author'        => $discount_object->post_author,
-				'description'   => $discount_object->post_excerpt,
-			)
-		);
-
-		$this->read_object_data( $discount, $discount_object );
-		$discount->read_meta_data();
-		$discount->set_object_read( true );
-		do_action( 'getpaid_read_discount', $discount );
-
-	}
-
-	/**
-	 * Method to update a discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function update( &$discount ) {
-		$discount->save_meta_data();
-		$discount->set_version( WPINV_VERSION );
-
-		if ( null === $discount->get_date_created( 'edit' ) ) {
-			$discount->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $discount->get_id() );
-
-		$changes = $discount->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $discount->get_date_created( 'edit' ),
-				'post_status'       => $discount->get_status( 'edit' ),
-				'post_title'        => $discount->get_name( 'edit' ),
-				'post_author'       => $discount->get_author( 'edit' ),
-				'post_modified'     => $discount->get_date_modified( 'edit' ),
-				'post_excerpt'      => $discount->get_description( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
-				clean_post_cache( $discount->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
-			}
-			$discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $discount );
-		$discount->apply_changes();
-		$this->clear_caches( $discount );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $discount->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_discount', $discount );
-		} else {
-			do_action( 'getpaid_update_discount', $discount );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function create( &$discount ) {
+        $discount->set_version( WPINV_VERSION );
+        $discount->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_discount_data',
+                array(
+                    'post_date'     => $discount->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_discount',
+                    'post_status'   => $this->get_post_status( $discount ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $discount->get_author( 'edit' ),
+                    'post_title'    => $discount->get_name( 'edit' ),
+                    'post_excerpt'  => $discount->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $discount->set_id( $id );
+            $this->update_post_meta( $discount );
+            $discount->save_meta_data();
+            $discount->apply_changes();
+            $this->clear_caches( $discount );
+            do_action( 'getpaid_new_discount', $discount );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $discount->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a discount from the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     *
+     */
+    public function read( &$discount ) {
+
+        $discount->set_defaults();
+        $discount_object = get_post( $discount->get_id() );
+
+        if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
+            $discount->last_error = __( 'Invalid discount.', 'invoicing' );
+            $discount->set_id( 0 );
+            return false;
+        }
+
+        $discount->set_props(
+            array(
+                'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
+                'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
+                'status'        => $discount_object->post_status,
+                'name'          => $discount_object->post_title,
+                'author'        => $discount_object->post_author,
+                'description'   => $discount_object->post_excerpt,
+            )
+        );
+
+        $this->read_object_data( $discount, $discount_object );
+        $discount->read_meta_data();
+        $discount->set_object_read( true );
+        do_action( 'getpaid_read_discount', $discount );
+
+    }
+
+    /**
+     * Method to update a discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function update( &$discount ) {
+        $discount->save_meta_data();
+        $discount->set_version( WPINV_VERSION );
+
+        if ( null === $discount->get_date_created( 'edit' ) ) {
+            $discount->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $discount->get_id() );
+
+        $changes = $discount->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $discount->get_date_created( 'edit' ),
+                'post_status'       => $discount->get_status( 'edit' ),
+                'post_title'        => $discount->get_name( 'edit' ),
+                'post_author'       => $discount->get_author( 'edit' ),
+                'post_modified'     => $discount->get_date_modified( 'edit' ),
+                'post_excerpt'      => $discount->get_description( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
+                clean_post_cache( $discount->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
+            }
+            $discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $discount );
+        $discount->apply_changes();
+        $this->clear_caches( $discount );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $discount->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_discount', $discount );
+        } else {
+            do_action( 'getpaid_update_discount', $discount );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

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

Indentation +338 added lines, -338 removed lines

@@ -14,346 +14,346 @@
  */
 class GetPaid_Data_Store_WP {
 
-	/**
-	 * Meta type. This should match up with
-	 * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
-	 * WP defines 'post', 'user', 'comment', and 'term'.
-	 *
-	 * @var string
-	 */
-	protected $meta_type = 'post';
-
-	/**
-	 * This only needs set if you are using a custom metadata type.
-	 *
-	 * @var string
-	 */
-	protected $object_id_field_for_meta = '';
-
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an object.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $internal_meta_keys = array();
-
-	/**
-	 * Meta data which should exist in the DB, even if empty.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $must_exist_meta_keys = array();
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array();
-
-	/**
-	 * Returns an array of meta for an object.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data $object GetPaid_Data object.
-	 * @return array
-	 */
-	public function read_meta( &$object ) {
-		global $wpdb;
-		$db_info       = $this->get_db_info();
-		$raw_meta_data = $wpdb->get_results(
-			$wpdb->prepare(
-				"SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value
+    /**
+     * Meta type. This should match up with
+     * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
+     * WP defines 'post', 'user', 'comment', and 'term'.
+     *
+     * @var string
+     */
+    protected $meta_type = 'post';
+
+    /**
+     * This only needs set if you are using a custom metadata type.
+     *
+     * @var string
+     */
+    protected $object_id_field_for_meta = '';
+
+    /**
+     * Data stored in meta keys, but not considered "meta" for an object.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $internal_meta_keys = array();
+
+    /**
+     * Meta data which should exist in the DB, even if empty.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $must_exist_meta_keys = array();
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array();
+
+    /**
+     * Returns an array of meta for an object.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data $object GetPaid_Data object.
+     * @return array
+     */
+    public function read_meta( &$object ) {
+        global $wpdb;
+        $db_info       = $this->get_db_info();
+        $raw_meta_data = $wpdb->get_results(
+            $wpdb->prepare(
+                "SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value
 				FROM {$db_info['table']}
 				WHERE {$db_info['object_id_field']} = %d
 				ORDER BY {$db_info['meta_id_field']}",
-				$object->get_id()
-			)
-		);
-
-		$this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
-		$meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
-		return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
-	}
-
-	/**
-	 * Deletes meta based on meta ID.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing at least ->id).
-	 */
-	public function delete_meta( &$object, $meta ) {
-		delete_metadata_by_mid( $this->meta_type, $meta->id );
-	}
-
-	/**
-	 * Add new piece of meta.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing ->key and ->value).
-	 * @return int meta ID
-	 */
-	public function add_meta( &$object, $meta ) {
-		return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
-	}
-
-	/**
-	 * Update meta.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing ->id, ->key and ->value).
-	 */
-	public function update_meta( &$object, $meta ) {
-		update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
-	}
-
-	/**
-	 * Table structure is slightly different between meta types, this function will return what we need to know.
-	 *
-	 * @since  1.0.19
-	 * @return array Array elements: table, object_id_field, meta_id_field
-	 */
-	protected function get_db_info() {
-		global $wpdb;
-
-		$meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well.
-		$table         = $wpdb->prefix;
-
-		// If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
-		if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
-			$table .= 'getpaid_';
-		}
-
-		$table          .= $this->meta_type . 'meta';
-		$object_id_field = $this->meta_type . '_id';
-
-		// Figure out our field names.
-		if ( 'user' === $this->meta_type ) {
-			$meta_id_field = 'umeta_id';
-			$table         = $wpdb->usermeta;
-		}
-
-		if ( ! empty( $this->object_id_field_for_meta ) ) {
-			$object_id_field = $this->object_id_field_for_meta;
-		}
-
-		return array(
-			'table'           => $table,
-			'object_id_field' => $object_id_field,
-			'meta_id_field'   => $meta_id_field,
-		);
-	}
-
-	/**
-	 * Internal meta keys we don't want exposed as part of meta_data. This is in
-	 * addition to all data props with _ prefix.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $key Prefix to be added to meta keys.
-	 * @return string
-	 */
-	protected function prefix_key( $key ) {
-		return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
-	}
-
-	/**
-	 * Callback to remove unwanted meta data.
-	 *
-	 * @param object $meta Meta object to check if it should be excluded or not.
-	 * @return bool
-	 */
-	protected function exclude_internal_meta_keys( $meta ) {
-		return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
-	}
-
-	/**
-	 * Gets a list of props and meta keys that need updated based on change state
-	 * or if they are present in the database or not.
-	 *
-	 * @param  GetPaid_Data $object         The GetPaid_Data object.
-	 * @param  array   $meta_key_to_props   A mapping of meta keys => prop names.
-	 * @param  string  $meta_type           The internal WP meta type (post, user, etc).
-	 * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
-	 */
-	protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
-		$props_to_update = array();
-		$changed_props   = $object->get_changes();
-
-		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $meta_key_to_props as $meta_key => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
-				$props_to_update[ $meta_key ] = $prop;
-			}
-		}
-
-		return $props_to_update;
-	}
-
-	/**
-	 * Read object data.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @param WP_Post   $post_object Post object.
-	 * @since 1.0.19
-	 */
-	protected function read_object_data( &$object, $post_object ) {
-		$id    = $object->get_id();
-		$props = array();
-
-		foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
-			$props[ $prop ] = get_post_meta( $id, $meta_key, true );
-		}
-
-		// Set object properties.
-		$object->set_props( $props );
-
-		// Gets extra data associated with the object if needed.
-		foreach ( $object->get_extra_data_keys() as $key ) {
-			$function = 'set_' . $key;
-			if ( is_callable( array( $object, $function ) ) ) {
-				$object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
-			}
-		}
-	}
-
-	/**
-	 * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$object ) {
-
-		$updated_props   = array();
-		$props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
-		$object_type     = $object->get_object_type();
-
-		foreach ( $props_to_update as $meta_key => $prop ) {
-			$value = $object->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-
-			$updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
-
-			if ( $updated ) {
-				$updated_props[] = $prop;
-			}
-		}
-
-		do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
-	}
-
-	/**
-	 * Update meta data in, or delete it from, the database.
-	 *
-	 * Avoids storing meta when it's either an empty string or empty array or null.
-	 * Other empty values such as numeric 0 should still be stored.
-	 * Data-stores can force meta to exist using `must_exist_meta_keys`.
-	 *
-	 * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
-	 *
-	 * @param GetPaid_Data $object The GetPaid_Data object.
-	 * @param string  $meta_key Meta key to update.
-	 * @param mixed   $meta_value Value to save.
-	 *
-	 * @since 1.0.19 Added to prevent empty meta being stored unless required.
-	 *
-	 * @return bool True if updated/deleted.
-	 */
-	protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
-		if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
-			$updated = delete_post_meta( $object->get_id(), $meta_key );
-		} else {
-			$updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
-		}
-
-		return (bool) $updated;
-	}
-
-	/**
-	 * Return list of internal meta keys.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_internal_meta_keys() {
-		return $this->internal_meta_keys;
-	}
-
-	/**
-	 * Clear any caches.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @since 1.0.19
-	 */
-	protected function clear_caches( &$object ) {
-		clean_post_cache( $object->get_id() );
-	}
-
-	/**
-	 * Method to delete a data object from the database.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @param array    $args Array of args to pass to the delete method.
-	 *
-	 * @return void
-	 */
-	public function delete( &$object, $args = array() ) {
-		$id          = $object->get_id();
-		$object_type = $object->get_object_type();
-
-		if ( 'invoice' == $object_type ) {
-			$object_type = $object->get_type();
-		}
-
-		$args        = wp_parse_args(
-			$args,
-			array(
-				'force_delete' => false,
-			)
-		);
-
-		if ( ! $id ) {
-			return;
-		}
-
-		if ( $args['force_delete'] ) {
-			do_action( "getpaid_delete_$object_type", $object );
-			wp_delete_post( $id, true );
-			$object->set_id( 0 );
-		} else {
-			do_action( "getpaid_trash_$object_type", $object );
-			wp_trash_post( $id );
-			$object->set_status( 'trash' );
-		}
-	}
-
-	/**
-	 * Get the status to save to the post object.
-	 *
-	 *
-	 * @since 1.0.19
-	 * @param  GetPaid_Data $object GetPaid_Data object.
-	 * @return string
-	 */
-	protected function get_post_status( $object ) {
-		$object_status = $object->get_status( 'edit' );
-		$object_type   = $object->get_object_type();
-
-		if ( ! $object_status ) {
-			$object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
-		}
-
-		return $object_status;
-	}
+                $object->get_id()
+            )
+        );
+
+        $this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
+        $meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
+        return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
+    }
+
+    /**
+     * Deletes meta based on meta ID.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing at least ->id).
+     */
+    public function delete_meta( &$object, $meta ) {
+        delete_metadata_by_mid( $this->meta_type, $meta->id );
+    }
+
+    /**
+     * Add new piece of meta.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing ->key and ->value).
+     * @return int meta ID
+     */
+    public function add_meta( &$object, $meta ) {
+        return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
+    }
+
+    /**
+     * Update meta.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing ->id, ->key and ->value).
+     */
+    public function update_meta( &$object, $meta ) {
+        update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
+    }
+
+    /**
+     * Table structure is slightly different between meta types, this function will return what we need to know.
+     *
+     * @since  1.0.19
+     * @return array Array elements: table, object_id_field, meta_id_field
+     */
+    protected function get_db_info() {
+        global $wpdb;
+
+        $meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well.
+        $table         = $wpdb->prefix;
+
+        // If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
+        if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
+            $table .= 'getpaid_';
+        }
+
+        $table          .= $this->meta_type . 'meta';
+        $object_id_field = $this->meta_type . '_id';
+
+        // Figure out our field names.
+        if ( 'user' === $this->meta_type ) {
+            $meta_id_field = 'umeta_id';
+            $table         = $wpdb->usermeta;
+        }
+
+        if ( ! empty( $this->object_id_field_for_meta ) ) {
+            $object_id_field = $this->object_id_field_for_meta;
+        }
+
+        return array(
+            'table'           => $table,
+            'object_id_field' => $object_id_field,
+            'meta_id_field'   => $meta_id_field,
+        );
+    }
+
+    /**
+     * Internal meta keys we don't want exposed as part of meta_data. This is in
+     * addition to all data props with _ prefix.
+     *
+     * @since 1.0.19
+     *
+     * @param string $key Prefix to be added to meta keys.
+     * @return string
+     */
+    protected function prefix_key( $key ) {
+        return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
+    }
+
+    /**
+     * Callback to remove unwanted meta data.
+     *
+     * @param object $meta Meta object to check if it should be excluded or not.
+     * @return bool
+     */
+    protected function exclude_internal_meta_keys( $meta ) {
+        return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
+    }
+
+    /**
+     * Gets a list of props and meta keys that need updated based on change state
+     * or if they are present in the database or not.
+     *
+     * @param  GetPaid_Data $object         The GetPaid_Data object.
+     * @param  array   $meta_key_to_props   A mapping of meta keys => prop names.
+     * @param  string  $meta_type           The internal WP meta type (post, user, etc).
+     * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
+     */
+    protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
+        $props_to_update = array();
+        $changed_props   = $object->get_changes();
+
+        // Props should be updated if they are a part of the $changed array or don't exist yet.
+        foreach ( $meta_key_to_props as $meta_key => $prop ) {
+            if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
+                $props_to_update[ $meta_key ] = $prop;
+            }
+        }
+
+        return $props_to_update;
+    }
+
+    /**
+     * Read object data.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @param WP_Post   $post_object Post object.
+     * @since 1.0.19
+     */
+    protected function read_object_data( &$object, $post_object ) {
+        $id    = $object->get_id();
+        $props = array();
+
+        foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
+            $props[ $prop ] = get_post_meta( $id, $meta_key, true );
+        }
+
+        // Set object properties.
+        $object->set_props( $props );
+
+        // Gets extra data associated with the object if needed.
+        foreach ( $object->get_extra_data_keys() as $key ) {
+            $function = 'set_' . $key;
+            if ( is_callable( array( $object, $function ) ) ) {
+                $object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
+            }
+        }
+    }
+
+    /**
+     * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$object ) {
+
+        $updated_props   = array();
+        $props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
+        $object_type     = $object->get_object_type();
+
+        foreach ( $props_to_update as $meta_key => $prop ) {
+            $value = $object->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+            $updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
+
+            if ( $updated ) {
+                $updated_props[] = $prop;
+            }
+        }
+
+        do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
+    }
+
+    /**
+     * Update meta data in, or delete it from, the database.
+     *
+     * Avoids storing meta when it's either an empty string or empty array or null.
+     * Other empty values such as numeric 0 should still be stored.
+     * Data-stores can force meta to exist using `must_exist_meta_keys`.
+     *
+     * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+     *
+     * @param GetPaid_Data $object The GetPaid_Data object.
+     * @param string  $meta_key Meta key to update.
+     * @param mixed   $meta_value Value to save.
+     *
+     * @since 1.0.19 Added to prevent empty meta being stored unless required.
+     *
+     * @return bool True if updated/deleted.
+     */
+    protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
+        if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+            $updated = delete_post_meta( $object->get_id(), $meta_key );
+        } else {
+            $updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
+        }
+
+        return (bool) $updated;
+    }
+
+    /**
+     * Return list of internal meta keys.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_internal_meta_keys() {
+        return $this->internal_meta_keys;
+    }
+
+    /**
+     * Clear any caches.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @since 1.0.19
+     */
+    protected function clear_caches( &$object ) {
+        clean_post_cache( $object->get_id() );
+    }
+
+    /**
+     * Method to delete a data object from the database.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @param array    $args Array of args to pass to the delete method.
+     *
+     * @return void
+     */
+    public function delete( &$object, $args = array() ) {
+        $id          = $object->get_id();
+        $object_type = $object->get_object_type();
+
+        if ( 'invoice' == $object_type ) {
+            $object_type = $object->get_type();
+        }
+
+        $args        = wp_parse_args(
+            $args,
+            array(
+                'force_delete' => false,
+            )
+        );
+
+        if ( ! $id ) {
+            return;
+        }
+
+        if ( $args['force_delete'] ) {
+            do_action( "getpaid_delete_$object_type", $object );
+            wp_delete_post( $id, true );
+            $object->set_id( 0 );
+        } else {
+            do_action( "getpaid_trash_$object_type", $object );
+            wp_trash_post( $id );
+            $object->set_status( 'trash' );
+        }
+    }
+
+    /**
+     * Get the status to save to the post object.
+     *
+     *
+     * @since 1.0.19
+     * @param  GetPaid_Data $object GetPaid_Data object.
+     * @return string
+     */
+    protected function get_post_status( $object ) {
+        $object_status = $object->get_status( 'edit' );
+        $object_type   = $object->get_object_type();
+
+        if ( ! $object_status ) {
+            $object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
+        }
+
+        return $object_status;
+    }
 
 }

includes/class-wpinv-notes.php

Indentation +114 added lines, -114 removed lines

@@ -12,119 +12,119 @@
  */
 class WPInv_Notes {
 
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-
-		// Filter inovice notes.
-		add_action( 'pre_get_comments', array( $this, 'set_invoice_note_type' ), 11, 1 );
-		add_action( 'comment_feed_where', array( $this, 'wpinv_comment_feed_where' ), 10, 1 );
-
-		// Fires after notes are loaded.
-		do_action( 'wpinv_notes_init', $this );
-	}
-
-	/**
-	 * Filters invoice notes query to only include our notes.
-	 *
-	 * @param WP_Comment_Query $query
-	 */
-	public function set_invoice_note_type( $query ) {
-		$post_id = ! empty( $query->query_vars['post_ID'] ) ? $query->query_vars['post_ID'] : $query->query_vars['post_id'];
-
-		if ( $post_id && getpaid_is_invoice_post_type( get_post_type( $post_id ) ) ) {
-			$query->query_vars['type'] = 'wpinv_note';
-		} else {
-
-			if ( empty( $query->query_vars['type__not_in'] ) ) {
-				$query->query_vars['type__not_in'] = array();
-			}
-
-			$query->query_vars['type__not_in'] = wpinv_parse_list( $query->query_vars['type__not_in'] );
-			$query->query_vars['type__not_in'] = array_merge( array( 'wpinv_note' ), $query->query_vars['type__not_in'] );
-		}
-
-		return $query;
-	}
-
-	/**
-	 * Exclude notes from the comments feed.
-	 */
-	function wpinv_comment_feed_where( $where ){
-		return $where . ( $where ? ' AND ' : '' ) . " comment_type != 'wpinv_note' ";
-	}
-
-	/**
-	 * Returns an array of invoice notes.
-	 *
-	 * @param int $invoice_id The invoice ID whose notes to retrieve.
-	 * @param string $type Optional. Pass in customer to only return customer notes.
-	 * @return WP_Comment[]
-	 */
-	public function get_invoice_notes( $invoice_id = 0, $type = 'all' ) {
-
-		// Default comment args.
-		$args = array(
-			'post_id'   => $invoice_id,
-			'orderby'   => 'comment_ID',
-			'order'     => 'ASC',
-		);
-
-		// Maybe only show customer comments.
-		if ( $type == 'customer' ) {
-			$args['meta_key']   = '_wpi_customer_note';
-			$args['meta_value'] = 1;
-		}
-
-		$args = apply_filters( 'wpinv_invoice_notes_args', $args, $this, $invoice_id, $type );
-
-		return get_comments( $args );
-	}
-
-	/**
-	 * Saves an invoice comment.
-	 * 
-	 * @param WPInv_Invoice $invoice The invoice to add the comment to.
-	 * @param string $note The note content.
-	 * @param string $note_author The name of the author of the note.
-	 * @param bool $for_customer Whether or not this comment is meant to be sent to the customer.
-	 * @return int|false The new note's ID on success, false on failure.
-	 */
-	function add_invoice_note( $invoice, $note, $note_author, $author_email, $for_customer = false ){
-
-		do_action( 'wpinv_pre_insert_invoice_note', $invoice->get_id(), $note, $for_customer );
-
-		/**
-		 * Insert the comment.
-		 */
-		$note_id = wp_insert_comment(
-			wp_filter_comment(
-				array(
-					'comment_post_ID'      => $invoice->get_id(),
-					'comment_content'      => $note,
-					'comment_agent'        => 'Invoicing',
-					'user_id'              => get_current_user_id(),
-					'comment_author'       => $note_author,
-					'comment_author_IP'    => wpinv_get_ip(),
-					'comment_author_email' => $author_email,
-					'comment_author_url'   => $invoice->get_view_url(),
-					'comment_type'         => 'wpinv_note',
-				)
-			)
-		);
-
-		do_action( 'wpinv_insert_payment_note', $note_id, $invoice->get_id(), $note, $for_customer );
-
-		// Are we notifying the customer?
-		if ( empty( $note_id ) || empty( $for_customer ) ) {
-			return $note_id;
-		}
-
-		add_comment_meta( $note_id, '_wpi_customer_note', 1 );
-		do_action( 'wpinv_new_customer_note', array( 'invoice_id' => $invoice->get_id(), 'user_note' => $note ) );
-		do_action( 'getpaid_new_customer_note', $invoice, $note );
-		return $note_id;
-	}
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+
+        // Filter inovice notes.
+        add_action( 'pre_get_comments', array( $this, 'set_invoice_note_type' ), 11, 1 );
+        add_action( 'comment_feed_where', array( $this, 'wpinv_comment_feed_where' ), 10, 1 );
+
+        // Fires after notes are loaded.
+        do_action( 'wpinv_notes_init', $this );
+    }
+
+    /**
+     * Filters invoice notes query to only include our notes.
+     *
+     * @param WP_Comment_Query $query
+     */
+    public function set_invoice_note_type( $query ) {
+        $post_id = ! empty( $query->query_vars['post_ID'] ) ? $query->query_vars['post_ID'] : $query->query_vars['post_id'];
+
+        if ( $post_id && getpaid_is_invoice_post_type( get_post_type( $post_id ) ) ) {
+            $query->query_vars['type'] = 'wpinv_note';
+        } else {
+
+            if ( empty( $query->query_vars['type__not_in'] ) ) {
+                $query->query_vars['type__not_in'] = array();
+            }
+
+            $query->query_vars['type__not_in'] = wpinv_parse_list( $query->query_vars['type__not_in'] );
+            $query->query_vars['type__not_in'] = array_merge( array( 'wpinv_note' ), $query->query_vars['type__not_in'] );
+        }
+
+        return $query;
+    }
+
+    /**
+     * Exclude notes from the comments feed.
+     */
+    function wpinv_comment_feed_where( $where ){
+        return $where . ( $where ? ' AND ' : '' ) . " comment_type != 'wpinv_note' ";
+    }
+
+    /**
+     * Returns an array of invoice notes.
+     *
+     * @param int $invoice_id The invoice ID whose notes to retrieve.
+     * @param string $type Optional. Pass in customer to only return customer notes.
+     * @return WP_Comment[]
+     */
+    public function get_invoice_notes( $invoice_id = 0, $type = 'all' ) {
+
+        // Default comment args.
+        $args = array(
+            'post_id'   => $invoice_id,
+            'orderby'   => 'comment_ID',
+            'order'     => 'ASC',
+        );
+
+        // Maybe only show customer comments.
+        if ( $type == 'customer' ) {
+            $args['meta_key']   = '_wpi_customer_note';
+            $args['meta_value'] = 1;
+        }
+
+        $args = apply_filters( 'wpinv_invoice_notes_args', $args, $this, $invoice_id, $type );
+
+        return get_comments( $args );
+    }
+
+    /**
+     * Saves an invoice comment.
+     * 
+     * @param WPInv_Invoice $invoice The invoice to add the comment to.
+     * @param string $note The note content.
+     * @param string $note_author The name of the author of the note.
+     * @param bool $for_customer Whether or not this comment is meant to be sent to the customer.
+     * @return int|false The new note's ID on success, false on failure.
+     */
+    function add_invoice_note( $invoice, $note, $note_author, $author_email, $for_customer = false ){
+
+        do_action( 'wpinv_pre_insert_invoice_note', $invoice->get_id(), $note, $for_customer );
+
+        /**
+         * Insert the comment.
+         */
+        $note_id = wp_insert_comment(
+            wp_filter_comment(
+                array(
+                    'comment_post_ID'      => $invoice->get_id(),
+                    'comment_content'      => $note,
+                    'comment_agent'        => 'Invoicing',
+                    'user_id'              => get_current_user_id(),
+                    'comment_author'       => $note_author,
+                    'comment_author_IP'    => wpinv_get_ip(),
+                    'comment_author_email' => $author_email,
+                    'comment_author_url'   => $invoice->get_view_url(),
+                    'comment_type'         => 'wpinv_note',
+                )
+            )
+        );
+
+        do_action( 'wpinv_insert_payment_note', $note_id, $invoice->get_id(), $note, $for_customer );
+
+        // Are we notifying the customer?
+        if ( empty( $note_id ) || empty( $for_customer ) ) {
+            return $note_id;
+        }
+
+        add_comment_meta( $note_id, '_wpi_customer_note', 1 );
+        do_action( 'wpinv_new_customer_note', array( 'invoice_id' => $invoice->get_id(), 'user_note' => $note ) );
+        do_action( 'getpaid_new_customer_note', $invoice, $note );
+        return $note_id;
+    }
 
 }

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 );
+    }
 
 }