@@ -15,138 +15,138 @@ |
||
| 15 | 15 | class WPInv_REST_Discounts_Controller extends GetPaid_REST_Posts_Controller { |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | - * Post type. |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 22 | - protected $post_type = 'wpi_discount'; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * The base of this controller's route. |
|
| 26 | - * |
|
| 27 | - * @since 1.0.13 |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $rest_base = 'discounts'; |
|
| 31 | - |
|
| 32 | - /** Contains this controller's class name. |
|
| 33 | - * |
|
| 34 | - * @var string |
|
| 35 | - */ |
|
| 36 | - public $crud_class = 'WPInv_Discount'; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * Registers the routes for the objects of the controller. |
|
| 40 | - * |
|
| 41 | - * @since 1.0.19 |
|
| 42 | - * |
|
| 43 | - * @see register_rest_route() |
|
| 44 | - */ |
|
| 45 | - public function register_namespace_routes( $namespace ) { |
|
| 46 | - |
|
| 47 | - parent::register_namespace_routes( $namespace ); |
|
| 48 | - |
|
| 49 | - register_rest_route( |
|
| 50 | - $this->namespace, |
|
| 51 | - '/' . $this->rest_base . '/discount-types', |
|
| 52 | - array( |
|
| 53 | - array( |
|
| 54 | - 'methods' => WP_REST_Server::READABLE, |
|
| 55 | - 'callback' => array( $this, 'get_discount_types' ), |
|
| 56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 57 | - ), |
|
| 58 | - ) |
|
| 59 | - ); |
|
| 60 | - |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Handles rest requests for discount types. |
|
| 65 | - * |
|
| 66 | - * @since 1.0.13 |
|
| 67 | - * |
|
| 68 | - * |
|
| 69 | - * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
| 70 | - */ |
|
| 71 | - public function get_discount_types() { |
|
| 72 | - return rest_ensure_response( wpinv_get_discount_types() ); |
|
| 73 | - } |
|
| 18 | + * Post type. |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | + protected $post_type = 'wpi_discount'; |
|
| 74 | 23 | |
| 75 | 24 | /** |
| 76 | - * Retrieves the query params for the discount collection. |
|
| 77 | - * |
|
| 78 | - * @since 1.0.13 |
|
| 79 | - * |
|
| 80 | - * @return array Collection parameters. |
|
| 81 | - */ |
|
| 82 | - public function get_collection_params() { |
|
| 83 | - |
|
| 84 | - $params = array_merge( |
|
| 85 | - |
|
| 86 | - parent::get_collection_params(), |
|
| 87 | - |
|
| 88 | - array( |
|
| 89 | - |
|
| 90 | - // Discount types |
|
| 91 | - 'type' => array( |
|
| 92 | - 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
| 93 | - 'type' => array( 'array', 'string' ), |
|
| 94 | - 'default' => 'any', |
|
| 95 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 96 | - 'sanitize_callback' => 'wpinv_parse_list', |
|
| 97 | - 'items' => array( |
|
| 98 | - 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
| 99 | - 'type' => 'string', |
|
| 100 | - ), |
|
| 101 | - ), |
|
| 102 | - |
|
| 103 | - ) |
|
| 104 | - ); |
|
| 105 | - |
|
| 106 | - // Filter collection parameters for the discounts controller. |
|
| 107 | - return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Determine the allowed query_vars for a get_items() response and |
|
| 112 | - * prepare for WP_Query. |
|
| 113 | - * |
|
| 114 | - * @param array $prepared_args Prepared arguments. |
|
| 115 | - * @param WP_REST_Request $request Request object. |
|
| 116 | - * @return array $query_args |
|
| 117 | - */ |
|
| 118 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 119 | - |
|
| 120 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 121 | - |
|
| 122 | - // Retrieve items by type. |
|
| 123 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 124 | - |
|
| 125 | - if ( empty( $query_args['meta_query'] ) ) { |
|
| 126 | - $query_args['meta_query'] = array(); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - $query_args['meta_query'][] = array( |
|
| 130 | - 'key' => '_wpi_discount_type', |
|
| 131 | - 'value' => implode( ',', $request['type'] ), |
|
| 132 | - 'compare' => 'IN', |
|
| 133 | - ); |
|
| 134 | - |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
| 138 | - |
|
| 139 | - } |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * Retrieves a valid list of post statuses. |
|
| 143 | - * |
|
| 144 | - * @since 1.0.15 |
|
| 145 | - * |
|
| 146 | - * @return array A list of registered item statuses. |
|
| 147 | - */ |
|
| 148 | - public function get_post_statuses() { |
|
| 149 | - return array( 'publish', 'pending', 'draft', 'expired' ); |
|
| 150 | - } |
|
| 25 | + * The base of this controller's route. |
|
| 26 | + * |
|
| 27 | + * @since 1.0.13 |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $rest_base = 'discounts'; |
|
| 31 | + |
|
| 32 | + /** Contains this controller's class name. |
|
| 33 | + * |
|
| 34 | + * @var string |
|
| 35 | + */ |
|
| 36 | + public $crud_class = 'WPInv_Discount'; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * Registers the routes for the objects of the controller. |
|
| 40 | + * |
|
| 41 | + * @since 1.0.19 |
|
| 42 | + * |
|
| 43 | + * @see register_rest_route() |
|
| 44 | + */ |
|
| 45 | + public function register_namespace_routes( $namespace ) { |
|
| 46 | + |
|
| 47 | + parent::register_namespace_routes( $namespace ); |
|
| 48 | + |
|
| 49 | + register_rest_route( |
|
| 50 | + $this->namespace, |
|
| 51 | + '/' . $this->rest_base . '/discount-types', |
|
| 52 | + array( |
|
| 53 | + array( |
|
| 54 | + 'methods' => WP_REST_Server::READABLE, |
|
| 55 | + 'callback' => array( $this, 'get_discount_types' ), |
|
| 56 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 57 | + ), |
|
| 58 | + ) |
|
| 59 | + ); |
|
| 60 | + |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Handles rest requests for discount types. |
|
| 65 | + * |
|
| 66 | + * @since 1.0.13 |
|
| 67 | + * |
|
| 68 | + * |
|
| 69 | + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
| 70 | + */ |
|
| 71 | + public function get_discount_types() { |
|
| 72 | + return rest_ensure_response( wpinv_get_discount_types() ); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * Retrieves the query params for the discount collection. |
|
| 77 | + * |
|
| 78 | + * @since 1.0.13 |
|
| 79 | + * |
|
| 80 | + * @return array Collection parameters. |
|
| 81 | + */ |
|
| 82 | + public function get_collection_params() { |
|
| 83 | + |
|
| 84 | + $params = array_merge( |
|
| 85 | + |
|
| 86 | + parent::get_collection_params(), |
|
| 87 | + |
|
| 88 | + array( |
|
| 89 | + |
|
| 90 | + // Discount types |
|
| 91 | + 'type' => array( |
|
| 92 | + 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
| 93 | + 'type' => array( 'array', 'string' ), |
|
| 94 | + 'default' => 'any', |
|
| 95 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 96 | + 'sanitize_callback' => 'wpinv_parse_list', |
|
| 97 | + 'items' => array( |
|
| 98 | + 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
| 99 | + 'type' => 'string', |
|
| 100 | + ), |
|
| 101 | + ), |
|
| 102 | + |
|
| 103 | + ) |
|
| 104 | + ); |
|
| 105 | + |
|
| 106 | + // Filter collection parameters for the discounts controller. |
|
| 107 | + return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Determine the allowed query_vars for a get_items() response and |
|
| 112 | + * prepare for WP_Query. |
|
| 113 | + * |
|
| 114 | + * @param array $prepared_args Prepared arguments. |
|
| 115 | + * @param WP_REST_Request $request Request object. |
|
| 116 | + * @return array $query_args |
|
| 117 | + */ |
|
| 118 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 119 | + |
|
| 120 | + $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 121 | + |
|
| 122 | + // Retrieve items by type. |
|
| 123 | + if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 124 | + |
|
| 125 | + if ( empty( $query_args['meta_query'] ) ) { |
|
| 126 | + $query_args['meta_query'] = array(); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + $query_args['meta_query'][] = array( |
|
| 130 | + 'key' => '_wpi_discount_type', |
|
| 131 | + 'value' => implode( ',', $request['type'] ), |
|
| 132 | + 'compare' => 'IN', |
|
| 133 | + ); |
|
| 134 | + |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
| 138 | + |
|
| 139 | + } |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * Retrieves a valid list of post statuses. |
|
| 143 | + * |
|
| 144 | + * @since 1.0.15 |
|
| 145 | + * |
|
| 146 | + * @return array A list of registered item statuses. |
|
| 147 | + */ |
|
| 148 | + public function get_post_statuses() { |
|
| 149 | + return array( 'publish', 'pending', 'draft', 'expired' ); |
|
| 150 | + } |
|
| 151 | 151 | |
| 152 | 152 | } |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * @version 1.0.19 |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | -defined( 'ABSPATH' ) || exit; |
|
| 8 | +defined('ABSPATH') || exit; |
|
| 9 | 9 | |
| 10 | 10 | /** |
| 11 | 11 | * REST API discounts controller class. |
@@ -42,9 +42,9 @@ discard block |
||
| 42 | 42 | * |
| 43 | 43 | * @see register_rest_route() |
| 44 | 44 | */ |
| 45 | - public function register_namespace_routes( $namespace ) { |
|
| 45 | + public function register_namespace_routes($namespace) { |
|
| 46 | 46 | |
| 47 | - parent::register_namespace_routes( $namespace ); |
|
| 47 | + parent::register_namespace_routes($namespace); |
|
| 48 | 48 | |
| 49 | 49 | register_rest_route( |
| 50 | 50 | $this->namespace, |
@@ -52,8 +52,8 @@ discard block |
||
| 52 | 52 | array( |
| 53 | 53 | array( |
| 54 | 54 | 'methods' => WP_REST_Server::READABLE, |
| 55 | - 'callback' => array( $this, 'get_discount_types' ), |
|
| 56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 55 | + 'callback' => array($this, 'get_discount_types'), |
|
| 56 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 57 | 57 | ), |
| 58 | 58 | ) |
| 59 | 59 | ); |
@@ -69,7 +69,7 @@ discard block |
||
| 69 | 69 | * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
| 70 | 70 | */ |
| 71 | 71 | public function get_discount_types() { |
| 72 | - return rest_ensure_response( wpinv_get_discount_types() ); |
|
| 72 | + return rest_ensure_response(wpinv_get_discount_types()); |
|
| 73 | 73 | } |
| 74 | 74 | |
| 75 | 75 | /** |
@@ -89,13 +89,13 @@ discard block |
||
| 89 | 89 | |
| 90 | 90 | // Discount types |
| 91 | 91 | 'type' => array( |
| 92 | - 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
| 93 | - 'type' => array( 'array', 'string' ), |
|
| 92 | + 'description' => __('Type of discounts to fetch.', 'invoicing'), |
|
| 93 | + 'type' => array('array', 'string'), |
|
| 94 | 94 | 'default' => 'any', |
| 95 | 95 | 'validate_callback' => 'rest_validate_request_arg', |
| 96 | 96 | 'sanitize_callback' => 'wpinv_parse_list', |
| 97 | 97 | 'items' => array( |
| 98 | - 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
| 98 | + 'enum' => array_merge(array('any'), array_keys(wpinv_get_discount_types())), |
|
| 99 | 99 | 'type' => 'string', |
| 100 | 100 | ), |
| 101 | 101 | ), |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | ); |
| 105 | 105 | |
| 106 | 106 | // Filter collection parameters for the discounts controller. |
| 107 | - return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
| 107 | + return apply_filters('getpaid_rest_discounts_collection_params', $params, $this); |
|
| 108 | 108 | } |
| 109 | 109 | |
| 110 | 110 | /** |
@@ -115,26 +115,26 @@ discard block |
||
| 115 | 115 | * @param WP_REST_Request $request Request object. |
| 116 | 116 | * @return array $query_args |
| 117 | 117 | */ |
| 118 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 118 | + protected function prepare_items_query($prepared_args = array(), $request = null) { |
|
| 119 | 119 | |
| 120 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 120 | + $query_args = parent::prepare_items_query($prepared_args); |
|
| 121 | 121 | |
| 122 | 122 | // Retrieve items by type. |
| 123 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 123 | + if (!in_array('any', $request['type'])) { |
|
| 124 | 124 | |
| 125 | - if ( empty( $query_args['meta_query'] ) ) { |
|
| 125 | + if (empty($query_args['meta_query'])) { |
|
| 126 | 126 | $query_args['meta_query'] = array(); |
| 127 | 127 | } |
| 128 | 128 | |
| 129 | 129 | $query_args['meta_query'][] = array( |
| 130 | 130 | 'key' => '_wpi_discount_type', |
| 131 | - 'value' => implode( ',', $request['type'] ), |
|
| 131 | + 'value' => implode(',', $request['type']), |
|
| 132 | 132 | 'compare' => 'IN', |
| 133 | 133 | ); |
| 134 | 134 | |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | - return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
| 137 | + return apply_filters('getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this); |
|
| 138 | 138 | |
| 139 | 139 | } |
| 140 | 140 | |
@@ -146,7 +146,7 @@ discard block |
||
| 146 | 146 | * @return array A list of registered item statuses. |
| 147 | 147 | */ |
| 148 | 148 | public function get_post_statuses() { |
| 149 | - return array( 'publish', 'pending', 'draft', 'expired' ); |
|
| 149 | + return array('publish', 'pending', 'draft', 'expired'); |
|
| 150 | 150 | } |
| 151 | 151 | |
| 152 | 152 | } |
@@ -1,7 +1,7 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) { |
| 4 | - exit; |
|
| 4 | + exit; |
|
| 5 | 5 | } |
| 6 | 6 | |
| 7 | 7 | global $wpdb; |
@@ -1,26 +1,26 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | -if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) { |
|
| 3 | +if (!defined('WP_UNINSTALL_PLUGIN')) { |
|
| 4 | 4 | exit; |
| 5 | 5 | } |
| 6 | 6 | |
| 7 | 7 | global $wpdb; |
| 8 | 8 | |
| 9 | -if ( get_option( 'wpinv_remove_data_on_invoice_unistall' ) ) { |
|
| 9 | +if (get_option('wpinv_remove_data_on_invoice_unistall')) { |
|
| 10 | 10 | |
| 11 | 11 | // Fetch settings. |
| 12 | - $settings = get_option( 'wpinv_settings' ); |
|
| 12 | + $settings = get_option('wpinv_settings'); |
|
| 13 | 13 | |
| 14 | 14 | // Delete pages. |
| 15 | - $pages = array( 'checkout_page', 'success_page', 'failure_page', 'invoice_history_page', 'quote_history_page', 'invoice_subscription_page' ); |
|
| 16 | - foreach ( $pages as $page ) { |
|
| 17 | - if ( is_array( $settings ) && ! empty( $settings[ $page ] ) ) { |
|
| 18 | - wp_delete_post( $settings[ $page ], true ); |
|
| 15 | + $pages = array('checkout_page', 'success_page', 'failure_page', 'invoice_history_page', 'quote_history_page', 'invoice_subscription_page'); |
|
| 16 | + foreach ($pages as $page) { |
|
| 17 | + if (is_array($settings) && !empty($settings[$page])) { |
|
| 18 | + wp_delete_post($settings[$page], true); |
|
| 19 | 19 | } |
| 20 | 20 | } |
| 21 | 21 | |
| 22 | 22 | // Delete options. |
| 23 | - $wpdb->query( "DELETE FROM {$wpdb->options} WHERE option_name LIKE 'wpinv\_%';" ); |
|
| 23 | + $wpdb->query("DELETE FROM {$wpdb->options} WHERE option_name LIKE 'wpinv\_%';"); |
|
| 24 | 24 | |
| 25 | 25 | // Delete posts. |
| 26 | 26 | $wpdb->query( |
@@ -49,9 +49,9 @@ discard block |
||
| 49 | 49 | ); |
| 50 | 50 | |
| 51 | 51 | // Cleanup Cron Schedule |
| 52 | - wp_clear_scheduled_hook( 'wp_session_garbage_collection' ); |
|
| 53 | - wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' ); |
|
| 54 | - wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' ); |
|
| 52 | + wp_clear_scheduled_hook('wp_session_garbage_collection'); |
|
| 53 | + wp_clear_scheduled_hook('wpinv_register_schedule_event_twicedaily'); |
|
| 54 | + wp_clear_scheduled_hook('wpinv_register_schedule_event_daily'); |
|
| 55 | 55 | |
| 56 | 56 | // Clear any cached data that has been removed |
| 57 | 57 | wp_cache_flush(); |
@@ -63,8 +63,8 @@ discard block |
||
| 63 | 63 | "{$wpdb->prefix}getpaid_invoice_items", |
| 64 | 64 | ); |
| 65 | 65 | |
| 66 | - foreach ( $tables as $table ) { |
|
| 67 | - $wpdb->query( "DROP TABLE IF EXISTS {$table}" ); |
|
| 66 | + foreach ($tables as $table) { |
|
| 67 | + $wpdb->query("DROP TABLE IF EXISTS {$table}"); |
|
| 68 | 68 | } |
| 69 | 69 | |
| 70 | 70 | } |
@@ -21,570 +21,570 @@ |
||
| 21 | 21 | */ |
| 22 | 22 | class GetPaid_REST_Controller extends WP_REST_Controller { |
| 23 | 23 | |
| 24 | - /** |
|
| 24 | + /** |
|
| 25 | 25 | * The namespaces of this controller's route. |
| 26 | 26 | * |
| 27 | 27 | * @since 1.0.19 |
| 28 | 28 | * @var array |
| 29 | 29 | */ |
| 30 | - protected $namespaces; |
|
| 30 | + protected $namespaces; |
|
| 31 | 31 | |
| 32 | - /** |
|
| 32 | + /** |
|
| 33 | 33 | * The official namespace of this controller's route. |
| 34 | 34 | * |
| 35 | 35 | * @since 1.0.19 |
| 36 | 36 | * @var string |
| 37 | 37 | */ |
| 38 | - protected $namespace = 'getpaid/v1'; |
|
| 38 | + protected $namespace = 'getpaid/v1'; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 40 | + /** |
|
| 41 | 41 | * Cached results of get_item_schema. |
| 42 | 42 | * |
| 43 | 43 | * @since 1.0.19 |
| 44 | 44 | * @var array |
| 45 | 45 | */ |
| 46 | - protected $schema; |
|
| 46 | + protected $schema; |
|
| 47 | 47 | |
| 48 | 48 | /** |
| 49 | - * Constructor. |
|
| 50 | - * |
|
| 51 | - * @since 1.0.19 |
|
| 52 | - * |
|
| 53 | - */ |
|
| 54 | - public function __construct() { |
|
| 55 | - |
|
| 56 | - // Offer several namespaces for backwards compatibility. |
|
| 57 | - $this->namespaces = apply_filters( |
|
| 58 | - 'getpaid_rest_api_namespaces', |
|
| 59 | - array( |
|
| 60 | - 'getpaid/v1', |
|
| 61 | - 'invoicing/v1', |
|
| 62 | - 'wpi/v1' |
|
| 63 | - ) |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - // Register REST routes. |
|
| 49 | + * Constructor. |
|
| 50 | + * |
|
| 51 | + * @since 1.0.19 |
|
| 52 | + * |
|
| 53 | + */ |
|
| 54 | + public function __construct() { |
|
| 55 | + |
|
| 56 | + // Offer several namespaces for backwards compatibility. |
|
| 57 | + $this->namespaces = apply_filters( |
|
| 58 | + 'getpaid_rest_api_namespaces', |
|
| 59 | + array( |
|
| 60 | + 'getpaid/v1', |
|
| 61 | + 'invoicing/v1', |
|
| 62 | + 'wpi/v1' |
|
| 63 | + ) |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + // Register REST routes. |
|
| 67 | 67 | add_action( 'rest_api_init', array( $this, 'register_routes' ) ); |
| 68 | 68 | |
| 69 | - } |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * Registers routes for each namespace. |
|
| 73 | - * |
|
| 74 | - * @since 1.0.19 |
|
| 75 | - * |
|
| 76 | - */ |
|
| 77 | - public function register_routes() { |
|
| 78 | - |
|
| 79 | - foreach ( $this->namespaces as $namespace ) { |
|
| 80 | - $this->register_namespace_routes( $namespace ); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Registers routes for a namespace. |
|
| 87 | - * |
|
| 88 | - * @since 1.0.19 |
|
| 89 | - * |
|
| 90 | - * @param string $namespace |
|
| 91 | - */ |
|
| 92 | - public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
| 93 | - |
|
| 94 | - getpaid_doing_it_wrong( |
|
| 95 | - __CLASS__ . '::' .__METHOD__, |
|
| 96 | - /* translators: %s: register_namespace_routes() */ |
|
| 97 | - sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
| 98 | - '1.0.19' |
|
| 99 | - ); |
|
| 100 | - |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * Get normalized rest base. |
|
| 105 | - * |
|
| 106 | - * @return string |
|
| 107 | - */ |
|
| 108 | - protected function get_normalized_rest_base() { |
|
| 109 | - return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * Fill batches. |
|
| 114 | - * |
|
| 115 | - * @param array array of request items. |
|
| 116 | - * @return array |
|
| 117 | - */ |
|
| 118 | - protected function fill_batch_keys( $items ) { |
|
| 119 | - |
|
| 120 | - $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
| 121 | - $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
| 122 | - $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
| 123 | - return $items; |
|
| 124 | - |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * Check batch limit. |
|
| 129 | - * |
|
| 130 | - * @param array $items Request items. |
|
| 131 | - * @return bool|WP_Error |
|
| 132 | - */ |
|
| 133 | - protected function check_batch_limit( $items ) { |
|
| 134 | - $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
| 135 | - $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
| 136 | - |
|
| 137 | - if ( $total > $limit ) { |
|
| 138 | - /* translators: %s: items limit */ |
|
| 139 | - return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - return true; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Bulk create items. |
|
| 147 | - * |
|
| 148 | - * @param array $items Array of items to create. |
|
| 149 | - * @param WP_REST_Request $request Full details about the request. |
|
| 150 | - * @param WP_REST_Server $wp_rest_server |
|
| 151 | - * @return array() |
|
| 152 | - */ |
|
| 153 | - protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
| 154 | - |
|
| 155 | - $query = $request->get_query_params(); |
|
| 156 | - $create = array(); |
|
| 157 | - |
|
| 158 | - foreach ( $items as $item ) { |
|
| 159 | - $_item = new WP_REST_Request( 'POST' ); |
|
| 160 | - |
|
| 161 | - // Default parameters. |
|
| 162 | - $defaults = array(); |
|
| 163 | - $schema = $this->get_public_item_schema(); |
|
| 164 | - foreach ( $schema['properties'] as $arg => $options ) { |
|
| 165 | - if ( isset( $options['default'] ) ) { |
|
| 166 | - $defaults[ $arg ] = $options['default']; |
|
| 167 | - } |
|
| 168 | - } |
|
| 169 | - $_item->set_default_params( $defaults ); |
|
| 170 | - |
|
| 171 | - // Set request parameters. |
|
| 172 | - $_item->set_body_params( $item ); |
|
| 173 | - |
|
| 174 | - // Set query (GET) parameters. |
|
| 175 | - $_item->set_query_params( $query ); |
|
| 176 | - |
|
| 177 | - // Create the item. |
|
| 178 | - $_response = $this->create_item( $_item ); |
|
| 179 | - |
|
| 180 | - // If an error occured... |
|
| 181 | - if ( is_wp_error( $_response ) ) { |
|
| 182 | - |
|
| 183 | - $create[] = array( |
|
| 184 | - 'id' => 0, |
|
| 185 | - 'error' => array( |
|
| 186 | - 'code' => $_response->get_error_code(), |
|
| 187 | - 'message' => $_response->get_error_message(), |
|
| 188 | - 'data' => $_response->get_error_data(), |
|
| 189 | - ), |
|
| 190 | - ); |
|
| 191 | - |
|
| 192 | - continue; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 196 | - |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - return $create; |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * Registers routes for each namespace. |
|
| 73 | + * |
|
| 74 | + * @since 1.0.19 |
|
| 75 | + * |
|
| 76 | + */ |
|
| 77 | + public function register_routes() { |
|
| 78 | + |
|
| 79 | + foreach ( $this->namespaces as $namespace ) { |
|
| 80 | + $this->register_namespace_routes( $namespace ); |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Registers routes for a namespace. |
|
| 87 | + * |
|
| 88 | + * @since 1.0.19 |
|
| 89 | + * |
|
| 90 | + * @param string $namespace |
|
| 91 | + */ |
|
| 92 | + public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
| 93 | + |
|
| 94 | + getpaid_doing_it_wrong( |
|
| 95 | + __CLASS__ . '::' .__METHOD__, |
|
| 96 | + /* translators: %s: register_namespace_routes() */ |
|
| 97 | + sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
| 98 | + '1.0.19' |
|
| 99 | + ); |
|
| 100 | + |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * Get normalized rest base. |
|
| 105 | + * |
|
| 106 | + * @return string |
|
| 107 | + */ |
|
| 108 | + protected function get_normalized_rest_base() { |
|
| 109 | + return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * Fill batches. |
|
| 114 | + * |
|
| 115 | + * @param array array of request items. |
|
| 116 | + * @return array |
|
| 117 | + */ |
|
| 118 | + protected function fill_batch_keys( $items ) { |
|
| 119 | + |
|
| 120 | + $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
| 121 | + $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
| 122 | + $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
| 123 | + return $items; |
|
| 124 | + |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * Check batch limit. |
|
| 129 | + * |
|
| 130 | + * @param array $items Request items. |
|
| 131 | + * @return bool|WP_Error |
|
| 132 | + */ |
|
| 133 | + protected function check_batch_limit( $items ) { |
|
| 134 | + $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
| 135 | + $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
| 136 | + |
|
| 137 | + if ( $total > $limit ) { |
|
| 138 | + /* translators: %s: items limit */ |
|
| 139 | + return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + return true; |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Bulk create items. |
|
| 147 | + * |
|
| 148 | + * @param array $items Array of items to create. |
|
| 149 | + * @param WP_REST_Request $request Full details about the request. |
|
| 150 | + * @param WP_REST_Server $wp_rest_server |
|
| 151 | + * @return array() |
|
| 152 | + */ |
|
| 153 | + protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
| 154 | + |
|
| 155 | + $query = $request->get_query_params(); |
|
| 156 | + $create = array(); |
|
| 157 | + |
|
| 158 | + foreach ( $items as $item ) { |
|
| 159 | + $_item = new WP_REST_Request( 'POST' ); |
|
| 160 | + |
|
| 161 | + // Default parameters. |
|
| 162 | + $defaults = array(); |
|
| 163 | + $schema = $this->get_public_item_schema(); |
|
| 164 | + foreach ( $schema['properties'] as $arg => $options ) { |
|
| 165 | + if ( isset( $options['default'] ) ) { |
|
| 166 | + $defaults[ $arg ] = $options['default']; |
|
| 167 | + } |
|
| 168 | + } |
|
| 169 | + $_item->set_default_params( $defaults ); |
|
| 170 | + |
|
| 171 | + // Set request parameters. |
|
| 172 | + $_item->set_body_params( $item ); |
|
| 173 | + |
|
| 174 | + // Set query (GET) parameters. |
|
| 175 | + $_item->set_query_params( $query ); |
|
| 176 | + |
|
| 177 | + // Create the item. |
|
| 178 | + $_response = $this->create_item( $_item ); |
|
| 179 | + |
|
| 180 | + // If an error occured... |
|
| 181 | + if ( is_wp_error( $_response ) ) { |
|
| 182 | + |
|
| 183 | + $create[] = array( |
|
| 184 | + 'id' => 0, |
|
| 185 | + 'error' => array( |
|
| 186 | + 'code' => $_response->get_error_code(), |
|
| 187 | + 'message' => $_response->get_error_message(), |
|
| 188 | + 'data' => $_response->get_error_data(), |
|
| 189 | + ), |
|
| 190 | + ); |
|
| 191 | + |
|
| 192 | + continue; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 196 | + |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + return $create; |
|
| 200 | + |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + /** |
|
| 204 | + * Bulk update items. |
|
| 205 | + * |
|
| 206 | + * @param array $items Array of items to update. |
|
| 207 | + * @param WP_REST_Request $request Full details about the request. |
|
| 208 | + * @param WP_REST_Server $wp_rest_server |
|
| 209 | + * @return array() |
|
| 210 | + */ |
|
| 211 | + protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
| 212 | + |
|
| 213 | + $query = $request->get_query_params(); |
|
| 214 | + $update = array(); |
|
| 215 | + |
|
| 216 | + foreach ( $items as $item ) { |
|
| 217 | + |
|
| 218 | + // Create a dummy request. |
|
| 219 | + $_item = new WP_REST_Request( 'PUT' ); |
|
| 220 | + |
|
| 221 | + // Add body params. |
|
| 222 | + $_item->set_body_params( $item ); |
|
| 223 | + |
|
| 224 | + // Set query (GET) parameters. |
|
| 225 | + $_item->set_query_params( $query ); |
|
| 226 | + |
|
| 227 | + // Update the item. |
|
| 228 | + $_response = $this->update_item( $_item ); |
|
| 229 | + |
|
| 230 | + // If an error occured... |
|
| 231 | + if ( is_wp_error( $_response ) ) { |
|
| 232 | + |
|
| 233 | + $update[] = array( |
|
| 234 | + 'id' => $item['id'], |
|
| 235 | + 'error' => array( |
|
| 236 | + 'code' => $_response->get_error_code(), |
|
| 237 | + 'message' => $_response->get_error_message(), |
|
| 238 | + 'data' => $_response->get_error_data(), |
|
| 239 | + ), |
|
| 240 | + ); |
|
| 241 | + |
|
| 242 | + continue; |
|
| 243 | + |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 247 | + |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + return $update; |
|
| 251 | + |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + /** |
|
| 255 | + * Bulk delete items. |
|
| 256 | + * |
|
| 257 | + * @param array $items Array of items to delete. |
|
| 258 | + * @param WP_REST_Server $wp_rest_server |
|
| 259 | + * @return array() |
|
| 260 | + */ |
|
| 261 | + protected function batch_delete_items( $items, $wp_rest_server ) { |
|
| 262 | + |
|
| 263 | + $delete = array(); |
|
| 264 | + |
|
| 265 | + foreach ( array_filter( $items ) as $id ) { |
|
| 266 | + |
|
| 267 | + // Prepare the request. |
|
| 268 | + $_item = new WP_REST_Request( 'DELETE' ); |
|
| 269 | + $_item->set_query_params( |
|
| 270 | + array( |
|
| 271 | + 'id' => $id, |
|
| 272 | + 'force' => true, |
|
| 273 | + ) |
|
| 274 | + ); |
|
| 275 | + |
|
| 276 | + // Delete the item. |
|
| 277 | + $_response = $this->delete_item( $_item ); |
|
| 278 | + |
|
| 279 | + if ( is_wp_error( $_response ) ) { |
|
| 280 | + |
|
| 281 | + $delete[] = array( |
|
| 282 | + 'id' => $id, |
|
| 283 | + 'error' => array( |
|
| 284 | + 'code' => $_response->get_error_code(), |
|
| 285 | + 'message' => $_response->get_error_message(), |
|
| 286 | + 'data' => $_response->get_error_data(), |
|
| 287 | + ), |
|
| 288 | + ); |
|
| 289 | + |
|
| 290 | + continue; |
|
| 291 | + } |
|
| 200 | 292 | |
| 201 | - } |
|
| 202 | - |
|
| 203 | - /** |
|
| 204 | - * Bulk update items. |
|
| 205 | - * |
|
| 206 | - * @param array $items Array of items to update. |
|
| 207 | - * @param WP_REST_Request $request Full details about the request. |
|
| 208 | - * @param WP_REST_Server $wp_rest_server |
|
| 209 | - * @return array() |
|
| 210 | - */ |
|
| 211 | - protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
| 212 | - |
|
| 213 | - $query = $request->get_query_params(); |
|
| 214 | - $update = array(); |
|
| 215 | - |
|
| 216 | - foreach ( $items as $item ) { |
|
| 217 | - |
|
| 218 | - // Create a dummy request. |
|
| 219 | - $_item = new WP_REST_Request( 'PUT' ); |
|
| 220 | - |
|
| 221 | - // Add body params. |
|
| 222 | - $_item->set_body_params( $item ); |
|
| 223 | - |
|
| 224 | - // Set query (GET) parameters. |
|
| 225 | - $_item->set_query_params( $query ); |
|
| 226 | - |
|
| 227 | - // Update the item. |
|
| 228 | - $_response = $this->update_item( $_item ); |
|
| 229 | - |
|
| 230 | - // If an error occured... |
|
| 231 | - if ( is_wp_error( $_response ) ) { |
|
| 232 | - |
|
| 233 | - $update[] = array( |
|
| 234 | - 'id' => $item['id'], |
|
| 235 | - 'error' => array( |
|
| 236 | - 'code' => $_response->get_error_code(), |
|
| 237 | - 'message' => $_response->get_error_message(), |
|
| 238 | - 'data' => $_response->get_error_data(), |
|
| 239 | - ), |
|
| 240 | - ); |
|
| 241 | - |
|
| 242 | - continue; |
|
| 243 | - |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 247 | - |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - return $update; |
|
| 251 | - |
|
| 252 | - } |
|
| 293 | + $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 253 | 294 | |
| 254 | - /** |
|
| 255 | - * Bulk delete items. |
|
| 256 | - * |
|
| 257 | - * @param array $items Array of items to delete. |
|
| 258 | - * @param WP_REST_Server $wp_rest_server |
|
| 259 | - * @return array() |
|
| 260 | - */ |
|
| 261 | - protected function batch_delete_items( $items, $wp_rest_server ) { |
|
| 262 | - |
|
| 263 | - $delete = array(); |
|
| 264 | - |
|
| 265 | - foreach ( array_filter( $items ) as $id ) { |
|
| 266 | - |
|
| 267 | - // Prepare the request. |
|
| 268 | - $_item = new WP_REST_Request( 'DELETE' ); |
|
| 269 | - $_item->set_query_params( |
|
| 270 | - array( |
|
| 271 | - 'id' => $id, |
|
| 272 | - 'force' => true, |
|
| 273 | - ) |
|
| 274 | - ); |
|
| 275 | - |
|
| 276 | - // Delete the item. |
|
| 277 | - $_response = $this->delete_item( $_item ); |
|
| 278 | - |
|
| 279 | - if ( is_wp_error( $_response ) ) { |
|
| 280 | - |
|
| 281 | - $delete[] = array( |
|
| 282 | - 'id' => $id, |
|
| 283 | - 'error' => array( |
|
| 284 | - 'code' => $_response->get_error_code(), |
|
| 285 | - 'message' => $_response->get_error_message(), |
|
| 286 | - 'data' => $_response->get_error_data(), |
|
| 287 | - ), |
|
| 288 | - ); |
|
| 289 | - |
|
| 290 | - continue; |
|
| 291 | - } |
|
| 292 | - |
|
| 293 | - $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 294 | - |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - return $delete; |
|
| 298 | - |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * Bulk create, update and delete items. |
|
| 303 | - * |
|
| 304 | - * @param WP_REST_Request $request Full details about the request. |
|
| 305 | - * @return WP_Error|array. |
|
| 306 | - */ |
|
| 307 | - public function batch_items( $request ) { |
|
| 308 | - global $wp_rest_server; |
|
| 309 | - |
|
| 310 | - // Prepare the batch items. |
|
| 311 | - $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
| 312 | - |
|
| 313 | - // Ensure that the batch has not exceeded the limit to prevent abuse. |
|
| 314 | - $limit = $this->check_batch_limit( $items ); |
|
| 315 | - if ( is_wp_error( $limit ) ) { |
|
| 316 | - return $limit; |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - // Process the items. |
|
| 320 | - return array( |
|
| 321 | - 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
| 322 | - 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
| 323 | - 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
| 324 | - ); |
|
| 325 | - |
|
| 326 | - } |
|
| 327 | - |
|
| 328 | - /** |
|
| 329 | - * Add meta query. |
|
| 330 | - * |
|
| 331 | - * @since 1.0.19 |
|
| 332 | - * @param array $args Query args. |
|
| 333 | - * @param array $meta_query Meta query. |
|
| 334 | - * @return array |
|
| 335 | - */ |
|
| 336 | - protected function add_meta_query( $args, $meta_query ) { |
|
| 337 | - if ( empty( $args['meta_query'] ) ) { |
|
| 338 | - $args['meta_query'] = array(); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - $args['meta_query'][] = $meta_query; |
|
| 342 | - |
|
| 343 | - return $args['meta_query']; |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - /** |
|
| 347 | - * Get the batch schema, conforming to JSON Schema. |
|
| 348 | - * |
|
| 349 | - * @return array |
|
| 350 | - */ |
|
| 351 | - public function get_public_batch_schema() { |
|
| 352 | - |
|
| 353 | - return array( |
|
| 354 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 355 | - 'title' => 'batch', |
|
| 356 | - 'type' => 'object', |
|
| 357 | - 'properties' => array( |
|
| 358 | - 'create' => array( |
|
| 359 | - 'description' => __( 'List of created resources.', 'invoicing' ), |
|
| 360 | - 'type' => 'array', |
|
| 361 | - 'context' => array( 'view', 'edit' ), |
|
| 362 | - 'items' => array( |
|
| 363 | - 'type' => 'object', |
|
| 364 | - ), |
|
| 365 | - ), |
|
| 366 | - 'update' => array( |
|
| 367 | - 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
| 368 | - 'type' => 'array', |
|
| 369 | - 'context' => array( 'view', 'edit' ), |
|
| 370 | - 'items' => array( |
|
| 371 | - 'type' => 'object', |
|
| 372 | - ), |
|
| 373 | - ), |
|
| 374 | - 'delete' => array( |
|
| 375 | - 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
| 376 | - 'type' => 'array', |
|
| 377 | - 'context' => array( 'view', 'edit' ), |
|
| 378 | - 'items' => array( |
|
| 379 | - 'type' => 'integer', |
|
| 380 | - ), |
|
| 381 | - ), |
|
| 382 | - ), |
|
| 383 | - ); |
|
| 384 | - |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Returns the value of schema['properties'] |
|
| 389 | - * |
|
| 390 | - * i.e Schema fields. |
|
| 391 | - * |
|
| 392 | - * @since 1.0.19 |
|
| 393 | - * @return array |
|
| 394 | - */ |
|
| 395 | - protected function get_schema_properties() { |
|
| 396 | - |
|
| 397 | - $schema = $this->get_item_schema(); |
|
| 398 | - $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
| 399 | - |
|
| 400 | - // For back-compat, include any field with an empty schema |
|
| 401 | - // because it won't be present in $this->get_item_schema(). |
|
| 402 | - foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
| 403 | - if ( is_null( $field_options['schema'] ) ) { |
|
| 404 | - $properties[ $field_name ] = $field_options; |
|
| 405 | - } |
|
| 406 | - } |
|
| 407 | - |
|
| 408 | - return $properties; |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - /** |
|
| 412 | - * Filters fields by context. |
|
| 413 | - * |
|
| 414 | - * @param array $fields Array of fields |
|
| 415 | - * @param string|null context view, edit or embed |
|
| 416 | - * @since 1.0.19 |
|
| 417 | - * @return array |
|
| 418 | - */ |
|
| 419 | - protected function filter_response_fields_by_context( $fields, $context ) { |
|
| 420 | - |
|
| 421 | - if ( empty( $context ) ) { |
|
| 422 | - return $fields; |
|
| 423 | - } |
|
| 424 | - |
|
| 425 | - foreach ( $fields as $name => $options ) { |
|
| 426 | - if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
| 427 | - unset( $fields[ $name ] ); |
|
| 428 | - } |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - return $fields; |
|
| 432 | - |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - /** |
|
| 436 | - * Filters fields by an array of requested fields. |
|
| 437 | - * |
|
| 438 | - * @param array $fields Array of available fields |
|
| 439 | - * @param array $requested array of requested fields. |
|
| 440 | - * @since 1.0.19 |
|
| 441 | - * @return array |
|
| 442 | - */ |
|
| 443 | - protected function filter_response_fields_by_array( $fields, $requested ) { |
|
| 444 | - |
|
| 445 | - // Trim off any whitespace from the list array. |
|
| 446 | - $requested = array_map( 'trim', $requested ); |
|
| 447 | - |
|
| 448 | - // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
|
| 449 | - if ( in_array( 'id', $fields, true ) ) { |
|
| 450 | - $requested[] = 'id'; |
|
| 451 | - } |
|
| 452 | - |
|
| 453 | - // Get rid of duplicate fields. |
|
| 454 | - $requested = array_unique( $requested ); |
|
| 455 | - |
|
| 456 | - // Return the list of all included fields which are available. |
|
| 457 | - return array_reduce( |
|
| 458 | - $requested, |
|
| 459 | - function( $response_fields, $field ) use ( $fields ) { |
|
| 460 | - |
|
| 461 | - if ( in_array( $field, $fields, true ) ) { |
|
| 462 | - $response_fields[] = $field; |
|
| 463 | - return $response_fields; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - // Check for nested fields if $field is not a direct match. |
|
| 467 | - $nested_fields = explode( '.', $field ); |
|
| 468 | - |
|
| 469 | - // A nested field is included so long as its top-level property is |
|
| 470 | - // present in the schema. |
|
| 471 | - if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
| 472 | - $response_fields[] = $field; |
|
| 473 | - } |
|
| 474 | - |
|
| 475 | - return $response_fields; |
|
| 476 | - }, |
|
| 477 | - array() |
|
| 478 | - ); |
|
| 479 | - |
|
| 480 | - } |
|
| 481 | - |
|
| 482 | - /** |
|
| 483 | - * Gets an array of fields to be included on the response. |
|
| 484 | - * |
|
| 485 | - * Included fields are based on item schema and `_fields=` request argument. |
|
| 486 | - * Copied from WordPress 5.3 to support old versions. |
|
| 487 | - * |
|
| 488 | - * @since 1.0.19 |
|
| 489 | - * @param WP_REST_Request $request Full details about the request. |
|
| 490 | - * @return array Fields to be included in the response. |
|
| 491 | - */ |
|
| 492 | - public function get_fields_for_response( $request ) { |
|
| 493 | - |
|
| 494 | - // Retrieve fields in the schema. |
|
| 495 | - $properties = $this->get_schema_properties(); |
|
| 496 | - |
|
| 497 | - // Exclude fields that specify a different context than the request context. |
|
| 498 | - $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
| 499 | - |
|
| 500 | - // We only need the field keys. |
|
| 501 | - $fields = array_keys( $properties ); |
|
| 502 | - |
|
| 503 | - // Is the user filtering the response fields?? |
|
| 504 | - if ( empty( $request['_fields'] ) ) { |
|
| 505 | - return $fields; |
|
| 506 | - } |
|
| 507 | - |
|
| 508 | - return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
| 509 | - |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - /** |
|
| 513 | - * Limits an object to the requested fields. |
|
| 514 | - * |
|
| 515 | - * Included fields are based on the `_fields` request argument. |
|
| 516 | - * |
|
| 517 | - * @since 1.0.19 |
|
| 518 | - * @param array $data Fields to include in the response. |
|
| 519 | - * @param array $fields Requested fields. |
|
| 520 | - * @return array Fields to be included in the response. |
|
| 521 | - */ |
|
| 522 | - public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
| 523 | - |
|
| 524 | - // Is the user filtering the response fields?? |
|
| 525 | - if ( empty( $fields ) ) { |
|
| 526 | - return $data; |
|
| 527 | - } |
|
| 528 | - |
|
| 529 | - foreach ( $data as $key => $value ) { |
|
| 530 | - |
|
| 531 | - // Numeric arrays. |
|
| 532 | - if ( is_numeric( $key ) && is_array( $value ) ) { |
|
| 533 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
| 534 | - continue; |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - // Generate a new prefix. |
|
| 538 | - $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
| 539 | - |
|
| 540 | - // Check if it was requested. |
|
| 541 | - if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
| 542 | - unset( $data[ $key ] ); |
|
| 543 | - continue; |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - if ( $key != 'meta_data' && is_array( $value ) ) { |
|
| 547 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
| 548 | - } |
|
| 549 | - |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - return $data; |
|
| 553 | - } |
|
| 554 | - |
|
| 555 | - /** |
|
| 556 | - * Given an array of fields to include in a response, some of which may be |
|
| 557 | - * `nested.fields`, determine whether the provided field should be included |
|
| 558 | - * in the response body. |
|
| 559 | - * |
|
| 560 | - * Copied from WordPress 5.3 to support old versions. |
|
| 561 | - * |
|
| 562 | - * @since 1.0.19 |
|
| 563 | - * |
|
| 564 | - * @param string $field A field to test for inclusion in the response body. |
|
| 565 | - * @param array $fields An array of string fields supported by the endpoint. |
|
| 566 | - * @return bool Whether to include the field or not. |
|
| 567 | - * @see rest_is_field_included() |
|
| 568 | - */ |
|
| 569 | - public function is_field_included( $field, $fields ) { |
|
| 570 | - if ( in_array( $field, $fields, true ) ) { |
|
| 571 | - return true; |
|
| 572 | - } |
|
| 573 | - |
|
| 574 | - foreach ( $fields as $accepted_field ) { |
|
| 575 | - // Check to see if $field is the parent of any item in $fields. |
|
| 576 | - // A field "parent" should be accepted if "parent.child" is accepted. |
|
| 577 | - if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
| 578 | - return true; |
|
| 579 | - } |
|
| 580 | - // Conversely, if "parent" is accepted, all "parent.child" fields |
|
| 581 | - // should also be accepted. |
|
| 582 | - if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
| 583 | - return true; |
|
| 584 | - } |
|
| 585 | - } |
|
| 586 | - |
|
| 587 | - return false; |
|
| 588 | - } |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + return $delete; |
|
| 298 | + |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * Bulk create, update and delete items. |
|
| 303 | + * |
|
| 304 | + * @param WP_REST_Request $request Full details about the request. |
|
| 305 | + * @return WP_Error|array. |
|
| 306 | + */ |
|
| 307 | + public function batch_items( $request ) { |
|
| 308 | + global $wp_rest_server; |
|
| 309 | + |
|
| 310 | + // Prepare the batch items. |
|
| 311 | + $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
| 312 | + |
|
| 313 | + // Ensure that the batch has not exceeded the limit to prevent abuse. |
|
| 314 | + $limit = $this->check_batch_limit( $items ); |
|
| 315 | + if ( is_wp_error( $limit ) ) { |
|
| 316 | + return $limit; |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + // Process the items. |
|
| 320 | + return array( |
|
| 321 | + 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
| 322 | + 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
| 323 | + 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
| 324 | + ); |
|
| 325 | + |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + /** |
|
| 329 | + * Add meta query. |
|
| 330 | + * |
|
| 331 | + * @since 1.0.19 |
|
| 332 | + * @param array $args Query args. |
|
| 333 | + * @param array $meta_query Meta query. |
|
| 334 | + * @return array |
|
| 335 | + */ |
|
| 336 | + protected function add_meta_query( $args, $meta_query ) { |
|
| 337 | + if ( empty( $args['meta_query'] ) ) { |
|
| 338 | + $args['meta_query'] = array(); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + $args['meta_query'][] = $meta_query; |
|
| 342 | + |
|
| 343 | + return $args['meta_query']; |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + /** |
|
| 347 | + * Get the batch schema, conforming to JSON Schema. |
|
| 348 | + * |
|
| 349 | + * @return array |
|
| 350 | + */ |
|
| 351 | + public function get_public_batch_schema() { |
|
| 352 | + |
|
| 353 | + return array( |
|
| 354 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 355 | + 'title' => 'batch', |
|
| 356 | + 'type' => 'object', |
|
| 357 | + 'properties' => array( |
|
| 358 | + 'create' => array( |
|
| 359 | + 'description' => __( 'List of created resources.', 'invoicing' ), |
|
| 360 | + 'type' => 'array', |
|
| 361 | + 'context' => array( 'view', 'edit' ), |
|
| 362 | + 'items' => array( |
|
| 363 | + 'type' => 'object', |
|
| 364 | + ), |
|
| 365 | + ), |
|
| 366 | + 'update' => array( |
|
| 367 | + 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
| 368 | + 'type' => 'array', |
|
| 369 | + 'context' => array( 'view', 'edit' ), |
|
| 370 | + 'items' => array( |
|
| 371 | + 'type' => 'object', |
|
| 372 | + ), |
|
| 373 | + ), |
|
| 374 | + 'delete' => array( |
|
| 375 | + 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
| 376 | + 'type' => 'array', |
|
| 377 | + 'context' => array( 'view', 'edit' ), |
|
| 378 | + 'items' => array( |
|
| 379 | + 'type' => 'integer', |
|
| 380 | + ), |
|
| 381 | + ), |
|
| 382 | + ), |
|
| 383 | + ); |
|
| 384 | + |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Returns the value of schema['properties'] |
|
| 389 | + * |
|
| 390 | + * i.e Schema fields. |
|
| 391 | + * |
|
| 392 | + * @since 1.0.19 |
|
| 393 | + * @return array |
|
| 394 | + */ |
|
| 395 | + protected function get_schema_properties() { |
|
| 396 | + |
|
| 397 | + $schema = $this->get_item_schema(); |
|
| 398 | + $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
| 399 | + |
|
| 400 | + // For back-compat, include any field with an empty schema |
|
| 401 | + // because it won't be present in $this->get_item_schema(). |
|
| 402 | + foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
| 403 | + if ( is_null( $field_options['schema'] ) ) { |
|
| 404 | + $properties[ $field_name ] = $field_options; |
|
| 405 | + } |
|
| 406 | + } |
|
| 407 | + |
|
| 408 | + return $properties; |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + /** |
|
| 412 | + * Filters fields by context. |
|
| 413 | + * |
|
| 414 | + * @param array $fields Array of fields |
|
| 415 | + * @param string|null context view, edit or embed |
|
| 416 | + * @since 1.0.19 |
|
| 417 | + * @return array |
|
| 418 | + */ |
|
| 419 | + protected function filter_response_fields_by_context( $fields, $context ) { |
|
| 420 | + |
|
| 421 | + if ( empty( $context ) ) { |
|
| 422 | + return $fields; |
|
| 423 | + } |
|
| 424 | + |
|
| 425 | + foreach ( $fields as $name => $options ) { |
|
| 426 | + if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
| 427 | + unset( $fields[ $name ] ); |
|
| 428 | + } |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + return $fields; |
|
| 432 | + |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + /** |
|
| 436 | + * Filters fields by an array of requested fields. |
|
| 437 | + * |
|
| 438 | + * @param array $fields Array of available fields |
|
| 439 | + * @param array $requested array of requested fields. |
|
| 440 | + * @since 1.0.19 |
|
| 441 | + * @return array |
|
| 442 | + */ |
|
| 443 | + protected function filter_response_fields_by_array( $fields, $requested ) { |
|
| 444 | + |
|
| 445 | + // Trim off any whitespace from the list array. |
|
| 446 | + $requested = array_map( 'trim', $requested ); |
|
| 447 | + |
|
| 448 | + // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
|
| 449 | + if ( in_array( 'id', $fields, true ) ) { |
|
| 450 | + $requested[] = 'id'; |
|
| 451 | + } |
|
| 452 | + |
|
| 453 | + // Get rid of duplicate fields. |
|
| 454 | + $requested = array_unique( $requested ); |
|
| 455 | + |
|
| 456 | + // Return the list of all included fields which are available. |
|
| 457 | + return array_reduce( |
|
| 458 | + $requested, |
|
| 459 | + function( $response_fields, $field ) use ( $fields ) { |
|
| 460 | + |
|
| 461 | + if ( in_array( $field, $fields, true ) ) { |
|
| 462 | + $response_fields[] = $field; |
|
| 463 | + return $response_fields; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + // Check for nested fields if $field is not a direct match. |
|
| 467 | + $nested_fields = explode( '.', $field ); |
|
| 468 | + |
|
| 469 | + // A nested field is included so long as its top-level property is |
|
| 470 | + // present in the schema. |
|
| 471 | + if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
| 472 | + $response_fields[] = $field; |
|
| 473 | + } |
|
| 474 | + |
|
| 475 | + return $response_fields; |
|
| 476 | + }, |
|
| 477 | + array() |
|
| 478 | + ); |
|
| 479 | + |
|
| 480 | + } |
|
| 481 | + |
|
| 482 | + /** |
|
| 483 | + * Gets an array of fields to be included on the response. |
|
| 484 | + * |
|
| 485 | + * Included fields are based on item schema and `_fields=` request argument. |
|
| 486 | + * Copied from WordPress 5.3 to support old versions. |
|
| 487 | + * |
|
| 488 | + * @since 1.0.19 |
|
| 489 | + * @param WP_REST_Request $request Full details about the request. |
|
| 490 | + * @return array Fields to be included in the response. |
|
| 491 | + */ |
|
| 492 | + public function get_fields_for_response( $request ) { |
|
| 493 | + |
|
| 494 | + // Retrieve fields in the schema. |
|
| 495 | + $properties = $this->get_schema_properties(); |
|
| 496 | + |
|
| 497 | + // Exclude fields that specify a different context than the request context. |
|
| 498 | + $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
| 499 | + |
|
| 500 | + // We only need the field keys. |
|
| 501 | + $fields = array_keys( $properties ); |
|
| 502 | + |
|
| 503 | + // Is the user filtering the response fields?? |
|
| 504 | + if ( empty( $request['_fields'] ) ) { |
|
| 505 | + return $fields; |
|
| 506 | + } |
|
| 507 | + |
|
| 508 | + return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
| 509 | + |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + /** |
|
| 513 | + * Limits an object to the requested fields. |
|
| 514 | + * |
|
| 515 | + * Included fields are based on the `_fields` request argument. |
|
| 516 | + * |
|
| 517 | + * @since 1.0.19 |
|
| 518 | + * @param array $data Fields to include in the response. |
|
| 519 | + * @param array $fields Requested fields. |
|
| 520 | + * @return array Fields to be included in the response. |
|
| 521 | + */ |
|
| 522 | + public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
| 523 | + |
|
| 524 | + // Is the user filtering the response fields?? |
|
| 525 | + if ( empty( $fields ) ) { |
|
| 526 | + return $data; |
|
| 527 | + } |
|
| 528 | + |
|
| 529 | + foreach ( $data as $key => $value ) { |
|
| 530 | + |
|
| 531 | + // Numeric arrays. |
|
| 532 | + if ( is_numeric( $key ) && is_array( $value ) ) { |
|
| 533 | + $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
| 534 | + continue; |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + // Generate a new prefix. |
|
| 538 | + $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
| 539 | + |
|
| 540 | + // Check if it was requested. |
|
| 541 | + if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
| 542 | + unset( $data[ $key ] ); |
|
| 543 | + continue; |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + if ( $key != 'meta_data' && is_array( $value ) ) { |
|
| 547 | + $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
| 548 | + } |
|
| 549 | + |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + return $data; |
|
| 553 | + } |
|
| 554 | + |
|
| 555 | + /** |
|
| 556 | + * Given an array of fields to include in a response, some of which may be |
|
| 557 | + * `nested.fields`, determine whether the provided field should be included |
|
| 558 | + * in the response body. |
|
| 559 | + * |
|
| 560 | + * Copied from WordPress 5.3 to support old versions. |
|
| 561 | + * |
|
| 562 | + * @since 1.0.19 |
|
| 563 | + * |
|
| 564 | + * @param string $field A field to test for inclusion in the response body. |
|
| 565 | + * @param array $fields An array of string fields supported by the endpoint. |
|
| 566 | + * @return bool Whether to include the field or not. |
|
| 567 | + * @see rest_is_field_included() |
|
| 568 | + */ |
|
| 569 | + public function is_field_included( $field, $fields ) { |
|
| 570 | + if ( in_array( $field, $fields, true ) ) { |
|
| 571 | + return true; |
|
| 572 | + } |
|
| 573 | + |
|
| 574 | + foreach ( $fields as $accepted_field ) { |
|
| 575 | + // Check to see if $field is the parent of any item in $fields. |
|
| 576 | + // A field "parent" should be accepted if "parent.child" is accepted. |
|
| 577 | + if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
| 578 | + return true; |
|
| 579 | + } |
|
| 580 | + // Conversely, if "parent" is accepted, all "parent.child" fields |
|
| 581 | + // should also be accepted. |
|
| 582 | + if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
| 583 | + return true; |
|
| 584 | + } |
|
| 585 | + } |
|
| 586 | + |
|
| 587 | + return false; |
|
| 588 | + } |
|
| 589 | 589 | |
| 590 | 590 | } |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * @version 1.0.19 |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | -defined( 'ABSPATH' ) || exit; |
|
| 11 | +defined('ABSPATH') || exit; |
|
| 12 | 12 | |
| 13 | 13 | /** |
| 14 | 14 | * Core class to access posts via the REST API. |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | ); |
| 65 | 65 | |
| 66 | 66 | // Register REST routes. |
| 67 | - add_action( 'rest_api_init', array( $this, 'register_routes' ) ); |
|
| 67 | + add_action('rest_api_init', array($this, 'register_routes')); |
|
| 68 | 68 | |
| 69 | 69 | } |
| 70 | 70 | |
@@ -76,8 +76,8 @@ discard block |
||
| 76 | 76 | */ |
| 77 | 77 | public function register_routes() { |
| 78 | 78 | |
| 79 | - foreach ( $this->namespaces as $namespace ) { |
|
| 80 | - $this->register_namespace_routes( $namespace ); |
|
| 79 | + foreach ($this->namespaces as $namespace) { |
|
| 80 | + $this->register_namespace_routes($namespace); |
|
| 81 | 81 | } |
| 82 | 82 | |
| 83 | 83 | } |
@@ -89,12 +89,12 @@ discard block |
||
| 89 | 89 | * |
| 90 | 90 | * @param string $namespace |
| 91 | 91 | */ |
| 92 | - public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
| 92 | + public function register_namespace_routes(/** @scrutinizer ignore-unused */ $namespace) { |
|
| 93 | 93 | |
| 94 | 94 | getpaid_doing_it_wrong( |
| 95 | - __CLASS__ . '::' .__METHOD__, |
|
| 95 | + __CLASS__ . '::' . __METHOD__, |
|
| 96 | 96 | /* translators: %s: register_namespace_routes() */ |
| 97 | - sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
| 97 | + sprintf(__("Method '%s' must be overridden."), __METHOD__), |
|
| 98 | 98 | '1.0.19' |
| 99 | 99 | ); |
| 100 | 100 | |
@@ -106,7 +106,7 @@ discard block |
||
| 106 | 106 | * @return string |
| 107 | 107 | */ |
| 108 | 108 | protected function get_normalized_rest_base() { |
| 109 | - return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
| 109 | + return preg_replace('/\(.*\)\//i', '', $this->rest_base); |
|
| 110 | 110 | } |
| 111 | 111 | |
| 112 | 112 | /** |
@@ -115,11 +115,11 @@ discard block |
||
| 115 | 115 | * @param array array of request items. |
| 116 | 116 | * @return array |
| 117 | 117 | */ |
| 118 | - protected function fill_batch_keys( $items ) { |
|
| 118 | + protected function fill_batch_keys($items) { |
|
| 119 | 119 | |
| 120 | - $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
| 121 | - $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
| 122 | - $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
| 120 | + $items['create'] = empty($items['create']) ? array() : $items['create']; |
|
| 121 | + $items['update'] = empty($items['update']) ? array() : $items['update']; |
|
| 122 | + $items['delete'] = empty($items['delete']) ? array() : wp_parse_id_list($items['delete']); |
|
| 123 | 123 | return $items; |
| 124 | 124 | |
| 125 | 125 | } |
@@ -130,13 +130,13 @@ discard block |
||
| 130 | 130 | * @param array $items Request items. |
| 131 | 131 | * @return bool|WP_Error |
| 132 | 132 | */ |
| 133 | - protected function check_batch_limit( $items ) { |
|
| 134 | - $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
| 135 | - $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
| 133 | + protected function check_batch_limit($items) { |
|
| 134 | + $limit = apply_filters('getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base()); |
|
| 135 | + $total = count($items['create']) + count($items['update']) + count($items['delete']); |
|
| 136 | 136 | |
| 137 | - if ( $total > $limit ) { |
|
| 137 | + if ($total > $limit) { |
|
| 138 | 138 | /* translators: %s: items limit */ |
| 139 | - return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
| 139 | + return new WP_Error('getpaid_rest_request_entity_too_large', sprintf(__('Unable to accept more than %s items for this request.', 'invoicing'), $limit), array('status' => 413)); |
|
| 140 | 140 | } |
| 141 | 141 | |
| 142 | 142 | return true; |
@@ -150,37 +150,37 @@ discard block |
||
| 150 | 150 | * @param WP_REST_Server $wp_rest_server |
| 151 | 151 | * @return array() |
| 152 | 152 | */ |
| 153 | - protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
| 153 | + protected function batch_create_items($items, $request, $wp_rest_server) { |
|
| 154 | 154 | |
| 155 | 155 | $query = $request->get_query_params(); |
| 156 | 156 | $create = array(); |
| 157 | 157 | |
| 158 | - foreach ( $items as $item ) { |
|
| 159 | - $_item = new WP_REST_Request( 'POST' ); |
|
| 158 | + foreach ($items as $item) { |
|
| 159 | + $_item = new WP_REST_Request('POST'); |
|
| 160 | 160 | |
| 161 | 161 | // Default parameters. |
| 162 | 162 | $defaults = array(); |
| 163 | 163 | $schema = $this->get_public_item_schema(); |
| 164 | - foreach ( $schema['properties'] as $arg => $options ) { |
|
| 165 | - if ( isset( $options['default'] ) ) { |
|
| 166 | - $defaults[ $arg ] = $options['default']; |
|
| 164 | + foreach ($schema['properties'] as $arg => $options) { |
|
| 165 | + if (isset($options['default'])) { |
|
| 166 | + $defaults[$arg] = $options['default']; |
|
| 167 | 167 | } |
| 168 | 168 | } |
| 169 | - $_item->set_default_params( $defaults ); |
|
| 169 | + $_item->set_default_params($defaults); |
|
| 170 | 170 | |
| 171 | 171 | // Set request parameters. |
| 172 | - $_item->set_body_params( $item ); |
|
| 172 | + $_item->set_body_params($item); |
|
| 173 | 173 | |
| 174 | 174 | // Set query (GET) parameters. |
| 175 | - $_item->set_query_params( $query ); |
|
| 175 | + $_item->set_query_params($query); |
|
| 176 | 176 | |
| 177 | 177 | // Create the item. |
| 178 | - $_response = $this->create_item( $_item ); |
|
| 178 | + $_response = $this->create_item($_item); |
|
| 179 | 179 | |
| 180 | 180 | // If an error occured... |
| 181 | - if ( is_wp_error( $_response ) ) { |
|
| 181 | + if (is_wp_error($_response)) { |
|
| 182 | 182 | |
| 183 | - $create[] = array( |
|
| 183 | + $create[] = array( |
|
| 184 | 184 | 'id' => 0, |
| 185 | 185 | 'error' => array( |
| 186 | 186 | 'code' => $_response->get_error_code(), |
@@ -192,7 +192,7 @@ discard block |
||
| 192 | 192 | continue; |
| 193 | 193 | } |
| 194 | 194 | |
| 195 | - $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 195 | + $create[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false); |
|
| 196 | 196 | |
| 197 | 197 | } |
| 198 | 198 | |
@@ -208,27 +208,27 @@ discard block |
||
| 208 | 208 | * @param WP_REST_Server $wp_rest_server |
| 209 | 209 | * @return array() |
| 210 | 210 | */ |
| 211 | - protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
| 211 | + protected function batch_update_items($items, $request, $wp_rest_server) { |
|
| 212 | 212 | |
| 213 | 213 | $query = $request->get_query_params(); |
| 214 | 214 | $update = array(); |
| 215 | 215 | |
| 216 | - foreach ( $items as $item ) { |
|
| 216 | + foreach ($items as $item) { |
|
| 217 | 217 | |
| 218 | 218 | // Create a dummy request. |
| 219 | - $_item = new WP_REST_Request( 'PUT' ); |
|
| 219 | + $_item = new WP_REST_Request('PUT'); |
|
| 220 | 220 | |
| 221 | 221 | // Add body params. |
| 222 | - $_item->set_body_params( $item ); |
|
| 222 | + $_item->set_body_params($item); |
|
| 223 | 223 | |
| 224 | 224 | // Set query (GET) parameters. |
| 225 | - $_item->set_query_params( $query ); |
|
| 225 | + $_item->set_query_params($query); |
|
| 226 | 226 | |
| 227 | 227 | // Update the item. |
| 228 | - $_response = $this->update_item( $_item ); |
|
| 228 | + $_response = $this->update_item($_item); |
|
| 229 | 229 | |
| 230 | 230 | // If an error occured... |
| 231 | - if ( is_wp_error( $_response ) ) { |
|
| 231 | + if (is_wp_error($_response)) { |
|
| 232 | 232 | |
| 233 | 233 | $update[] = array( |
| 234 | 234 | 'id' => $item['id'], |
@@ -243,7 +243,7 @@ discard block |
||
| 243 | 243 | |
| 244 | 244 | } |
| 245 | 245 | |
| 246 | - $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 246 | + $update[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false); |
|
| 247 | 247 | |
| 248 | 248 | } |
| 249 | 249 | |
@@ -258,14 +258,14 @@ discard block |
||
| 258 | 258 | * @param WP_REST_Server $wp_rest_server |
| 259 | 259 | * @return array() |
| 260 | 260 | */ |
| 261 | - protected function batch_delete_items( $items, $wp_rest_server ) { |
|
| 261 | + protected function batch_delete_items($items, $wp_rest_server) { |
|
| 262 | 262 | |
| 263 | 263 | $delete = array(); |
| 264 | 264 | |
| 265 | - foreach ( array_filter( $items ) as $id ) { |
|
| 265 | + foreach (array_filter($items) as $id) { |
|
| 266 | 266 | |
| 267 | 267 | // Prepare the request. |
| 268 | - $_item = new WP_REST_Request( 'DELETE' ); |
|
| 268 | + $_item = new WP_REST_Request('DELETE'); |
|
| 269 | 269 | $_item->set_query_params( |
| 270 | 270 | array( |
| 271 | 271 | 'id' => $id, |
@@ -274,9 +274,9 @@ discard block |
||
| 274 | 274 | ); |
| 275 | 275 | |
| 276 | 276 | // Delete the item. |
| 277 | - $_response = $this->delete_item( $_item ); |
|
| 277 | + $_response = $this->delete_item($_item); |
|
| 278 | 278 | |
| 279 | - if ( is_wp_error( $_response ) ) { |
|
| 279 | + if (is_wp_error($_response)) { |
|
| 280 | 280 | |
| 281 | 281 | $delete[] = array( |
| 282 | 282 | 'id' => $id, |
@@ -290,7 +290,7 @@ discard block |
||
| 290 | 290 | continue; |
| 291 | 291 | } |
| 292 | 292 | |
| 293 | - $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 293 | + $delete[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false); |
|
| 294 | 294 | |
| 295 | 295 | } |
| 296 | 296 | |
@@ -304,23 +304,23 @@ discard block |
||
| 304 | 304 | * @param WP_REST_Request $request Full details about the request. |
| 305 | 305 | * @return WP_Error|array. |
| 306 | 306 | */ |
| 307 | - public function batch_items( $request ) { |
|
| 307 | + public function batch_items($request) { |
|
| 308 | 308 | global $wp_rest_server; |
| 309 | 309 | |
| 310 | 310 | // Prepare the batch items. |
| 311 | - $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
| 311 | + $items = $this->fill_batch_keys(array_filter($request->get_params())); |
|
| 312 | 312 | |
| 313 | 313 | // Ensure that the batch has not exceeded the limit to prevent abuse. |
| 314 | - $limit = $this->check_batch_limit( $items ); |
|
| 315 | - if ( is_wp_error( $limit ) ) { |
|
| 314 | + $limit = $this->check_batch_limit($items); |
|
| 315 | + if (is_wp_error($limit)) { |
|
| 316 | 316 | return $limit; |
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | // Process the items. |
| 320 | 320 | return array( |
| 321 | - 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
| 322 | - 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
| 323 | - 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
| 321 | + 'create' => $this->batch_create_items($items['create'], $request, $wp_rest_server), |
|
| 322 | + 'update' => $this->batch_update_items($items['update'], $request, $wp_rest_server), |
|
| 323 | + 'delete' => $this->batch_delete_items($items['delete'], $wp_rest_server), |
|
| 324 | 324 | ); |
| 325 | 325 | |
| 326 | 326 | } |
@@ -333,8 +333,8 @@ discard block |
||
| 333 | 333 | * @param array $meta_query Meta query. |
| 334 | 334 | * @return array |
| 335 | 335 | */ |
| 336 | - protected function add_meta_query( $args, $meta_query ) { |
|
| 337 | - if ( empty( $args['meta_query'] ) ) { |
|
| 336 | + protected function add_meta_query($args, $meta_query) { |
|
| 337 | + if (empty($args['meta_query'])) { |
|
| 338 | 338 | $args['meta_query'] = array(); |
| 339 | 339 | } |
| 340 | 340 | |
@@ -356,25 +356,25 @@ discard block |
||
| 356 | 356 | 'type' => 'object', |
| 357 | 357 | 'properties' => array( |
| 358 | 358 | 'create' => array( |
| 359 | - 'description' => __( 'List of created resources.', 'invoicing' ), |
|
| 359 | + 'description' => __('List of created resources.', 'invoicing'), |
|
| 360 | 360 | 'type' => 'array', |
| 361 | - 'context' => array( 'view', 'edit' ), |
|
| 361 | + 'context' => array('view', 'edit'), |
|
| 362 | 362 | 'items' => array( |
| 363 | 363 | 'type' => 'object', |
| 364 | 364 | ), |
| 365 | 365 | ), |
| 366 | 366 | 'update' => array( |
| 367 | - 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
| 367 | + 'description' => __('List of updated resources.', 'invoicing'), |
|
| 368 | 368 | 'type' => 'array', |
| 369 | - 'context' => array( 'view', 'edit' ), |
|
| 369 | + 'context' => array('view', 'edit'), |
|
| 370 | 370 | 'items' => array( |
| 371 | 371 | 'type' => 'object', |
| 372 | 372 | ), |
| 373 | 373 | ), |
| 374 | 374 | 'delete' => array( |
| 375 | - 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
| 375 | + 'description' => __('List of deleted resources.', 'invoicing'), |
|
| 376 | 376 | 'type' => 'array', |
| 377 | - 'context' => array( 'view', 'edit' ), |
|
| 377 | + 'context' => array('view', 'edit'), |
|
| 378 | 378 | 'items' => array( |
| 379 | 379 | 'type' => 'integer', |
| 380 | 380 | ), |
@@ -395,13 +395,13 @@ discard block |
||
| 395 | 395 | protected function get_schema_properties() { |
| 396 | 396 | |
| 397 | 397 | $schema = $this->get_item_schema(); |
| 398 | - $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
| 398 | + $properties = isset($schema['properties']) ? $schema['properties'] : array(); |
|
| 399 | 399 | |
| 400 | 400 | // For back-compat, include any field with an empty schema |
| 401 | 401 | // because it won't be present in $this->get_item_schema(). |
| 402 | - foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
| 403 | - if ( is_null( $field_options['schema'] ) ) { |
|
| 404 | - $properties[ $field_name ] = $field_options; |
|
| 402 | + foreach ($this->get_additional_fields() as $field_name => $field_options) { |
|
| 403 | + if (is_null($field_options['schema'])) { |
|
| 404 | + $properties[$field_name] = $field_options; |
|
| 405 | 405 | } |
| 406 | 406 | } |
| 407 | 407 | |
@@ -416,15 +416,15 @@ discard block |
||
| 416 | 416 | * @since 1.0.19 |
| 417 | 417 | * @return array |
| 418 | 418 | */ |
| 419 | - protected function filter_response_fields_by_context( $fields, $context ) { |
|
| 419 | + protected function filter_response_fields_by_context($fields, $context) { |
|
| 420 | 420 | |
| 421 | - if ( empty( $context ) ) { |
|
| 421 | + if (empty($context)) { |
|
| 422 | 422 | return $fields; |
| 423 | 423 | } |
| 424 | 424 | |
| 425 | - foreach ( $fields as $name => $options ) { |
|
| 426 | - if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
| 427 | - unset( $fields[ $name ] ); |
|
| 425 | + foreach ($fields as $name => $options) { |
|
| 426 | + if (!empty($options['context']) && !in_array($context, $options['context'], true)) { |
|
| 427 | + unset($fields[$name]); |
|
| 428 | 428 | } |
| 429 | 429 | } |
| 430 | 430 | |
@@ -440,35 +440,35 @@ discard block |
||
| 440 | 440 | * @since 1.0.19 |
| 441 | 441 | * @return array |
| 442 | 442 | */ |
| 443 | - protected function filter_response_fields_by_array( $fields, $requested ) { |
|
| 443 | + protected function filter_response_fields_by_array($fields, $requested) { |
|
| 444 | 444 | |
| 445 | 445 | // Trim off any whitespace from the list array. |
| 446 | - $requested = array_map( 'trim', $requested ); |
|
| 446 | + $requested = array_map('trim', $requested); |
|
| 447 | 447 | |
| 448 | 448 | // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
| 449 | - if ( in_array( 'id', $fields, true ) ) { |
|
| 449 | + if (in_array('id', $fields, true)) { |
|
| 450 | 450 | $requested[] = 'id'; |
| 451 | 451 | } |
| 452 | 452 | |
| 453 | 453 | // Get rid of duplicate fields. |
| 454 | - $requested = array_unique( $requested ); |
|
| 454 | + $requested = array_unique($requested); |
|
| 455 | 455 | |
| 456 | 456 | // Return the list of all included fields which are available. |
| 457 | 457 | return array_reduce( |
| 458 | 458 | $requested, |
| 459 | - function( $response_fields, $field ) use ( $fields ) { |
|
| 459 | + function($response_fields, $field) use ($fields) { |
|
| 460 | 460 | |
| 461 | - if ( in_array( $field, $fields, true ) ) { |
|
| 461 | + if (in_array($field, $fields, true)) { |
|
| 462 | 462 | $response_fields[] = $field; |
| 463 | 463 | return $response_fields; |
| 464 | 464 | } |
| 465 | 465 | |
| 466 | 466 | // Check for nested fields if $field is not a direct match. |
| 467 | - $nested_fields = explode( '.', $field ); |
|
| 467 | + $nested_fields = explode('.', $field); |
|
| 468 | 468 | |
| 469 | 469 | // A nested field is included so long as its top-level property is |
| 470 | 470 | // present in the schema. |
| 471 | - if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
| 471 | + if (in_array($nested_fields[0], $fields, true)) { |
|
| 472 | 472 | $response_fields[] = $field; |
| 473 | 473 | } |
| 474 | 474 | |
@@ -489,23 +489,23 @@ discard block |
||
| 489 | 489 | * @param WP_REST_Request $request Full details about the request. |
| 490 | 490 | * @return array Fields to be included in the response. |
| 491 | 491 | */ |
| 492 | - public function get_fields_for_response( $request ) { |
|
| 492 | + public function get_fields_for_response($request) { |
|
| 493 | 493 | |
| 494 | 494 | // Retrieve fields in the schema. |
| 495 | 495 | $properties = $this->get_schema_properties(); |
| 496 | 496 | |
| 497 | 497 | // Exclude fields that specify a different context than the request context. |
| 498 | - $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
| 498 | + $properties = $this->filter_response_fields_by_context($properties, $request['context']); |
|
| 499 | 499 | |
| 500 | 500 | // We only need the field keys. |
| 501 | - $fields = array_keys( $properties ); |
|
| 501 | + $fields = array_keys($properties); |
|
| 502 | 502 | |
| 503 | 503 | // Is the user filtering the response fields?? |
| 504 | - if ( empty( $request['_fields'] ) ) { |
|
| 504 | + if (empty($request['_fields'])) { |
|
| 505 | 505 | return $fields; |
| 506 | 506 | } |
| 507 | 507 | |
| 508 | - return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
| 508 | + return $this->filter_response_fields_by_array($fields, wpinv_parse_list($request['_fields'])); |
|
| 509 | 509 | |
| 510 | 510 | } |
| 511 | 511 | |
@@ -519,32 +519,32 @@ discard block |
||
| 519 | 519 | * @param array $fields Requested fields. |
| 520 | 520 | * @return array Fields to be included in the response. |
| 521 | 521 | */ |
| 522 | - public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
| 522 | + public function limit_object_to_requested_fields($data, $fields, $prefix = '') { |
|
| 523 | 523 | |
| 524 | 524 | // Is the user filtering the response fields?? |
| 525 | - if ( empty( $fields ) ) { |
|
| 525 | + if (empty($fields)) { |
|
| 526 | 526 | return $data; |
| 527 | 527 | } |
| 528 | 528 | |
| 529 | - foreach ( $data as $key => $value ) { |
|
| 529 | + foreach ($data as $key => $value) { |
|
| 530 | 530 | |
| 531 | 531 | // Numeric arrays. |
| 532 | - if ( is_numeric( $key ) && is_array( $value ) ) { |
|
| 533 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
| 532 | + if (is_numeric($key) && is_array($value)) { |
|
| 533 | + $data[$key] = $this->limit_object_to_requested_fields($value, $fields, $prefix); |
|
| 534 | 534 | continue; |
| 535 | 535 | } |
| 536 | 536 | |
| 537 | 537 | // Generate a new prefix. |
| 538 | - $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
| 538 | + $new_prefix = empty($prefix) ? $key : "$prefix.$key"; |
|
| 539 | 539 | |
| 540 | 540 | // Check if it was requested. |
| 541 | - if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
| 542 | - unset( $data[ $key ] ); |
|
| 541 | + if (!empty($key) && !$this->is_field_included($new_prefix, $fields)) { |
|
| 542 | + unset($data[$key]); |
|
| 543 | 543 | continue; |
| 544 | 544 | } |
| 545 | 545 | |
| 546 | - if ( $key != 'meta_data' && is_array( $value ) ) { |
|
| 547 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
| 546 | + if ($key != 'meta_data' && is_array($value)) { |
|
| 547 | + $data[$key] = $this->limit_object_to_requested_fields($value, $fields, $new_prefix); |
|
| 548 | 548 | } |
| 549 | 549 | |
| 550 | 550 | } |
@@ -566,20 +566,20 @@ discard block |
||
| 566 | 566 | * @return bool Whether to include the field or not. |
| 567 | 567 | * @see rest_is_field_included() |
| 568 | 568 | */ |
| 569 | - public function is_field_included( $field, $fields ) { |
|
| 570 | - if ( in_array( $field, $fields, true ) ) { |
|
| 569 | + public function is_field_included($field, $fields) { |
|
| 570 | + if (in_array($field, $fields, true)) { |
|
| 571 | 571 | return true; |
| 572 | 572 | } |
| 573 | 573 | |
| 574 | - foreach ( $fields as $accepted_field ) { |
|
| 574 | + foreach ($fields as $accepted_field) { |
|
| 575 | 575 | // Check to see if $field is the parent of any item in $fields. |
| 576 | 576 | // A field "parent" should be accepted if "parent.child" is accepted. |
| 577 | - if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
| 577 | + if (strpos($accepted_field, "$field.") === 0) { |
|
| 578 | 578 | return true; |
| 579 | 579 | } |
| 580 | 580 | // Conversely, if "parent" is accepted, all "parent.child" fields |
| 581 | 581 | // should also be accepted. |
| 582 | - if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
| 582 | + if (strpos($field, "$accepted_field.") === 0) { |
|
| 583 | 583 | return true; |
| 584 | 584 | } |
| 585 | 585 | } |
@@ -18,628 +18,628 @@ |
||
| 18 | 18 | class GetPaid_REST_Posts_Controller extends GetPaid_REST_CRUD_Controller { |
| 19 | 19 | |
| 20 | 20 | /** |
| 21 | - * Post type. |
|
| 22 | - * |
|
| 23 | - * @var string |
|
| 24 | - */ |
|
| 25 | - protected $post_type; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * Controls visibility on frontend. |
|
| 29 | - * |
|
| 30 | - * @var string |
|
| 31 | - */ |
|
| 32 | - public $public = false; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * Registers the routes for the objects of the controller. |
|
| 36 | - * |
|
| 37 | - * @since 1.0.19 |
|
| 38 | - * |
|
| 39 | - * @see register_rest_route() |
|
| 40 | - */ |
|
| 41 | - public function register_namespace_routes( $namespace ) { |
|
| 42 | - |
|
| 43 | - parent::register_namespace_routes( $namespace ); |
|
| 44 | - |
|
| 45 | - register_rest_route( |
|
| 46 | - $namespace, |
|
| 47 | - '/' . $this->rest_base . '/batch', |
|
| 48 | - array( |
|
| 49 | - array( |
|
| 50 | - 'methods' => WP_REST_Server::EDITABLE, |
|
| 51 | - 'callback' => array( $this, 'batch_items' ), |
|
| 52 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 53 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 54 | - ), |
|
| 55 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 56 | - ) |
|
| 57 | - ); |
|
| 58 | - |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Check permissions of items on REST API. |
|
| 63 | - * |
|
| 64 | - * @since 1.0.19 |
|
| 65 | - * @param string $context Request context. |
|
| 66 | - * @param int $object_id Post ID. |
|
| 67 | - * @return bool |
|
| 68 | - */ |
|
| 69 | - public function check_post_permissions( $context = 'read', $object_id = 0 ) { |
|
| 70 | - |
|
| 71 | - $contexts = array( |
|
| 72 | - 'read' => 'read_private_posts', |
|
| 73 | - 'create' => 'publish_posts', |
|
| 74 | - 'edit' => 'edit_post', |
|
| 75 | - 'delete' => 'delete_post', |
|
| 76 | - 'batch' => 'edit_others_posts', |
|
| 77 | - ); |
|
| 78 | - |
|
| 79 | - $cap = $contexts[ $context ]; |
|
| 80 | - $post_type_object = get_post_type_object( $this->post_type ); |
|
| 81 | - $permission = current_user_can( $post_type_object->cap->$cap, $object_id ); |
|
| 82 | - |
|
| 83 | - return apply_filters( 'getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type ); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Check if a given request has access to read items. |
|
| 88 | - * |
|
| 89 | - * @param WP_REST_Request $request Full details about the request. |
|
| 90 | - * @return WP_Error|boolean |
|
| 91 | - */ |
|
| 92 | - public function get_items_permissions_check( $request ) { |
|
| 93 | - return $this->check_post_permissions() ? true : new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * Check if a given request has access to create an item. |
|
| 98 | - * |
|
| 99 | - * @param WP_REST_Request $request Full details about the request. |
|
| 100 | - * @return WP_Error|boolean |
|
| 101 | - */ |
|
| 102 | - public function create_item_permissions_check( $request ) { |
|
| 103 | - 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() ) ); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Check if a given request has access to read an item. |
|
| 108 | - * |
|
| 109 | - * @param WP_REST_Request $request Full details about the request. |
|
| 110 | - * @return WP_Error|boolean |
|
| 111 | - */ |
|
| 112 | - public function get_item_permissions_check( $request ) { |
|
| 113 | - $post = get_post( (int) $request['id'] ); |
|
| 114 | - |
|
| 115 | - if ( $post && ! $this->check_post_permissions( 'read', $post->ID ) ) { |
|
| 116 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - return true; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Check if a given request has access to update an item. |
|
| 124 | - * |
|
| 125 | - * @param WP_REST_Request $request Full details about the request. |
|
| 126 | - * @return WP_Error|boolean |
|
| 127 | - */ |
|
| 128 | - public function update_item_permissions_check( $request ) { |
|
| 129 | - $post = get_post( (int) $request['id'] ); |
|
| 130 | - |
|
| 131 | - if ( $post && ! $this->check_post_permissions( 'edit', $post->ID ) ) { |
|
| 132 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - return true; |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * Check if a given request has access to delete an item. |
|
| 140 | - * |
|
| 141 | - * @param WP_REST_Request $request Full details about the request. |
|
| 142 | - * @return bool|WP_Error |
|
| 143 | - */ |
|
| 144 | - public function delete_item_permissions_check( $request ) { |
|
| 145 | - $post = get_post( (int) $request['id'] ); |
|
| 146 | - |
|
| 147 | - if ( $post && ! $this->check_post_permissions( 'delete', $post->ID ) ) { |
|
| 148 | - return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - return true; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Check if a given request has access batch create, update and delete items. |
|
| 156 | - * |
|
| 157 | - * @param WP_REST_Request $request Full details about the request. |
|
| 158 | - * |
|
| 159 | - * @return boolean|WP_Error |
|
| 160 | - */ |
|
| 161 | - public function batch_items_permissions_check( $request ) { |
|
| 162 | - 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() ) ); |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * @deprecated |
|
| 167 | - */ |
|
| 168 | - public function get_post( $object_id ) { |
|
| 169 | - return $this->get_object( $object_id ); |
|
| 21 | + * Post type. |
|
| 22 | + * |
|
| 23 | + * @var string |
|
| 24 | + */ |
|
| 25 | + protected $post_type; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Controls visibility on frontend. |
|
| 29 | + * |
|
| 30 | + * @var string |
|
| 31 | + */ |
|
| 32 | + public $public = false; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * Registers the routes for the objects of the controller. |
|
| 36 | + * |
|
| 37 | + * @since 1.0.19 |
|
| 38 | + * |
|
| 39 | + * @see register_rest_route() |
|
| 40 | + */ |
|
| 41 | + public function register_namespace_routes( $namespace ) { |
|
| 42 | + |
|
| 43 | + parent::register_namespace_routes( $namespace ); |
|
| 44 | + |
|
| 45 | + register_rest_route( |
|
| 46 | + $namespace, |
|
| 47 | + '/' . $this->rest_base . '/batch', |
|
| 48 | + array( |
|
| 49 | + array( |
|
| 50 | + 'methods' => WP_REST_Server::EDITABLE, |
|
| 51 | + 'callback' => array( $this, 'batch_items' ), |
|
| 52 | + 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 53 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 54 | + ), |
|
| 55 | + 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 56 | + ) |
|
| 57 | + ); |
|
| 58 | + |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Check permissions of items on REST API. |
|
| 63 | + * |
|
| 64 | + * @since 1.0.19 |
|
| 65 | + * @param string $context Request context. |
|
| 66 | + * @param int $object_id Post ID. |
|
| 67 | + * @return bool |
|
| 68 | + */ |
|
| 69 | + public function check_post_permissions( $context = 'read', $object_id = 0 ) { |
|
| 70 | + |
|
| 71 | + $contexts = array( |
|
| 72 | + 'read' => 'read_private_posts', |
|
| 73 | + 'create' => 'publish_posts', |
|
| 74 | + 'edit' => 'edit_post', |
|
| 75 | + 'delete' => 'delete_post', |
|
| 76 | + 'batch' => 'edit_others_posts', |
|
| 77 | + ); |
|
| 78 | + |
|
| 79 | + $cap = $contexts[ $context ]; |
|
| 80 | + $post_type_object = get_post_type_object( $this->post_type ); |
|
| 81 | + $permission = current_user_can( $post_type_object->cap->$cap, $object_id ); |
|
| 82 | + |
|
| 83 | + return apply_filters( 'getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type ); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * Check if a given request has access to read items. |
|
| 88 | + * |
|
| 89 | + * @param WP_REST_Request $request Full details about the request. |
|
| 90 | + * @return WP_Error|boolean |
|
| 91 | + */ |
|
| 92 | + public function get_items_permissions_check( $request ) { |
|
| 93 | + return $this->check_post_permissions() ? true : new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * Check if a given request has access to create an item. |
|
| 98 | + * |
|
| 99 | + * @param WP_REST_Request $request Full details about the request. |
|
| 100 | + * @return WP_Error|boolean |
|
| 101 | + */ |
|
| 102 | + public function create_item_permissions_check( $request ) { |
|
| 103 | + 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() ) ); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Check if a given request has access to read an item. |
|
| 108 | + * |
|
| 109 | + * @param WP_REST_Request $request Full details about the request. |
|
| 110 | + * @return WP_Error|boolean |
|
| 111 | + */ |
|
| 112 | + public function get_item_permissions_check( $request ) { |
|
| 113 | + $post = get_post( (int) $request['id'] ); |
|
| 114 | + |
|
| 115 | + if ( $post && ! $this->check_post_permissions( 'read', $post->ID ) ) { |
|
| 116 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + return true; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Check if a given request has access to update an item. |
|
| 124 | + * |
|
| 125 | + * @param WP_REST_Request $request Full details about the request. |
|
| 126 | + * @return WP_Error|boolean |
|
| 127 | + */ |
|
| 128 | + public function update_item_permissions_check( $request ) { |
|
| 129 | + $post = get_post( (int) $request['id'] ); |
|
| 130 | + |
|
| 131 | + if ( $post && ! $this->check_post_permissions( 'edit', $post->ID ) ) { |
|
| 132 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + return true; |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * Check if a given request has access to delete an item. |
|
| 140 | + * |
|
| 141 | + * @param WP_REST_Request $request Full details about the request. |
|
| 142 | + * @return bool|WP_Error |
|
| 143 | + */ |
|
| 144 | + public function delete_item_permissions_check( $request ) { |
|
| 145 | + $post = get_post( (int) $request['id'] ); |
|
| 146 | + |
|
| 147 | + if ( $post && ! $this->check_post_permissions( 'delete', $post->ID ) ) { |
|
| 148 | + return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + return true; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Check if a given request has access batch create, update and delete items. |
|
| 156 | + * |
|
| 157 | + * @param WP_REST_Request $request Full details about the request. |
|
| 158 | + * |
|
| 159 | + * @return boolean|WP_Error |
|
| 160 | + */ |
|
| 161 | + public function batch_items_permissions_check( $request ) { |
|
| 162 | + 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() ) ); |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * @deprecated |
|
| 167 | + */ |
|
| 168 | + public function get_post( $object_id ) { |
|
| 169 | + return $this->get_object( $object_id ); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * Get a single object. |
|
| 174 | + * |
|
| 175 | + * @param WP_REST_Request $request Full details about the request. |
|
| 176 | + * @return WP_Error|WP_REST_Response |
|
| 177 | + */ |
|
| 178 | + public function get_item( $request ) { |
|
| 179 | + |
|
| 180 | + // Fetch item. |
|
| 181 | + $response = parent::get_item( $request ); |
|
| 182 | + |
|
| 183 | + // (Maybe) add a link to the html pagee. |
|
| 184 | + if ( $this->public && ! is_wp_error( $response ) ) { |
|
| 185 | + $response->link_header( 'alternate', get_permalink( $this->data_object->get_id() ), array( 'type' => 'text/html' ) ); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + return $response; |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + /** |
|
| 192 | + * Create a single object. |
|
| 193 | + * |
|
| 194 | + * @param WP_REST_Request $request Full details about the request. |
|
| 195 | + * @return WP_Error|WP_REST_Response |
|
| 196 | + */ |
|
| 197 | + public function create_item( $request ) { |
|
| 198 | + |
|
| 199 | + // Create item. |
|
| 200 | + $response = parent::create_item( $request ); |
|
| 201 | + |
|
| 202 | + // Fire a hook after an item is created. |
|
| 203 | + if ( ! is_wp_error( $response ) ) { |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * Fires after a single item is created or updated via the REST API. |
|
| 207 | + * |
|
| 208 | + * @param WP_Post $post Post object. |
|
| 209 | + * @param WP_REST_Request $request Request object. |
|
| 210 | + * @param boolean $creating True when creating item, false when updating. |
|
| 211 | + */ |
|
| 212 | + do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true ); |
|
| 213 | + |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + return $response; |
|
| 217 | + |
|
| 170 | 218 | } |
| 171 | 219 | |
| 172 | - /** |
|
| 173 | - * Get a single object. |
|
| 174 | - * |
|
| 175 | - * @param WP_REST_Request $request Full details about the request. |
|
| 176 | - * @return WP_Error|WP_REST_Response |
|
| 177 | - */ |
|
| 178 | - public function get_item( $request ) { |
|
| 179 | - |
|
| 180 | - // Fetch item. |
|
| 181 | - $response = parent::get_item( $request ); |
|
| 182 | - |
|
| 183 | - // (Maybe) add a link to the html pagee. |
|
| 184 | - if ( $this->public && ! is_wp_error( $response ) ) { |
|
| 185 | - $response->link_header( 'alternate', get_permalink( $this->data_object->get_id() ), array( 'type' => 'text/html' ) ); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - return $response; |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - /** |
|
| 192 | - * Create a single object. |
|
| 193 | - * |
|
| 194 | - * @param WP_REST_Request $request Full details about the request. |
|
| 195 | - * @return WP_Error|WP_REST_Response |
|
| 196 | - */ |
|
| 197 | - public function create_item( $request ) { |
|
| 198 | - |
|
| 199 | - // Create item. |
|
| 200 | - $response = parent::create_item( $request ); |
|
| 201 | - |
|
| 202 | - // Fire a hook after an item is created. |
|
| 203 | - if ( ! is_wp_error( $response ) ) { |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * Fires after a single item is created or updated via the REST API. |
|
| 207 | - * |
|
| 208 | - * @param WP_Post $post Post object. |
|
| 209 | - * @param WP_REST_Request $request Request object. |
|
| 210 | - * @param boolean $creating True when creating item, false when updating. |
|
| 211 | - */ |
|
| 212 | - do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true ); |
|
| 213 | - |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - return $response; |
|
| 217 | - |
|
| 218 | - } |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * Update a single object. |
|
| 222 | - * |
|
| 223 | - * @param WP_REST_Request $request Full details about the request. |
|
| 224 | - * @return WP_Error|WP_REST_Response |
|
| 225 | - */ |
|
| 226 | - public function update_item( $request ) { |
|
| 227 | - |
|
| 228 | - // Create item. |
|
| 229 | - $response = parent::update_item( $request ); |
|
| 230 | - |
|
| 231 | - // Fire a hook after an item is created. |
|
| 232 | - if ( ! is_wp_error( $response ) ) { |
|
| 233 | - |
|
| 234 | - /** |
|
| 235 | - * Fires after a single item is created or updated via the REST API. |
|
| 236 | - * |
|
| 237 | - * @param WP_Post $post Post object. |
|
| 238 | - * @param WP_REST_Request $request Request object. |
|
| 239 | - * @param boolean $creating True when creating item, false when updating. |
|
| 240 | - */ |
|
| 241 | - do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false ); |
|
| 242 | - |
|
| 243 | - } |
|
| 244 | - |
|
| 245 | - return $response; |
|
| 246 | - |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - /** |
|
| 250 | - * Get a collection of objects. |
|
| 251 | - * |
|
| 252 | - * @param WP_REST_Request $request Full details about the request. |
|
| 253 | - * @return WP_Error|WP_REST_Response |
|
| 254 | - */ |
|
| 255 | - public function get_items( $request ) { |
|
| 256 | - |
|
| 257 | - $args = array(); |
|
| 258 | - $args['offset'] = $request['offset']; |
|
| 259 | - $args['order'] = $request['order']; |
|
| 260 | - $args['orderby'] = $request['orderby']; |
|
| 261 | - $args['paged'] = $request['page']; |
|
| 262 | - $args['post__in'] = $request['include']; |
|
| 263 | - $args['post__not_in'] = $request['exclude']; |
|
| 264 | - $args['posts_per_page'] = $request['per_page']; |
|
| 265 | - $args['name'] = $request['slug']; |
|
| 266 | - $args['post_parent__in'] = $request['parent']; |
|
| 267 | - $args['post_parent__not_in'] = $request['parent_exclude']; |
|
| 268 | - $args['s'] = $request['search']; |
|
| 269 | - $args['post_status'] = wpinv_parse_list( $request['status'] ); |
|
| 270 | - |
|
| 271 | - $args['date_query'] = array(); |
|
| 272 | - |
|
| 273 | - // Set before into date query. Date query must be specified as an array of an array. |
|
| 274 | - if ( isset( $request['before'] ) ) { |
|
| 275 | - $args['date_query'][0]['before'] = $request['before']; |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - // Set after into date query. Date query must be specified as an array of an array. |
|
| 279 | - if ( isset( $request['after'] ) ) { |
|
| 280 | - $args['date_query'][0]['after'] = $request['after']; |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - // Force the post_type & fields arguments, since they're not a user input variable. |
|
| 284 | - $args['post_type'] = $this->post_type; |
|
| 285 | - $args['fields'] = 'ids'; |
|
| 286 | - |
|
| 287 | - // Filter the query arguments for a request. |
|
| 288 | - $args = apply_filters( "getpaid_rest_{$this->post_type}_query", $args, $request ); |
|
| 289 | - $query_args = $this->prepare_items_query( $args, $request ); |
|
| 290 | - |
|
| 291 | - $posts_query = new WP_Query(); |
|
| 292 | - $query_result = $posts_query->query( $query_args ); |
|
| 293 | - |
|
| 294 | - $posts = array(); |
|
| 295 | - foreach ( $query_result as $post_id ) { |
|
| 296 | - if ( ! $this->check_post_permissions( 'read', $post_id ) ) { |
|
| 297 | - continue; |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - $data = $this->prepare_item_for_response( $this->get_object( $post_id ), $request ); |
|
| 301 | - $posts[] = $this->prepare_response_for_collection( $data ); |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - $page = (int) $query_args['paged']; |
|
| 305 | - $total_posts = $posts_query->found_posts; |
|
| 306 | - |
|
| 307 | - if ( $total_posts < 1 ) { |
|
| 308 | - // Out-of-bounds, run the query again without LIMIT for total count. |
|
| 309 | - unset( $query_args['paged'] ); |
|
| 310 | - $count_query = new WP_Query(); |
|
| 311 | - $count_query->query( $query_args ); |
|
| 312 | - $total_posts = $count_query->found_posts; |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - $max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] ); |
|
| 316 | - |
|
| 317 | - $response = rest_ensure_response( $posts ); |
|
| 318 | - $response->header( 'X-WP-Total', (int) $total_posts ); |
|
| 319 | - $response->header( 'X-WP-TotalPages', (int) $max_pages ); |
|
| 320 | - |
|
| 321 | - $request_params = $request->get_query_params(); |
|
| 322 | - $base = add_query_arg( $request_params, rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) ); |
|
| 323 | - |
|
| 324 | - if ( $page > 1 ) { |
|
| 325 | - $prev_page = $page - 1; |
|
| 326 | - if ( $prev_page > $max_pages ) { |
|
| 327 | - $prev_page = $max_pages; |
|
| 328 | - } |
|
| 329 | - $prev_link = add_query_arg( 'page', $prev_page, $base ); |
|
| 330 | - $response->link_header( 'prev', $prev_link ); |
|
| 331 | - } |
|
| 332 | - if ( $max_pages > $page ) { |
|
| 333 | - $next_page = $page + 1; |
|
| 334 | - $next_link = add_query_arg( 'page', $next_page, $base ); |
|
| 335 | - $response->link_header( 'next', $next_link ); |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - return $response; |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - /** |
|
| 342 | - * Delete a single item. |
|
| 343 | - * |
|
| 344 | - * @param WP_REST_Request $request Full details about the request. |
|
| 345 | - * @return WP_REST_Response|WP_Error |
|
| 346 | - */ |
|
| 347 | - public function delete_item( $request ) { |
|
| 348 | - |
|
| 349 | - // Fetch the item. |
|
| 350 | - $item = $this->get_object( $request['id'] ); |
|
| 351 | - if ( is_wp_error( $item ) ) { |
|
| 352 | - return $item; |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - $supports_trash = EMPTY_TRASH_DAYS > 0; |
|
| 356 | - $force = $supports_trash && (bool) $request['force']; |
|
| 357 | - |
|
| 358 | - if ( ! $this->check_post_permissions( 'delete', $item->ID ) ) { |
|
| 359 | - return new WP_Error( "cannot_delete", __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 360 | - } |
|
| 361 | - |
|
| 362 | - $request->set_param( 'context', 'edit' ); |
|
| 363 | - $response = $this->prepare_item_for_response( $item, $request ); |
|
| 364 | - |
|
| 365 | - if ( ! wp_delete_post( $item->ID, $force ) ) { |
|
| 366 | - return new WP_Error( 'rest_cannot_delete', sprintf( __( 'The resource cannot be deleted.', 'invoicing' ), $this->post_type ), array( 'status' => 500 ) ); |
|
| 367 | - } |
|
| 368 | - |
|
| 369 | - return $response; |
|
| 370 | - } |
|
| 371 | - |
|
| 372 | - /** |
|
| 373 | - * Prepare links for the request. |
|
| 374 | - * |
|
| 375 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 376 | - * @return array Links for the given object. |
|
| 377 | - */ |
|
| 378 | - protected function prepare_links( $object ) { |
|
| 379 | - |
|
| 380 | - $links = parent::prepare_links( $object ); |
|
| 381 | - |
|
| 382 | - if ( is_callable( array( $object, 'get_user_id' ) ) ) { |
|
| 383 | - $links['user'] = array( |
|
| 384 | - 'href' => rest_url( 'wp/v2/users/' . call_user_func( array( $object, 'get_user_id' ) ) ), |
|
| 385 | - 'embeddable' => true, |
|
| 386 | - ); |
|
| 387 | - } |
|
| 388 | - |
|
| 389 | - if ( is_callable( array( $object, 'get_owner' ) ) ) { |
|
| 390 | - $links['owner'] = array( |
|
| 391 | - 'href' => rest_url( 'wp/v2/users/' . call_user_func( array( $object, 'get_owner' ) ) ), |
|
| 392 | - 'embeddable' => true, |
|
| 393 | - ); |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - if ( is_callable( array( $object, 'get_parent_id' ) ) && call_user_func( array( $object, 'get_parent_id' ) ) ) { |
|
| 397 | - $links['parent'] = array( |
|
| 398 | - 'href' => rest_url( "$this->namespace/$this->rest_base/" . call_user_func( array( $object, 'get_parent_id' ) ) ), |
|
| 399 | - 'embeddable' => true, |
|
| 400 | - ); |
|
| 401 | - } |
|
| 402 | - |
|
| 403 | - return $links; |
|
| 404 | - } |
|
| 405 | - |
|
| 406 | - /** |
|
| 407 | - * Determine the allowed query_vars for a get_items() response and |
|
| 408 | - * prepare for WP_Query. |
|
| 409 | - * |
|
| 410 | - * @param array $prepared_args Prepared arguments. |
|
| 411 | - * @param WP_REST_Request $request Request object. |
|
| 412 | - * @return array $query_args |
|
| 413 | - */ |
|
| 414 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 415 | - |
|
| 416 | - $valid_vars = array_flip( $this->get_allowed_query_vars() ); |
|
| 417 | - $query_args = array(); |
|
| 418 | - foreach ( $valid_vars as $var => $index ) { |
|
| 419 | - if ( isset( $prepared_args[ $var ] ) ) { |
|
| 420 | - $query_args[ $var ] = apply_filters( "getpaid_rest_query_var-{$var}", $prepared_args[ $var ], $index ); |
|
| 421 | - } |
|
| 422 | - } |
|
| 423 | - |
|
| 424 | - $query_args['ignore_sticky_posts'] = true; |
|
| 425 | - |
|
| 426 | - if ( 'include' === $query_args['orderby'] ) { |
|
| 427 | - $query_args['orderby'] = 'post__in'; |
|
| 428 | - } elseif ( 'id' === $query_args['orderby'] ) { |
|
| 429 | - $query_args['orderby'] = 'ID'; // ID must be capitalized. |
|
| 430 | - } elseif ( 'slug' === $query_args['orderby'] ) { |
|
| 431 | - $query_args['orderby'] = 'name'; |
|
| 432 | - } |
|
| 433 | - |
|
| 434 | - return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this ); |
|
| 435 | - |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - /** |
|
| 439 | - * Get all the WP Query vars that are allowed for the API request. |
|
| 440 | - * |
|
| 441 | - * @return array |
|
| 442 | - */ |
|
| 443 | - protected function get_allowed_query_vars() { |
|
| 444 | - global $wp; |
|
| 445 | - |
|
| 446 | - /** |
|
| 447 | - * Filter the publicly allowed query vars. |
|
| 448 | - * |
|
| 449 | - * Allows adjusting of the default query vars that are made public. |
|
| 450 | - * |
|
| 451 | - * @param array Array of allowed WP_Query query vars. |
|
| 452 | - */ |
|
| 453 | - $valid_vars = apply_filters( 'query_vars', $wp->public_query_vars ); |
|
| 454 | - |
|
| 455 | - $post_type_obj = get_post_type_object( $this->post_type ); |
|
| 456 | - if ( current_user_can( $post_type_obj->cap->edit_posts ) ) { |
|
| 457 | - $private = apply_filters( 'getpaid_rest_private_query_vars', $wp->private_query_vars ); |
|
| 458 | - $valid_vars = array_merge( $valid_vars, $private ); |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - // Define our own in addition to WP's normal vars. |
|
| 462 | - $rest_valid = array( |
|
| 463 | - 'post_status', |
|
| 464 | - 'date_query', |
|
| 465 | - 'ignore_sticky_posts', |
|
| 466 | - 'offset', |
|
| 467 | - 'post__in', |
|
| 468 | - 'post__not_in', |
|
| 469 | - 'post_parent', |
|
| 470 | - 'post_parent__in', |
|
| 471 | - 'post_parent__not_in', |
|
| 472 | - 'posts_per_page', |
|
| 473 | - 'meta_query', |
|
| 474 | - 'tax_query', |
|
| 475 | - 'meta_key', |
|
| 476 | - 'meta_value', |
|
| 477 | - 'meta_compare', |
|
| 478 | - 'meta_value_num', |
|
| 479 | - ); |
|
| 480 | - $valid_vars = array_merge( $valid_vars, $rest_valid ); |
|
| 481 | - |
|
| 482 | - // Filter allowed query vars for the REST API. |
|
| 483 | - $valid_vars = apply_filters( 'getpaid_rest_query_vars', $valid_vars, $this ); |
|
| 484 | - |
|
| 485 | - return $valid_vars; |
|
| 486 | - } |
|
| 487 | - |
|
| 488 | - /** |
|
| 489 | - * Get the query params for collections of attachments. |
|
| 490 | - * |
|
| 491 | - * @return array |
|
| 492 | - */ |
|
| 493 | - public function get_collection_params() { |
|
| 494 | - |
|
| 495 | - return array_merge( |
|
| 496 | - |
|
| 497 | - parent::get_collection_params(), |
|
| 498 | - |
|
| 499 | - array( |
|
| 500 | - 'status' => array( |
|
| 501 | - 'default' => $this->get_post_statuses(), |
|
| 502 | - 'description' => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ), |
|
| 503 | - 'type' => array( 'array', 'string' ), |
|
| 504 | - 'items' => array( |
|
| 505 | - 'enum' => $this->get_post_statuses(), |
|
| 506 | - 'type' => 'string', |
|
| 507 | - ), |
|
| 508 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 509 | - 'sanitize_callback' => array( $this, 'sanitize_post_statuses' ), |
|
| 510 | - ), |
|
| 511 | - 'after' => array( |
|
| 512 | - 'description' => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ), |
|
| 513 | - 'type' => 'string', |
|
| 514 | - 'format' => 'string', |
|
| 515 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 516 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 517 | - ), |
|
| 518 | - 'before' => array( |
|
| 519 | - 'description' => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ), |
|
| 520 | - 'type' => 'string', |
|
| 521 | - 'format' => 'string', |
|
| 522 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 523 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 524 | - ), |
|
| 525 | - 'exclude' => array( |
|
| 526 | - 'description' => __( 'Ensure result set excludes specific IDs.', 'invoicing' ), |
|
| 527 | - 'type' => 'array', |
|
| 528 | - 'items' => array( |
|
| 529 | - 'type' => 'integer', |
|
| 530 | - ), |
|
| 531 | - 'default' => array(), |
|
| 532 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 533 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 534 | - ), |
|
| 535 | - 'include' => array( |
|
| 536 | - 'description' => __( 'Limit result set to specific ids.', 'invoicing' ), |
|
| 537 | - 'type' => 'array', |
|
| 538 | - 'items' => array( |
|
| 539 | - 'type' => 'integer', |
|
| 540 | - ), |
|
| 541 | - 'default' => array(), |
|
| 542 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 543 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 544 | - ), |
|
| 545 | - 'offset' => array( |
|
| 546 | - 'description' => __( 'Offset the result set by a specific number of items.', 'invoicing' ), |
|
| 547 | - 'type' => 'integer', |
|
| 548 | - 'sanitize_callback' => 'absint', |
|
| 549 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 550 | - ), |
|
| 551 | - 'order' => array( |
|
| 552 | - 'description' => __( 'Order sort attribute ascending or descending.', 'invoicing' ), |
|
| 553 | - 'type' => 'string', |
|
| 554 | - 'default' => 'desc', |
|
| 555 | - 'enum' => array( 'asc', 'desc' ), |
|
| 556 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 557 | - ), |
|
| 558 | - 'orderby' => array( |
|
| 559 | - 'description' => __( 'Sort collection by object attribute.', 'invoicing' ), |
|
| 560 | - 'type' => 'string', |
|
| 561 | - 'default' => 'date', |
|
| 562 | - 'enum' => array( |
|
| 563 | - 'date', |
|
| 564 | - 'id', |
|
| 565 | - 'include', |
|
| 566 | - 'title', |
|
| 567 | - 'slug', |
|
| 568 | - 'modified', |
|
| 569 | - ), |
|
| 570 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 571 | - ), |
|
| 572 | - ) |
|
| 573 | - ); |
|
| 574 | - } |
|
| 575 | - |
|
| 576 | - /** |
|
| 577 | - * Retrieves the items's schema, conforming to JSON Schema. |
|
| 578 | - * |
|
| 579 | - * @since 1.0.19 |
|
| 580 | - * |
|
| 581 | - * @return array Item schema data. |
|
| 582 | - */ |
|
| 583 | - public function get_item_schema() { |
|
| 584 | - |
|
| 585 | - // Maybe retrieve the schema from cache. |
|
| 586 | - if ( ! empty( $this->schema ) ) { |
|
| 587 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 588 | - } |
|
| 589 | - |
|
| 590 | - $type = str_replace( 'wpi_', '', $this->post_type ); |
|
| 591 | - $schema = array( |
|
| 592 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 593 | - 'title' => $this->post_type, |
|
| 594 | - 'type' => 'object', |
|
| 595 | - 'properties' => wpinv_get_data( "$type-schema" ), |
|
| 596 | - ); |
|
| 597 | - |
|
| 598 | - // Filters the invoice schema for the REST API. |
|
| 220 | + /** |
|
| 221 | + * Update a single object. |
|
| 222 | + * |
|
| 223 | + * @param WP_REST_Request $request Full details about the request. |
|
| 224 | + * @return WP_Error|WP_REST_Response |
|
| 225 | + */ |
|
| 226 | + public function update_item( $request ) { |
|
| 227 | + |
|
| 228 | + // Create item. |
|
| 229 | + $response = parent::update_item( $request ); |
|
| 230 | + |
|
| 231 | + // Fire a hook after an item is created. |
|
| 232 | + if ( ! is_wp_error( $response ) ) { |
|
| 233 | + |
|
| 234 | + /** |
|
| 235 | + * Fires after a single item is created or updated via the REST API. |
|
| 236 | + * |
|
| 237 | + * @param WP_Post $post Post object. |
|
| 238 | + * @param WP_REST_Request $request Request object. |
|
| 239 | + * @param boolean $creating True when creating item, false when updating. |
|
| 240 | + */ |
|
| 241 | + do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false ); |
|
| 242 | + |
|
| 243 | + } |
|
| 244 | + |
|
| 245 | + return $response; |
|
| 246 | + |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + /** |
|
| 250 | + * Get a collection of objects. |
|
| 251 | + * |
|
| 252 | + * @param WP_REST_Request $request Full details about the request. |
|
| 253 | + * @return WP_Error|WP_REST_Response |
|
| 254 | + */ |
|
| 255 | + public function get_items( $request ) { |
|
| 256 | + |
|
| 257 | + $args = array(); |
|
| 258 | + $args['offset'] = $request['offset']; |
|
| 259 | + $args['order'] = $request['order']; |
|
| 260 | + $args['orderby'] = $request['orderby']; |
|
| 261 | + $args['paged'] = $request['page']; |
|
| 262 | + $args['post__in'] = $request['include']; |
|
| 263 | + $args['post__not_in'] = $request['exclude']; |
|
| 264 | + $args['posts_per_page'] = $request['per_page']; |
|
| 265 | + $args['name'] = $request['slug']; |
|
| 266 | + $args['post_parent__in'] = $request['parent']; |
|
| 267 | + $args['post_parent__not_in'] = $request['parent_exclude']; |
|
| 268 | + $args['s'] = $request['search']; |
|
| 269 | + $args['post_status'] = wpinv_parse_list( $request['status'] ); |
|
| 270 | + |
|
| 271 | + $args['date_query'] = array(); |
|
| 272 | + |
|
| 273 | + // Set before into date query. Date query must be specified as an array of an array. |
|
| 274 | + if ( isset( $request['before'] ) ) { |
|
| 275 | + $args['date_query'][0]['before'] = $request['before']; |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + // Set after into date query. Date query must be specified as an array of an array. |
|
| 279 | + if ( isset( $request['after'] ) ) { |
|
| 280 | + $args['date_query'][0]['after'] = $request['after']; |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + // Force the post_type & fields arguments, since they're not a user input variable. |
|
| 284 | + $args['post_type'] = $this->post_type; |
|
| 285 | + $args['fields'] = 'ids'; |
|
| 286 | + |
|
| 287 | + // Filter the query arguments for a request. |
|
| 288 | + $args = apply_filters( "getpaid_rest_{$this->post_type}_query", $args, $request ); |
|
| 289 | + $query_args = $this->prepare_items_query( $args, $request ); |
|
| 290 | + |
|
| 291 | + $posts_query = new WP_Query(); |
|
| 292 | + $query_result = $posts_query->query( $query_args ); |
|
| 293 | + |
|
| 294 | + $posts = array(); |
|
| 295 | + foreach ( $query_result as $post_id ) { |
|
| 296 | + if ( ! $this->check_post_permissions( 'read', $post_id ) ) { |
|
| 297 | + continue; |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + $data = $this->prepare_item_for_response( $this->get_object( $post_id ), $request ); |
|
| 301 | + $posts[] = $this->prepare_response_for_collection( $data ); |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + $page = (int) $query_args['paged']; |
|
| 305 | + $total_posts = $posts_query->found_posts; |
|
| 306 | + |
|
| 307 | + if ( $total_posts < 1 ) { |
|
| 308 | + // Out-of-bounds, run the query again without LIMIT for total count. |
|
| 309 | + unset( $query_args['paged'] ); |
|
| 310 | + $count_query = new WP_Query(); |
|
| 311 | + $count_query->query( $query_args ); |
|
| 312 | + $total_posts = $count_query->found_posts; |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + $max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] ); |
|
| 316 | + |
|
| 317 | + $response = rest_ensure_response( $posts ); |
|
| 318 | + $response->header( 'X-WP-Total', (int) $total_posts ); |
|
| 319 | + $response->header( 'X-WP-TotalPages', (int) $max_pages ); |
|
| 320 | + |
|
| 321 | + $request_params = $request->get_query_params(); |
|
| 322 | + $base = add_query_arg( $request_params, rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) ); |
|
| 323 | + |
|
| 324 | + if ( $page > 1 ) { |
|
| 325 | + $prev_page = $page - 1; |
|
| 326 | + if ( $prev_page > $max_pages ) { |
|
| 327 | + $prev_page = $max_pages; |
|
| 328 | + } |
|
| 329 | + $prev_link = add_query_arg( 'page', $prev_page, $base ); |
|
| 330 | + $response->link_header( 'prev', $prev_link ); |
|
| 331 | + } |
|
| 332 | + if ( $max_pages > $page ) { |
|
| 333 | + $next_page = $page + 1; |
|
| 334 | + $next_link = add_query_arg( 'page', $next_page, $base ); |
|
| 335 | + $response->link_header( 'next', $next_link ); |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + return $response; |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + /** |
|
| 342 | + * Delete a single item. |
|
| 343 | + * |
|
| 344 | + * @param WP_REST_Request $request Full details about the request. |
|
| 345 | + * @return WP_REST_Response|WP_Error |
|
| 346 | + */ |
|
| 347 | + public function delete_item( $request ) { |
|
| 348 | + |
|
| 349 | + // Fetch the item. |
|
| 350 | + $item = $this->get_object( $request['id'] ); |
|
| 351 | + if ( is_wp_error( $item ) ) { |
|
| 352 | + return $item; |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + $supports_trash = EMPTY_TRASH_DAYS > 0; |
|
| 356 | + $force = $supports_trash && (bool) $request['force']; |
|
| 357 | + |
|
| 358 | + if ( ! $this->check_post_permissions( 'delete', $item->ID ) ) { |
|
| 359 | + return new WP_Error( "cannot_delete", __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 360 | + } |
|
| 361 | + |
|
| 362 | + $request->set_param( 'context', 'edit' ); |
|
| 363 | + $response = $this->prepare_item_for_response( $item, $request ); |
|
| 364 | + |
|
| 365 | + if ( ! wp_delete_post( $item->ID, $force ) ) { |
|
| 366 | + return new WP_Error( 'rest_cannot_delete', sprintf( __( 'The resource cannot be deleted.', 'invoicing' ), $this->post_type ), array( 'status' => 500 ) ); |
|
| 367 | + } |
|
| 368 | + |
|
| 369 | + return $response; |
|
| 370 | + } |
|
| 371 | + |
|
| 372 | + /** |
|
| 373 | + * Prepare links for the request. |
|
| 374 | + * |
|
| 375 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 376 | + * @return array Links for the given object. |
|
| 377 | + */ |
|
| 378 | + protected function prepare_links( $object ) { |
|
| 379 | + |
|
| 380 | + $links = parent::prepare_links( $object ); |
|
| 381 | + |
|
| 382 | + if ( is_callable( array( $object, 'get_user_id' ) ) ) { |
|
| 383 | + $links['user'] = array( |
|
| 384 | + 'href' => rest_url( 'wp/v2/users/' . call_user_func( array( $object, 'get_user_id' ) ) ), |
|
| 385 | + 'embeddable' => true, |
|
| 386 | + ); |
|
| 387 | + } |
|
| 388 | + |
|
| 389 | + if ( is_callable( array( $object, 'get_owner' ) ) ) { |
|
| 390 | + $links['owner'] = array( |
|
| 391 | + 'href' => rest_url( 'wp/v2/users/' . call_user_func( array( $object, 'get_owner' ) ) ), |
|
| 392 | + 'embeddable' => true, |
|
| 393 | + ); |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + if ( is_callable( array( $object, 'get_parent_id' ) ) && call_user_func( array( $object, 'get_parent_id' ) ) ) { |
|
| 397 | + $links['parent'] = array( |
|
| 398 | + 'href' => rest_url( "$this->namespace/$this->rest_base/" . call_user_func( array( $object, 'get_parent_id' ) ) ), |
|
| 399 | + 'embeddable' => true, |
|
| 400 | + ); |
|
| 401 | + } |
|
| 402 | + |
|
| 403 | + return $links; |
|
| 404 | + } |
|
| 405 | + |
|
| 406 | + /** |
|
| 407 | + * Determine the allowed query_vars for a get_items() response and |
|
| 408 | + * prepare for WP_Query. |
|
| 409 | + * |
|
| 410 | + * @param array $prepared_args Prepared arguments. |
|
| 411 | + * @param WP_REST_Request $request Request object. |
|
| 412 | + * @return array $query_args |
|
| 413 | + */ |
|
| 414 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 415 | + |
|
| 416 | + $valid_vars = array_flip( $this->get_allowed_query_vars() ); |
|
| 417 | + $query_args = array(); |
|
| 418 | + foreach ( $valid_vars as $var => $index ) { |
|
| 419 | + if ( isset( $prepared_args[ $var ] ) ) { |
|
| 420 | + $query_args[ $var ] = apply_filters( "getpaid_rest_query_var-{$var}", $prepared_args[ $var ], $index ); |
|
| 421 | + } |
|
| 422 | + } |
|
| 423 | + |
|
| 424 | + $query_args['ignore_sticky_posts'] = true; |
|
| 425 | + |
|
| 426 | + if ( 'include' === $query_args['orderby'] ) { |
|
| 427 | + $query_args['orderby'] = 'post__in'; |
|
| 428 | + } elseif ( 'id' === $query_args['orderby'] ) { |
|
| 429 | + $query_args['orderby'] = 'ID'; // ID must be capitalized. |
|
| 430 | + } elseif ( 'slug' === $query_args['orderby'] ) { |
|
| 431 | + $query_args['orderby'] = 'name'; |
|
| 432 | + } |
|
| 433 | + |
|
| 434 | + return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this ); |
|
| 435 | + |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + /** |
|
| 439 | + * Get all the WP Query vars that are allowed for the API request. |
|
| 440 | + * |
|
| 441 | + * @return array |
|
| 442 | + */ |
|
| 443 | + protected function get_allowed_query_vars() { |
|
| 444 | + global $wp; |
|
| 445 | + |
|
| 446 | + /** |
|
| 447 | + * Filter the publicly allowed query vars. |
|
| 448 | + * |
|
| 449 | + * Allows adjusting of the default query vars that are made public. |
|
| 450 | + * |
|
| 451 | + * @param array Array of allowed WP_Query query vars. |
|
| 452 | + */ |
|
| 453 | + $valid_vars = apply_filters( 'query_vars', $wp->public_query_vars ); |
|
| 454 | + |
|
| 455 | + $post_type_obj = get_post_type_object( $this->post_type ); |
|
| 456 | + if ( current_user_can( $post_type_obj->cap->edit_posts ) ) { |
|
| 457 | + $private = apply_filters( 'getpaid_rest_private_query_vars', $wp->private_query_vars ); |
|
| 458 | + $valid_vars = array_merge( $valid_vars, $private ); |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + // Define our own in addition to WP's normal vars. |
|
| 462 | + $rest_valid = array( |
|
| 463 | + 'post_status', |
|
| 464 | + 'date_query', |
|
| 465 | + 'ignore_sticky_posts', |
|
| 466 | + 'offset', |
|
| 467 | + 'post__in', |
|
| 468 | + 'post__not_in', |
|
| 469 | + 'post_parent', |
|
| 470 | + 'post_parent__in', |
|
| 471 | + 'post_parent__not_in', |
|
| 472 | + 'posts_per_page', |
|
| 473 | + 'meta_query', |
|
| 474 | + 'tax_query', |
|
| 475 | + 'meta_key', |
|
| 476 | + 'meta_value', |
|
| 477 | + 'meta_compare', |
|
| 478 | + 'meta_value_num', |
|
| 479 | + ); |
|
| 480 | + $valid_vars = array_merge( $valid_vars, $rest_valid ); |
|
| 481 | + |
|
| 482 | + // Filter allowed query vars for the REST API. |
|
| 483 | + $valid_vars = apply_filters( 'getpaid_rest_query_vars', $valid_vars, $this ); |
|
| 484 | + |
|
| 485 | + return $valid_vars; |
|
| 486 | + } |
|
| 487 | + |
|
| 488 | + /** |
|
| 489 | + * Get the query params for collections of attachments. |
|
| 490 | + * |
|
| 491 | + * @return array |
|
| 492 | + */ |
|
| 493 | + public function get_collection_params() { |
|
| 494 | + |
|
| 495 | + return array_merge( |
|
| 496 | + |
|
| 497 | + parent::get_collection_params(), |
|
| 498 | + |
|
| 499 | + array( |
|
| 500 | + 'status' => array( |
|
| 501 | + 'default' => $this->get_post_statuses(), |
|
| 502 | + 'description' => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ), |
|
| 503 | + 'type' => array( 'array', 'string' ), |
|
| 504 | + 'items' => array( |
|
| 505 | + 'enum' => $this->get_post_statuses(), |
|
| 506 | + 'type' => 'string', |
|
| 507 | + ), |
|
| 508 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 509 | + 'sanitize_callback' => array( $this, 'sanitize_post_statuses' ), |
|
| 510 | + ), |
|
| 511 | + 'after' => array( |
|
| 512 | + 'description' => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ), |
|
| 513 | + 'type' => 'string', |
|
| 514 | + 'format' => 'string', |
|
| 515 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 516 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 517 | + ), |
|
| 518 | + 'before' => array( |
|
| 519 | + 'description' => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ), |
|
| 520 | + 'type' => 'string', |
|
| 521 | + 'format' => 'string', |
|
| 522 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 523 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 524 | + ), |
|
| 525 | + 'exclude' => array( |
|
| 526 | + 'description' => __( 'Ensure result set excludes specific IDs.', 'invoicing' ), |
|
| 527 | + 'type' => 'array', |
|
| 528 | + 'items' => array( |
|
| 529 | + 'type' => 'integer', |
|
| 530 | + ), |
|
| 531 | + 'default' => array(), |
|
| 532 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 533 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 534 | + ), |
|
| 535 | + 'include' => array( |
|
| 536 | + 'description' => __( 'Limit result set to specific ids.', 'invoicing' ), |
|
| 537 | + 'type' => 'array', |
|
| 538 | + 'items' => array( |
|
| 539 | + 'type' => 'integer', |
|
| 540 | + ), |
|
| 541 | + 'default' => array(), |
|
| 542 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 543 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 544 | + ), |
|
| 545 | + 'offset' => array( |
|
| 546 | + 'description' => __( 'Offset the result set by a specific number of items.', 'invoicing' ), |
|
| 547 | + 'type' => 'integer', |
|
| 548 | + 'sanitize_callback' => 'absint', |
|
| 549 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 550 | + ), |
|
| 551 | + 'order' => array( |
|
| 552 | + 'description' => __( 'Order sort attribute ascending or descending.', 'invoicing' ), |
|
| 553 | + 'type' => 'string', |
|
| 554 | + 'default' => 'desc', |
|
| 555 | + 'enum' => array( 'asc', 'desc' ), |
|
| 556 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 557 | + ), |
|
| 558 | + 'orderby' => array( |
|
| 559 | + 'description' => __( 'Sort collection by object attribute.', 'invoicing' ), |
|
| 560 | + 'type' => 'string', |
|
| 561 | + 'default' => 'date', |
|
| 562 | + 'enum' => array( |
|
| 563 | + 'date', |
|
| 564 | + 'id', |
|
| 565 | + 'include', |
|
| 566 | + 'title', |
|
| 567 | + 'slug', |
|
| 568 | + 'modified', |
|
| 569 | + ), |
|
| 570 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 571 | + ), |
|
| 572 | + ) |
|
| 573 | + ); |
|
| 574 | + } |
|
| 575 | + |
|
| 576 | + /** |
|
| 577 | + * Retrieves the items's schema, conforming to JSON Schema. |
|
| 578 | + * |
|
| 579 | + * @since 1.0.19 |
|
| 580 | + * |
|
| 581 | + * @return array Item schema data. |
|
| 582 | + */ |
|
| 583 | + public function get_item_schema() { |
|
| 584 | + |
|
| 585 | + // Maybe retrieve the schema from cache. |
|
| 586 | + if ( ! empty( $this->schema ) ) { |
|
| 587 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 588 | + } |
|
| 589 | + |
|
| 590 | + $type = str_replace( 'wpi_', '', $this->post_type ); |
|
| 591 | + $schema = array( |
|
| 592 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 593 | + 'title' => $this->post_type, |
|
| 594 | + 'type' => 'object', |
|
| 595 | + 'properties' => wpinv_get_data( "$type-schema" ), |
|
| 596 | + ); |
|
| 597 | + |
|
| 598 | + // Filters the invoice schema for the REST API. |
|
| 599 | 599 | $schema = apply_filters( "wpinv_rest_{$type}_schema", $schema ); |
| 600 | 600 | |
| 601 | - // Cache the invoice schema. |
|
| 602 | - $this->schema = $schema; |
|
| 603 | - |
|
| 604 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 605 | - } |
|
| 606 | - |
|
| 607 | - /** |
|
| 608 | - * Sanitizes and validates the list of post statuses. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.13 |
|
| 611 | - * |
|
| 612 | - * @param string|array $statuses One or more post statuses. |
|
| 613 | - * @param WP_REST_Request $request Full details about the request. |
|
| 614 | - * @param string $parameter Additional parameter to pass to validation. |
|
| 615 | - * @return array|WP_Error A list of valid statuses, otherwise WP_Error object. |
|
| 616 | - */ |
|
| 617 | - public function sanitize_post_statuses( $statuses, $request, $parameter ) { |
|
| 618 | - return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() ); |
|
| 619 | - } |
|
| 620 | - |
|
| 621 | - /** |
|
| 622 | - * Retrieves a valid list of post statuses. |
|
| 623 | - * |
|
| 624 | - * @since 1.0.19 |
|
| 625 | - * |
|
| 626 | - * @return array A list of registered item statuses. |
|
| 627 | - */ |
|
| 628 | - public function get_post_statuses() { |
|
| 629 | - return get_post_stati(); |
|
| 630 | - } |
|
| 631 | - |
|
| 632 | - /** |
|
| 633 | - * Checks if a key should be included in a response. |
|
| 634 | - * |
|
| 635 | - * @since 1.0.19 |
|
| 636 | - * @param GetPaid_Data $object Data object. |
|
| 637 | - * @param string $field_key The key to check for. |
|
| 638 | - * @return bool |
|
| 639 | - */ |
|
| 640 | - public function object_supports_field( $object, $field_key ) { |
|
| 641 | - $supports = parent::object_supports_field( $object, $field_key ); |
|
| 642 | - return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key ); |
|
| 643 | - } |
|
| 601 | + // Cache the invoice schema. |
|
| 602 | + $this->schema = $schema; |
|
| 603 | + |
|
| 604 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 605 | + } |
|
| 606 | + |
|
| 607 | + /** |
|
| 608 | + * Sanitizes and validates the list of post statuses. |
|
| 609 | + * |
|
| 610 | + * @since 1.0.13 |
|
| 611 | + * |
|
| 612 | + * @param string|array $statuses One or more post statuses. |
|
| 613 | + * @param WP_REST_Request $request Full details about the request. |
|
| 614 | + * @param string $parameter Additional parameter to pass to validation. |
|
| 615 | + * @return array|WP_Error A list of valid statuses, otherwise WP_Error object. |
|
| 616 | + */ |
|
| 617 | + public function sanitize_post_statuses( $statuses, $request, $parameter ) { |
|
| 618 | + return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() ); |
|
| 619 | + } |
|
| 620 | + |
|
| 621 | + /** |
|
| 622 | + * Retrieves a valid list of post statuses. |
|
| 623 | + * |
|
| 624 | + * @since 1.0.19 |
|
| 625 | + * |
|
| 626 | + * @return array A list of registered item statuses. |
|
| 627 | + */ |
|
| 628 | + public function get_post_statuses() { |
|
| 629 | + return get_post_stati(); |
|
| 630 | + } |
|
| 631 | + |
|
| 632 | + /** |
|
| 633 | + * Checks if a key should be included in a response. |
|
| 634 | + * |
|
| 635 | + * @since 1.0.19 |
|
| 636 | + * @param GetPaid_Data $object Data object. |
|
| 637 | + * @param string $field_key The key to check for. |
|
| 638 | + * @return bool |
|
| 639 | + */ |
|
| 640 | + public function object_supports_field( $object, $field_key ) { |
|
| 641 | + $supports = parent::object_supports_field( $object, $field_key ); |
|
| 642 | + return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key ); |
|
| 643 | + } |
|
| 644 | 644 | |
| 645 | 645 | } |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * @version 1.0.19 |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | -defined( 'ABSPATH' ) || exit; |
|
| 11 | +defined('ABSPATH') || exit; |
|
| 12 | 12 | |
| 13 | 13 | /** |
| 14 | 14 | * GetPaid REST Posts controller class. |
@@ -38,9 +38,9 @@ discard block |
||
| 38 | 38 | * |
| 39 | 39 | * @see register_rest_route() |
| 40 | 40 | */ |
| 41 | - public function register_namespace_routes( $namespace ) { |
|
| 41 | + public function register_namespace_routes($namespace) { |
|
| 42 | 42 | |
| 43 | - parent::register_namespace_routes( $namespace ); |
|
| 43 | + parent::register_namespace_routes($namespace); |
|
| 44 | 44 | |
| 45 | 45 | register_rest_route( |
| 46 | 46 | $namespace, |
@@ -48,11 +48,11 @@ discard block |
||
| 48 | 48 | array( |
| 49 | 49 | array( |
| 50 | 50 | 'methods' => WP_REST_Server::EDITABLE, |
| 51 | - 'callback' => array( $this, 'batch_items' ), |
|
| 52 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 53 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 51 | + 'callback' => array($this, 'batch_items'), |
|
| 52 | + 'permission_callback' => array($this, 'batch_items_permissions_check'), |
|
| 53 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE), |
|
| 54 | 54 | ), |
| 55 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 55 | + 'schema' => array($this, 'get_public_batch_schema'), |
|
| 56 | 56 | ) |
| 57 | 57 | ); |
| 58 | 58 | |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | * @param int $object_id Post ID. |
| 67 | 67 | * @return bool |
| 68 | 68 | */ |
| 69 | - public function check_post_permissions( $context = 'read', $object_id = 0 ) { |
|
| 69 | + public function check_post_permissions($context = 'read', $object_id = 0) { |
|
| 70 | 70 | |
| 71 | 71 | $contexts = array( |
| 72 | 72 | 'read' => 'read_private_posts', |
@@ -76,11 +76,11 @@ discard block |
||
| 76 | 76 | 'batch' => 'edit_others_posts', |
| 77 | 77 | ); |
| 78 | 78 | |
| 79 | - $cap = $contexts[ $context ]; |
|
| 80 | - $post_type_object = get_post_type_object( $this->post_type ); |
|
| 81 | - $permission = current_user_can( $post_type_object->cap->$cap, $object_id ); |
|
| 79 | + $cap = $contexts[$context]; |
|
| 80 | + $post_type_object = get_post_type_object($this->post_type); |
|
| 81 | + $permission = current_user_can($post_type_object->cap->$cap, $object_id); |
|
| 82 | 82 | |
| 83 | - return apply_filters( 'getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type ); |
|
| 83 | + return apply_filters('getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type); |
|
| 84 | 84 | } |
| 85 | 85 | |
| 86 | 86 | /** |
@@ -89,8 +89,8 @@ discard block |
||
| 89 | 89 | * @param WP_REST_Request $request Full details about the request. |
| 90 | 90 | * @return WP_Error|boolean |
| 91 | 91 | */ |
| 92 | - public function get_items_permissions_check( $request ) { |
|
| 93 | - return $this->check_post_permissions() ? true : new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 92 | + public function get_items_permissions_check($request) { |
|
| 93 | + return $this->check_post_permissions() ? true : new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 94 | 94 | } |
| 95 | 95 | |
| 96 | 96 | /** |
@@ -99,8 +99,8 @@ discard block |
||
| 99 | 99 | * @param WP_REST_Request $request Full details about the request. |
| 100 | 100 | * @return WP_Error|boolean |
| 101 | 101 | */ |
| 102 | - public function create_item_permissions_check( $request ) { |
|
| 103 | - 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() ) ); |
|
| 102 | + public function create_item_permissions_check($request) { |
|
| 103 | + 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())); |
|
| 104 | 104 | } |
| 105 | 105 | |
| 106 | 106 | /** |
@@ -109,11 +109,11 @@ discard block |
||
| 109 | 109 | * @param WP_REST_Request $request Full details about the request. |
| 110 | 110 | * @return WP_Error|boolean |
| 111 | 111 | */ |
| 112 | - public function get_item_permissions_check( $request ) { |
|
| 113 | - $post = get_post( (int) $request['id'] ); |
|
| 112 | + public function get_item_permissions_check($request) { |
|
| 113 | + $post = get_post((int) $request['id']); |
|
| 114 | 114 | |
| 115 | - if ( $post && ! $this->check_post_permissions( 'read', $post->ID ) ) { |
|
| 116 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 115 | + if ($post && !$this->check_post_permissions('read', $post->ID)) { |
|
| 116 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot view this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 117 | 117 | } |
| 118 | 118 | |
| 119 | 119 | return true; |
@@ -125,11 +125,11 @@ discard block |
||
| 125 | 125 | * @param WP_REST_Request $request Full details about the request. |
| 126 | 126 | * @return WP_Error|boolean |
| 127 | 127 | */ |
| 128 | - public function update_item_permissions_check( $request ) { |
|
| 129 | - $post = get_post( (int) $request['id'] ); |
|
| 128 | + public function update_item_permissions_check($request) { |
|
| 129 | + $post = get_post((int) $request['id']); |
|
| 130 | 130 | |
| 131 | - if ( $post && ! $this->check_post_permissions( 'edit', $post->ID ) ) { |
|
| 132 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 131 | + if ($post && !$this->check_post_permissions('edit', $post->ID)) { |
|
| 132 | + return new WP_Error('rest_cannot_edit', __('Sorry, you are not allowed to edit this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | 135 | return true; |
@@ -141,11 +141,11 @@ discard block |
||
| 141 | 141 | * @param WP_REST_Request $request Full details about the request. |
| 142 | 142 | * @return bool|WP_Error |
| 143 | 143 | */ |
| 144 | - public function delete_item_permissions_check( $request ) { |
|
| 145 | - $post = get_post( (int) $request['id'] ); |
|
| 144 | + public function delete_item_permissions_check($request) { |
|
| 145 | + $post = get_post((int) $request['id']); |
|
| 146 | 146 | |
| 147 | - if ( $post && ! $this->check_post_permissions( 'delete', $post->ID ) ) { |
|
| 148 | - return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 147 | + if ($post && !$this->check_post_permissions('delete', $post->ID)) { |
|
| 148 | + return new WP_Error('rest_cannot_delete', __('Sorry, you are not allowed to delete this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 149 | 149 | } |
| 150 | 150 | |
| 151 | 151 | return true; |
@@ -158,15 +158,15 @@ discard block |
||
| 158 | 158 | * |
| 159 | 159 | * @return boolean|WP_Error |
| 160 | 160 | */ |
| 161 | - public function batch_items_permissions_check( $request ) { |
|
| 162 | - 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() ) ); |
|
| 161 | + public function batch_items_permissions_check($request) { |
|
| 162 | + 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())); |
|
| 163 | 163 | } |
| 164 | 164 | |
| 165 | 165 | /** |
| 166 | 166 | * @deprecated |
| 167 | 167 | */ |
| 168 | - public function get_post( $object_id ) { |
|
| 169 | - return $this->get_object( $object_id ); |
|
| 168 | + public function get_post($object_id) { |
|
| 169 | + return $this->get_object($object_id); |
|
| 170 | 170 | } |
| 171 | 171 | |
| 172 | 172 | /** |
@@ -175,14 +175,14 @@ discard block |
||
| 175 | 175 | * @param WP_REST_Request $request Full details about the request. |
| 176 | 176 | * @return WP_Error|WP_REST_Response |
| 177 | 177 | */ |
| 178 | - public function get_item( $request ) { |
|
| 178 | + public function get_item($request) { |
|
| 179 | 179 | |
| 180 | 180 | // Fetch item. |
| 181 | - $response = parent::get_item( $request ); |
|
| 181 | + $response = parent::get_item($request); |
|
| 182 | 182 | |
| 183 | 183 | // (Maybe) add a link to the html pagee. |
| 184 | - if ( $this->public && ! is_wp_error( $response ) ) { |
|
| 185 | - $response->link_header( 'alternate', get_permalink( $this->data_object->get_id() ), array( 'type' => 'text/html' ) ); |
|
| 184 | + if ($this->public && !is_wp_error($response)) { |
|
| 185 | + $response->link_header('alternate', get_permalink($this->data_object->get_id()), array('type' => 'text/html')); |
|
| 186 | 186 | } |
| 187 | 187 | |
| 188 | 188 | return $response; |
@@ -194,13 +194,13 @@ discard block |
||
| 194 | 194 | * @param WP_REST_Request $request Full details about the request. |
| 195 | 195 | * @return WP_Error|WP_REST_Response |
| 196 | 196 | */ |
| 197 | - public function create_item( $request ) { |
|
| 197 | + public function create_item($request) { |
|
| 198 | 198 | |
| 199 | 199 | // Create item. |
| 200 | - $response = parent::create_item( $request ); |
|
| 200 | + $response = parent::create_item($request); |
|
| 201 | 201 | |
| 202 | 202 | // Fire a hook after an item is created. |
| 203 | - if ( ! is_wp_error( $response ) ) { |
|
| 203 | + if (!is_wp_error($response)) { |
|
| 204 | 204 | |
| 205 | 205 | /** |
| 206 | 206 | * Fires after a single item is created or updated via the REST API. |
@@ -209,7 +209,7 @@ discard block |
||
| 209 | 209 | * @param WP_REST_Request $request Request object. |
| 210 | 210 | * @param boolean $creating True when creating item, false when updating. |
| 211 | 211 | */ |
| 212 | - do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true ); |
|
| 212 | + do_action("getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true); |
|
| 213 | 213 | |
| 214 | 214 | } |
| 215 | 215 | |
@@ -223,13 +223,13 @@ discard block |
||
| 223 | 223 | * @param WP_REST_Request $request Full details about the request. |
| 224 | 224 | * @return WP_Error|WP_REST_Response |
| 225 | 225 | */ |
| 226 | - public function update_item( $request ) { |
|
| 226 | + public function update_item($request) { |
|
| 227 | 227 | |
| 228 | 228 | // Create item. |
| 229 | - $response = parent::update_item( $request ); |
|
| 229 | + $response = parent::update_item($request); |
|
| 230 | 230 | |
| 231 | 231 | // Fire a hook after an item is created. |
| 232 | - if ( ! is_wp_error( $response ) ) { |
|
| 232 | + if (!is_wp_error($response)) { |
|
| 233 | 233 | |
| 234 | 234 | /** |
| 235 | 235 | * Fires after a single item is created or updated via the REST API. |
@@ -238,7 +238,7 @@ discard block |
||
| 238 | 238 | * @param WP_REST_Request $request Request object. |
| 239 | 239 | * @param boolean $creating True when creating item, false when updating. |
| 240 | 240 | */ |
| 241 | - do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false ); |
|
| 241 | + do_action("getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false); |
|
| 242 | 242 | |
| 243 | 243 | } |
| 244 | 244 | |
@@ -252,7 +252,7 @@ discard block |
||
| 252 | 252 | * @param WP_REST_Request $request Full details about the request. |
| 253 | 253 | * @return WP_Error|WP_REST_Response |
| 254 | 254 | */ |
| 255 | - public function get_items( $request ) { |
|
| 255 | + public function get_items($request) { |
|
| 256 | 256 | |
| 257 | 257 | $args = array(); |
| 258 | 258 | $args['offset'] = $request['offset']; |
@@ -266,17 +266,17 @@ discard block |
||
| 266 | 266 | $args['post_parent__in'] = $request['parent']; |
| 267 | 267 | $args['post_parent__not_in'] = $request['parent_exclude']; |
| 268 | 268 | $args['s'] = $request['search']; |
| 269 | - $args['post_status'] = wpinv_parse_list( $request['status'] ); |
|
| 269 | + $args['post_status'] = wpinv_parse_list($request['status']); |
|
| 270 | 270 | |
| 271 | 271 | $args['date_query'] = array(); |
| 272 | 272 | |
| 273 | 273 | // Set before into date query. Date query must be specified as an array of an array. |
| 274 | - if ( isset( $request['before'] ) ) { |
|
| 274 | + if (isset($request['before'])) { |
|
| 275 | 275 | $args['date_query'][0]['before'] = $request['before']; |
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | // Set after into date query. Date query must be specified as an array of an array. |
| 279 | - if ( isset( $request['after'] ) ) { |
|
| 279 | + if (isset($request['after'])) { |
|
| 280 | 280 | $args['date_query'][0]['after'] = $request['after']; |
| 281 | 281 | } |
| 282 | 282 | |
@@ -285,54 +285,54 @@ discard block |
||
| 285 | 285 | $args['fields'] = 'ids'; |
| 286 | 286 | |
| 287 | 287 | // Filter the query arguments for a request. |
| 288 | - $args = apply_filters( "getpaid_rest_{$this->post_type}_query", $args, $request ); |
|
| 289 | - $query_args = $this->prepare_items_query( $args, $request ); |
|
| 288 | + $args = apply_filters("getpaid_rest_{$this->post_type}_query", $args, $request); |
|
| 289 | + $query_args = $this->prepare_items_query($args, $request); |
|
| 290 | 290 | |
| 291 | 291 | $posts_query = new WP_Query(); |
| 292 | - $query_result = $posts_query->query( $query_args ); |
|
| 292 | + $query_result = $posts_query->query($query_args); |
|
| 293 | 293 | |
| 294 | 294 | $posts = array(); |
| 295 | - foreach ( $query_result as $post_id ) { |
|
| 296 | - if ( ! $this->check_post_permissions( 'read', $post_id ) ) { |
|
| 295 | + foreach ($query_result as $post_id) { |
|
| 296 | + if (!$this->check_post_permissions('read', $post_id)) { |
|
| 297 | 297 | continue; |
| 298 | 298 | } |
| 299 | 299 | |
| 300 | - $data = $this->prepare_item_for_response( $this->get_object( $post_id ), $request ); |
|
| 301 | - $posts[] = $this->prepare_response_for_collection( $data ); |
|
| 300 | + $data = $this->prepare_item_for_response($this->get_object($post_id), $request); |
|
| 301 | + $posts[] = $this->prepare_response_for_collection($data); |
|
| 302 | 302 | } |
| 303 | 303 | |
| 304 | 304 | $page = (int) $query_args['paged']; |
| 305 | 305 | $total_posts = $posts_query->found_posts; |
| 306 | 306 | |
| 307 | - if ( $total_posts < 1 ) { |
|
| 307 | + if ($total_posts < 1) { |
|
| 308 | 308 | // Out-of-bounds, run the query again without LIMIT for total count. |
| 309 | - unset( $query_args['paged'] ); |
|
| 309 | + unset($query_args['paged']); |
|
| 310 | 310 | $count_query = new WP_Query(); |
| 311 | - $count_query->query( $query_args ); |
|
| 311 | + $count_query->query($query_args); |
|
| 312 | 312 | $total_posts = $count_query->found_posts; |
| 313 | 313 | } |
| 314 | 314 | |
| 315 | - $max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] ); |
|
| 315 | + $max_pages = ceil($total_posts / (int) $query_args['posts_per_page']); |
|
| 316 | 316 | |
| 317 | - $response = rest_ensure_response( $posts ); |
|
| 318 | - $response->header( 'X-WP-Total', (int) $total_posts ); |
|
| 319 | - $response->header( 'X-WP-TotalPages', (int) $max_pages ); |
|
| 317 | + $response = rest_ensure_response($posts); |
|
| 318 | + $response->header('X-WP-Total', (int) $total_posts); |
|
| 319 | + $response->header('X-WP-TotalPages', (int) $max_pages); |
|
| 320 | 320 | |
| 321 | 321 | $request_params = $request->get_query_params(); |
| 322 | - $base = add_query_arg( $request_params, rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) ); |
|
| 322 | + $base = add_query_arg($request_params, rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base))); |
|
| 323 | 323 | |
| 324 | - if ( $page > 1 ) { |
|
| 324 | + if ($page > 1) { |
|
| 325 | 325 | $prev_page = $page - 1; |
| 326 | - if ( $prev_page > $max_pages ) { |
|
| 326 | + if ($prev_page > $max_pages) { |
|
| 327 | 327 | $prev_page = $max_pages; |
| 328 | 328 | } |
| 329 | - $prev_link = add_query_arg( 'page', $prev_page, $base ); |
|
| 330 | - $response->link_header( 'prev', $prev_link ); |
|
| 329 | + $prev_link = add_query_arg('page', $prev_page, $base); |
|
| 330 | + $response->link_header('prev', $prev_link); |
|
| 331 | 331 | } |
| 332 | - if ( $max_pages > $page ) { |
|
| 332 | + if ($max_pages > $page) { |
|
| 333 | 333 | $next_page = $page + 1; |
| 334 | - $next_link = add_query_arg( 'page', $next_page, $base ); |
|
| 335 | - $response->link_header( 'next', $next_link ); |
|
| 334 | + $next_link = add_query_arg('page', $next_page, $base); |
|
| 335 | + $response->link_header('next', $next_link); |
|
| 336 | 336 | } |
| 337 | 337 | |
| 338 | 338 | return $response; |
@@ -344,26 +344,26 @@ discard block |
||
| 344 | 344 | * @param WP_REST_Request $request Full details about the request. |
| 345 | 345 | * @return WP_REST_Response|WP_Error |
| 346 | 346 | */ |
| 347 | - public function delete_item( $request ) { |
|
| 347 | + public function delete_item($request) { |
|
| 348 | 348 | |
| 349 | 349 | // Fetch the item. |
| 350 | - $item = $this->get_object( $request['id'] ); |
|
| 351 | - if ( is_wp_error( $item ) ) { |
|
| 350 | + $item = $this->get_object($request['id']); |
|
| 351 | + if (is_wp_error($item)) { |
|
| 352 | 352 | return $item; |
| 353 | 353 | } |
| 354 | 354 | |
| 355 | 355 | $supports_trash = EMPTY_TRASH_DAYS > 0; |
| 356 | 356 | $force = $supports_trash && (bool) $request['force']; |
| 357 | 357 | |
| 358 | - if ( ! $this->check_post_permissions( 'delete', $item->ID ) ) { |
|
| 359 | - return new WP_Error( "cannot_delete", __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 358 | + if (!$this->check_post_permissions('delete', $item->ID)) { |
|
| 359 | + return new WP_Error("cannot_delete", __('Sorry, you are not allowed to delete this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 360 | 360 | } |
| 361 | 361 | |
| 362 | - $request->set_param( 'context', 'edit' ); |
|
| 363 | - $response = $this->prepare_item_for_response( $item, $request ); |
|
| 362 | + $request->set_param('context', 'edit'); |
|
| 363 | + $response = $this->prepare_item_for_response($item, $request); |
|
| 364 | 364 | |
| 365 | - if ( ! wp_delete_post( $item->ID, $force ) ) { |
|
| 366 | - return new WP_Error( 'rest_cannot_delete', sprintf( __( 'The resource cannot be deleted.', 'invoicing' ), $this->post_type ), array( 'status' => 500 ) ); |
|
| 365 | + if (!wp_delete_post($item->ID, $force)) { |
|
| 366 | + return new WP_Error('rest_cannot_delete', sprintf(__('The resource cannot be deleted.', 'invoicing'), $this->post_type), array('status' => 500)); |
|
| 367 | 367 | } |
| 368 | 368 | |
| 369 | 369 | return $response; |
@@ -375,27 +375,27 @@ discard block |
||
| 375 | 375 | * @param GetPaid_Data $object GetPaid_Data object. |
| 376 | 376 | * @return array Links for the given object. |
| 377 | 377 | */ |
| 378 | - protected function prepare_links( $object ) { |
|
| 378 | + protected function prepare_links($object) { |
|
| 379 | 379 | |
| 380 | - $links = parent::prepare_links( $object ); |
|
| 380 | + $links = parent::prepare_links($object); |
|
| 381 | 381 | |
| 382 | - if ( is_callable( array( $object, 'get_user_id' ) ) ) { |
|
| 382 | + if (is_callable(array($object, 'get_user_id'))) { |
|
| 383 | 383 | $links['user'] = array( |
| 384 | - 'href' => rest_url( 'wp/v2/users/' . call_user_func( array( $object, 'get_user_id' ) ) ), |
|
| 384 | + 'href' => rest_url('wp/v2/users/' . call_user_func(array($object, 'get_user_id'))), |
|
| 385 | 385 | 'embeddable' => true, |
| 386 | 386 | ); |
| 387 | 387 | } |
| 388 | 388 | |
| 389 | - if ( is_callable( array( $object, 'get_owner' ) ) ) { |
|
| 390 | - $links['owner'] = array( |
|
| 391 | - 'href' => rest_url( 'wp/v2/users/' . call_user_func( array( $object, 'get_owner' ) ) ), |
|
| 389 | + if (is_callable(array($object, 'get_owner'))) { |
|
| 390 | + $links['owner'] = array( |
|
| 391 | + 'href' => rest_url('wp/v2/users/' . call_user_func(array($object, 'get_owner'))), |
|
| 392 | 392 | 'embeddable' => true, |
| 393 | 393 | ); |
| 394 | 394 | } |
| 395 | 395 | |
| 396 | - if ( is_callable( array( $object, 'get_parent_id' ) ) && call_user_func( array( $object, 'get_parent_id' ) ) ) { |
|
| 397 | - $links['parent'] = array( |
|
| 398 | - 'href' => rest_url( "$this->namespace/$this->rest_base/" . call_user_func( array( $object, 'get_parent_id' ) ) ), |
|
| 396 | + if (is_callable(array($object, 'get_parent_id')) && call_user_func(array($object, 'get_parent_id'))) { |
|
| 397 | + $links['parent'] = array( |
|
| 398 | + 'href' => rest_url("$this->namespace/$this->rest_base/" . call_user_func(array($object, 'get_parent_id'))), |
|
| 399 | 399 | 'embeddable' => true, |
| 400 | 400 | ); |
| 401 | 401 | } |
@@ -411,27 +411,27 @@ discard block |
||
| 411 | 411 | * @param WP_REST_Request $request Request object. |
| 412 | 412 | * @return array $query_args |
| 413 | 413 | */ |
| 414 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 414 | + protected function prepare_items_query($prepared_args = array(), $request = null) { |
|
| 415 | 415 | |
| 416 | - $valid_vars = array_flip( $this->get_allowed_query_vars() ); |
|
| 416 | + $valid_vars = array_flip($this->get_allowed_query_vars()); |
|
| 417 | 417 | $query_args = array(); |
| 418 | - foreach ( $valid_vars as $var => $index ) { |
|
| 419 | - if ( isset( $prepared_args[ $var ] ) ) { |
|
| 420 | - $query_args[ $var ] = apply_filters( "getpaid_rest_query_var-{$var}", $prepared_args[ $var ], $index ); |
|
| 418 | + foreach ($valid_vars as $var => $index) { |
|
| 419 | + if (isset($prepared_args[$var])) { |
|
| 420 | + $query_args[$var] = apply_filters("getpaid_rest_query_var-{$var}", $prepared_args[$var], $index); |
|
| 421 | 421 | } |
| 422 | 422 | } |
| 423 | 423 | |
| 424 | 424 | $query_args['ignore_sticky_posts'] = true; |
| 425 | 425 | |
| 426 | - if ( 'include' === $query_args['orderby'] ) { |
|
| 426 | + if ('include' === $query_args['orderby']) { |
|
| 427 | 427 | $query_args['orderby'] = 'post__in'; |
| 428 | - } elseif ( 'id' === $query_args['orderby'] ) { |
|
| 428 | + } elseif ('id' === $query_args['orderby']) { |
|
| 429 | 429 | $query_args['orderby'] = 'ID'; // ID must be capitalized. |
| 430 | - } elseif ( 'slug' === $query_args['orderby'] ) { |
|
| 430 | + } elseif ('slug' === $query_args['orderby']) { |
|
| 431 | 431 | $query_args['orderby'] = 'name'; |
| 432 | 432 | } |
| 433 | 433 | |
| 434 | - return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this ); |
|
| 434 | + return apply_filters('getpaid_rest_prepare_items_query', $query_args, $request, $this); |
|
| 435 | 435 | |
| 436 | 436 | } |
| 437 | 437 | |
@@ -450,12 +450,12 @@ discard block |
||
| 450 | 450 | * |
| 451 | 451 | * @param array Array of allowed WP_Query query vars. |
| 452 | 452 | */ |
| 453 | - $valid_vars = apply_filters( 'query_vars', $wp->public_query_vars ); |
|
| 453 | + $valid_vars = apply_filters('query_vars', $wp->public_query_vars); |
|
| 454 | 454 | |
| 455 | - $post_type_obj = get_post_type_object( $this->post_type ); |
|
| 456 | - if ( current_user_can( $post_type_obj->cap->edit_posts ) ) { |
|
| 457 | - $private = apply_filters( 'getpaid_rest_private_query_vars', $wp->private_query_vars ); |
|
| 458 | - $valid_vars = array_merge( $valid_vars, $private ); |
|
| 455 | + $post_type_obj = get_post_type_object($this->post_type); |
|
| 456 | + if (current_user_can($post_type_obj->cap->edit_posts)) { |
|
| 457 | + $private = apply_filters('getpaid_rest_private_query_vars', $wp->private_query_vars); |
|
| 458 | + $valid_vars = array_merge($valid_vars, $private); |
|
| 459 | 459 | } |
| 460 | 460 | |
| 461 | 461 | // Define our own in addition to WP's normal vars. |
@@ -477,10 +477,10 @@ discard block |
||
| 477 | 477 | 'meta_compare', |
| 478 | 478 | 'meta_value_num', |
| 479 | 479 | ); |
| 480 | - $valid_vars = array_merge( $valid_vars, $rest_valid ); |
|
| 480 | + $valid_vars = array_merge($valid_vars, $rest_valid); |
|
| 481 | 481 | |
| 482 | 482 | // Filter allowed query vars for the REST API. |
| 483 | - $valid_vars = apply_filters( 'getpaid_rest_query_vars', $valid_vars, $this ); |
|
| 483 | + $valid_vars = apply_filters('getpaid_rest_query_vars', $valid_vars, $this); |
|
| 484 | 484 | |
| 485 | 485 | return $valid_vars; |
| 486 | 486 | } |
@@ -499,31 +499,31 @@ discard block |
||
| 499 | 499 | array( |
| 500 | 500 | 'status' => array( |
| 501 | 501 | 'default' => $this->get_post_statuses(), |
| 502 | - 'description' => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ), |
|
| 503 | - 'type' => array( 'array', 'string' ), |
|
| 502 | + 'description' => __('Limit result set to resources assigned one or more statuses.', 'invoicing'), |
|
| 503 | + 'type' => array('array', 'string'), |
|
| 504 | 504 | 'items' => array( |
| 505 | 505 | 'enum' => $this->get_post_statuses(), |
| 506 | 506 | 'type' => 'string', |
| 507 | 507 | ), |
| 508 | 508 | 'validate_callback' => 'rest_validate_request_arg', |
| 509 | - 'sanitize_callback' => array( $this, 'sanitize_post_statuses' ), |
|
| 509 | + 'sanitize_callback' => array($this, 'sanitize_post_statuses'), |
|
| 510 | 510 | ), |
| 511 | 511 | 'after' => array( |
| 512 | - 'description' => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ), |
|
| 512 | + 'description' => __('Limit response to resources created after a given ISO8601 compliant date.', 'invoicing'), |
|
| 513 | 513 | 'type' => 'string', |
| 514 | 514 | 'format' => 'string', |
| 515 | 515 | 'validate_callback' => 'rest_validate_request_arg', |
| 516 | 516 | 'sanitize_callback' => 'sanitize_text_field', |
| 517 | 517 | ), |
| 518 | 518 | 'before' => array( |
| 519 | - 'description' => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ), |
|
| 519 | + 'description' => __('Limit response to resources created before a given ISO8601 compliant date.', 'invoicing'), |
|
| 520 | 520 | 'type' => 'string', |
| 521 | 521 | 'format' => 'string', |
| 522 | 522 | 'validate_callback' => 'rest_validate_request_arg', |
| 523 | 523 | 'sanitize_callback' => 'sanitize_text_field', |
| 524 | 524 | ), |
| 525 | 525 | 'exclude' => array( |
| 526 | - 'description' => __( 'Ensure result set excludes specific IDs.', 'invoicing' ), |
|
| 526 | + 'description' => __('Ensure result set excludes specific IDs.', 'invoicing'), |
|
| 527 | 527 | 'type' => 'array', |
| 528 | 528 | 'items' => array( |
| 529 | 529 | 'type' => 'integer', |
@@ -533,7 +533,7 @@ discard block |
||
| 533 | 533 | 'validate_callback' => 'rest_validate_request_arg', |
| 534 | 534 | ), |
| 535 | 535 | 'include' => array( |
| 536 | - 'description' => __( 'Limit result set to specific ids.', 'invoicing' ), |
|
| 536 | + 'description' => __('Limit result set to specific ids.', 'invoicing'), |
|
| 537 | 537 | 'type' => 'array', |
| 538 | 538 | 'items' => array( |
| 539 | 539 | 'type' => 'integer', |
@@ -543,20 +543,20 @@ discard block |
||
| 543 | 543 | 'validate_callback' => 'rest_validate_request_arg', |
| 544 | 544 | ), |
| 545 | 545 | 'offset' => array( |
| 546 | - 'description' => __( 'Offset the result set by a specific number of items.', 'invoicing' ), |
|
| 546 | + 'description' => __('Offset the result set by a specific number of items.', 'invoicing'), |
|
| 547 | 547 | 'type' => 'integer', |
| 548 | 548 | 'sanitize_callback' => 'absint', |
| 549 | 549 | 'validate_callback' => 'rest_validate_request_arg', |
| 550 | 550 | ), |
| 551 | 551 | 'order' => array( |
| 552 | - 'description' => __( 'Order sort attribute ascending or descending.', 'invoicing' ), |
|
| 552 | + 'description' => __('Order sort attribute ascending or descending.', 'invoicing'), |
|
| 553 | 553 | 'type' => 'string', |
| 554 | 554 | 'default' => 'desc', |
| 555 | - 'enum' => array( 'asc', 'desc' ), |
|
| 555 | + 'enum' => array('asc', 'desc'), |
|
| 556 | 556 | 'validate_callback' => 'rest_validate_request_arg', |
| 557 | 557 | ), |
| 558 | 558 | 'orderby' => array( |
| 559 | - 'description' => __( 'Sort collection by object attribute.', 'invoicing' ), |
|
| 559 | + 'description' => __('Sort collection by object attribute.', 'invoicing'), |
|
| 560 | 560 | 'type' => 'string', |
| 561 | 561 | 'default' => 'date', |
| 562 | 562 | 'enum' => array( |
@@ -583,25 +583,25 @@ discard block |
||
| 583 | 583 | public function get_item_schema() { |
| 584 | 584 | |
| 585 | 585 | // Maybe retrieve the schema from cache. |
| 586 | - if ( ! empty( $this->schema ) ) { |
|
| 587 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 586 | + if (!empty($this->schema)) { |
|
| 587 | + return $this->add_additional_fields_schema($this->schema); |
|
| 588 | 588 | } |
| 589 | 589 | |
| 590 | - $type = str_replace( 'wpi_', '', $this->post_type ); |
|
| 590 | + $type = str_replace('wpi_', '', $this->post_type); |
|
| 591 | 591 | $schema = array( |
| 592 | 592 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 593 | 593 | 'title' => $this->post_type, |
| 594 | 594 | 'type' => 'object', |
| 595 | - 'properties' => wpinv_get_data( "$type-schema" ), |
|
| 595 | + 'properties' => wpinv_get_data("$type-schema"), |
|
| 596 | 596 | ); |
| 597 | 597 | |
| 598 | 598 | // Filters the invoice schema for the REST API. |
| 599 | - $schema = apply_filters( "wpinv_rest_{$type}_schema", $schema ); |
|
| 599 | + $schema = apply_filters("wpinv_rest_{$type}_schema", $schema); |
|
| 600 | 600 | |
| 601 | 601 | // Cache the invoice schema. |
| 602 | 602 | $this->schema = $schema; |
| 603 | 603 | |
| 604 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 604 | + return $this->add_additional_fields_schema($this->schema); |
|
| 605 | 605 | } |
| 606 | 606 | |
| 607 | 607 | /** |
@@ -614,8 +614,8 @@ discard block |
||
| 614 | 614 | * @param string $parameter Additional parameter to pass to validation. |
| 615 | 615 | * @return array|WP_Error A list of valid statuses, otherwise WP_Error object. |
| 616 | 616 | */ |
| 617 | - public function sanitize_post_statuses( $statuses, $request, $parameter ) { |
|
| 618 | - return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() ); |
|
| 617 | + public function sanitize_post_statuses($statuses, $request, $parameter) { |
|
| 618 | + return array_intersect(wp_parse_slug_list($statuses), $this->get_post_statuses()); |
|
| 619 | 619 | } |
| 620 | 620 | |
| 621 | 621 | /** |
@@ -637,9 +637,9 @@ discard block |
||
| 637 | 637 | * @param string $field_key The key to check for. |
| 638 | 638 | * @return bool |
| 639 | 639 | */ |
| 640 | - public function object_supports_field( $object, $field_key ) { |
|
| 641 | - $supports = parent::object_supports_field( $object, $field_key ); |
|
| 642 | - return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key ); |
|
| 640 | + public function object_supports_field($object, $field_key) { |
|
| 641 | + $supports = parent::object_supports_field($object, $field_key); |
|
| 642 | + return apply_filters("getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key); |
|
| 643 | 643 | } |
| 644 | 644 | |
| 645 | 645 | } |
@@ -3,7 +3,9 @@ |
||
| 3 | 3 | * Displays a list of all subscriptions rules |
| 4 | 4 | */ |
| 5 | 5 | |
| 6 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 6 | +if ( ! defined( 'ABSPATH' ) ) { |
|
| 7 | + exit; |
|
| 8 | +} |
|
| 7 | 9 | |
| 8 | 10 | if ( ! class_exists( 'WP_List_Table' ) ) { |
| 9 | 11 | include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
@@ -6,7 +6,7 @@ discard block |
||
| 6 | 6 | if ( ! defined( 'ABSPATH' ) ) exit; |
| 7 | 7 | |
| 8 | 8 | if ( ! class_exists( 'WP_List_Table' ) ) { |
| 9 | - include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 9 | + include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 10 | 10 | } |
| 11 | 11 | |
| 12 | 12 | /** |
@@ -14,467 +14,467 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | class WPInv_Subscriptions_List_Table extends WP_List_Table { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * URL of this page |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - * @since 1.0.19 |
|
| 22 | - */ |
|
| 23 | - public $base_url; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * Query |
|
| 27 | - * |
|
| 28 | - * @var GetPaid_Subscriptions_Query |
|
| 29 | - * @since 1.0.19 |
|
| 30 | - */ |
|
| 31 | - public $query; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Total subscriptions |
|
| 35 | - * |
|
| 36 | - * @var string |
|
| 37 | - * @since 1.0.0 |
|
| 38 | - */ |
|
| 39 | - public $total_count; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * Current status subscriptions |
|
| 43 | - * |
|
| 44 | - * @var string |
|
| 45 | - * @since 1.0.0 |
|
| 46 | - */ |
|
| 47 | - public $current_total_count; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Status counts |
|
| 51 | - * |
|
| 52 | - * @var array |
|
| 53 | - * @since 1.0.19 |
|
| 54 | - */ |
|
| 55 | - public $status_counts; |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Number of results to show per page |
|
| 59 | - * |
|
| 60 | - * @var int |
|
| 61 | - * @since 1.0.0 |
|
| 62 | - */ |
|
| 63 | - public $per_page = 10; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Constructor function. |
|
| 67 | - */ |
|
| 68 | - public function __construct() { |
|
| 69 | - |
|
| 70 | - parent::__construct( |
|
| 71 | - array( |
|
| 72 | - 'singular' => 'subscription', |
|
| 73 | - 'plural' => 'subscriptions', |
|
| 74 | - ) |
|
| 75 | - ); |
|
| 76 | - |
|
| 77 | - $this->process_bulk_action(); |
|
| 78 | - |
|
| 79 | - $this->prepare_query(); |
|
| 80 | - |
|
| 81 | - $this->base_url = remove_query_arg( 'status' ); |
|
| 82 | - |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Prepares the display query |
|
| 87 | - */ |
|
| 88 | - public function prepare_query() { |
|
| 89 | - |
|
| 90 | - // Prepare query args. |
|
| 91 | - $query = array( |
|
| 92 | - 'number' => $this->per_page, |
|
| 93 | - 'paged' => $this->get_paged(), |
|
| 94 | - 'status' => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all', |
|
| 95 | - 'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id', |
|
| 96 | - 'order' => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC', |
|
| 97 | - 'customer_in' => $this->get_user_in(), |
|
| 98 | - ); |
|
| 99 | - |
|
| 100 | - if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) { |
|
| 101 | - $this->total_count = 0; |
|
| 102 | - $this->current_total_count = 0; |
|
| 103 | - $this->items = array(); |
|
| 104 | - $this->status_counts = array(); |
|
| 105 | - return; |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - // Prepare class properties. |
|
| 109 | - $this->query = new GetPaid_Subscriptions_Query( $query ); |
|
| 110 | - $this->total_count = $this->query->get_total(); |
|
| 111 | - $this->current_total_count = $this->query->get_total(); |
|
| 112 | - $this->items = $this->query->get_results(); |
|
| 113 | - $this->status_counts = getpaid_get_subscription_status_counts( $query ); |
|
| 114 | - |
|
| 115 | - if ( 'all' != $query['status'] ) { |
|
| 116 | - unset( $query['status'] ); |
|
| 117 | - $this->total_count = getpaid_get_subscriptions( $query, 'count' ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Get user in. |
|
| 124 | - * |
|
| 125 | - */ |
|
| 126 | - public function get_user_in() { |
|
| 127 | - |
|
| 128 | - // Abort if no user. |
|
| 129 | - if ( empty( $_GET['s'] ) ) { |
|
| 130 | - return null; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - // Or invalid user. |
|
| 134 | - $user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) ); |
|
| 135 | - |
|
| 136 | - if ( empty( $user ) ) { |
|
| 137 | - return null; |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - // Search matching users. |
|
| 141 | - $user = '*' . $user . '*'; |
|
| 142 | - $users = new WP_User_Query( |
|
| 143 | - array( |
|
| 144 | - 'fields' => 'ID', |
|
| 145 | - 'search' => $user, |
|
| 146 | - 'count_total' => false, |
|
| 147 | - ) |
|
| 148 | - ); |
|
| 149 | - |
|
| 150 | - return $users->get_results(); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * Gets the list of views available on this table. |
|
| 155 | - * |
|
| 156 | - * The format is an associative array: |
|
| 157 | - * - `'id' => 'link'` |
|
| 158 | - * |
|
| 159 | - * @since 1.0.0 |
|
| 160 | - * |
|
| 161 | - * @return array |
|
| 162 | - */ |
|
| 163 | - public function get_views() { |
|
| 164 | - |
|
| 165 | - $current = isset( $_GET['status'] ) ? $_GET['status'] : 'all'; |
|
| 166 | - $views = array( |
|
| 167 | - |
|
| 168 | - 'all' => sprintf( |
|
| 169 | - '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 170 | - esc_url( add_query_arg( 'status', false, $this->base_url ) ), |
|
| 171 | - $current === 'all' ? ' class="current"' : '', |
|
| 172 | - __('All','invoicing' ), |
|
| 173 | - $this->total_count |
|
| 174 | - ) |
|
| 175 | - |
|
| 176 | - ); |
|
| 177 | - |
|
| 178 | - foreach ( array_filter( $this->status_counts ) as $status => $count ) { |
|
| 179 | - |
|
| 180 | - $views[ $status ] = sprintf( |
|
| 181 | - '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 182 | - esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ), |
|
| 183 | - $current === $status ? ' class="current"' : '', |
|
| 184 | - esc_html( getpaid_get_subscription_status_label( $status ) ), |
|
| 185 | - $count |
|
| 186 | - ); |
|
| 187 | - |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - return $views; |
|
| 191 | - |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - /** |
|
| 195 | - * Render most columns |
|
| 196 | - * |
|
| 197 | - * @access private |
|
| 198 | - * @since 1.0.0 |
|
| 199 | - * @return string |
|
| 200 | - */ |
|
| 201 | - public function column_default( $item, $column_name ) { |
|
| 202 | - return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name ); |
|
| 203 | - } |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * This is how checkbox column renders. |
|
| 207 | - * |
|
| 208 | - * @param WPInv_Subscription $item |
|
| 209 | - * @return string |
|
| 210 | - */ |
|
| 211 | - public function column_cb( $item ) { |
|
| 212 | - return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) ); |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - /** |
|
| 216 | - * Status column |
|
| 217 | - * |
|
| 218 | - * @param WPInv_Subscription $item |
|
| 219 | - * @since 1.0.0 |
|
| 220 | - * @return string |
|
| 221 | - */ |
|
| 222 | - public function column_status( $item ) { |
|
| 223 | - return $item->get_status_label_html(); |
|
| 224 | - } |
|
| 225 | - |
|
| 226 | - /** |
|
| 227 | - * Subscription column |
|
| 228 | - * |
|
| 229 | - * @param WPInv_Subscription $item |
|
| 230 | - * @since 1.0.0 |
|
| 231 | - * @return string |
|
| 232 | - */ |
|
| 233 | - public function column_subscription( $item ) { |
|
| 234 | - |
|
| 235 | - $username = __( '(Missing User)', 'invoicing' ); |
|
| 236 | - |
|
| 237 | - $user = get_userdata( $item->get_customer_id() ); |
|
| 238 | - if ( $user ) { |
|
| 239 | - |
|
| 240 | - $username = sprintf( |
|
| 241 | - '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 242 | - absint( $user->ID ), |
|
| 243 | - ! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 244 | - ); |
|
| 245 | - |
|
| 246 | - } |
|
| 247 | - |
|
| 248 | - // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name |
|
| 249 | - $column_content = sprintf( |
|
| 250 | - _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ), |
|
| 251 | - '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">', |
|
| 252 | - '<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>', |
|
| 253 | - $username |
|
| 254 | - ); |
|
| 255 | - |
|
| 256 | - $row_actions = array(); |
|
| 257 | - |
|
| 258 | - // View subscription. |
|
| 259 | - $view_url = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) )); |
|
| 260 | - $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>'; |
|
| 261 | - |
|
| 262 | - // View invoice. |
|
| 263 | - $invoice = get_post( $item->get_parent_invoice_id() ); |
|
| 264 | - |
|
| 265 | - if ( ! empty( $invoice ) ) { |
|
| 266 | - $invoice_url = get_edit_post_link( $invoice ); |
|
| 267 | - $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>'; |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - $delete_url = esc_url( |
|
| 271 | - wp_nonce_url( |
|
| 272 | - add_query_arg( |
|
| 273 | - array( |
|
| 274 | - 'getpaid-admin-action' => 'subscription_manual_delete', |
|
| 275 | - 'id' => $item->get_id(), |
|
| 276 | - ) |
|
| 277 | - ), |
|
| 278 | - 'getpaid-nonce', |
|
| 279 | - 'getpaid-nonce' |
|
| 280 | - ) |
|
| 281 | - ); |
|
| 282 | - $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>'; |
|
| 283 | - |
|
| 284 | - $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) ); |
|
| 285 | - |
|
| 286 | - return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions; |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * Renewal date column |
|
| 291 | - * |
|
| 292 | - * @param WPInv_Subscription $item |
|
| 293 | - * @since 1.0.0 |
|
| 294 | - * @return string |
|
| 295 | - */ |
|
| 296 | - public function column_renewal_date( $item ) { |
|
| 297 | - return getpaid_format_date_value( $item->get_expiration() ); |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * Start date column |
|
| 302 | - * |
|
| 303 | - * @param WPInv_Subscription $item |
|
| 304 | - * @since 1.0.0 |
|
| 305 | - * @return string |
|
| 306 | - */ |
|
| 307 | - public function column_start_date( $item ) { |
|
| 308 | - |
|
| 309 | - $gateway = $item->get_parent_invoice()->get_gateway_title(); |
|
| 310 | - |
|
| 311 | - if ( empty( $gateway ) ) { |
|
| 312 | - return getpaid_format_date_value( $item->get_date_created() ); |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - $url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item ); |
|
| 316 | - if ( ! empty( $url ) ) { |
|
| 317 | - |
|
| 318 | - return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 319 | - __( 'Via %s', 'invoicing' ), |
|
| 320 | - '<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>' |
|
| 321 | - ); |
|
| 322 | - |
|
| 323 | - } |
|
| 324 | - |
|
| 325 | - return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 326 | - __( 'Via %s', 'invoicing' ), |
|
| 327 | - '<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>' |
|
| 328 | - ); |
|
| 329 | - |
|
| 330 | - } |
|
| 331 | - |
|
| 332 | - /** |
|
| 333 | - * Amount column |
|
| 334 | - * |
|
| 335 | - * @param WPInv_Subscription $item |
|
| 336 | - * @since 1.0.19 |
|
| 337 | - * @return string |
|
| 338 | - */ |
|
| 339 | - public static function column_amount( $item ) { |
|
| 340 | - $amount = getpaid_get_formatted_subscription_amount( $item ); |
|
| 341 | - return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>"; |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * Billing Times column |
|
| 346 | - * |
|
| 347 | - * @param WPInv_Subscription $item |
|
| 348 | - * @since 1.0.0 |
|
| 349 | - * @return string |
|
| 350 | - */ |
|
| 351 | - public function column_renewals( $item ) { |
|
| 352 | - $max_bills = $item->get_bill_times(); |
|
| 353 | - return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * Product ID column |
|
| 358 | - * |
|
| 359 | - * @param WPInv_Subscription $item |
|
| 360 | - * @since 1.0.0 |
|
| 361 | - * @return string |
|
| 362 | - */ |
|
| 363 | - public function column_item( $item ) { |
|
| 364 | - $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() ); |
|
| 365 | - |
|
| 366 | - if ( empty( $subscription_group ) ) { |
|
| 367 | - return $this->generate_item_markup( $item->get_product_id() ); |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 371 | - return implode( ' | ', $markup ); |
|
| 372 | - |
|
| 373 | - } |
|
| 374 | - |
|
| 375 | - /** |
|
| 376 | - * Generates the items markup. |
|
| 377 | - * |
|
| 378 | - * @param int $item_id |
|
| 379 | - * @since 1.0.0 |
|
| 380 | - * @return string |
|
| 381 | - */ |
|
| 382 | - public static function generate_item_markup( $item_id ) { |
|
| 383 | - $item = get_post( $item_id ); |
|
| 384 | - |
|
| 385 | - if ( ! empty( $item ) ) { |
|
| 386 | - $link = get_edit_post_link( $item ); |
|
| 387 | - $link = esc_url( $link ); |
|
| 388 | - $name = esc_html( get_the_title( $item ) ); |
|
| 389 | - return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name; |
|
| 390 | - } else { |
|
| 391 | - return sprintf( __( 'Item #%s', 'invoicing' ), $item_id ); |
|
| 392 | - } |
|
| 393 | - |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - /** |
|
| 397 | - * Retrieve the current page number |
|
| 398 | - * |
|
| 399 | - * @return int |
|
| 400 | - */ |
|
| 401 | - public function get_paged() { |
|
| 402 | - return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - /** |
|
| 406 | - * Setup the final data for the table |
|
| 407 | - * |
|
| 408 | - */ |
|
| 409 | - public function prepare_items() { |
|
| 410 | - |
|
| 411 | - $columns = $this->get_columns(); |
|
| 412 | - $hidden = array(); |
|
| 413 | - $sortable = $this->get_sortable_columns(); |
|
| 414 | - |
|
| 415 | - $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 416 | - |
|
| 417 | - $this->set_pagination_args( |
|
| 418 | - array( |
|
| 419 | - 'total_items' => $this->current_total_count, |
|
| 420 | - 'per_page' => $this->per_page, |
|
| 421 | - 'total_pages' => ceil( $this->current_total_count / $this->per_page ) |
|
| 422 | - ) |
|
| 423 | - ); |
|
| 424 | - } |
|
| 425 | - |
|
| 426 | - /** |
|
| 427 | - * Table columns |
|
| 428 | - * |
|
| 429 | - * @return array |
|
| 430 | - */ |
|
| 431 | - public function get_columns(){ |
|
| 432 | - $columns = array( |
|
| 433 | - 'cb' => '<input type="checkbox" />', |
|
| 434 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 435 | - 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 436 | - 'renewal_date' => __( 'Next Payment', 'invoicing' ), |
|
| 437 | - 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 438 | - 'item' => __( 'Items', 'invoicing' ), |
|
| 439 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 440 | - ); |
|
| 441 | - |
|
| 442 | - return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns ); |
|
| 443 | - } |
|
| 444 | - |
|
| 445 | - /** |
|
| 446 | - * Sortable table columns. |
|
| 447 | - * |
|
| 448 | - * @return array |
|
| 449 | - */ |
|
| 450 | - public function get_sortable_columns() { |
|
| 451 | - $sortable = array( |
|
| 452 | - 'subscription' => array( 'id', true ), |
|
| 453 | - 'start_date' => array( 'created', true ), |
|
| 454 | - 'renewal_date' => array( 'expiration', true ), |
|
| 455 | - 'renewals' => array( 'bill_times', true ), |
|
| 456 | - 'item' => array( 'product_id', true ), |
|
| 457 | - 'status' => array( 'status', true ), |
|
| 458 | - ); |
|
| 459 | - |
|
| 460 | - return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable ); |
|
| 461 | - } |
|
| 462 | - |
|
| 463 | - /** |
|
| 464 | - * Whether the table has items to display or not |
|
| 465 | - * |
|
| 466 | - * @return bool |
|
| 467 | - */ |
|
| 468 | - public function has_items() { |
|
| 469 | - return ! empty( $this->current_total_count ); |
|
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * Processes bulk actions. |
|
| 474 | - * |
|
| 475 | - */ |
|
| 476 | - public function process_bulk_action() { |
|
| 477 | - |
|
| 478 | - } |
|
| 17 | + /** |
|
| 18 | + * URL of this page |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + * @since 1.0.19 |
|
| 22 | + */ |
|
| 23 | + public $base_url; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * Query |
|
| 27 | + * |
|
| 28 | + * @var GetPaid_Subscriptions_Query |
|
| 29 | + * @since 1.0.19 |
|
| 30 | + */ |
|
| 31 | + public $query; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Total subscriptions |
|
| 35 | + * |
|
| 36 | + * @var string |
|
| 37 | + * @since 1.0.0 |
|
| 38 | + */ |
|
| 39 | + public $total_count; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * Current status subscriptions |
|
| 43 | + * |
|
| 44 | + * @var string |
|
| 45 | + * @since 1.0.0 |
|
| 46 | + */ |
|
| 47 | + public $current_total_count; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Status counts |
|
| 51 | + * |
|
| 52 | + * @var array |
|
| 53 | + * @since 1.0.19 |
|
| 54 | + */ |
|
| 55 | + public $status_counts; |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Number of results to show per page |
|
| 59 | + * |
|
| 60 | + * @var int |
|
| 61 | + * @since 1.0.0 |
|
| 62 | + */ |
|
| 63 | + public $per_page = 10; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Constructor function. |
|
| 67 | + */ |
|
| 68 | + public function __construct() { |
|
| 69 | + |
|
| 70 | + parent::__construct( |
|
| 71 | + array( |
|
| 72 | + 'singular' => 'subscription', |
|
| 73 | + 'plural' => 'subscriptions', |
|
| 74 | + ) |
|
| 75 | + ); |
|
| 76 | + |
|
| 77 | + $this->process_bulk_action(); |
|
| 78 | + |
|
| 79 | + $this->prepare_query(); |
|
| 80 | + |
|
| 81 | + $this->base_url = remove_query_arg( 'status' ); |
|
| 82 | + |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Prepares the display query |
|
| 87 | + */ |
|
| 88 | + public function prepare_query() { |
|
| 89 | + |
|
| 90 | + // Prepare query args. |
|
| 91 | + $query = array( |
|
| 92 | + 'number' => $this->per_page, |
|
| 93 | + 'paged' => $this->get_paged(), |
|
| 94 | + 'status' => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all', |
|
| 95 | + 'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id', |
|
| 96 | + 'order' => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC', |
|
| 97 | + 'customer_in' => $this->get_user_in(), |
|
| 98 | + ); |
|
| 99 | + |
|
| 100 | + if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) { |
|
| 101 | + $this->total_count = 0; |
|
| 102 | + $this->current_total_count = 0; |
|
| 103 | + $this->items = array(); |
|
| 104 | + $this->status_counts = array(); |
|
| 105 | + return; |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + // Prepare class properties. |
|
| 109 | + $this->query = new GetPaid_Subscriptions_Query( $query ); |
|
| 110 | + $this->total_count = $this->query->get_total(); |
|
| 111 | + $this->current_total_count = $this->query->get_total(); |
|
| 112 | + $this->items = $this->query->get_results(); |
|
| 113 | + $this->status_counts = getpaid_get_subscription_status_counts( $query ); |
|
| 114 | + |
|
| 115 | + if ( 'all' != $query['status'] ) { |
|
| 116 | + unset( $query['status'] ); |
|
| 117 | + $this->total_count = getpaid_get_subscriptions( $query, 'count' ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Get user in. |
|
| 124 | + * |
|
| 125 | + */ |
|
| 126 | + public function get_user_in() { |
|
| 127 | + |
|
| 128 | + // Abort if no user. |
|
| 129 | + if ( empty( $_GET['s'] ) ) { |
|
| 130 | + return null; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + // Or invalid user. |
|
| 134 | + $user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) ); |
|
| 135 | + |
|
| 136 | + if ( empty( $user ) ) { |
|
| 137 | + return null; |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + // Search matching users. |
|
| 141 | + $user = '*' . $user . '*'; |
|
| 142 | + $users = new WP_User_Query( |
|
| 143 | + array( |
|
| 144 | + 'fields' => 'ID', |
|
| 145 | + 'search' => $user, |
|
| 146 | + 'count_total' => false, |
|
| 147 | + ) |
|
| 148 | + ); |
|
| 149 | + |
|
| 150 | + return $users->get_results(); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * Gets the list of views available on this table. |
|
| 155 | + * |
|
| 156 | + * The format is an associative array: |
|
| 157 | + * - `'id' => 'link'` |
|
| 158 | + * |
|
| 159 | + * @since 1.0.0 |
|
| 160 | + * |
|
| 161 | + * @return array |
|
| 162 | + */ |
|
| 163 | + public function get_views() { |
|
| 164 | + |
|
| 165 | + $current = isset( $_GET['status'] ) ? $_GET['status'] : 'all'; |
|
| 166 | + $views = array( |
|
| 167 | + |
|
| 168 | + 'all' => sprintf( |
|
| 169 | + '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 170 | + esc_url( add_query_arg( 'status', false, $this->base_url ) ), |
|
| 171 | + $current === 'all' ? ' class="current"' : '', |
|
| 172 | + __('All','invoicing' ), |
|
| 173 | + $this->total_count |
|
| 174 | + ) |
|
| 175 | + |
|
| 176 | + ); |
|
| 177 | + |
|
| 178 | + foreach ( array_filter( $this->status_counts ) as $status => $count ) { |
|
| 179 | + |
|
| 180 | + $views[ $status ] = sprintf( |
|
| 181 | + '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 182 | + esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ), |
|
| 183 | + $current === $status ? ' class="current"' : '', |
|
| 184 | + esc_html( getpaid_get_subscription_status_label( $status ) ), |
|
| 185 | + $count |
|
| 186 | + ); |
|
| 187 | + |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + return $views; |
|
| 191 | + |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + /** |
|
| 195 | + * Render most columns |
|
| 196 | + * |
|
| 197 | + * @access private |
|
| 198 | + * @since 1.0.0 |
|
| 199 | + * @return string |
|
| 200 | + */ |
|
| 201 | + public function column_default( $item, $column_name ) { |
|
| 202 | + return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name ); |
|
| 203 | + } |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * This is how checkbox column renders. |
|
| 207 | + * |
|
| 208 | + * @param WPInv_Subscription $item |
|
| 209 | + * @return string |
|
| 210 | + */ |
|
| 211 | + public function column_cb( $item ) { |
|
| 212 | + return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) ); |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + /** |
|
| 216 | + * Status column |
|
| 217 | + * |
|
| 218 | + * @param WPInv_Subscription $item |
|
| 219 | + * @since 1.0.0 |
|
| 220 | + * @return string |
|
| 221 | + */ |
|
| 222 | + public function column_status( $item ) { |
|
| 223 | + return $item->get_status_label_html(); |
|
| 224 | + } |
|
| 225 | + |
|
| 226 | + /** |
|
| 227 | + * Subscription column |
|
| 228 | + * |
|
| 229 | + * @param WPInv_Subscription $item |
|
| 230 | + * @since 1.0.0 |
|
| 231 | + * @return string |
|
| 232 | + */ |
|
| 233 | + public function column_subscription( $item ) { |
|
| 234 | + |
|
| 235 | + $username = __( '(Missing User)', 'invoicing' ); |
|
| 236 | + |
|
| 237 | + $user = get_userdata( $item->get_customer_id() ); |
|
| 238 | + if ( $user ) { |
|
| 239 | + |
|
| 240 | + $username = sprintf( |
|
| 241 | + '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 242 | + absint( $user->ID ), |
|
| 243 | + ! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 244 | + ); |
|
| 245 | + |
|
| 246 | + } |
|
| 247 | + |
|
| 248 | + // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name |
|
| 249 | + $column_content = sprintf( |
|
| 250 | + _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ), |
|
| 251 | + '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">', |
|
| 252 | + '<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>', |
|
| 253 | + $username |
|
| 254 | + ); |
|
| 255 | + |
|
| 256 | + $row_actions = array(); |
|
| 257 | + |
|
| 258 | + // View subscription. |
|
| 259 | + $view_url = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) )); |
|
| 260 | + $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>'; |
|
| 261 | + |
|
| 262 | + // View invoice. |
|
| 263 | + $invoice = get_post( $item->get_parent_invoice_id() ); |
|
| 264 | + |
|
| 265 | + if ( ! empty( $invoice ) ) { |
|
| 266 | + $invoice_url = get_edit_post_link( $invoice ); |
|
| 267 | + $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>'; |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + $delete_url = esc_url( |
|
| 271 | + wp_nonce_url( |
|
| 272 | + add_query_arg( |
|
| 273 | + array( |
|
| 274 | + 'getpaid-admin-action' => 'subscription_manual_delete', |
|
| 275 | + 'id' => $item->get_id(), |
|
| 276 | + ) |
|
| 277 | + ), |
|
| 278 | + 'getpaid-nonce', |
|
| 279 | + 'getpaid-nonce' |
|
| 280 | + ) |
|
| 281 | + ); |
|
| 282 | + $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>'; |
|
| 283 | + |
|
| 284 | + $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) ); |
|
| 285 | + |
|
| 286 | + return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions; |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * Renewal date column |
|
| 291 | + * |
|
| 292 | + * @param WPInv_Subscription $item |
|
| 293 | + * @since 1.0.0 |
|
| 294 | + * @return string |
|
| 295 | + */ |
|
| 296 | + public function column_renewal_date( $item ) { |
|
| 297 | + return getpaid_format_date_value( $item->get_expiration() ); |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * Start date column |
|
| 302 | + * |
|
| 303 | + * @param WPInv_Subscription $item |
|
| 304 | + * @since 1.0.0 |
|
| 305 | + * @return string |
|
| 306 | + */ |
|
| 307 | + public function column_start_date( $item ) { |
|
| 308 | + |
|
| 309 | + $gateway = $item->get_parent_invoice()->get_gateway_title(); |
|
| 310 | + |
|
| 311 | + if ( empty( $gateway ) ) { |
|
| 312 | + return getpaid_format_date_value( $item->get_date_created() ); |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + $url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item ); |
|
| 316 | + if ( ! empty( $url ) ) { |
|
| 317 | + |
|
| 318 | + return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 319 | + __( 'Via %s', 'invoicing' ), |
|
| 320 | + '<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>' |
|
| 321 | + ); |
|
| 322 | + |
|
| 323 | + } |
|
| 324 | + |
|
| 325 | + return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 326 | + __( 'Via %s', 'invoicing' ), |
|
| 327 | + '<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>' |
|
| 328 | + ); |
|
| 329 | + |
|
| 330 | + } |
|
| 331 | + |
|
| 332 | + /** |
|
| 333 | + * Amount column |
|
| 334 | + * |
|
| 335 | + * @param WPInv_Subscription $item |
|
| 336 | + * @since 1.0.19 |
|
| 337 | + * @return string |
|
| 338 | + */ |
|
| 339 | + public static function column_amount( $item ) { |
|
| 340 | + $amount = getpaid_get_formatted_subscription_amount( $item ); |
|
| 341 | + return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>"; |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * Billing Times column |
|
| 346 | + * |
|
| 347 | + * @param WPInv_Subscription $item |
|
| 348 | + * @since 1.0.0 |
|
| 349 | + * @return string |
|
| 350 | + */ |
|
| 351 | + public function column_renewals( $item ) { |
|
| 352 | + $max_bills = $item->get_bill_times(); |
|
| 353 | + return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * Product ID column |
|
| 358 | + * |
|
| 359 | + * @param WPInv_Subscription $item |
|
| 360 | + * @since 1.0.0 |
|
| 361 | + * @return string |
|
| 362 | + */ |
|
| 363 | + public function column_item( $item ) { |
|
| 364 | + $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() ); |
|
| 365 | + |
|
| 366 | + if ( empty( $subscription_group ) ) { |
|
| 367 | + return $this->generate_item_markup( $item->get_product_id() ); |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 371 | + return implode( ' | ', $markup ); |
|
| 372 | + |
|
| 373 | + } |
|
| 374 | + |
|
| 375 | + /** |
|
| 376 | + * Generates the items markup. |
|
| 377 | + * |
|
| 378 | + * @param int $item_id |
|
| 379 | + * @since 1.0.0 |
|
| 380 | + * @return string |
|
| 381 | + */ |
|
| 382 | + public static function generate_item_markup( $item_id ) { |
|
| 383 | + $item = get_post( $item_id ); |
|
| 384 | + |
|
| 385 | + if ( ! empty( $item ) ) { |
|
| 386 | + $link = get_edit_post_link( $item ); |
|
| 387 | + $link = esc_url( $link ); |
|
| 388 | + $name = esc_html( get_the_title( $item ) ); |
|
| 389 | + return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name; |
|
| 390 | + } else { |
|
| 391 | + return sprintf( __( 'Item #%s', 'invoicing' ), $item_id ); |
|
| 392 | + } |
|
| 393 | + |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + /** |
|
| 397 | + * Retrieve the current page number |
|
| 398 | + * |
|
| 399 | + * @return int |
|
| 400 | + */ |
|
| 401 | + public function get_paged() { |
|
| 402 | + return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + /** |
|
| 406 | + * Setup the final data for the table |
|
| 407 | + * |
|
| 408 | + */ |
|
| 409 | + public function prepare_items() { |
|
| 410 | + |
|
| 411 | + $columns = $this->get_columns(); |
|
| 412 | + $hidden = array(); |
|
| 413 | + $sortable = $this->get_sortable_columns(); |
|
| 414 | + |
|
| 415 | + $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 416 | + |
|
| 417 | + $this->set_pagination_args( |
|
| 418 | + array( |
|
| 419 | + 'total_items' => $this->current_total_count, |
|
| 420 | + 'per_page' => $this->per_page, |
|
| 421 | + 'total_pages' => ceil( $this->current_total_count / $this->per_page ) |
|
| 422 | + ) |
|
| 423 | + ); |
|
| 424 | + } |
|
| 425 | + |
|
| 426 | + /** |
|
| 427 | + * Table columns |
|
| 428 | + * |
|
| 429 | + * @return array |
|
| 430 | + */ |
|
| 431 | + public function get_columns(){ |
|
| 432 | + $columns = array( |
|
| 433 | + 'cb' => '<input type="checkbox" />', |
|
| 434 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 435 | + 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 436 | + 'renewal_date' => __( 'Next Payment', 'invoicing' ), |
|
| 437 | + 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 438 | + 'item' => __( 'Items', 'invoicing' ), |
|
| 439 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 440 | + ); |
|
| 441 | + |
|
| 442 | + return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns ); |
|
| 443 | + } |
|
| 444 | + |
|
| 445 | + /** |
|
| 446 | + * Sortable table columns. |
|
| 447 | + * |
|
| 448 | + * @return array |
|
| 449 | + */ |
|
| 450 | + public function get_sortable_columns() { |
|
| 451 | + $sortable = array( |
|
| 452 | + 'subscription' => array( 'id', true ), |
|
| 453 | + 'start_date' => array( 'created', true ), |
|
| 454 | + 'renewal_date' => array( 'expiration', true ), |
|
| 455 | + 'renewals' => array( 'bill_times', true ), |
|
| 456 | + 'item' => array( 'product_id', true ), |
|
| 457 | + 'status' => array( 'status', true ), |
|
| 458 | + ); |
|
| 459 | + |
|
| 460 | + return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable ); |
|
| 461 | + } |
|
| 462 | + |
|
| 463 | + /** |
|
| 464 | + * Whether the table has items to display or not |
|
| 465 | + * |
|
| 466 | + * @return bool |
|
| 467 | + */ |
|
| 468 | + public function has_items() { |
|
| 469 | + return ! empty( $this->current_total_count ); |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * Processes bulk actions. |
|
| 474 | + * |
|
| 475 | + */ |
|
| 476 | + public function process_bulk_action() { |
|
| 477 | + |
|
| 478 | + } |
|
| 479 | 479 | |
| 480 | 480 | } |
@@ -3,9 +3,9 @@ discard block |
||
| 3 | 3 | * Displays a list of all subscriptions rules |
| 4 | 4 | */ |
| 5 | 5 | |
| 6 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 6 | +if (!defined('ABSPATH')) exit; |
|
| 7 | 7 | |
| 8 | -if ( ! class_exists( 'WP_List_Table' ) ) { |
|
| 8 | +if (!class_exists('WP_List_Table')) { |
|
| 9 | 9 | include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
| 10 | 10 | } |
| 11 | 11 | |
@@ -78,7 +78,7 @@ discard block |
||
| 78 | 78 | |
| 79 | 79 | $this->prepare_query(); |
| 80 | 80 | |
| 81 | - $this->base_url = remove_query_arg( 'status' ); |
|
| 81 | + $this->base_url = remove_query_arg('status'); |
|
| 82 | 82 | |
| 83 | 83 | } |
| 84 | 84 | |
@@ -91,13 +91,13 @@ discard block |
||
| 91 | 91 | $query = array( |
| 92 | 92 | 'number' => $this->per_page, |
| 93 | 93 | 'paged' => $this->get_paged(), |
| 94 | - 'status' => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all', |
|
| 95 | - 'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id', |
|
| 96 | - 'order' => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC', |
|
| 94 | + 'status' => (isset($_GET['status']) && array_key_exists($_GET['status'], getpaid_get_subscription_statuses())) ? $_GET['status'] : 'all', |
|
| 95 | + 'orderby' => (isset($_GET['orderby'])) ? $_GET['orderby'] : 'id', |
|
| 96 | + 'order' => (isset($_GET['order'])) ? $_GET['order'] : 'DESC', |
|
| 97 | 97 | 'customer_in' => $this->get_user_in(), |
| 98 | 98 | ); |
| 99 | 99 | |
| 100 | - if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) { |
|
| 100 | + if (is_array($query['customer_in']) && empty($query['customer_in'])) { |
|
| 101 | 101 | $this->total_count = 0; |
| 102 | 102 | $this->current_total_count = 0; |
| 103 | 103 | $this->items = array(); |
@@ -106,15 +106,15 @@ discard block |
||
| 106 | 106 | } |
| 107 | 107 | |
| 108 | 108 | // Prepare class properties. |
| 109 | - $this->query = new GetPaid_Subscriptions_Query( $query ); |
|
| 109 | + $this->query = new GetPaid_Subscriptions_Query($query); |
|
| 110 | 110 | $this->total_count = $this->query->get_total(); |
| 111 | 111 | $this->current_total_count = $this->query->get_total(); |
| 112 | 112 | $this->items = $this->query->get_results(); |
| 113 | - $this->status_counts = getpaid_get_subscription_status_counts( $query ); |
|
| 113 | + $this->status_counts = getpaid_get_subscription_status_counts($query); |
|
| 114 | 114 | |
| 115 | - if ( 'all' != $query['status'] ) { |
|
| 116 | - unset( $query['status'] ); |
|
| 117 | - $this->total_count = getpaid_get_subscriptions( $query, 'count' ); |
|
| 115 | + if ('all' != $query['status']) { |
|
| 116 | + unset($query['status']); |
|
| 117 | + $this->total_count = getpaid_get_subscriptions($query, 'count'); |
|
| 118 | 118 | } |
| 119 | 119 | |
| 120 | 120 | } |
@@ -126,14 +126,14 @@ discard block |
||
| 126 | 126 | public function get_user_in() { |
| 127 | 127 | |
| 128 | 128 | // Abort if no user. |
| 129 | - if ( empty( $_GET['s'] ) ) { |
|
| 129 | + if (empty($_GET['s'])) { |
|
| 130 | 130 | return null; |
| 131 | 131 | } |
| 132 | 132 | |
| 133 | 133 | // Or invalid user. |
| 134 | - $user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) ); |
|
| 134 | + $user = wp_unslash(sanitize_text_field($_REQUEST['s'])); |
|
| 135 | 135 | |
| 136 | - if ( empty( $user ) ) { |
|
| 136 | + if (empty($user)) { |
|
| 137 | 137 | return null; |
| 138 | 138 | } |
| 139 | 139 | |
@@ -162,26 +162,26 @@ discard block |
||
| 162 | 162 | */ |
| 163 | 163 | public function get_views() { |
| 164 | 164 | |
| 165 | - $current = isset( $_GET['status'] ) ? $_GET['status'] : 'all'; |
|
| 165 | + $current = isset($_GET['status']) ? $_GET['status'] : 'all'; |
|
| 166 | 166 | $views = array( |
| 167 | 167 | |
| 168 | 168 | 'all' => sprintf( |
| 169 | 169 | '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
| 170 | - esc_url( add_query_arg( 'status', false, $this->base_url ) ), |
|
| 170 | + esc_url(add_query_arg('status', false, $this->base_url)), |
|
| 171 | 171 | $current === 'all' ? ' class="current"' : '', |
| 172 | - __('All','invoicing' ), |
|
| 172 | + __('All', 'invoicing'), |
|
| 173 | 173 | $this->total_count |
| 174 | 174 | ) |
| 175 | 175 | |
| 176 | 176 | ); |
| 177 | 177 | |
| 178 | - foreach ( array_filter( $this->status_counts ) as $status => $count ) { |
|
| 178 | + foreach (array_filter($this->status_counts) as $status => $count) { |
|
| 179 | 179 | |
| 180 | - $views[ $status ] = sprintf( |
|
| 180 | + $views[$status] = sprintf( |
|
| 181 | 181 | '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
| 182 | - esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ), |
|
| 182 | + esc_url(add_query_arg('status', urlencode($status), $this->base_url)), |
|
| 183 | 183 | $current === $status ? ' class="current"' : '', |
| 184 | - esc_html( getpaid_get_subscription_status_label( $status ) ), |
|
| 184 | + esc_html(getpaid_get_subscription_status_label($status)), |
|
| 185 | 185 | $count |
| 186 | 186 | ); |
| 187 | 187 | |
@@ -198,8 +198,8 @@ discard block |
||
| 198 | 198 | * @since 1.0.0 |
| 199 | 199 | * @return string |
| 200 | 200 | */ |
| 201 | - public function column_default( $item, $column_name ) { |
|
| 202 | - return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name ); |
|
| 201 | + public function column_default($item, $column_name) { |
|
| 202 | + return apply_filters("getpaid_subscriptions_table_column_$column_name", $item->$column_name); |
|
| 203 | 203 | } |
| 204 | 204 | |
| 205 | 205 | /** |
@@ -208,8 +208,8 @@ discard block |
||
| 208 | 208 | * @param WPInv_Subscription $item |
| 209 | 209 | * @return string |
| 210 | 210 | */ |
| 211 | - public function column_cb( $item ) { |
|
| 212 | - return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) ); |
|
| 211 | + public function column_cb($item) { |
|
| 212 | + return sprintf('<input type="checkbox" name="id[]" value="%s" />', esc_html($item->get_id())); |
|
| 213 | 213 | } |
| 214 | 214 | |
| 215 | 215 | /** |
@@ -219,7 +219,7 @@ discard block |
||
| 219 | 219 | * @since 1.0.0 |
| 220 | 220 | * @return string |
| 221 | 221 | */ |
| 222 | - public function column_status( $item ) { |
|
| 222 | + public function column_status($item) { |
|
| 223 | 223 | return $item->get_status_label_html(); |
| 224 | 224 | } |
| 225 | 225 | |
@@ -230,44 +230,44 @@ discard block |
||
| 230 | 230 | * @since 1.0.0 |
| 231 | 231 | * @return string |
| 232 | 232 | */ |
| 233 | - public function column_subscription( $item ) { |
|
| 233 | + public function column_subscription($item) { |
|
| 234 | 234 | |
| 235 | - $username = __( '(Missing User)', 'invoicing' ); |
|
| 235 | + $username = __('(Missing User)', 'invoicing'); |
|
| 236 | 236 | |
| 237 | - $user = get_userdata( $item->get_customer_id() ); |
|
| 238 | - if ( $user ) { |
|
| 237 | + $user = get_userdata($item->get_customer_id()); |
|
| 238 | + if ($user) { |
|
| 239 | 239 | |
| 240 | 240 | $username = sprintf( |
| 241 | 241 | '<a href="user-edit.php?user_id=%s">%s</a>', |
| 242 | - absint( $user->ID ), |
|
| 243 | - ! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 242 | + absint($user->ID), |
|
| 243 | + !empty($user->display_name) ? esc_html($user->display_name) : sanitize_email($user->user_email) |
|
| 244 | 244 | ); |
| 245 | 245 | |
| 246 | 246 | } |
| 247 | 247 | |
| 248 | 248 | // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name |
| 249 | 249 | $column_content = sprintf( |
| 250 | - _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ), |
|
| 251 | - '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">', |
|
| 252 | - '<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>', |
|
| 250 | + _x('%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing'), |
|
| 251 | + '<a href="' . esc_url(admin_url('admin.php?page=wpinv-subscriptions&id=' . absint($item->get_id()))) . '">', |
|
| 252 | + '<strong>' . esc_attr($item->get_id()) . '</strong>', '</a>', |
|
| 253 | 253 | $username |
| 254 | 254 | ); |
| 255 | 255 | |
| 256 | 256 | $row_actions = array(); |
| 257 | 257 | |
| 258 | 258 | // View subscription. |
| 259 | - $view_url = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) )); |
|
| 260 | - $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>'; |
|
| 259 | + $view_url = esc_url(add_query_arg('id', $item->get_id(), admin_url('admin.php?page=wpinv-subscriptions'))); |
|
| 260 | + $row_actions['view'] = '<a href="' . $view_url . '">' . __('View Subscription', 'invoicing') . '</a>'; |
|
| 261 | 261 | |
| 262 | 262 | // View invoice. |
| 263 | - $invoice = get_post( $item->get_parent_invoice_id() ); |
|
| 263 | + $invoice = get_post($item->get_parent_invoice_id()); |
|
| 264 | 264 | |
| 265 | - if ( ! empty( $invoice ) ) { |
|
| 266 | - $invoice_url = get_edit_post_link( $invoice ); |
|
| 267 | - $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>'; |
|
| 265 | + if (!empty($invoice)) { |
|
| 266 | + $invoice_url = get_edit_post_link($invoice); |
|
| 267 | + $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __('View Invoice', 'invoicing') . '</a>'; |
|
| 268 | 268 | } |
| 269 | 269 | |
| 270 | - $delete_url = esc_url( |
|
| 270 | + $delete_url = esc_url( |
|
| 271 | 271 | wp_nonce_url( |
| 272 | 272 | add_query_arg( |
| 273 | 273 | array( |
@@ -279,11 +279,11 @@ discard block |
||
| 279 | 279 | 'getpaid-nonce' |
| 280 | 280 | ) |
| 281 | 281 | ); |
| 282 | - $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>'; |
|
| 282 | + $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __('Delete Subscription', 'invoicing') . '</a>'; |
|
| 283 | 283 | |
| 284 | - $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) ); |
|
| 284 | + $row_actions = $this->row_actions(apply_filters('getpaid_subscription_table_row_actions', $row_actions, $item)); |
|
| 285 | 285 | |
| 286 | - return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions; |
|
| 286 | + return "<strong>$column_content</strong>" . $this->column_amount($item) . $row_actions; |
|
| 287 | 287 | } |
| 288 | 288 | |
| 289 | 289 | /** |
@@ -293,8 +293,8 @@ discard block |
||
| 293 | 293 | * @since 1.0.0 |
| 294 | 294 | * @return string |
| 295 | 295 | */ |
| 296 | - public function column_renewal_date( $item ) { |
|
| 297 | - return getpaid_format_date_value( $item->get_expiration() ); |
|
| 296 | + public function column_renewal_date($item) { |
|
| 297 | + return getpaid_format_date_value($item->get_expiration()); |
|
| 298 | 298 | } |
| 299 | 299 | |
| 300 | 300 | /** |
@@ -304,27 +304,27 @@ discard block |
||
| 304 | 304 | * @since 1.0.0 |
| 305 | 305 | * @return string |
| 306 | 306 | */ |
| 307 | - public function column_start_date( $item ) { |
|
| 307 | + public function column_start_date($item) { |
|
| 308 | 308 | |
| 309 | 309 | $gateway = $item->get_parent_invoice()->get_gateway_title(); |
| 310 | 310 | |
| 311 | - if ( empty( $gateway ) ) { |
|
| 312 | - return getpaid_format_date_value( $item->get_date_created() ); |
|
| 311 | + if (empty($gateway)) { |
|
| 312 | + return getpaid_format_date_value($item->get_date_created()); |
|
| 313 | 313 | } |
| 314 | 314 | |
| 315 | - $url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item ); |
|
| 316 | - if ( ! empty( $url ) ) { |
|
| 315 | + $url = apply_filters('getpaid_remote_subscription_profile_url', '', $item); |
|
| 316 | + if (!empty($url)) { |
|
| 317 | 317 | |
| 318 | - return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 319 | - __( 'Via %s', 'invoicing' ), |
|
| 320 | - '<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>' |
|
| 318 | + return getpaid_format_date_value($item->get_date_created()) . '<br>' . sprintf( |
|
| 319 | + __('Via %s', 'invoicing'), |
|
| 320 | + '<strong><a href="' . esc_url($url) . '" target="_blank">' . esc_html($item->get_parent_invoice()->get_gateway_title()) . '</a></strong>' |
|
| 321 | 321 | ); |
| 322 | 322 | |
| 323 | 323 | } |
| 324 | 324 | |
| 325 | - return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 326 | - __( 'Via %s', 'invoicing' ), |
|
| 327 | - '<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>' |
|
| 325 | + return getpaid_format_date_value($item->get_date_created()) . '<br>' . sprintf( |
|
| 326 | + __('Via %s', 'invoicing'), |
|
| 327 | + '<strong>' . esc_html($item->get_parent_invoice()->get_gateway_title()) . '</strong>' |
|
| 328 | 328 | ); |
| 329 | 329 | |
| 330 | 330 | } |
@@ -336,8 +336,8 @@ discard block |
||
| 336 | 336 | * @since 1.0.19 |
| 337 | 337 | * @return string |
| 338 | 338 | */ |
| 339 | - public static function column_amount( $item ) { |
|
| 340 | - $amount = getpaid_get_formatted_subscription_amount( $item ); |
|
| 339 | + public static function column_amount($item) { |
|
| 340 | + $amount = getpaid_get_formatted_subscription_amount($item); |
|
| 341 | 341 | return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>"; |
| 342 | 342 | } |
| 343 | 343 | |
@@ -348,9 +348,9 @@ discard block |
||
| 348 | 348 | * @since 1.0.0 |
| 349 | 349 | * @return string |
| 350 | 350 | */ |
| 351 | - public function column_renewals( $item ) { |
|
| 351 | + public function column_renewals($item) { |
|
| 352 | 352 | $max_bills = $item->get_bill_times(); |
| 353 | - return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 353 | + return $item->get_times_billed() . ' / ' . (empty($max_bills) ? "∞" : $max_bills); |
|
| 354 | 354 | } |
| 355 | 355 | |
| 356 | 356 | /** |
@@ -360,15 +360,15 @@ discard block |
||
| 360 | 360 | * @since 1.0.0 |
| 361 | 361 | * @return string |
| 362 | 362 | */ |
| 363 | - public function column_item( $item ) { |
|
| 364 | - $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() ); |
|
| 363 | + public function column_item($item) { |
|
| 364 | + $subscription_group = getpaid_get_invoice_subscription_group($item->get_parent_invoice_id(), $item->get_id()); |
|
| 365 | 365 | |
| 366 | - if ( empty( $subscription_group ) ) { |
|
| 367 | - return $this->generate_item_markup( $item->get_product_id() ); |
|
| 366 | + if (empty($subscription_group)) { |
|
| 367 | + return $this->generate_item_markup($item->get_product_id()); |
|
| 368 | 368 | } |
| 369 | 369 | |
| 370 | - $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 371 | - return implode( ' | ', $markup ); |
|
| 370 | + $markup = array_map(array($this, 'generate_item_markup'), array_keys($subscription_group['items'])); |
|
| 371 | + return implode(' | ', $markup); |
|
| 372 | 372 | |
| 373 | 373 | } |
| 374 | 374 | |
@@ -379,16 +379,16 @@ discard block |
||
| 379 | 379 | * @since 1.0.0 |
| 380 | 380 | * @return string |
| 381 | 381 | */ |
| 382 | - public static function generate_item_markup( $item_id ) { |
|
| 383 | - $item = get_post( $item_id ); |
|
| 382 | + public static function generate_item_markup($item_id) { |
|
| 383 | + $item = get_post($item_id); |
|
| 384 | 384 | |
| 385 | - if ( ! empty( $item ) ) { |
|
| 386 | - $link = get_edit_post_link( $item ); |
|
| 387 | - $link = esc_url( $link ); |
|
| 388 | - $name = esc_html( get_the_title( $item ) ); |
|
| 385 | + if (!empty($item)) { |
|
| 386 | + $link = get_edit_post_link($item); |
|
| 387 | + $link = esc_url($link); |
|
| 388 | + $name = esc_html(get_the_title($item)); |
|
| 389 | 389 | return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name; |
| 390 | 390 | } else { |
| 391 | - return sprintf( __( 'Item #%s', 'invoicing' ), $item_id ); |
|
| 391 | + return sprintf(__('Item #%s', 'invoicing'), $item_id); |
|
| 392 | 392 | } |
| 393 | 393 | |
| 394 | 394 | } |
@@ -399,7 +399,7 @@ discard block |
||
| 399 | 399 | * @return int |
| 400 | 400 | */ |
| 401 | 401 | public function get_paged() { |
| 402 | - return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 402 | + return isset($_GET['paged']) ? absint($_GET['paged']) : 1; |
|
| 403 | 403 | } |
| 404 | 404 | |
| 405 | 405 | /** |
@@ -412,13 +412,13 @@ discard block |
||
| 412 | 412 | $hidden = array(); |
| 413 | 413 | $sortable = $this->get_sortable_columns(); |
| 414 | 414 | |
| 415 | - $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 415 | + $this->_column_headers = array($columns, $hidden, $sortable); |
|
| 416 | 416 | |
| 417 | 417 | $this->set_pagination_args( |
| 418 | 418 | array( |
| 419 | 419 | 'total_items' => $this->current_total_count, |
| 420 | 420 | 'per_page' => $this->per_page, |
| 421 | - 'total_pages' => ceil( $this->current_total_count / $this->per_page ) |
|
| 421 | + 'total_pages' => ceil($this->current_total_count / $this->per_page) |
|
| 422 | 422 | ) |
| 423 | 423 | ); |
| 424 | 424 | } |
@@ -428,18 +428,18 @@ discard block |
||
| 428 | 428 | * |
| 429 | 429 | * @return array |
| 430 | 430 | */ |
| 431 | - public function get_columns(){ |
|
| 431 | + public function get_columns() { |
|
| 432 | 432 | $columns = array( |
| 433 | 433 | 'cb' => '<input type="checkbox" />', |
| 434 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 435 | - 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 436 | - 'renewal_date' => __( 'Next Payment', 'invoicing' ), |
|
| 437 | - 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 438 | - 'item' => __( 'Items', 'invoicing' ), |
|
| 439 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 434 | + 'subscription' => __('Subscription', 'invoicing'), |
|
| 435 | + 'start_date' => __('Start Date', 'invoicing'), |
|
| 436 | + 'renewal_date' => __('Next Payment', 'invoicing'), |
|
| 437 | + 'renewals' => __('Payments', 'invoicing'), |
|
| 438 | + 'item' => __('Items', 'invoicing'), |
|
| 439 | + 'status' => __('Status', 'invoicing'), |
|
| 440 | 440 | ); |
| 441 | 441 | |
| 442 | - return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns ); |
|
| 442 | + return apply_filters('manage_getpaid_subscriptions_table_columns', $columns); |
|
| 443 | 443 | } |
| 444 | 444 | |
| 445 | 445 | /** |
@@ -449,15 +449,15 @@ discard block |
||
| 449 | 449 | */ |
| 450 | 450 | public function get_sortable_columns() { |
| 451 | 451 | $sortable = array( |
| 452 | - 'subscription' => array( 'id', true ), |
|
| 453 | - 'start_date' => array( 'created', true ), |
|
| 454 | - 'renewal_date' => array( 'expiration', true ), |
|
| 455 | - 'renewals' => array( 'bill_times', true ), |
|
| 456 | - 'item' => array( 'product_id', true ), |
|
| 457 | - 'status' => array( 'status', true ), |
|
| 452 | + 'subscription' => array('id', true), |
|
| 453 | + 'start_date' => array('created', true), |
|
| 454 | + 'renewal_date' => array('expiration', true), |
|
| 455 | + 'renewals' => array('bill_times', true), |
|
| 456 | + 'item' => array('product_id', true), |
|
| 457 | + 'status' => array('status', true), |
|
| 458 | 458 | ); |
| 459 | 459 | |
| 460 | - return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable ); |
|
| 460 | + return apply_filters('manage_getpaid_subscriptions_sortable_table_columns', $sortable); |
|
| 461 | 461 | } |
| 462 | 462 | |
| 463 | 463 | /** |
@@ -466,7 +466,7 @@ discard block |
||
| 466 | 466 | * @return bool |
| 467 | 467 | */ |
| 468 | 468 | public function has_items() { |
| 469 | - return ! empty( $this->current_total_count ); |
|
| 469 | + return !empty($this->current_total_count); |
|
| 470 | 470 | } |
| 471 | 471 | |
| 472 | 472 | /** |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | * |
| 5 | 5 | */ |
| 6 | 6 | if ( ! defined( 'ABSPATH' ) ) { |
| 7 | - exit; |
|
| 7 | + exit; |
|
| 8 | 8 | } |
| 9 | 9 | |
| 10 | 10 | /** |
@@ -14,179 +14,179 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | class GetPaid_Payment_Form_Data_Store extends GetPaid_Data_Store_WP { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * Data stored in meta keys, but not considered "meta" for a form. |
|
| 19 | - * |
|
| 20 | - * @since 1.0.19 |
|
| 21 | - * @var array |
|
| 22 | - */ |
|
| 23 | - protected $internal_meta_keys = array( |
|
| 24 | - 'wpinv_form_elements', |
|
| 25 | - 'wpinv_form_items', |
|
| 26 | - 'wpinv_form_earned', |
|
| 27 | - 'wpinv_form_refunded', |
|
| 28 | - 'wpinv_form_cancelled', |
|
| 29 | - 'wpinv_form_failed' |
|
| 30 | - ); |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * A map of meta keys to data props. |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * |
|
| 37 | - * @var array |
|
| 38 | - */ |
|
| 39 | - protected $meta_key_to_props = array( |
|
| 40 | - 'wpinv_form_elements' => 'elements', |
|
| 41 | - 'wpinv_form_items' => 'items', |
|
| 42 | - 'wpinv_form_earned' => 'earned', |
|
| 43 | - 'wpinv_form_refunded' => 'refunded', |
|
| 44 | - 'wpinv_form_cancelled' => 'cancelled', |
|
| 45 | - 'wpinv_form_failed' => 'failed', |
|
| 46 | - ); |
|
| 47 | - |
|
| 48 | - /* |
|
| 17 | + /** |
|
| 18 | + * Data stored in meta keys, but not considered "meta" for a form. |
|
| 19 | + * |
|
| 20 | + * @since 1.0.19 |
|
| 21 | + * @var array |
|
| 22 | + */ |
|
| 23 | + protected $internal_meta_keys = array( |
|
| 24 | + 'wpinv_form_elements', |
|
| 25 | + 'wpinv_form_items', |
|
| 26 | + 'wpinv_form_earned', |
|
| 27 | + 'wpinv_form_refunded', |
|
| 28 | + 'wpinv_form_cancelled', |
|
| 29 | + 'wpinv_form_failed' |
|
| 30 | + ); |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * A map of meta keys to data props. |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * |
|
| 37 | + * @var array |
|
| 38 | + */ |
|
| 39 | + protected $meta_key_to_props = array( |
|
| 40 | + 'wpinv_form_elements' => 'elements', |
|
| 41 | + 'wpinv_form_items' => 'items', |
|
| 42 | + 'wpinv_form_earned' => 'earned', |
|
| 43 | + 'wpinv_form_refunded' => 'refunded', |
|
| 44 | + 'wpinv_form_cancelled' => 'cancelled', |
|
| 45 | + 'wpinv_form_failed' => 'failed', |
|
| 46 | + ); |
|
| 47 | + |
|
| 48 | + /* |
|
| 49 | 49 | |-------------------------------------------------------------------------- |
| 50 | 50 | | CRUD Methods |
| 51 | 51 | |-------------------------------------------------------------------------- |
| 52 | 52 | */ |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Method to create a new form in the database. |
|
| 56 | - * |
|
| 57 | - * @param GetPaid_Payment_Form $form Form object. |
|
| 58 | - */ |
|
| 59 | - public function create( &$form ) { |
|
| 60 | - $form->set_version( WPINV_VERSION ); |
|
| 61 | - $form->set_date_created( current_time('mysql') ); |
|
| 62 | - |
|
| 63 | - // Create a new post. |
|
| 64 | - $id = wp_insert_post( |
|
| 65 | - apply_filters( |
|
| 66 | - 'getpaid_new_payment_form_data', |
|
| 67 | - array( |
|
| 68 | - 'post_date' => $form->get_date_created( 'edit' ), |
|
| 69 | - 'post_type' => 'wpi_payment_form', |
|
| 70 | - 'post_status' => $this->get_post_status( $form ), |
|
| 71 | - 'ping_status' => 'closed', |
|
| 72 | - 'post_author' => $form->get_author( 'edit' ), |
|
| 73 | - 'post_title' => $form->get_name( 'edit' ), |
|
| 74 | - ) |
|
| 75 | - ), |
|
| 76 | - true |
|
| 77 | - ); |
|
| 78 | - |
|
| 79 | - if ( $id && ! is_wp_error( $id ) ) { |
|
| 80 | - $form->set_id( $id ); |
|
| 81 | - $this->update_post_meta( $form ); |
|
| 82 | - $form->save_meta_data(); |
|
| 83 | - $form->apply_changes(); |
|
| 84 | - $this->clear_caches( $form ); |
|
| 85 | - do_action( 'getpaid_create_payment_form', $form ); |
|
| 86 | - return true; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - if ( is_wp_error( $id ) ) { |
|
| 90 | - $form->last_error = $id->get_error_message(); |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - return false; |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * Method to read a form from the database. |
|
| 98 | - * |
|
| 99 | - * @param GetPaid_Payment_Form $form Form object. |
|
| 100 | - * |
|
| 101 | - */ |
|
| 102 | - public function read( &$form ) { |
|
| 103 | - |
|
| 104 | - $form->set_defaults(); |
|
| 105 | - $form_object = get_post( $form->get_id() ); |
|
| 106 | - |
|
| 107 | - if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) { |
|
| 108 | - $form->last_error = __( 'Invalid form.', 'invoicing' ); |
|
| 109 | - $form->set_id( 0 ); |
|
| 110 | - return false; |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - $form->set_props( |
|
| 114 | - array( |
|
| 115 | - 'date_created' => 0 < $form_object->post_date ? $form_object->post_date : null, |
|
| 116 | - 'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null, |
|
| 117 | - 'status' => $form_object->post_status, |
|
| 118 | - 'name' => $form_object->post_title, |
|
| 119 | - 'author' => $form_object->post_author, |
|
| 120 | - ) |
|
| 121 | - ); |
|
| 122 | - |
|
| 123 | - $this->read_object_data( $form, $form_object ); |
|
| 124 | - $form->read_meta_data(); |
|
| 125 | - $form->set_object_read( true ); |
|
| 126 | - do_action( 'getpaid_read_payment_form', $form ); |
|
| 127 | - |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * Method to update a form in the database. |
|
| 132 | - * |
|
| 133 | - * @param GetPaid_Payment_Form $form Form object. |
|
| 134 | - */ |
|
| 135 | - public function update( &$form ) { |
|
| 136 | - $form->save_meta_data(); |
|
| 137 | - $form->set_version( WPINV_VERSION ); |
|
| 138 | - |
|
| 139 | - if ( null === $form->get_date_created( 'edit' ) ) { |
|
| 140 | - $form->set_date_created( current_time('mysql') ); |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - // Grab the current status so we can compare. |
|
| 144 | - $previous_status = get_post_status( $form->get_id() ); |
|
| 145 | - |
|
| 146 | - $changes = $form->get_changes(); |
|
| 147 | - |
|
| 148 | - // Only update the post when the post data changes. |
|
| 149 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
| 150 | - $post_data = array( |
|
| 151 | - 'post_date' => $form->get_date_created( 'edit' ), |
|
| 152 | - 'post_status' => $form->get_status( 'edit' ), |
|
| 153 | - 'post_title' => $form->get_name( 'edit' ), |
|
| 154 | - 'post_author' => $form->get_author( 'edit' ), |
|
| 155 | - 'post_modified' => $form->get_date_modified( 'edit' ), |
|
| 156 | - ); |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * When updating this object, to prevent infinite loops, use $wpdb |
|
| 160 | - * to update data, since wp_update_post spawns more calls to the |
|
| 161 | - * save_post action. |
|
| 162 | - * |
|
| 163 | - * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 164 | - * or an update purely from CRUD. |
|
| 165 | - */ |
|
| 166 | - if ( doing_action( 'save_post' ) ) { |
|
| 167 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) ); |
|
| 168 | - clean_post_cache( $form->get_id() ); |
|
| 169 | - } else { |
|
| 170 | - wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) ); |
|
| 171 | - } |
|
| 172 | - $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 173 | - } |
|
| 174 | - $this->update_post_meta( $form ); |
|
| 175 | - $form->apply_changes(); |
|
| 176 | - $this->clear_caches( $form ); |
|
| 177 | - |
|
| 178 | - // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 179 | - $new_status = $form->get_status( 'edit' ); |
|
| 180 | - |
|
| 181 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 182 | - do_action( 'getpaid_new_payment_form', $form ); |
|
| 183 | - } else { |
|
| 184 | - do_action( 'getpaid_update_payment_form', $form ); |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - /* |
|
| 54 | + /** |
|
| 55 | + * Method to create a new form in the database. |
|
| 56 | + * |
|
| 57 | + * @param GetPaid_Payment_Form $form Form object. |
|
| 58 | + */ |
|
| 59 | + public function create( &$form ) { |
|
| 60 | + $form->set_version( WPINV_VERSION ); |
|
| 61 | + $form->set_date_created( current_time('mysql') ); |
|
| 62 | + |
|
| 63 | + // Create a new post. |
|
| 64 | + $id = wp_insert_post( |
|
| 65 | + apply_filters( |
|
| 66 | + 'getpaid_new_payment_form_data', |
|
| 67 | + array( |
|
| 68 | + 'post_date' => $form->get_date_created( 'edit' ), |
|
| 69 | + 'post_type' => 'wpi_payment_form', |
|
| 70 | + 'post_status' => $this->get_post_status( $form ), |
|
| 71 | + 'ping_status' => 'closed', |
|
| 72 | + 'post_author' => $form->get_author( 'edit' ), |
|
| 73 | + 'post_title' => $form->get_name( 'edit' ), |
|
| 74 | + ) |
|
| 75 | + ), |
|
| 76 | + true |
|
| 77 | + ); |
|
| 78 | + |
|
| 79 | + if ( $id && ! is_wp_error( $id ) ) { |
|
| 80 | + $form->set_id( $id ); |
|
| 81 | + $this->update_post_meta( $form ); |
|
| 82 | + $form->save_meta_data(); |
|
| 83 | + $form->apply_changes(); |
|
| 84 | + $this->clear_caches( $form ); |
|
| 85 | + do_action( 'getpaid_create_payment_form', $form ); |
|
| 86 | + return true; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + if ( is_wp_error( $id ) ) { |
|
| 90 | + $form->last_error = $id->get_error_message(); |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + return false; |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * Method to read a form from the database. |
|
| 98 | + * |
|
| 99 | + * @param GetPaid_Payment_Form $form Form object. |
|
| 100 | + * |
|
| 101 | + */ |
|
| 102 | + public function read( &$form ) { |
|
| 103 | + |
|
| 104 | + $form->set_defaults(); |
|
| 105 | + $form_object = get_post( $form->get_id() ); |
|
| 106 | + |
|
| 107 | + if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) { |
|
| 108 | + $form->last_error = __( 'Invalid form.', 'invoicing' ); |
|
| 109 | + $form->set_id( 0 ); |
|
| 110 | + return false; |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + $form->set_props( |
|
| 114 | + array( |
|
| 115 | + 'date_created' => 0 < $form_object->post_date ? $form_object->post_date : null, |
|
| 116 | + 'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null, |
|
| 117 | + 'status' => $form_object->post_status, |
|
| 118 | + 'name' => $form_object->post_title, |
|
| 119 | + 'author' => $form_object->post_author, |
|
| 120 | + ) |
|
| 121 | + ); |
|
| 122 | + |
|
| 123 | + $this->read_object_data( $form, $form_object ); |
|
| 124 | + $form->read_meta_data(); |
|
| 125 | + $form->set_object_read( true ); |
|
| 126 | + do_action( 'getpaid_read_payment_form', $form ); |
|
| 127 | + |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * Method to update a form in the database. |
|
| 132 | + * |
|
| 133 | + * @param GetPaid_Payment_Form $form Form object. |
|
| 134 | + */ |
|
| 135 | + public function update( &$form ) { |
|
| 136 | + $form->save_meta_data(); |
|
| 137 | + $form->set_version( WPINV_VERSION ); |
|
| 138 | + |
|
| 139 | + if ( null === $form->get_date_created( 'edit' ) ) { |
|
| 140 | + $form->set_date_created( current_time('mysql') ); |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + // Grab the current status so we can compare. |
|
| 144 | + $previous_status = get_post_status( $form->get_id() ); |
|
| 145 | + |
|
| 146 | + $changes = $form->get_changes(); |
|
| 147 | + |
|
| 148 | + // Only update the post when the post data changes. |
|
| 149 | + if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
| 150 | + $post_data = array( |
|
| 151 | + 'post_date' => $form->get_date_created( 'edit' ), |
|
| 152 | + 'post_status' => $form->get_status( 'edit' ), |
|
| 153 | + 'post_title' => $form->get_name( 'edit' ), |
|
| 154 | + 'post_author' => $form->get_author( 'edit' ), |
|
| 155 | + 'post_modified' => $form->get_date_modified( 'edit' ), |
|
| 156 | + ); |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * When updating this object, to prevent infinite loops, use $wpdb |
|
| 160 | + * to update data, since wp_update_post spawns more calls to the |
|
| 161 | + * save_post action. |
|
| 162 | + * |
|
| 163 | + * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 164 | + * or an update purely from CRUD. |
|
| 165 | + */ |
|
| 166 | + if ( doing_action( 'save_post' ) ) { |
|
| 167 | + $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) ); |
|
| 168 | + clean_post_cache( $form->get_id() ); |
|
| 169 | + } else { |
|
| 170 | + wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) ); |
|
| 171 | + } |
|
| 172 | + $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 173 | + } |
|
| 174 | + $this->update_post_meta( $form ); |
|
| 175 | + $form->apply_changes(); |
|
| 176 | + $this->clear_caches( $form ); |
|
| 177 | + |
|
| 178 | + // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 179 | + $new_status = $form->get_status( 'edit' ); |
|
| 180 | + |
|
| 181 | + if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 182 | + do_action( 'getpaid_new_payment_form', $form ); |
|
| 183 | + } else { |
|
| 184 | + do_action( 'getpaid_update_payment_form', $form ); |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + /* |
|
| 190 | 190 | |-------------------------------------------------------------------------- |
| 191 | 191 | | Additional Methods |
| 192 | 192 | |-------------------------------------------------------------------------- |
@@ -3,7 +3,7 @@ discard block |
||
| 3 | 3 | * GetPaid_Payment_Form_Data_Store class file. |
| 4 | 4 | * |
| 5 | 5 | */ |
| 6 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 6 | +if (!defined('ABSPATH')) { |
|
| 7 | 7 | exit; |
| 8 | 8 | } |
| 9 | 9 | |
@@ -56,37 +56,37 @@ discard block |
||
| 56 | 56 | * |
| 57 | 57 | * @param GetPaid_Payment_Form $form Form object. |
| 58 | 58 | */ |
| 59 | - public function create( &$form ) { |
|
| 60 | - $form->set_version( WPINV_VERSION ); |
|
| 61 | - $form->set_date_created( current_time('mysql') ); |
|
| 59 | + public function create(&$form) { |
|
| 60 | + $form->set_version(WPINV_VERSION); |
|
| 61 | + $form->set_date_created(current_time('mysql')); |
|
| 62 | 62 | |
| 63 | 63 | // Create a new post. |
| 64 | 64 | $id = wp_insert_post( |
| 65 | 65 | apply_filters( |
| 66 | 66 | 'getpaid_new_payment_form_data', |
| 67 | 67 | array( |
| 68 | - 'post_date' => $form->get_date_created( 'edit' ), |
|
| 68 | + 'post_date' => $form->get_date_created('edit'), |
|
| 69 | 69 | 'post_type' => 'wpi_payment_form', |
| 70 | - 'post_status' => $this->get_post_status( $form ), |
|
| 70 | + 'post_status' => $this->get_post_status($form), |
|
| 71 | 71 | 'ping_status' => 'closed', |
| 72 | - 'post_author' => $form->get_author( 'edit' ), |
|
| 73 | - 'post_title' => $form->get_name( 'edit' ), |
|
| 72 | + 'post_author' => $form->get_author('edit'), |
|
| 73 | + 'post_title' => $form->get_name('edit'), |
|
| 74 | 74 | ) |
| 75 | 75 | ), |
| 76 | 76 | true |
| 77 | 77 | ); |
| 78 | 78 | |
| 79 | - if ( $id && ! is_wp_error( $id ) ) { |
|
| 80 | - $form->set_id( $id ); |
|
| 81 | - $this->update_post_meta( $form ); |
|
| 79 | + if ($id && !is_wp_error($id)) { |
|
| 80 | + $form->set_id($id); |
|
| 81 | + $this->update_post_meta($form); |
|
| 82 | 82 | $form->save_meta_data(); |
| 83 | 83 | $form->apply_changes(); |
| 84 | - $this->clear_caches( $form ); |
|
| 85 | - do_action( 'getpaid_create_payment_form', $form ); |
|
| 84 | + $this->clear_caches($form); |
|
| 85 | + do_action('getpaid_create_payment_form', $form); |
|
| 86 | 86 | return true; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - if ( is_wp_error( $id ) ) { |
|
| 89 | + if (is_wp_error($id)) { |
|
| 90 | 90 | $form->last_error = $id->get_error_message(); |
| 91 | 91 | } |
| 92 | 92 | |
@@ -99,14 +99,14 @@ discard block |
||
| 99 | 99 | * @param GetPaid_Payment_Form $form Form object. |
| 100 | 100 | * |
| 101 | 101 | */ |
| 102 | - public function read( &$form ) { |
|
| 102 | + public function read(&$form) { |
|
| 103 | 103 | |
| 104 | 104 | $form->set_defaults(); |
| 105 | - $form_object = get_post( $form->get_id() ); |
|
| 105 | + $form_object = get_post($form->get_id()); |
|
| 106 | 106 | |
| 107 | - if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) { |
|
| 108 | - $form->last_error = __( 'Invalid form.', 'invoicing' ); |
|
| 109 | - $form->set_id( 0 ); |
|
| 107 | + if (!$form->get_id() || !$form_object || $form_object->post_type != 'wpi_payment_form') { |
|
| 108 | + $form->last_error = __('Invalid form.', 'invoicing'); |
|
| 109 | + $form->set_id(0); |
|
| 110 | 110 | return false; |
| 111 | 111 | } |
| 112 | 112 | |
@@ -120,10 +120,10 @@ discard block |
||
| 120 | 120 | ) |
| 121 | 121 | ); |
| 122 | 122 | |
| 123 | - $this->read_object_data( $form, $form_object ); |
|
| 123 | + $this->read_object_data($form, $form_object); |
|
| 124 | 124 | $form->read_meta_data(); |
| 125 | - $form->set_object_read( true ); |
|
| 126 | - do_action( 'getpaid_read_payment_form', $form ); |
|
| 125 | + $form->set_object_read(true); |
|
| 126 | + do_action('getpaid_read_payment_form', $form); |
|
| 127 | 127 | |
| 128 | 128 | } |
| 129 | 129 | |
@@ -132,27 +132,27 @@ discard block |
||
| 132 | 132 | * |
| 133 | 133 | * @param GetPaid_Payment_Form $form Form object. |
| 134 | 134 | */ |
| 135 | - public function update( &$form ) { |
|
| 135 | + public function update(&$form) { |
|
| 136 | 136 | $form->save_meta_data(); |
| 137 | - $form->set_version( WPINV_VERSION ); |
|
| 137 | + $form->set_version(WPINV_VERSION); |
|
| 138 | 138 | |
| 139 | - if ( null === $form->get_date_created( 'edit' ) ) { |
|
| 140 | - $form->set_date_created( current_time('mysql') ); |
|
| 139 | + if (null === $form->get_date_created('edit')) { |
|
| 140 | + $form->set_date_created(current_time('mysql')); |
|
| 141 | 141 | } |
| 142 | 142 | |
| 143 | 143 | // Grab the current status so we can compare. |
| 144 | - $previous_status = get_post_status( $form->get_id() ); |
|
| 144 | + $previous_status = get_post_status($form->get_id()); |
|
| 145 | 145 | |
| 146 | 146 | $changes = $form->get_changes(); |
| 147 | 147 | |
| 148 | 148 | // Only update the post when the post data changes. |
| 149 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
| 149 | + if (array_intersect(array('date_created', 'date_modified', 'status', 'name', 'author'), array_keys($changes))) { |
|
| 150 | 150 | $post_data = array( |
| 151 | - 'post_date' => $form->get_date_created( 'edit' ), |
|
| 152 | - 'post_status' => $form->get_status( 'edit' ), |
|
| 153 | - 'post_title' => $form->get_name( 'edit' ), |
|
| 154 | - 'post_author' => $form->get_author( 'edit' ), |
|
| 155 | - 'post_modified' => $form->get_date_modified( 'edit' ), |
|
| 151 | + 'post_date' => $form->get_date_created('edit'), |
|
| 152 | + 'post_status' => $form->get_status('edit'), |
|
| 153 | + 'post_title' => $form->get_name('edit'), |
|
| 154 | + 'post_author' => $form->get_author('edit'), |
|
| 155 | + 'post_modified' => $form->get_date_modified('edit'), |
|
| 156 | 156 | ); |
| 157 | 157 | |
| 158 | 158 | /** |
@@ -163,25 +163,25 @@ discard block |
||
| 163 | 163 | * This ensures hooks are fired by either WP itself (admin screen save), |
| 164 | 164 | * or an update purely from CRUD. |
| 165 | 165 | */ |
| 166 | - if ( doing_action( 'save_post' ) ) { |
|
| 167 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) ); |
|
| 168 | - clean_post_cache( $form->get_id() ); |
|
| 166 | + if (doing_action('save_post')) { |
|
| 167 | + $GLOBALS['wpdb']->update($GLOBALS['wpdb']->posts, $post_data, array('ID' => $form->get_id())); |
|
| 168 | + clean_post_cache($form->get_id()); |
|
| 169 | 169 | } else { |
| 170 | - wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) ); |
|
| 170 | + wp_update_post(array_merge(array('ID' => $form->get_id()), $post_data)); |
|
| 171 | 171 | } |
| 172 | - $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 172 | + $form->read_meta_data(true); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 173 | 173 | } |
| 174 | - $this->update_post_meta( $form ); |
|
| 174 | + $this->update_post_meta($form); |
|
| 175 | 175 | $form->apply_changes(); |
| 176 | - $this->clear_caches( $form ); |
|
| 176 | + $this->clear_caches($form); |
|
| 177 | 177 | |
| 178 | 178 | // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
| 179 | - $new_status = $form->get_status( 'edit' ); |
|
| 179 | + $new_status = $form->get_status('edit'); |
|
| 180 | 180 | |
| 181 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 182 | - do_action( 'getpaid_new_payment_form', $form ); |
|
| 181 | + if ($new_status !== $previous_status && in_array($previous_status, array('new', 'auto-draft', 'draft'), true)) { |
|
| 182 | + do_action('getpaid_new_payment_form', $form); |
|
| 183 | 183 | } else { |
| 184 | - do_action( 'getpaid_update_payment_form', $form ); |
|
| 184 | + do_action('getpaid_update_payment_form', $form); |
|
| 185 | 185 | } |
| 186 | 186 | |
| 187 | 187 | } |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | * GetPaid_Discount_Data_Store class file. |
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 7 | +if (!defined('ABSPATH')) { |
|
| 8 | 8 | exit; |
| 9 | 9 | } |
| 10 | 10 | |
@@ -71,38 +71,38 @@ discard block |
||
| 71 | 71 | * |
| 72 | 72 | * @param WPInv_Discount $discount Discount object. |
| 73 | 73 | */ |
| 74 | - public function create( &$discount ) { |
|
| 75 | - $discount->set_version( WPINV_VERSION ); |
|
| 76 | - $discount->set_date_created( current_time('mysql') ); |
|
| 74 | + public function create(&$discount) { |
|
| 75 | + $discount->set_version(WPINV_VERSION); |
|
| 76 | + $discount->set_date_created(current_time('mysql')); |
|
| 77 | 77 | |
| 78 | 78 | // Create a new post. |
| 79 | 79 | $id = wp_insert_post( |
| 80 | 80 | apply_filters( |
| 81 | 81 | 'getpaid_new_discount_data', |
| 82 | 82 | array( |
| 83 | - 'post_date' => $discount->get_date_created( 'edit' ), |
|
| 83 | + 'post_date' => $discount->get_date_created('edit'), |
|
| 84 | 84 | 'post_type' => 'wpi_discount', |
| 85 | - 'post_status' => $this->get_post_status( $discount ), |
|
| 85 | + 'post_status' => $this->get_post_status($discount), |
|
| 86 | 86 | 'ping_status' => 'closed', |
| 87 | - 'post_author' => $discount->get_author( 'edit' ), |
|
| 88 | - 'post_title' => $discount->get_name( 'edit' ), |
|
| 89 | - 'post_excerpt' => $discount->get_description( 'edit' ), |
|
| 87 | + 'post_author' => $discount->get_author('edit'), |
|
| 88 | + 'post_title' => $discount->get_name('edit'), |
|
| 89 | + 'post_excerpt' => $discount->get_description('edit'), |
|
| 90 | 90 | ) |
| 91 | 91 | ), |
| 92 | 92 | true |
| 93 | 93 | ); |
| 94 | 94 | |
| 95 | - if ( $id && ! is_wp_error( $id ) ) { |
|
| 96 | - $discount->set_id( $id ); |
|
| 97 | - $this->update_post_meta( $discount ); |
|
| 95 | + if ($id && !is_wp_error($id)) { |
|
| 96 | + $discount->set_id($id); |
|
| 97 | + $this->update_post_meta($discount); |
|
| 98 | 98 | $discount->save_meta_data(); |
| 99 | 99 | $discount->apply_changes(); |
| 100 | - $this->clear_caches( $discount ); |
|
| 101 | - do_action( 'getpaid_new_discount', $discount ); |
|
| 100 | + $this->clear_caches($discount); |
|
| 101 | + do_action('getpaid_new_discount', $discount); |
|
| 102 | 102 | return true; |
| 103 | 103 | } |
| 104 | 104 | |
| 105 | - if ( is_wp_error( $id ) ) { |
|
| 105 | + if (is_wp_error($id)) { |
|
| 106 | 106 | $discount->last_error = $id->get_error_message(); |
| 107 | 107 | } |
| 108 | 108 | |
@@ -115,14 +115,14 @@ discard block |
||
| 115 | 115 | * @param WPInv_Discount $discount Discount object. |
| 116 | 116 | * |
| 117 | 117 | */ |
| 118 | - public function read( &$discount ) { |
|
| 118 | + public function read(&$discount) { |
|
| 119 | 119 | |
| 120 | 120 | $discount->set_defaults(); |
| 121 | - $discount_object = get_post( $discount->get_id() ); |
|
| 121 | + $discount_object = get_post($discount->get_id()); |
|
| 122 | 122 | |
| 123 | - if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) { |
|
| 124 | - $discount->last_error = __( 'Invalid discount.', 'invoicing' ); |
|
| 125 | - $discount->set_id( 0 ); |
|
| 123 | + if (!$discount->get_id() || !$discount_object || $discount_object->post_type != 'wpi_discount') { |
|
| 124 | + $discount->last_error = __('Invalid discount.', 'invoicing'); |
|
| 125 | + $discount->set_id(0); |
|
| 126 | 126 | return false; |
| 127 | 127 | } |
| 128 | 128 | |
@@ -137,10 +137,10 @@ discard block |
||
| 137 | 137 | ) |
| 138 | 138 | ); |
| 139 | 139 | |
| 140 | - $this->read_object_data( $discount, $discount_object ); |
|
| 140 | + $this->read_object_data($discount, $discount_object); |
|
| 141 | 141 | $discount->read_meta_data(); |
| 142 | - $discount->set_object_read( true ); |
|
| 143 | - do_action( 'getpaid_read_discount', $discount ); |
|
| 142 | + $discount->set_object_read(true); |
|
| 143 | + do_action('getpaid_read_discount', $discount); |
|
| 144 | 144 | |
| 145 | 145 | } |
| 146 | 146 | |
@@ -149,28 +149,28 @@ discard block |
||
| 149 | 149 | * |
| 150 | 150 | * @param WPInv_Discount $discount Discount object. |
| 151 | 151 | */ |
| 152 | - public function update( &$discount ) { |
|
| 152 | + public function update(&$discount) { |
|
| 153 | 153 | $discount->save_meta_data(); |
| 154 | - $discount->set_version( WPINV_VERSION ); |
|
| 154 | + $discount->set_version(WPINV_VERSION); |
|
| 155 | 155 | |
| 156 | - if ( null === $discount->get_date_created( 'edit' ) ) { |
|
| 157 | - $discount->set_date_created( current_time('mysql') ); |
|
| 156 | + if (null === $discount->get_date_created('edit')) { |
|
| 157 | + $discount->set_date_created(current_time('mysql')); |
|
| 158 | 158 | } |
| 159 | 159 | |
| 160 | 160 | // Grab the current status so we can compare. |
| 161 | - $previous_status = get_post_status( $discount->get_id() ); |
|
| 161 | + $previous_status = get_post_status($discount->get_id()); |
|
| 162 | 162 | |
| 163 | 163 | $changes = $discount->get_changes(); |
| 164 | 164 | |
| 165 | 165 | // Only update the post when the post data changes. |
| 166 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) { |
|
| 166 | + if (array_intersect(array('date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt'), array_keys($changes))) { |
|
| 167 | 167 | $post_data = array( |
| 168 | - 'post_date' => $discount->get_date_created( 'edit' ), |
|
| 169 | - 'post_status' => $discount->get_status( 'edit' ), |
|
| 170 | - 'post_title' => $discount->get_name( 'edit' ), |
|
| 171 | - 'post_author' => $discount->get_author( 'edit' ), |
|
| 172 | - 'post_modified' => $discount->get_date_modified( 'edit' ), |
|
| 173 | - 'post_excerpt' => $discount->get_description( 'edit' ), |
|
| 168 | + 'post_date' => $discount->get_date_created('edit'), |
|
| 169 | + 'post_status' => $discount->get_status('edit'), |
|
| 170 | + 'post_title' => $discount->get_name('edit'), |
|
| 171 | + 'post_author' => $discount->get_author('edit'), |
|
| 172 | + 'post_modified' => $discount->get_date_modified('edit'), |
|
| 173 | + 'post_excerpt' => $discount->get_description('edit'), |
|
| 174 | 174 | ); |
| 175 | 175 | |
| 176 | 176 | /** |
@@ -181,25 +181,25 @@ discard block |
||
| 181 | 181 | * This ensures hooks are fired by either WP itself (admin screen save), |
| 182 | 182 | * or an update purely from CRUD. |
| 183 | 183 | */ |
| 184 | - if ( doing_action( 'save_post' ) ) { |
|
| 185 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) ); |
|
| 186 | - clean_post_cache( $discount->get_id() ); |
|
| 184 | + if (doing_action('save_post')) { |
|
| 185 | + $GLOBALS['wpdb']->update($GLOBALS['wpdb']->posts, $post_data, array('ID' => $discount->get_id())); |
|
| 186 | + clean_post_cache($discount->get_id()); |
|
| 187 | 187 | } else { |
| 188 | - wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) ); |
|
| 188 | + wp_update_post(array_merge(array('ID' => $discount->get_id()), $post_data)); |
|
| 189 | 189 | } |
| 190 | - $discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 190 | + $discount->read_meta_data(true); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 191 | 191 | } |
| 192 | - $this->update_post_meta( $discount ); |
|
| 192 | + $this->update_post_meta($discount); |
|
| 193 | 193 | $discount->apply_changes(); |
| 194 | - $this->clear_caches( $discount ); |
|
| 194 | + $this->clear_caches($discount); |
|
| 195 | 195 | |
| 196 | 196 | // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
| 197 | - $new_status = $discount->get_status( 'edit' ); |
|
| 197 | + $new_status = $discount->get_status('edit'); |
|
| 198 | 198 | |
| 199 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 200 | - do_action( 'getpaid_new_discount', $discount ); |
|
| 199 | + if ($new_status !== $previous_status && in_array($previous_status, array('new', 'auto-draft', 'draft'), true)) { |
|
| 200 | + do_action('getpaid_new_discount', $discount); |
|
| 201 | 201 | } else { |
| 202 | - do_action( 'getpaid_update_discount', $discount ); |
|
| 202 | + do_action('getpaid_update_discount', $discount); |
|
| 203 | 203 | } |
| 204 | 204 | |
| 205 | 205 | } |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | 7 | if ( ! defined( 'ABSPATH' ) ) { |
| 8 | - exit; |
|
| 8 | + exit; |
|
| 9 | 9 | } |
| 10 | 10 | |
| 11 | 11 | /** |
@@ -15,198 +15,198 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class GetPaid_Discount_Data_Store extends GetPaid_Data_Store_WP { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Data stored in meta keys, but not considered "meta" for a discount. |
|
| 20 | - * |
|
| 21 | - * @since 1.0.19 |
|
| 22 | - * @var array |
|
| 23 | - */ |
|
| 24 | - protected $internal_meta_keys = array( |
|
| 25 | - '_wpi_discount_code', |
|
| 26 | - '_wpi_discount_amount', |
|
| 27 | - '_wpi_discount_start', |
|
| 28 | - '_wpi_discount_expiration', |
|
| 29 | - '_wpi_discount_type', |
|
| 30 | - '_wpi_discount_uses', |
|
| 31 | - '_wpi_discount_is_single_use', |
|
| 32 | - '_wpi_discount_items', |
|
| 33 | - '_wpi_discount_excluded_items', |
|
| 34 | - '_wpi_discount_required_items', |
|
| 35 | - '_wpi_discount_max_uses', |
|
| 36 | - '_wpi_discount_is_recurring', |
|
| 37 | - '_wpi_discount_min_total', |
|
| 38 | - '_wpi_discount_max_total', |
|
| 39 | - ); |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * A map of meta keys to data props. |
|
| 43 | - * |
|
| 44 | - * @since 1.0.19 |
|
| 45 | - * |
|
| 46 | - * @var array |
|
| 47 | - */ |
|
| 48 | - protected $meta_key_to_props = array( |
|
| 49 | - '_wpi_discount_code' => 'code', |
|
| 50 | - '_wpi_discount_amount' => 'amount', |
|
| 51 | - '_wpi_discount_start' => 'start', |
|
| 52 | - '_wpi_discount_expiration' => 'expiration', |
|
| 53 | - '_wpi_discount_type' => 'type', |
|
| 54 | - '_wpi_discount_uses' => 'uses', |
|
| 55 | - '_wpi_discount_is_single_use' => 'is_single_use', |
|
| 56 | - '_wpi_discount_items' => 'items', |
|
| 57 | - '_wpi_discount_excluded_items' => 'excluded_items', |
|
| 58 | - '_wpi_discount_required_items' => 'required_items', |
|
| 59 | - '_wpi_discount_max_uses' => 'max_uses', |
|
| 60 | - '_wpi_discount_is_recurring' => 'is_recurring', |
|
| 61 | - '_wpi_discount_min_total' => 'min_total', |
|
| 62 | - '_wpi_discount_max_total' => 'max_total', |
|
| 63 | - ); |
|
| 64 | - |
|
| 65 | - /* |
|
| 18 | + /** |
|
| 19 | + * Data stored in meta keys, but not considered "meta" for a discount. |
|
| 20 | + * |
|
| 21 | + * @since 1.0.19 |
|
| 22 | + * @var array |
|
| 23 | + */ |
|
| 24 | + protected $internal_meta_keys = array( |
|
| 25 | + '_wpi_discount_code', |
|
| 26 | + '_wpi_discount_amount', |
|
| 27 | + '_wpi_discount_start', |
|
| 28 | + '_wpi_discount_expiration', |
|
| 29 | + '_wpi_discount_type', |
|
| 30 | + '_wpi_discount_uses', |
|
| 31 | + '_wpi_discount_is_single_use', |
|
| 32 | + '_wpi_discount_items', |
|
| 33 | + '_wpi_discount_excluded_items', |
|
| 34 | + '_wpi_discount_required_items', |
|
| 35 | + '_wpi_discount_max_uses', |
|
| 36 | + '_wpi_discount_is_recurring', |
|
| 37 | + '_wpi_discount_min_total', |
|
| 38 | + '_wpi_discount_max_total', |
|
| 39 | + ); |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * A map of meta keys to data props. |
|
| 43 | + * |
|
| 44 | + * @since 1.0.19 |
|
| 45 | + * |
|
| 46 | + * @var array |
|
| 47 | + */ |
|
| 48 | + protected $meta_key_to_props = array( |
|
| 49 | + '_wpi_discount_code' => 'code', |
|
| 50 | + '_wpi_discount_amount' => 'amount', |
|
| 51 | + '_wpi_discount_start' => 'start', |
|
| 52 | + '_wpi_discount_expiration' => 'expiration', |
|
| 53 | + '_wpi_discount_type' => 'type', |
|
| 54 | + '_wpi_discount_uses' => 'uses', |
|
| 55 | + '_wpi_discount_is_single_use' => 'is_single_use', |
|
| 56 | + '_wpi_discount_items' => 'items', |
|
| 57 | + '_wpi_discount_excluded_items' => 'excluded_items', |
|
| 58 | + '_wpi_discount_required_items' => 'required_items', |
|
| 59 | + '_wpi_discount_max_uses' => 'max_uses', |
|
| 60 | + '_wpi_discount_is_recurring' => 'is_recurring', |
|
| 61 | + '_wpi_discount_min_total' => 'min_total', |
|
| 62 | + '_wpi_discount_max_total' => 'max_total', |
|
| 63 | + ); |
|
| 64 | + |
|
| 65 | + /* |
|
| 66 | 66 | |-------------------------------------------------------------------------- |
| 67 | 67 | | CRUD Methods |
| 68 | 68 | |-------------------------------------------------------------------------- |
| 69 | 69 | */ |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Method to create a new discount in the database. |
|
| 73 | - * |
|
| 74 | - * @param WPInv_Discount $discount Discount object. |
|
| 75 | - */ |
|
| 76 | - public function create( &$discount ) { |
|
| 77 | - $discount->set_version( WPINV_VERSION ); |
|
| 78 | - $discount->set_date_created( current_time('mysql') ); |
|
| 79 | - |
|
| 80 | - // Create a new post. |
|
| 81 | - $id = wp_insert_post( |
|
| 82 | - apply_filters( |
|
| 83 | - 'getpaid_new_discount_data', |
|
| 84 | - array( |
|
| 85 | - 'post_date' => $discount->get_date_created( 'edit' ), |
|
| 86 | - 'post_type' => 'wpi_discount', |
|
| 87 | - 'post_status' => $this->get_post_status( $discount ), |
|
| 88 | - 'ping_status' => 'closed', |
|
| 89 | - 'post_author' => $discount->get_author( 'edit' ), |
|
| 90 | - 'post_title' => $discount->get_name( 'edit' ), |
|
| 91 | - 'post_excerpt' => $discount->get_description( 'edit' ), |
|
| 92 | - ) |
|
| 93 | - ), |
|
| 94 | - true |
|
| 95 | - ); |
|
| 96 | - |
|
| 97 | - if ( $id && ! is_wp_error( $id ) ) { |
|
| 98 | - $discount->set_id( $id ); |
|
| 99 | - $this->update_post_meta( $discount ); |
|
| 100 | - $discount->save_meta_data(); |
|
| 101 | - $discount->apply_changes(); |
|
| 102 | - $this->clear_caches( $discount ); |
|
| 103 | - do_action( 'getpaid_new_discount', $discount ); |
|
| 104 | - return true; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - if ( is_wp_error( $id ) ) { |
|
| 108 | - $discount->last_error = $id->get_error_message(); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - return false; |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * Method to read a discount from the database. |
|
| 116 | - * |
|
| 117 | - * @param WPInv_Discount $discount Discount object. |
|
| 118 | - * |
|
| 119 | - */ |
|
| 120 | - public function read( &$discount ) { |
|
| 121 | - |
|
| 122 | - $discount->set_defaults(); |
|
| 123 | - $discount_object = get_post( $discount->get_id() ); |
|
| 124 | - |
|
| 125 | - if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) { |
|
| 126 | - $discount->last_error = __( 'Invalid discount.', 'invoicing' ); |
|
| 127 | - $discount->set_id( 0 ); |
|
| 128 | - return false; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - $discount->set_props( |
|
| 132 | - array( |
|
| 133 | - 'date_created' => 0 < $discount_object->post_date ? $discount_object->post_date : null, |
|
| 134 | - 'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null, |
|
| 135 | - 'status' => $discount_object->post_status, |
|
| 136 | - 'name' => $discount_object->post_title, |
|
| 137 | - 'author' => $discount_object->post_author, |
|
| 138 | - 'description' => $discount_object->post_excerpt, |
|
| 139 | - ) |
|
| 140 | - ); |
|
| 141 | - |
|
| 142 | - $this->read_object_data( $discount, $discount_object ); |
|
| 143 | - $discount->read_meta_data(); |
|
| 144 | - $discount->set_object_read( true ); |
|
| 145 | - do_action( 'getpaid_read_discount', $discount ); |
|
| 146 | - |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - /** |
|
| 150 | - * Method to update a discount in the database. |
|
| 151 | - * |
|
| 152 | - * @param WPInv_Discount $discount Discount object. |
|
| 153 | - */ |
|
| 154 | - public function update( &$discount ) { |
|
| 155 | - $discount->save_meta_data(); |
|
| 156 | - $discount->set_version( WPINV_VERSION ); |
|
| 157 | - |
|
| 158 | - if ( null === $discount->get_date_created( 'edit' ) ) { |
|
| 159 | - $discount->set_date_created( current_time('mysql') ); |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - // Grab the current status so we can compare. |
|
| 163 | - $previous_status = get_post_status( $discount->get_id() ); |
|
| 164 | - |
|
| 165 | - $changes = $discount->get_changes(); |
|
| 166 | - |
|
| 167 | - // Only update the post when the post data changes. |
|
| 168 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) { |
|
| 169 | - $post_data = array( |
|
| 170 | - 'post_date' => $discount->get_date_created( 'edit' ), |
|
| 171 | - 'post_status' => $discount->get_status( 'edit' ), |
|
| 172 | - 'post_title' => $discount->get_name( 'edit' ), |
|
| 173 | - 'post_author' => $discount->get_author( 'edit' ), |
|
| 174 | - 'post_modified' => $discount->get_date_modified( 'edit' ), |
|
| 175 | - 'post_excerpt' => $discount->get_description( 'edit' ), |
|
| 176 | - ); |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * When updating this object, to prevent infinite loops, use $wpdb |
|
| 180 | - * to update data, since wp_update_post spawns more calls to the |
|
| 181 | - * save_post action. |
|
| 182 | - * |
|
| 183 | - * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 184 | - * or an update purely from CRUD. |
|
| 185 | - */ |
|
| 186 | - if ( doing_action( 'save_post' ) ) { |
|
| 187 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) ); |
|
| 188 | - clean_post_cache( $discount->get_id() ); |
|
| 189 | - } else { |
|
| 190 | - wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) ); |
|
| 191 | - } |
|
| 192 | - $discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 193 | - } |
|
| 194 | - $this->update_post_meta( $discount ); |
|
| 195 | - $discount->apply_changes(); |
|
| 196 | - $this->clear_caches( $discount ); |
|
| 197 | - |
|
| 198 | - // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 199 | - $new_status = $discount->get_status( 'edit' ); |
|
| 200 | - |
|
| 201 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 202 | - do_action( 'getpaid_new_discount', $discount ); |
|
| 203 | - } else { |
|
| 204 | - do_action( 'getpaid_update_discount', $discount ); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - /* |
|
| 71 | + /** |
|
| 72 | + * Method to create a new discount in the database. |
|
| 73 | + * |
|
| 74 | + * @param WPInv_Discount $discount Discount object. |
|
| 75 | + */ |
|
| 76 | + public function create( &$discount ) { |
|
| 77 | + $discount->set_version( WPINV_VERSION ); |
|
| 78 | + $discount->set_date_created( current_time('mysql') ); |
|
| 79 | + |
|
| 80 | + // Create a new post. |
|
| 81 | + $id = wp_insert_post( |
|
| 82 | + apply_filters( |
|
| 83 | + 'getpaid_new_discount_data', |
|
| 84 | + array( |
|
| 85 | + 'post_date' => $discount->get_date_created( 'edit' ), |
|
| 86 | + 'post_type' => 'wpi_discount', |
|
| 87 | + 'post_status' => $this->get_post_status( $discount ), |
|
| 88 | + 'ping_status' => 'closed', |
|
| 89 | + 'post_author' => $discount->get_author( 'edit' ), |
|
| 90 | + 'post_title' => $discount->get_name( 'edit' ), |
|
| 91 | + 'post_excerpt' => $discount->get_description( 'edit' ), |
|
| 92 | + ) |
|
| 93 | + ), |
|
| 94 | + true |
|
| 95 | + ); |
|
| 96 | + |
|
| 97 | + if ( $id && ! is_wp_error( $id ) ) { |
|
| 98 | + $discount->set_id( $id ); |
|
| 99 | + $this->update_post_meta( $discount ); |
|
| 100 | + $discount->save_meta_data(); |
|
| 101 | + $discount->apply_changes(); |
|
| 102 | + $this->clear_caches( $discount ); |
|
| 103 | + do_action( 'getpaid_new_discount', $discount ); |
|
| 104 | + return true; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + if ( is_wp_error( $id ) ) { |
|
| 108 | + $discount->last_error = $id->get_error_message(); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + return false; |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * Method to read a discount from the database. |
|
| 116 | + * |
|
| 117 | + * @param WPInv_Discount $discount Discount object. |
|
| 118 | + * |
|
| 119 | + */ |
|
| 120 | + public function read( &$discount ) { |
|
| 121 | + |
|
| 122 | + $discount->set_defaults(); |
|
| 123 | + $discount_object = get_post( $discount->get_id() ); |
|
| 124 | + |
|
| 125 | + if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) { |
|
| 126 | + $discount->last_error = __( 'Invalid discount.', 'invoicing' ); |
|
| 127 | + $discount->set_id( 0 ); |
|
| 128 | + return false; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + $discount->set_props( |
|
| 132 | + array( |
|
| 133 | + 'date_created' => 0 < $discount_object->post_date ? $discount_object->post_date : null, |
|
| 134 | + 'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null, |
|
| 135 | + 'status' => $discount_object->post_status, |
|
| 136 | + 'name' => $discount_object->post_title, |
|
| 137 | + 'author' => $discount_object->post_author, |
|
| 138 | + 'description' => $discount_object->post_excerpt, |
|
| 139 | + ) |
|
| 140 | + ); |
|
| 141 | + |
|
| 142 | + $this->read_object_data( $discount, $discount_object ); |
|
| 143 | + $discount->read_meta_data(); |
|
| 144 | + $discount->set_object_read( true ); |
|
| 145 | + do_action( 'getpaid_read_discount', $discount ); |
|
| 146 | + |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + /** |
|
| 150 | + * Method to update a discount in the database. |
|
| 151 | + * |
|
| 152 | + * @param WPInv_Discount $discount Discount object. |
|
| 153 | + */ |
|
| 154 | + public function update( &$discount ) { |
|
| 155 | + $discount->save_meta_data(); |
|
| 156 | + $discount->set_version( WPINV_VERSION ); |
|
| 157 | + |
|
| 158 | + if ( null === $discount->get_date_created( 'edit' ) ) { |
|
| 159 | + $discount->set_date_created( current_time('mysql') ); |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + // Grab the current status so we can compare. |
|
| 163 | + $previous_status = get_post_status( $discount->get_id() ); |
|
| 164 | + |
|
| 165 | + $changes = $discount->get_changes(); |
|
| 166 | + |
|
| 167 | + // Only update the post when the post data changes. |
|
| 168 | + if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) { |
|
| 169 | + $post_data = array( |
|
| 170 | + 'post_date' => $discount->get_date_created( 'edit' ), |
|
| 171 | + 'post_status' => $discount->get_status( 'edit' ), |
|
| 172 | + 'post_title' => $discount->get_name( 'edit' ), |
|
| 173 | + 'post_author' => $discount->get_author( 'edit' ), |
|
| 174 | + 'post_modified' => $discount->get_date_modified( 'edit' ), |
|
| 175 | + 'post_excerpt' => $discount->get_description( 'edit' ), |
|
| 176 | + ); |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * When updating this object, to prevent infinite loops, use $wpdb |
|
| 180 | + * to update data, since wp_update_post spawns more calls to the |
|
| 181 | + * save_post action. |
|
| 182 | + * |
|
| 183 | + * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 184 | + * or an update purely from CRUD. |
|
| 185 | + */ |
|
| 186 | + if ( doing_action( 'save_post' ) ) { |
|
| 187 | + $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) ); |
|
| 188 | + clean_post_cache( $discount->get_id() ); |
|
| 189 | + } else { |
|
| 190 | + wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) ); |
|
| 191 | + } |
|
| 192 | + $discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 193 | + } |
|
| 194 | + $this->update_post_meta( $discount ); |
|
| 195 | + $discount->apply_changes(); |
|
| 196 | + $this->clear_caches( $discount ); |
|
| 197 | + |
|
| 198 | + // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 199 | + $new_status = $discount->get_status( 'edit' ); |
|
| 200 | + |
|
| 201 | + if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 202 | + do_action( 'getpaid_new_discount', $discount ); |
|
| 203 | + } else { |
|
| 204 | + do_action( 'getpaid_update_discount', $discount ); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + /* |
|
| 210 | 210 | |-------------------------------------------------------------------------- |
| 211 | 211 | | Additional Methods |
| 212 | 212 | |-------------------------------------------------------------------------- |
@@ -14,346 +14,346 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class GetPaid_Data_Store_WP { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * Meta type. This should match up with |
|
| 19 | - * the types available at https://developer.wordpress.org/reference/functions/add_metadata/. |
|
| 20 | - * WP defines 'post', 'user', 'comment', and 'term'. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - protected $meta_type = 'post'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * This only needs set if you are using a custom metadata type. |
|
| 28 | - * |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 31 | - protected $object_id_field_for_meta = ''; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Data stored in meta keys, but not considered "meta" for an object. |
|
| 35 | - * |
|
| 36 | - * @since 1.0.19 |
|
| 37 | - * |
|
| 38 | - * @var array |
|
| 39 | - */ |
|
| 40 | - protected $internal_meta_keys = array(); |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Meta data which should exist in the DB, even if empty. |
|
| 44 | - * |
|
| 45 | - * @since 1.0.19 |
|
| 46 | - * |
|
| 47 | - * @var array |
|
| 48 | - */ |
|
| 49 | - protected $must_exist_meta_keys = array(); |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * A map of meta keys to data props. |
|
| 53 | - * |
|
| 54 | - * @since 1.0.19 |
|
| 55 | - * |
|
| 56 | - * @var array |
|
| 57 | - */ |
|
| 58 | - protected $meta_key_to_props = array(); |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Returns an array of meta for an object. |
|
| 62 | - * |
|
| 63 | - * @since 1.0.19 |
|
| 64 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 65 | - * @return array |
|
| 66 | - */ |
|
| 67 | - public function read_meta( &$object ) { |
|
| 68 | - global $wpdb; |
|
| 69 | - $db_info = $this->get_db_info(); |
|
| 70 | - $raw_meta_data = $wpdb->get_results( |
|
| 71 | - $wpdb->prepare( |
|
| 72 | - "SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value |
|
| 17 | + /** |
|
| 18 | + * Meta type. This should match up with |
|
| 19 | + * the types available at https://developer.wordpress.org/reference/functions/add_metadata/. |
|
| 20 | + * WP defines 'post', 'user', 'comment', and 'term'. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + protected $meta_type = 'post'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * This only needs set if you are using a custom metadata type. |
|
| 28 | + * |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | + protected $object_id_field_for_meta = ''; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Data stored in meta keys, but not considered "meta" for an object. |
|
| 35 | + * |
|
| 36 | + * @since 1.0.19 |
|
| 37 | + * |
|
| 38 | + * @var array |
|
| 39 | + */ |
|
| 40 | + protected $internal_meta_keys = array(); |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Meta data which should exist in the DB, even if empty. |
|
| 44 | + * |
|
| 45 | + * @since 1.0.19 |
|
| 46 | + * |
|
| 47 | + * @var array |
|
| 48 | + */ |
|
| 49 | + protected $must_exist_meta_keys = array(); |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * A map of meta keys to data props. |
|
| 53 | + * |
|
| 54 | + * @since 1.0.19 |
|
| 55 | + * |
|
| 56 | + * @var array |
|
| 57 | + */ |
|
| 58 | + protected $meta_key_to_props = array(); |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Returns an array of meta for an object. |
|
| 62 | + * |
|
| 63 | + * @since 1.0.19 |
|
| 64 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 65 | + * @return array |
|
| 66 | + */ |
|
| 67 | + public function read_meta( &$object ) { |
|
| 68 | + global $wpdb; |
|
| 69 | + $db_info = $this->get_db_info(); |
|
| 70 | + $raw_meta_data = $wpdb->get_results( |
|
| 71 | + $wpdb->prepare( |
|
| 72 | + "SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value |
|
| 73 | 73 | FROM {$db_info['table']} |
| 74 | 74 | WHERE {$db_info['object_id_field']} = %d |
| 75 | 75 | ORDER BY {$db_info['meta_id_field']}", |
| 76 | - $object->get_id() |
|
| 77 | - ) |
|
| 78 | - ); |
|
| 79 | - |
|
| 80 | - $this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys ); |
|
| 81 | - $meta_data = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) ); |
|
| 82 | - return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this ); |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Deletes meta based on meta ID. |
|
| 87 | - * |
|
| 88 | - * @since 1.0.19 |
|
| 89 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 90 | - * @param stdClass $meta (containing at least ->id). |
|
| 91 | - */ |
|
| 92 | - public function delete_meta( &$object, $meta ) { |
|
| 93 | - delete_metadata_by_mid( $this->meta_type, $meta->id ); |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * Add new piece of meta. |
|
| 98 | - * |
|
| 99 | - * @since 1.0.19 |
|
| 100 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 101 | - * @param stdClass $meta (containing ->key and ->value). |
|
| 102 | - * @return int meta ID |
|
| 103 | - */ |
|
| 104 | - public function add_meta( &$object, $meta ) { |
|
| 105 | - return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false ); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Update meta. |
|
| 110 | - * |
|
| 111 | - * @since 1.0.19 |
|
| 112 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 113 | - * @param stdClass $meta (containing ->id, ->key and ->value). |
|
| 114 | - */ |
|
| 115 | - public function update_meta( &$object, $meta ) { |
|
| 116 | - update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key ); |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * Table structure is slightly different between meta types, this function will return what we need to know. |
|
| 121 | - * |
|
| 122 | - * @since 1.0.19 |
|
| 123 | - * @return array Array elements: table, object_id_field, meta_id_field |
|
| 124 | - */ |
|
| 125 | - protected function get_db_info() { |
|
| 126 | - global $wpdb; |
|
| 127 | - |
|
| 128 | - $meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well. |
|
| 129 | - $table = $wpdb->prefix; |
|
| 130 | - |
|
| 131 | - // If we are dealing with a type of metadata that is not a core type, the table should be prefixed. |
|
| 132 | - if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) { |
|
| 133 | - $table .= 'getpaid_'; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - $table .= $this->meta_type . 'meta'; |
|
| 137 | - $object_id_field = $this->meta_type . '_id'; |
|
| 138 | - |
|
| 139 | - // Figure out our field names. |
|
| 140 | - if ( 'user' === $this->meta_type ) { |
|
| 141 | - $meta_id_field = 'umeta_id'; |
|
| 142 | - $table = $wpdb->usermeta; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - if ( ! empty( $this->object_id_field_for_meta ) ) { |
|
| 146 | - $object_id_field = $this->object_id_field_for_meta; |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - return array( |
|
| 150 | - 'table' => $table, |
|
| 151 | - 'object_id_field' => $object_id_field, |
|
| 152 | - 'meta_id_field' => $meta_id_field, |
|
| 153 | - ); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Internal meta keys we don't want exposed as part of meta_data. This is in |
|
| 158 | - * addition to all data props with _ prefix. |
|
| 159 | - * |
|
| 160 | - * @since 1.0.19 |
|
| 161 | - * |
|
| 162 | - * @param string $key Prefix to be added to meta keys. |
|
| 163 | - * @return string |
|
| 164 | - */ |
|
| 165 | - protected function prefix_key( $key ) { |
|
| 166 | - return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key; |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * Callback to remove unwanted meta data. |
|
| 171 | - * |
|
| 172 | - * @param object $meta Meta object to check if it should be excluded or not. |
|
| 173 | - * @return bool |
|
| 174 | - */ |
|
| 175 | - protected function exclude_internal_meta_keys( $meta ) { |
|
| 176 | - return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' ); |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - /** |
|
| 180 | - * Gets a list of props and meta keys that need updated based on change state |
|
| 181 | - * or if they are present in the database or not. |
|
| 182 | - * |
|
| 183 | - * @param GetPaid_Data $object The GetPaid_Data object. |
|
| 184 | - * @param array $meta_key_to_props A mapping of meta keys => prop names. |
|
| 185 | - * @param string $meta_type The internal WP meta type (post, user, etc). |
|
| 186 | - * @return array A mapping of meta keys => prop names, filtered by ones that should be updated. |
|
| 187 | - */ |
|
| 188 | - protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) { |
|
| 189 | - $props_to_update = array(); |
|
| 190 | - $changed_props = $object->get_changes(); |
|
| 191 | - |
|
| 192 | - // Props should be updated if they are a part of the $changed array or don't exist yet. |
|
| 193 | - foreach ( $meta_key_to_props as $meta_key => $prop ) { |
|
| 194 | - if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) { |
|
| 195 | - $props_to_update[ $meta_key ] = $prop; |
|
| 196 | - } |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - return $props_to_update; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Read object data. |
|
| 204 | - * |
|
| 205 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 206 | - * @param WP_Post $post_object Post object. |
|
| 207 | - * @since 1.0.19 |
|
| 208 | - */ |
|
| 209 | - protected function read_object_data( &$object, $post_object ) { |
|
| 210 | - $id = $object->get_id(); |
|
| 211 | - $props = array(); |
|
| 212 | - |
|
| 213 | - foreach ( $this->meta_key_to_props as $meta_key => $prop ) { |
|
| 214 | - $props[ $prop ] = get_post_meta( $id, $meta_key, true ); |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - // Set object properties. |
|
| 218 | - $object->set_props( $props ); |
|
| 219 | - |
|
| 220 | - // Gets extra data associated with the object if needed. |
|
| 221 | - foreach ( $object->get_extra_data_keys() as $key ) { |
|
| 222 | - $function = 'set_' . $key; |
|
| 223 | - if ( is_callable( array( $object, $function ) ) ) { |
|
| 224 | - $object->{$function}( get_post_meta( $object->get_id(), $key, true ) ); |
|
| 225 | - } |
|
| 226 | - } |
|
| 227 | - } |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class. |
|
| 231 | - * |
|
| 232 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 233 | - * @since 1.0.19 |
|
| 234 | - */ |
|
| 235 | - protected function update_post_meta( &$object ) { |
|
| 236 | - |
|
| 237 | - $updated_props = array(); |
|
| 238 | - $props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props ); |
|
| 239 | - $object_type = $object->get_object_type(); |
|
| 240 | - |
|
| 241 | - foreach ( $props_to_update as $meta_key => $prop ) { |
|
| 242 | - $value = $object->{"get_$prop"}( 'edit' ); |
|
| 243 | - $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
| 244 | - |
|
| 245 | - $updated = $this->update_or_delete_post_meta( $object, $meta_key, $value ); |
|
| 246 | - |
|
| 247 | - if ( $updated ) { |
|
| 248 | - $updated_props[] = $prop; |
|
| 249 | - } |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props ); |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - /** |
|
| 256 | - * Update meta data in, or delete it from, the database. |
|
| 257 | - * |
|
| 258 | - * Avoids storing meta when it's either an empty string or empty array or null. |
|
| 259 | - * Other empty values such as numeric 0 should still be stored. |
|
| 260 | - * Data-stores can force meta to exist using `must_exist_meta_keys`. |
|
| 261 | - * |
|
| 262 | - * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist. |
|
| 263 | - * |
|
| 264 | - * @param GetPaid_Data $object The GetPaid_Data object. |
|
| 265 | - * @param string $meta_key Meta key to update. |
|
| 266 | - * @param mixed $meta_value Value to save. |
|
| 267 | - * |
|
| 268 | - * @since 1.0.19 Added to prevent empty meta being stored unless required. |
|
| 269 | - * |
|
| 270 | - * @return bool True if updated/deleted. |
|
| 271 | - */ |
|
| 272 | - protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) { |
|
| 273 | - if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) { |
|
| 274 | - $updated = delete_post_meta( $object->get_id(), $meta_key ); |
|
| 275 | - } else { |
|
| 276 | - $updated = update_post_meta( $object->get_id(), $meta_key, $meta_value ); |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - return (bool) $updated; |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - /** |
|
| 283 | - * Return list of internal meta keys. |
|
| 284 | - * |
|
| 285 | - * @since 1.0.19 |
|
| 286 | - * @return array |
|
| 287 | - */ |
|
| 288 | - public function get_internal_meta_keys() { |
|
| 289 | - return $this->internal_meta_keys; |
|
| 290 | - } |
|
| 291 | - |
|
| 292 | - /** |
|
| 293 | - * Clear any caches. |
|
| 294 | - * |
|
| 295 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 296 | - * @since 1.0.19 |
|
| 297 | - */ |
|
| 298 | - protected function clear_caches( &$object ) { |
|
| 299 | - clean_post_cache( $object->get_id() ); |
|
| 300 | - } |
|
| 301 | - |
|
| 302 | - /** |
|
| 303 | - * Method to delete a data object from the database. |
|
| 304 | - * |
|
| 305 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 306 | - * @param array $args Array of args to pass to the delete method. |
|
| 307 | - * |
|
| 308 | - * @return void |
|
| 309 | - */ |
|
| 310 | - public function delete( &$object, $args = array() ) { |
|
| 311 | - $id = $object->get_id(); |
|
| 312 | - $object_type = $object->get_object_type(); |
|
| 313 | - |
|
| 314 | - if ( 'invoice' == $object_type ) { |
|
| 315 | - $object_type = $object->get_type(); |
|
| 316 | - } |
|
| 317 | - |
|
| 318 | - $args = wp_parse_args( |
|
| 319 | - $args, |
|
| 320 | - array( |
|
| 321 | - 'force_delete' => false, |
|
| 322 | - ) |
|
| 323 | - ); |
|
| 324 | - |
|
| 325 | - if ( ! $id ) { |
|
| 326 | - return; |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - if ( $args['force_delete'] ) { |
|
| 330 | - do_action( "getpaid_delete_$object_type", $object ); |
|
| 331 | - wp_delete_post( $id, true ); |
|
| 332 | - $object->set_id( 0 ); |
|
| 333 | - } else { |
|
| 334 | - do_action( "getpaid_trash_$object_type", $object ); |
|
| 335 | - wp_trash_post( $id ); |
|
| 336 | - $object->set_status( 'trash' ); |
|
| 337 | - } |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /** |
|
| 341 | - * Get the status to save to the post object. |
|
| 342 | - * |
|
| 343 | - * |
|
| 344 | - * @since 1.0.19 |
|
| 345 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 346 | - * @return string |
|
| 347 | - */ |
|
| 348 | - protected function get_post_status( $object ) { |
|
| 349 | - $object_status = $object->get_status( 'edit' ); |
|
| 350 | - $object_type = $object->get_object_type(); |
|
| 351 | - |
|
| 352 | - if ( ! $object_status ) { |
|
| 353 | - $object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' ); |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - return $object_status; |
|
| 357 | - } |
|
| 76 | + $object->get_id() |
|
| 77 | + ) |
|
| 78 | + ); |
|
| 79 | + |
|
| 80 | + $this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys ); |
|
| 81 | + $meta_data = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) ); |
|
| 82 | + return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this ); |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Deletes meta based on meta ID. |
|
| 87 | + * |
|
| 88 | + * @since 1.0.19 |
|
| 89 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 90 | + * @param stdClass $meta (containing at least ->id). |
|
| 91 | + */ |
|
| 92 | + public function delete_meta( &$object, $meta ) { |
|
| 93 | + delete_metadata_by_mid( $this->meta_type, $meta->id ); |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * Add new piece of meta. |
|
| 98 | + * |
|
| 99 | + * @since 1.0.19 |
|
| 100 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 101 | + * @param stdClass $meta (containing ->key and ->value). |
|
| 102 | + * @return int meta ID |
|
| 103 | + */ |
|
| 104 | + public function add_meta( &$object, $meta ) { |
|
| 105 | + return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false ); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Update meta. |
|
| 110 | + * |
|
| 111 | + * @since 1.0.19 |
|
| 112 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 113 | + * @param stdClass $meta (containing ->id, ->key and ->value). |
|
| 114 | + */ |
|
| 115 | + public function update_meta( &$object, $meta ) { |
|
| 116 | + update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key ); |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * Table structure is slightly different between meta types, this function will return what we need to know. |
|
| 121 | + * |
|
| 122 | + * @since 1.0.19 |
|
| 123 | + * @return array Array elements: table, object_id_field, meta_id_field |
|
| 124 | + */ |
|
| 125 | + protected function get_db_info() { |
|
| 126 | + global $wpdb; |
|
| 127 | + |
|
| 128 | + $meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well. |
|
| 129 | + $table = $wpdb->prefix; |
|
| 130 | + |
|
| 131 | + // If we are dealing with a type of metadata that is not a core type, the table should be prefixed. |
|
| 132 | + if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) { |
|
| 133 | + $table .= 'getpaid_'; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + $table .= $this->meta_type . 'meta'; |
|
| 137 | + $object_id_field = $this->meta_type . '_id'; |
|
| 138 | + |
|
| 139 | + // Figure out our field names. |
|
| 140 | + if ( 'user' === $this->meta_type ) { |
|
| 141 | + $meta_id_field = 'umeta_id'; |
|
| 142 | + $table = $wpdb->usermeta; |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + if ( ! empty( $this->object_id_field_for_meta ) ) { |
|
| 146 | + $object_id_field = $this->object_id_field_for_meta; |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + return array( |
|
| 150 | + 'table' => $table, |
|
| 151 | + 'object_id_field' => $object_id_field, |
|
| 152 | + 'meta_id_field' => $meta_id_field, |
|
| 153 | + ); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Internal meta keys we don't want exposed as part of meta_data. This is in |
|
| 158 | + * addition to all data props with _ prefix. |
|
| 159 | + * |
|
| 160 | + * @since 1.0.19 |
|
| 161 | + * |
|
| 162 | + * @param string $key Prefix to be added to meta keys. |
|
| 163 | + * @return string |
|
| 164 | + */ |
|
| 165 | + protected function prefix_key( $key ) { |
|
| 166 | + return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key; |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * Callback to remove unwanted meta data. |
|
| 171 | + * |
|
| 172 | + * @param object $meta Meta object to check if it should be excluded or not. |
|
| 173 | + * @return bool |
|
| 174 | + */ |
|
| 175 | + protected function exclude_internal_meta_keys( $meta ) { |
|
| 176 | + return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' ); |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + /** |
|
| 180 | + * Gets a list of props and meta keys that need updated based on change state |
|
| 181 | + * or if they are present in the database or not. |
|
| 182 | + * |
|
| 183 | + * @param GetPaid_Data $object The GetPaid_Data object. |
|
| 184 | + * @param array $meta_key_to_props A mapping of meta keys => prop names. |
|
| 185 | + * @param string $meta_type The internal WP meta type (post, user, etc). |
|
| 186 | + * @return array A mapping of meta keys => prop names, filtered by ones that should be updated. |
|
| 187 | + */ |
|
| 188 | + protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) { |
|
| 189 | + $props_to_update = array(); |
|
| 190 | + $changed_props = $object->get_changes(); |
|
| 191 | + |
|
| 192 | + // Props should be updated if they are a part of the $changed array or don't exist yet. |
|
| 193 | + foreach ( $meta_key_to_props as $meta_key => $prop ) { |
|
| 194 | + if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) { |
|
| 195 | + $props_to_update[ $meta_key ] = $prop; |
|
| 196 | + } |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + return $props_to_update; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Read object data. |
|
| 204 | + * |
|
| 205 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 206 | + * @param WP_Post $post_object Post object. |
|
| 207 | + * @since 1.0.19 |
|
| 208 | + */ |
|
| 209 | + protected function read_object_data( &$object, $post_object ) { |
|
| 210 | + $id = $object->get_id(); |
|
| 211 | + $props = array(); |
|
| 212 | + |
|
| 213 | + foreach ( $this->meta_key_to_props as $meta_key => $prop ) { |
|
| 214 | + $props[ $prop ] = get_post_meta( $id, $meta_key, true ); |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + // Set object properties. |
|
| 218 | + $object->set_props( $props ); |
|
| 219 | + |
|
| 220 | + // Gets extra data associated with the object if needed. |
|
| 221 | + foreach ( $object->get_extra_data_keys() as $key ) { |
|
| 222 | + $function = 'set_' . $key; |
|
| 223 | + if ( is_callable( array( $object, $function ) ) ) { |
|
| 224 | + $object->{$function}( get_post_meta( $object->get_id(), $key, true ) ); |
|
| 225 | + } |
|
| 226 | + } |
|
| 227 | + } |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class. |
|
| 231 | + * |
|
| 232 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 233 | + * @since 1.0.19 |
|
| 234 | + */ |
|
| 235 | + protected function update_post_meta( &$object ) { |
|
| 236 | + |
|
| 237 | + $updated_props = array(); |
|
| 238 | + $props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props ); |
|
| 239 | + $object_type = $object->get_object_type(); |
|
| 240 | + |
|
| 241 | + foreach ( $props_to_update as $meta_key => $prop ) { |
|
| 242 | + $value = $object->{"get_$prop"}( 'edit' ); |
|
| 243 | + $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
| 244 | + |
|
| 245 | + $updated = $this->update_or_delete_post_meta( $object, $meta_key, $value ); |
|
| 246 | + |
|
| 247 | + if ( $updated ) { |
|
| 248 | + $updated_props[] = $prop; |
|
| 249 | + } |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props ); |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + /** |
|
| 256 | + * Update meta data in, or delete it from, the database. |
|
| 257 | + * |
|
| 258 | + * Avoids storing meta when it's either an empty string or empty array or null. |
|
| 259 | + * Other empty values such as numeric 0 should still be stored. |
|
| 260 | + * Data-stores can force meta to exist using `must_exist_meta_keys`. |
|
| 261 | + * |
|
| 262 | + * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist. |
|
| 263 | + * |
|
| 264 | + * @param GetPaid_Data $object The GetPaid_Data object. |
|
| 265 | + * @param string $meta_key Meta key to update. |
|
| 266 | + * @param mixed $meta_value Value to save. |
|
| 267 | + * |
|
| 268 | + * @since 1.0.19 Added to prevent empty meta being stored unless required. |
|
| 269 | + * |
|
| 270 | + * @return bool True if updated/deleted. |
|
| 271 | + */ |
|
| 272 | + protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) { |
|
| 273 | + if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) { |
|
| 274 | + $updated = delete_post_meta( $object->get_id(), $meta_key ); |
|
| 275 | + } else { |
|
| 276 | + $updated = update_post_meta( $object->get_id(), $meta_key, $meta_value ); |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + return (bool) $updated; |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + /** |
|
| 283 | + * Return list of internal meta keys. |
|
| 284 | + * |
|
| 285 | + * @since 1.0.19 |
|
| 286 | + * @return array |
|
| 287 | + */ |
|
| 288 | + public function get_internal_meta_keys() { |
|
| 289 | + return $this->internal_meta_keys; |
|
| 290 | + } |
|
| 291 | + |
|
| 292 | + /** |
|
| 293 | + * Clear any caches. |
|
| 294 | + * |
|
| 295 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 296 | + * @since 1.0.19 |
|
| 297 | + */ |
|
| 298 | + protected function clear_caches( &$object ) { |
|
| 299 | + clean_post_cache( $object->get_id() ); |
|
| 300 | + } |
|
| 301 | + |
|
| 302 | + /** |
|
| 303 | + * Method to delete a data object from the database. |
|
| 304 | + * |
|
| 305 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 306 | + * @param array $args Array of args to pass to the delete method. |
|
| 307 | + * |
|
| 308 | + * @return void |
|
| 309 | + */ |
|
| 310 | + public function delete( &$object, $args = array() ) { |
|
| 311 | + $id = $object->get_id(); |
|
| 312 | + $object_type = $object->get_object_type(); |
|
| 313 | + |
|
| 314 | + if ( 'invoice' == $object_type ) { |
|
| 315 | + $object_type = $object->get_type(); |
|
| 316 | + } |
|
| 317 | + |
|
| 318 | + $args = wp_parse_args( |
|
| 319 | + $args, |
|
| 320 | + array( |
|
| 321 | + 'force_delete' => false, |
|
| 322 | + ) |
|
| 323 | + ); |
|
| 324 | + |
|
| 325 | + if ( ! $id ) { |
|
| 326 | + return; |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + if ( $args['force_delete'] ) { |
|
| 330 | + do_action( "getpaid_delete_$object_type", $object ); |
|
| 331 | + wp_delete_post( $id, true ); |
|
| 332 | + $object->set_id( 0 ); |
|
| 333 | + } else { |
|
| 334 | + do_action( "getpaid_trash_$object_type", $object ); |
|
| 335 | + wp_trash_post( $id ); |
|
| 336 | + $object->set_status( 'trash' ); |
|
| 337 | + } |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /** |
|
| 341 | + * Get the status to save to the post object. |
|
| 342 | + * |
|
| 343 | + * |
|
| 344 | + * @since 1.0.19 |
|
| 345 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 346 | + * @return string |
|
| 347 | + */ |
|
| 348 | + protected function get_post_status( $object ) { |
|
| 349 | + $object_status = $object->get_status( 'edit' ); |
|
| 350 | + $object_type = $object->get_object_type(); |
|
| 351 | + |
|
| 352 | + if ( ! $object_status ) { |
|
| 353 | + $object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' ); |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + return $object_status; |
|
| 357 | + } |
|
| 358 | 358 | |
| 359 | 359 | } |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * @version 1.0.19 |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | -defined( 'ABSPATH' ) || exit; |
|
| 8 | +defined('ABSPATH') || exit; |
|
| 9 | 9 | |
| 10 | 10 | /** |
| 11 | 11 | * GetPaid_Data_Store_WP class. |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | * @param GetPaid_Data $object GetPaid_Data object. |
| 65 | 65 | * @return array |
| 66 | 66 | */ |
| 67 | - public function read_meta( &$object ) { |
|
| 67 | + public function read_meta(&$object) { |
|
| 68 | 68 | global $wpdb; |
| 69 | 69 | $db_info = $this->get_db_info(); |
| 70 | 70 | $raw_meta_data = $wpdb->get_results( |
@@ -77,9 +77,9 @@ discard block |
||
| 77 | 77 | ) |
| 78 | 78 | ); |
| 79 | 79 | |
| 80 | - $this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys ); |
|
| 81 | - $meta_data = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) ); |
|
| 82 | - return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this ); |
|
| 80 | + $this->internal_meta_keys = array_merge(array_map(array($this, 'prefix_key'), $object->get_data_keys()), $this->internal_meta_keys); |
|
| 81 | + $meta_data = array_filter($raw_meta_data, array($this, 'exclude_internal_meta_keys')); |
|
| 82 | + return apply_filters("getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this); |
|
| 83 | 83 | } |
| 84 | 84 | |
| 85 | 85 | /** |
@@ -89,8 +89,8 @@ discard block |
||
| 89 | 89 | * @param GetPaid_Data $object GetPaid_Data object. |
| 90 | 90 | * @param stdClass $meta (containing at least ->id). |
| 91 | 91 | */ |
| 92 | - public function delete_meta( &$object, $meta ) { |
|
| 93 | - delete_metadata_by_mid( $this->meta_type, $meta->id ); |
|
| 92 | + public function delete_meta(&$object, $meta) { |
|
| 93 | + delete_metadata_by_mid($this->meta_type, $meta->id); |
|
| 94 | 94 | } |
| 95 | 95 | |
| 96 | 96 | /** |
@@ -101,8 +101,8 @@ discard block |
||
| 101 | 101 | * @param stdClass $meta (containing ->key and ->value). |
| 102 | 102 | * @return int meta ID |
| 103 | 103 | */ |
| 104 | - public function add_meta( &$object, $meta ) { |
|
| 105 | - return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false ); |
|
| 104 | + public function add_meta(&$object, $meta) { |
|
| 105 | + return add_metadata($this->meta_type, $object->get_id(), $meta->key, is_string($meta->value) ? wp_slash($meta->value) : $meta->value, false); |
|
| 106 | 106 | } |
| 107 | 107 | |
| 108 | 108 | /** |
@@ -112,8 +112,8 @@ discard block |
||
| 112 | 112 | * @param GetPaid_Data $object GetPaid_Data object. |
| 113 | 113 | * @param stdClass $meta (containing ->id, ->key and ->value). |
| 114 | 114 | */ |
| 115 | - public function update_meta( &$object, $meta ) { |
|
| 116 | - update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key ); |
|
| 115 | + public function update_meta(&$object, $meta) { |
|
| 116 | + update_metadata_by_mid($this->meta_type, $meta->id, $meta->value, $meta->key); |
|
| 117 | 117 | } |
| 118 | 118 | |
| 119 | 119 | /** |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | $table = $wpdb->prefix; |
| 130 | 130 | |
| 131 | 131 | // If we are dealing with a type of metadata that is not a core type, the table should be prefixed. |
| 132 | - if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) { |
|
| 132 | + if (!in_array($this->meta_type, array('post', 'user', 'comment', 'term'), true)) { |
|
| 133 | 133 | $table .= 'getpaid_'; |
| 134 | 134 | } |
| 135 | 135 | |
@@ -137,12 +137,12 @@ discard block |
||
| 137 | 137 | $object_id_field = $this->meta_type . '_id'; |
| 138 | 138 | |
| 139 | 139 | // Figure out our field names. |
| 140 | - if ( 'user' === $this->meta_type ) { |
|
| 140 | + if ('user' === $this->meta_type) { |
|
| 141 | 141 | $meta_id_field = 'umeta_id'; |
| 142 | 142 | $table = $wpdb->usermeta; |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - if ( ! empty( $this->object_id_field_for_meta ) ) { |
|
| 145 | + if (!empty($this->object_id_field_for_meta)) { |
|
| 146 | 146 | $object_id_field = $this->object_id_field_for_meta; |
| 147 | 147 | } |
| 148 | 148 | |
@@ -162,8 +162,8 @@ discard block |
||
| 162 | 162 | * @param string $key Prefix to be added to meta keys. |
| 163 | 163 | * @return string |
| 164 | 164 | */ |
| 165 | - protected function prefix_key( $key ) { |
|
| 166 | - return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key; |
|
| 165 | + protected function prefix_key($key) { |
|
| 166 | + return '_' === substr($key, 0, 1) ? $key : '_' . $key; |
|
| 167 | 167 | } |
| 168 | 168 | |
| 169 | 169 | /** |
@@ -172,8 +172,8 @@ discard block |
||
| 172 | 172 | * @param object $meta Meta object to check if it should be excluded or not. |
| 173 | 173 | * @return bool |
| 174 | 174 | */ |
| 175 | - protected function exclude_internal_meta_keys( $meta ) { |
|
| 176 | - return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' ); |
|
| 175 | + protected function exclude_internal_meta_keys($meta) { |
|
| 176 | + return !in_array($meta->meta_key, $this->internal_meta_keys, true) && 0 !== stripos($meta->meta_key, 'wp_'); |
|
| 177 | 177 | } |
| 178 | 178 | |
| 179 | 179 | /** |
@@ -185,14 +185,14 @@ discard block |
||
| 185 | 185 | * @param string $meta_type The internal WP meta type (post, user, etc). |
| 186 | 186 | * @return array A mapping of meta keys => prop names, filtered by ones that should be updated. |
| 187 | 187 | */ |
| 188 | - protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) { |
|
| 188 | + protected function get_props_to_update($object, $meta_key_to_props, $meta_type = 'post') { |
|
| 189 | 189 | $props_to_update = array(); |
| 190 | 190 | $changed_props = $object->get_changes(); |
| 191 | 191 | |
| 192 | 192 | // Props should be updated if they are a part of the $changed array or don't exist yet. |
| 193 | - foreach ( $meta_key_to_props as $meta_key => $prop ) { |
|
| 194 | - if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) { |
|
| 195 | - $props_to_update[ $meta_key ] = $prop; |
|
| 193 | + foreach ($meta_key_to_props as $meta_key => $prop) { |
|
| 194 | + if (array_key_exists($prop, $changed_props) || !metadata_exists($meta_type, $object->get_id(), $meta_key)) { |
|
| 195 | + $props_to_update[$meta_key] = $prop; |
|
| 196 | 196 | } |
| 197 | 197 | } |
| 198 | 198 | |
@@ -206,22 +206,22 @@ discard block |
||
| 206 | 206 | * @param WP_Post $post_object Post object. |
| 207 | 207 | * @since 1.0.19 |
| 208 | 208 | */ |
| 209 | - protected function read_object_data( &$object, $post_object ) { |
|
| 209 | + protected function read_object_data(&$object, $post_object) { |
|
| 210 | 210 | $id = $object->get_id(); |
| 211 | 211 | $props = array(); |
| 212 | 212 | |
| 213 | - foreach ( $this->meta_key_to_props as $meta_key => $prop ) { |
|
| 214 | - $props[ $prop ] = get_post_meta( $id, $meta_key, true ); |
|
| 213 | + foreach ($this->meta_key_to_props as $meta_key => $prop) { |
|
| 214 | + $props[$prop] = get_post_meta($id, $meta_key, true); |
|
| 215 | 215 | } |
| 216 | 216 | |
| 217 | 217 | // Set object properties. |
| 218 | - $object->set_props( $props ); |
|
| 218 | + $object->set_props($props); |
|
| 219 | 219 | |
| 220 | 220 | // Gets extra data associated with the object if needed. |
| 221 | - foreach ( $object->get_extra_data_keys() as $key ) { |
|
| 221 | + foreach ($object->get_extra_data_keys() as $key) { |
|
| 222 | 222 | $function = 'set_' . $key; |
| 223 | - if ( is_callable( array( $object, $function ) ) ) { |
|
| 224 | - $object->{$function}( get_post_meta( $object->get_id(), $key, true ) ); |
|
| 223 | + if (is_callable(array($object, $function))) { |
|
| 224 | + $object->{$function}(get_post_meta($object->get_id(), $key, true)); |
|
| 225 | 225 | } |
| 226 | 226 | } |
| 227 | 227 | } |
@@ -232,24 +232,24 @@ discard block |
||
| 232 | 232 | * @param GetPaid_Data $object GetPaid_Data object. |
| 233 | 233 | * @since 1.0.19 |
| 234 | 234 | */ |
| 235 | - protected function update_post_meta( &$object ) { |
|
| 235 | + protected function update_post_meta(&$object) { |
|
| 236 | 236 | |
| 237 | 237 | $updated_props = array(); |
| 238 | - $props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props ); |
|
| 238 | + $props_to_update = $this->get_props_to_update($object, $this->meta_key_to_props); |
|
| 239 | 239 | $object_type = $object->get_object_type(); |
| 240 | 240 | |
| 241 | - foreach ( $props_to_update as $meta_key => $prop ) { |
|
| 242 | - $value = $object->{"get_$prop"}( 'edit' ); |
|
| 243 | - $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
| 241 | + foreach ($props_to_update as $meta_key => $prop) { |
|
| 242 | + $value = $object->{"get_$prop"}('edit'); |
|
| 243 | + $value = is_string($value) ? wp_slash($value) : $value; |
|
| 244 | 244 | |
| 245 | - $updated = $this->update_or_delete_post_meta( $object, $meta_key, $value ); |
|
| 245 | + $updated = $this->update_or_delete_post_meta($object, $meta_key, $value); |
|
| 246 | 246 | |
| 247 | - if ( $updated ) { |
|
| 247 | + if ($updated) { |
|
| 248 | 248 | $updated_props[] = $prop; |
| 249 | 249 | } |
| 250 | 250 | } |
| 251 | 251 | |
| 252 | - do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props ); |
|
| 252 | + do_action("getpaid_{$object_type}_object_updated_props", $object, $updated_props); |
|
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | /** |
@@ -269,11 +269,11 @@ discard block |
||
| 269 | 269 | * |
| 270 | 270 | * @return bool True if updated/deleted. |
| 271 | 271 | */ |
| 272 | - protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) { |
|
| 273 | - if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) { |
|
| 274 | - $updated = delete_post_meta( $object->get_id(), $meta_key ); |
|
| 272 | + protected function update_or_delete_post_meta($object, $meta_key, $meta_value) { |
|
| 273 | + if (in_array($meta_value, array(array(), '', null), true) && !in_array($meta_key, $this->must_exist_meta_keys, true)) { |
|
| 274 | + $updated = delete_post_meta($object->get_id(), $meta_key); |
|
| 275 | 275 | } else { |
| 276 | - $updated = update_post_meta( $object->get_id(), $meta_key, $meta_value ); |
|
| 276 | + $updated = update_post_meta($object->get_id(), $meta_key, $meta_value); |
|
| 277 | 277 | } |
| 278 | 278 | |
| 279 | 279 | return (bool) $updated; |
@@ -295,8 +295,8 @@ discard block |
||
| 295 | 295 | * @param GetPaid_Data $object GetPaid_Data object. |
| 296 | 296 | * @since 1.0.19 |
| 297 | 297 | */ |
| 298 | - protected function clear_caches( &$object ) { |
|
| 299 | - clean_post_cache( $object->get_id() ); |
|
| 298 | + protected function clear_caches(&$object) { |
|
| 299 | + clean_post_cache($object->get_id()); |
|
| 300 | 300 | } |
| 301 | 301 | |
| 302 | 302 | /** |
@@ -307,33 +307,33 @@ discard block |
||
| 307 | 307 | * |
| 308 | 308 | * @return void |
| 309 | 309 | */ |
| 310 | - public function delete( &$object, $args = array() ) { |
|
| 310 | + public function delete(&$object, $args = array()) { |
|
| 311 | 311 | $id = $object->get_id(); |
| 312 | 312 | $object_type = $object->get_object_type(); |
| 313 | 313 | |
| 314 | - if ( 'invoice' == $object_type ) { |
|
| 314 | + if ('invoice' == $object_type) { |
|
| 315 | 315 | $object_type = $object->get_type(); |
| 316 | 316 | } |
| 317 | 317 | |
| 318 | - $args = wp_parse_args( |
|
| 318 | + $args = wp_parse_args( |
|
| 319 | 319 | $args, |
| 320 | 320 | array( |
| 321 | 321 | 'force_delete' => false, |
| 322 | 322 | ) |
| 323 | 323 | ); |
| 324 | 324 | |
| 325 | - if ( ! $id ) { |
|
| 325 | + if (!$id) { |
|
| 326 | 326 | return; |
| 327 | 327 | } |
| 328 | 328 | |
| 329 | - if ( $args['force_delete'] ) { |
|
| 330 | - do_action( "getpaid_delete_$object_type", $object ); |
|
| 331 | - wp_delete_post( $id, true ); |
|
| 332 | - $object->set_id( 0 ); |
|
| 329 | + if ($args['force_delete']) { |
|
| 330 | + do_action("getpaid_delete_$object_type", $object); |
|
| 331 | + wp_delete_post($id, true); |
|
| 332 | + $object->set_id(0); |
|
| 333 | 333 | } else { |
| 334 | - do_action( "getpaid_trash_$object_type", $object ); |
|
| 335 | - wp_trash_post( $id ); |
|
| 336 | - $object->set_status( 'trash' ); |
|
| 334 | + do_action("getpaid_trash_$object_type", $object); |
|
| 335 | + wp_trash_post($id); |
|
| 336 | + $object->set_status('trash'); |
|
| 337 | 337 | } |
| 338 | 338 | } |
| 339 | 339 | |
@@ -345,12 +345,12 @@ discard block |
||
| 345 | 345 | * @param GetPaid_Data $object GetPaid_Data object. |
| 346 | 346 | * @return string |
| 347 | 347 | */ |
| 348 | - protected function get_post_status( $object ) { |
|
| 349 | - $object_status = $object->get_status( 'edit' ); |
|
| 348 | + protected function get_post_status($object) { |
|
| 349 | + $object_status = $object->get_status('edit'); |
|
| 350 | 350 | $object_type = $object->get_object_type(); |
| 351 | 351 | |
| 352 | - if ( ! $object_status ) { |
|
| 353 | - $object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' ); |
|
| 352 | + if (!$object_status) { |
|
| 353 | + $object_status = apply_filters("getpaid_default_{$object_type}_status", 'draft'); |
|
| 354 | 354 | } |
| 355 | 355 | |
| 356 | 356 | return $object_status; |
@@ -7,22 +7,22 @@ |
||
| 7 | 7 | * @version 1.0.19 |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -defined( 'ABSPATH' ) || exit; |
|
| 10 | +defined('ABSPATH') || exit; |
|
| 11 | 11 | |
| 12 | 12 | // Print the email header. |
| 13 | -do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin ); |
|
| 13 | +do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin); |
|
| 14 | 14 | |
| 15 | 15 | // Generate the custom message body. |
| 16 | 16 | echo $message_body; |
| 17 | 17 | |
| 18 | 18 | // Print invoice details. |
| 19 | -do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin ); |
|
| 19 | +do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin); |
|
| 20 | 20 | |
| 21 | 21 | // Print invoice items. |
| 22 | -do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin ); |
|
| 22 | +do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin); |
|
| 23 | 23 | |
| 24 | 24 | // Print the billing details. |
| 25 | -do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin ); |
|
| 25 | +do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin); |
|
| 26 | 26 | |
| 27 | 27 | // Print the email footer. |
| 28 | -do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin ); |
|
| 28 | +do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin); |
|