@@ -18,756 +18,756 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * An array of available settings. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $settings; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Route base. |
|
| 30 | - * |
|
| 31 | - * @var string |
|
| 32 | - */ |
|
| 33 | - protected $rest_base = 'settings'; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Registers the routes for the objects of the controller. |
|
| 37 | - * |
|
| 38 | - * @since 2.0.0 |
|
| 39 | - * |
|
| 40 | - * @see register_rest_route() |
|
| 41 | - */ |
|
| 42 | - public function register_namespace_routes( $namespace ) { |
|
| 43 | - |
|
| 44 | - // List all registered tabs. |
|
| 45 | - register_rest_route( |
|
| 46 | - $namespace, |
|
| 47 | - $this->rest_base, |
|
| 48 | - array( |
|
| 49 | - array( |
|
| 50 | - 'methods' => WP_REST_Server::READABLE, |
|
| 51 | - 'callback' => array( $this, 'get_tabs' ), |
|
| 52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 53 | - ), |
|
| 54 | - 'schema' => '__return_empty_array', |
|
| 55 | - ) |
|
| 56 | - ); |
|
| 57 | - |
|
| 58 | - // View/Update a single setting. |
|
| 59 | - register_rest_route( |
|
| 60 | - $namespace, |
|
| 61 | - $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
| 62 | - array( |
|
| 63 | - 'args' => array( |
|
| 64 | - 'id' => array( |
|
| 65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
| 66 | - 'type' => 'string', |
|
| 67 | - 'required' => true, |
|
| 68 | - ), |
|
| 69 | - ), |
|
| 70 | - array( |
|
| 71 | - 'methods' => WP_REST_Server::READABLE, |
|
| 72 | - 'callback' => array( $this, 'get_item' ), |
|
| 73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 74 | - ), |
|
| 75 | - array( |
|
| 76 | - 'methods' => WP_REST_Server::EDITABLE, |
|
| 77 | - 'callback' => array( $this, 'update_item' ), |
|
| 78 | - 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
| 79 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 80 | - ), |
|
| 81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 82 | - ) |
|
| 83 | - ); |
|
| 84 | - |
|
| 85 | - // List registered sections for a given tab. |
|
| 86 | - register_rest_route( |
|
| 87 | - $namespace, |
|
| 88 | - $this->rest_base . '/(?P<tab>[\w-]+)', |
|
| 89 | - array( |
|
| 90 | - 'args' => array( |
|
| 91 | - 'tab' => array( |
|
| 92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
| 93 | - 'type' => 'string', |
|
| 94 | - 'required' => true, |
|
| 95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 96 | - ), |
|
| 97 | - ), |
|
| 98 | - array( |
|
| 99 | - 'methods' => WP_REST_Server::READABLE, |
|
| 100 | - 'callback' => array( $this, 'get_sections' ), |
|
| 101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 102 | - ), |
|
| 103 | - 'schema' => '__return_empty_array', |
|
| 104 | - ) |
|
| 105 | - ); |
|
| 106 | - |
|
| 107 | - // List all registered settings for a given tab. |
|
| 108 | - register_rest_route( |
|
| 109 | - $namespace, |
|
| 110 | - $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
| 111 | - array( |
|
| 112 | - 'args' => array( |
|
| 113 | - 'tab' => array( |
|
| 114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 115 | - 'type' => 'string', |
|
| 116 | - 'required' => true, |
|
| 117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 118 | - ), |
|
| 119 | - 'section' => array( |
|
| 120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 121 | - 'type' => 'string', |
|
| 122 | - 'required' => true, |
|
| 123 | - ), |
|
| 124 | - ), |
|
| 125 | - array( |
|
| 126 | - 'methods' => WP_REST_Server::READABLE, |
|
| 127 | - 'callback' => array( $this, 'get_items' ), |
|
| 128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 129 | - ), |
|
| 130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 131 | - ) |
|
| 132 | - ); |
|
| 133 | - |
|
| 134 | - register_rest_route( |
|
| 135 | - $namespace, |
|
| 136 | - '/' . $this->rest_base . '/batch', |
|
| 137 | - array( |
|
| 138 | - 'args' => array( |
|
| 139 | - 'id' => array( |
|
| 140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
| 141 | - 'type' => 'string', |
|
| 142 | - ), |
|
| 143 | - ), |
|
| 144 | - array( |
|
| 145 | - 'methods' => WP_REST_Server::EDITABLE, |
|
| 146 | - 'callback' => array( $this, 'batch_items' ), |
|
| 147 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 148 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 149 | - ), |
|
| 150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 151 | - ) |
|
| 152 | - ); |
|
| 153 | - |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Return all settings. |
|
| 158 | - * |
|
| 159 | - * @since 2.0.0 |
|
| 160 | - * @param WP_REST_Request $request Request data. |
|
| 161 | - * @return WP_Error|WP_REST_Response |
|
| 162 | - */ |
|
| 163 | - public function get_items( $request ) { |
|
| 164 | - |
|
| 165 | - $settings = $this->get_settings(); |
|
| 166 | - |
|
| 167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
| 168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
| 172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
| 176 | - $prepared = array(); |
|
| 177 | - |
|
| 178 | - foreach ( $settings as $setting ) { |
|
| 179 | - |
|
| 180 | - $setting = $this->sanitize_setting( $setting ); |
|
| 181 | - $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
| 182 | - $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
| 183 | - |
|
| 184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
| 185 | - $prepared[] = $setting_data; |
|
| 186 | - } |
|
| 21 | + /** |
|
| 22 | + * An array of available settings. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $settings; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Route base. |
|
| 30 | + * |
|
| 31 | + * @var string |
|
| 32 | + */ |
|
| 33 | + protected $rest_base = 'settings'; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Registers the routes for the objects of the controller. |
|
| 37 | + * |
|
| 38 | + * @since 2.0.0 |
|
| 39 | + * |
|
| 40 | + * @see register_rest_route() |
|
| 41 | + */ |
|
| 42 | + public function register_namespace_routes( $namespace ) { |
|
| 43 | + |
|
| 44 | + // List all registered tabs. |
|
| 45 | + register_rest_route( |
|
| 46 | + $namespace, |
|
| 47 | + $this->rest_base, |
|
| 48 | + array( |
|
| 49 | + array( |
|
| 50 | + 'methods' => WP_REST_Server::READABLE, |
|
| 51 | + 'callback' => array( $this, 'get_tabs' ), |
|
| 52 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 53 | + ), |
|
| 54 | + 'schema' => '__return_empty_array', |
|
| 55 | + ) |
|
| 56 | + ); |
|
| 57 | + |
|
| 58 | + // View/Update a single setting. |
|
| 59 | + register_rest_route( |
|
| 60 | + $namespace, |
|
| 61 | + $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
| 62 | + array( |
|
| 63 | + 'args' => array( |
|
| 64 | + 'id' => array( |
|
| 65 | + 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
| 66 | + 'type' => 'string', |
|
| 67 | + 'required' => true, |
|
| 68 | + ), |
|
| 69 | + ), |
|
| 70 | + array( |
|
| 71 | + 'methods' => WP_REST_Server::READABLE, |
|
| 72 | + 'callback' => array( $this, 'get_item' ), |
|
| 73 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 74 | + ), |
|
| 75 | + array( |
|
| 76 | + 'methods' => WP_REST_Server::EDITABLE, |
|
| 77 | + 'callback' => array( $this, 'update_item' ), |
|
| 78 | + 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
| 79 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 80 | + ), |
|
| 81 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 82 | + ) |
|
| 83 | + ); |
|
| 84 | + |
|
| 85 | + // List registered sections for a given tab. |
|
| 86 | + register_rest_route( |
|
| 87 | + $namespace, |
|
| 88 | + $this->rest_base . '/(?P<tab>[\w-]+)', |
|
| 89 | + array( |
|
| 90 | + 'args' => array( |
|
| 91 | + 'tab' => array( |
|
| 92 | + 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
| 93 | + 'type' => 'string', |
|
| 94 | + 'required' => true, |
|
| 95 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 96 | + ), |
|
| 97 | + ), |
|
| 98 | + array( |
|
| 99 | + 'methods' => WP_REST_Server::READABLE, |
|
| 100 | + 'callback' => array( $this, 'get_sections' ), |
|
| 101 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 102 | + ), |
|
| 103 | + 'schema' => '__return_empty_array', |
|
| 104 | + ) |
|
| 105 | + ); |
|
| 106 | + |
|
| 107 | + // List all registered settings for a given tab. |
|
| 108 | + register_rest_route( |
|
| 109 | + $namespace, |
|
| 110 | + $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
| 111 | + array( |
|
| 112 | + 'args' => array( |
|
| 113 | + 'tab' => array( |
|
| 114 | + 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 115 | + 'type' => 'string', |
|
| 116 | + 'required' => true, |
|
| 117 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 118 | + ), |
|
| 119 | + 'section' => array( |
|
| 120 | + 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 121 | + 'type' => 'string', |
|
| 122 | + 'required' => true, |
|
| 123 | + ), |
|
| 124 | + ), |
|
| 125 | + array( |
|
| 126 | + 'methods' => WP_REST_Server::READABLE, |
|
| 127 | + 'callback' => array( $this, 'get_items' ), |
|
| 128 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 129 | + ), |
|
| 130 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 131 | + ) |
|
| 132 | + ); |
|
| 133 | + |
|
| 134 | + register_rest_route( |
|
| 135 | + $namespace, |
|
| 136 | + '/' . $this->rest_base . '/batch', |
|
| 137 | + array( |
|
| 138 | + 'args' => array( |
|
| 139 | + 'id' => array( |
|
| 140 | + 'description' => __( 'Setting ID.', 'invoicing' ), |
|
| 141 | + 'type' => 'string', |
|
| 142 | + ), |
|
| 143 | + ), |
|
| 144 | + array( |
|
| 145 | + 'methods' => WP_REST_Server::EDITABLE, |
|
| 146 | + 'callback' => array( $this, 'batch_items' ), |
|
| 147 | + 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 148 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 149 | + ), |
|
| 150 | + 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 151 | + ) |
|
| 152 | + ); |
|
| 153 | + |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Return all settings. |
|
| 158 | + * |
|
| 159 | + * @since 2.0.0 |
|
| 160 | + * @param WP_REST_Request $request Request data. |
|
| 161 | + * @return WP_Error|WP_REST_Response |
|
| 162 | + */ |
|
| 163 | + public function get_items( $request ) { |
|
| 164 | + |
|
| 165 | + $settings = $this->get_settings(); |
|
| 166 | + |
|
| 167 | + if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
| 168 | + return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
| 172 | + return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
| 176 | + $prepared = array(); |
|
| 177 | + |
|
| 178 | + foreach ( $settings as $setting ) { |
|
| 179 | + |
|
| 180 | + $setting = $this->sanitize_setting( $setting ); |
|
| 181 | + $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
| 182 | + $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
| 183 | + |
|
| 184 | + if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
| 185 | + $prepared[] = $setting_data; |
|
| 186 | + } |
|
| 187 | 187 | } |
| 188 | 188 | |
| 189 | - return rest_ensure_response( $prepared ); |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Return a single setting. |
|
| 194 | - * |
|
| 195 | - * @since 2.0.0 |
|
| 196 | - * @param WP_REST_Request $request Request data. |
|
| 197 | - * @return WP_Error|WP_REST_Response |
|
| 198 | - */ |
|
| 199 | - public function get_item( $request ) { |
|
| 200 | - $setting = $this->get_setting( $request['id'] ); |
|
| 201 | - |
|
| 202 | - if ( is_wp_error( $setting ) ) { |
|
| 203 | - return $setting; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - $setting = $this->sanitize_setting( $setting ); |
|
| 207 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 208 | - return rest_ensure_response( $response ); |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * Update a single setting. |
|
| 213 | - * |
|
| 214 | - * @since 2.0.0 |
|
| 215 | - * @param WP_REST_Request $request Request data. |
|
| 216 | - * @return WP_Error|WP_REST_Response |
|
| 217 | - */ |
|
| 218 | - public function update_item( $request ) { |
|
| 219 | - $setting = $this->get_setting( $request['id'] ); |
|
| 220 | - |
|
| 221 | - if ( is_wp_error( $setting ) ) { |
|
| 222 | - return $setting; |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 226 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 227 | - } else { |
|
| 228 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - if ( is_wp_error( $value ) ) { |
|
| 232 | - return $value; |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - wpinv_update_option( $request['id'], $value ); |
|
| 236 | - $setting['value'] = $value; |
|
| 237 | - $setting = $this->sanitize_setting( $setting ); |
|
| 238 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 239 | - |
|
| 240 | - return rest_ensure_response( $response ); |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Makes sure the current user has access to READ the settings APIs. |
|
| 245 | - * |
|
| 246 | - * @since 2.0.0 |
|
| 247 | - * @param WP_REST_Request $request Full data about the request. |
|
| 248 | - * @return WP_Error|boolean |
|
| 249 | - */ |
|
| 250 | - public function get_items_permissions_check( $request ) { |
|
| 251 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 252 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - return true; |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * Makes sure the current user has access to WRITE the settings APIs. |
|
| 260 | - * |
|
| 261 | - * @since 2.0.0 |
|
| 262 | - * @param WP_REST_Request $request Full data about the request. |
|
| 263 | - * @return WP_Error|boolean |
|
| 264 | - */ |
|
| 265 | - public function update_items_permissions_check( $request ) { |
|
| 266 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 267 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - return true; |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - /** |
|
| 274 | - * Check if a given request has access batch create, update and delete items. |
|
| 275 | - * |
|
| 276 | - * @param WP_REST_Request $request Full details about the request. |
|
| 277 | - * |
|
| 278 | - * @return boolean|WP_Error |
|
| 279 | - */ |
|
| 280 | - public function batch_items_permissions_check( $request ) { |
|
| 281 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 282 | - } |
|
| 283 | - |
|
| 284 | - /** |
|
| 285 | - * Prepare links for the request. |
|
| 286 | - * |
|
| 287 | - * @param string $setting_id Setting ID. |
|
| 288 | - * @return array Links for the given setting. |
|
| 289 | - */ |
|
| 290 | - protected function prepare_links( $setting_id ) { |
|
| 291 | - |
|
| 292 | - $links = array( |
|
| 293 | - 'self' => array( |
|
| 294 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 295 | - ), |
|
| 296 | - 'collection' => array( |
|
| 297 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 298 | - ), |
|
| 299 | - ); |
|
| 300 | - |
|
| 301 | - return $links; |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - /** |
|
| 305 | - * Prepare a settings object for serialization. |
|
| 306 | - * |
|
| 307 | - * @since 2.0.0 |
|
| 308 | - * @param array $item Setting object. |
|
| 309 | - * @param WP_REST_Request $request Request object. |
|
| 310 | - * @return WP_REST_Response $response Response data. |
|
| 311 | - */ |
|
| 312 | - public function prepare_item_for_response( $item, $request ) { |
|
| 313 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 314 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 315 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 316 | - |
|
| 317 | - $response = rest_ensure_response( $data ); |
|
| 318 | - |
|
| 319 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 320 | - |
|
| 321 | - return $response; |
|
| 322 | - } |
|
| 323 | - |
|
| 324 | - /** |
|
| 325 | - * Filters out bad values from the settings array/filter so we |
|
| 326 | - * only return known values via the API. |
|
| 327 | - * |
|
| 328 | - * @since 2.0.0 |
|
| 329 | - * @param array $setting Setting. |
|
| 330 | - * @return array |
|
| 331 | - */ |
|
| 332 | - public function filter_setting( $setting ) { |
|
| 333 | - return array_intersect_key( |
|
| 334 | - $setting, |
|
| 335 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 336 | - ); |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - /** |
|
| 340 | - * Callback for allowed keys for each setting response. |
|
| 341 | - * |
|
| 342 | - * @param string $key Key to check. |
|
| 343 | - * @return boolean |
|
| 344 | - */ |
|
| 345 | - public function allowed_setting_keys( $key ) { |
|
| 346 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 347 | - } |
|
| 348 | - |
|
| 349 | - /** |
|
| 350 | - * Returns default options for a setting. null means the field is required. |
|
| 351 | - * |
|
| 352 | - * @since 2.0.0 |
|
| 353 | - * @return array |
|
| 354 | - */ |
|
| 355 | - protected function setting_defaults() { |
|
| 356 | - return array( |
|
| 357 | - 'id' => null, |
|
| 358 | - 'name' => null, |
|
| 359 | - 'desc' => '', |
|
| 360 | - 'options' => array(), |
|
| 361 | - 'std' => false, |
|
| 362 | - 'value' => false, |
|
| 363 | - 'placeholder' => '', |
|
| 364 | - 'readonly' => false, |
|
| 365 | - 'faux' => false, |
|
| 366 | - 'section' => 'main', |
|
| 367 | - 'tab' => 'general', |
|
| 368 | - 'type' => 'text', |
|
| 369 | - ); |
|
| 370 | - } |
|
| 371 | - |
|
| 372 | - /** |
|
| 373 | - * Sanitizes a setting's field. |
|
| 374 | - * |
|
| 375 | - * @param array $setting The setting to sanitize. |
|
| 376 | - * @return array |
|
| 377 | - */ |
|
| 378 | - public function sanitize_setting( $setting ) { |
|
| 379 | - |
|
| 380 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 381 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 382 | - return $this->filter_setting( $setting ); |
|
| 383 | - |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - /** |
|
| 387 | - * Get setting data. |
|
| 388 | - * |
|
| 389 | - * @since 2.0.0 |
|
| 390 | - * @param string $setting_id Setting ID. |
|
| 391 | - * @return array|WP_Error |
|
| 392 | - */ |
|
| 393 | - public function get_setting( $setting_id ) { |
|
| 394 | - |
|
| 395 | - if ( empty( $setting_id ) ) { |
|
| 396 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - $settings = $this->get_settings(); |
|
| 400 | - |
|
| 401 | - foreach ( $settings as $tabs ) { |
|
| 402 | - |
|
| 403 | - foreach ( $tabs as $sections ) { |
|
| 404 | - |
|
| 405 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
| 406 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 407 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - return $sections[ $setting_id ]; |
|
| 411 | - } |
|
| 189 | + return rest_ensure_response( $prepared ); |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Return a single setting. |
|
| 194 | + * |
|
| 195 | + * @since 2.0.0 |
|
| 196 | + * @param WP_REST_Request $request Request data. |
|
| 197 | + * @return WP_Error|WP_REST_Response |
|
| 198 | + */ |
|
| 199 | + public function get_item( $request ) { |
|
| 200 | + $setting = $this->get_setting( $request['id'] ); |
|
| 201 | + |
|
| 202 | + if ( is_wp_error( $setting ) ) { |
|
| 203 | + return $setting; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + $setting = $this->sanitize_setting( $setting ); |
|
| 207 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 208 | + return rest_ensure_response( $response ); |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * Update a single setting. |
|
| 213 | + * |
|
| 214 | + * @since 2.0.0 |
|
| 215 | + * @param WP_REST_Request $request Request data. |
|
| 216 | + * @return WP_Error|WP_REST_Response |
|
| 217 | + */ |
|
| 218 | + public function update_item( $request ) { |
|
| 219 | + $setting = $this->get_setting( $request['id'] ); |
|
| 220 | + |
|
| 221 | + if ( is_wp_error( $setting ) ) { |
|
| 222 | + return $setting; |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 226 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 227 | + } else { |
|
| 228 | + $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + if ( is_wp_error( $value ) ) { |
|
| 232 | + return $value; |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + wpinv_update_option( $request['id'], $value ); |
|
| 236 | + $setting['value'] = $value; |
|
| 237 | + $setting = $this->sanitize_setting( $setting ); |
|
| 238 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 239 | + |
|
| 240 | + return rest_ensure_response( $response ); |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Makes sure the current user has access to READ the settings APIs. |
|
| 245 | + * |
|
| 246 | + * @since 2.0.0 |
|
| 247 | + * @param WP_REST_Request $request Full data about the request. |
|
| 248 | + * @return WP_Error|boolean |
|
| 249 | + */ |
|
| 250 | + public function get_items_permissions_check( $request ) { |
|
| 251 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 252 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + return true; |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * Makes sure the current user has access to WRITE the settings APIs. |
|
| 260 | + * |
|
| 261 | + * @since 2.0.0 |
|
| 262 | + * @param WP_REST_Request $request Full data about the request. |
|
| 263 | + * @return WP_Error|boolean |
|
| 264 | + */ |
|
| 265 | + public function update_items_permissions_check( $request ) { |
|
| 266 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 267 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + return true; |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + /** |
|
| 274 | + * Check if a given request has access batch create, update and delete items. |
|
| 275 | + * |
|
| 276 | + * @param WP_REST_Request $request Full details about the request. |
|
| 277 | + * |
|
| 278 | + * @return boolean|WP_Error |
|
| 279 | + */ |
|
| 280 | + public function batch_items_permissions_check( $request ) { |
|
| 281 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 282 | + } |
|
| 283 | + |
|
| 284 | + /** |
|
| 285 | + * Prepare links for the request. |
|
| 286 | + * |
|
| 287 | + * @param string $setting_id Setting ID. |
|
| 288 | + * @return array Links for the given setting. |
|
| 289 | + */ |
|
| 290 | + protected function prepare_links( $setting_id ) { |
|
| 291 | + |
|
| 292 | + $links = array( |
|
| 293 | + 'self' => array( |
|
| 294 | + 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 295 | + ), |
|
| 296 | + 'collection' => array( |
|
| 297 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 298 | + ), |
|
| 299 | + ); |
|
| 300 | + |
|
| 301 | + return $links; |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + /** |
|
| 305 | + * Prepare a settings object for serialization. |
|
| 306 | + * |
|
| 307 | + * @since 2.0.0 |
|
| 308 | + * @param array $item Setting object. |
|
| 309 | + * @param WP_REST_Request $request Request object. |
|
| 310 | + * @return WP_REST_Response $response Response data. |
|
| 311 | + */ |
|
| 312 | + public function prepare_item_for_response( $item, $request ) { |
|
| 313 | + $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 314 | + $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 315 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 316 | + |
|
| 317 | + $response = rest_ensure_response( $data ); |
|
| 318 | + |
|
| 319 | + $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 320 | + |
|
| 321 | + return $response; |
|
| 322 | + } |
|
| 323 | + |
|
| 324 | + /** |
|
| 325 | + * Filters out bad values from the settings array/filter so we |
|
| 326 | + * only return known values via the API. |
|
| 327 | + * |
|
| 328 | + * @since 2.0.0 |
|
| 329 | + * @param array $setting Setting. |
|
| 330 | + * @return array |
|
| 331 | + */ |
|
| 332 | + public function filter_setting( $setting ) { |
|
| 333 | + return array_intersect_key( |
|
| 334 | + $setting, |
|
| 335 | + array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 336 | + ); |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + /** |
|
| 340 | + * Callback for allowed keys for each setting response. |
|
| 341 | + * |
|
| 342 | + * @param string $key Key to check. |
|
| 343 | + * @return boolean |
|
| 344 | + */ |
|
| 345 | + public function allowed_setting_keys( $key ) { |
|
| 346 | + return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 347 | + } |
|
| 348 | + |
|
| 349 | + /** |
|
| 350 | + * Returns default options for a setting. null means the field is required. |
|
| 351 | + * |
|
| 352 | + * @since 2.0.0 |
|
| 353 | + * @return array |
|
| 354 | + */ |
|
| 355 | + protected function setting_defaults() { |
|
| 356 | + return array( |
|
| 357 | + 'id' => null, |
|
| 358 | + 'name' => null, |
|
| 359 | + 'desc' => '', |
|
| 360 | + 'options' => array(), |
|
| 361 | + 'std' => false, |
|
| 362 | + 'value' => false, |
|
| 363 | + 'placeholder' => '', |
|
| 364 | + 'readonly' => false, |
|
| 365 | + 'faux' => false, |
|
| 366 | + 'section' => 'main', |
|
| 367 | + 'tab' => 'general', |
|
| 368 | + 'type' => 'text', |
|
| 369 | + ); |
|
| 370 | + } |
|
| 371 | + |
|
| 372 | + /** |
|
| 373 | + * Sanitizes a setting's field. |
|
| 374 | + * |
|
| 375 | + * @param array $setting The setting to sanitize. |
|
| 376 | + * @return array |
|
| 377 | + */ |
|
| 378 | + public function sanitize_setting( $setting ) { |
|
| 379 | + |
|
| 380 | + $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 381 | + $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 382 | + return $this->filter_setting( $setting ); |
|
| 383 | + |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + /** |
|
| 387 | + * Get setting data. |
|
| 388 | + * |
|
| 389 | + * @since 2.0.0 |
|
| 390 | + * @param string $setting_id Setting ID. |
|
| 391 | + * @return array|WP_Error |
|
| 392 | + */ |
|
| 393 | + public function get_setting( $setting_id ) { |
|
| 394 | + |
|
| 395 | + if ( empty( $setting_id ) ) { |
|
| 396 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + $settings = $this->get_settings(); |
|
| 400 | + |
|
| 401 | + foreach ( $settings as $tabs ) { |
|
| 402 | + |
|
| 403 | + foreach ( $tabs as $sections ) { |
|
| 404 | + |
|
| 405 | + if ( isset( $sections[ $setting_id ] ) ) { |
|
| 406 | + if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 407 | + return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + return $sections[ $setting_id ]; |
|
| 411 | + } |
|
| 412 | 412 | } |
| 413 | 413 | } |
| 414 | 414 | |
| 415 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - /** |
|
| 419 | - * Get all tabs. |
|
| 420 | - * |
|
| 421 | - * @param WP_REST_Request $request Request data. |
|
| 422 | - * @return array |
|
| 423 | - */ |
|
| 424 | - public function get_tabs( $request ) { |
|
| 425 | - $tabs = wpinv_get_settings_tabs(); |
|
| 426 | - $prepared = array(); |
|
| 427 | - |
|
| 428 | - foreach ( $tabs as $id => $tab ) { |
|
| 429 | - |
|
| 430 | - $_request = $request; |
|
| 431 | - $_request['tab'] = sanitize_title( $id ); |
|
| 432 | - $data = array( |
|
| 433 | - 'id' => sanitize_title( $id ), |
|
| 434 | - 'label' => sanitize_text_field( $tab ), |
|
| 435 | - 'sections' => $this->get_sections( $_request ), |
|
| 436 | - ); |
|
| 437 | - |
|
| 438 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 439 | - $response = rest_ensure_response( $data ); |
|
| 440 | - |
|
| 441 | - if ( ! is_wp_error( $response ) ) { |
|
| 442 | - $links = array( |
|
| 443 | - 'sections' => array( |
|
| 444 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 445 | - ), |
|
| 446 | - 'collection' => array( |
|
| 447 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 448 | - ), |
|
| 449 | - ); |
|
| 450 | - $response->add_links( $links ); |
|
| 451 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 452 | - } |
|
| 453 | - |
|
| 454 | - $prepared[] = $response; |
|
| 455 | - |
|
| 456 | - } |
|
| 457 | - |
|
| 458 | - return rest_ensure_response( $prepared ); |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - /** |
|
| 462 | - * Get all sections. |
|
| 463 | - * |
|
| 464 | - * @param WP_REST_Request $request Request data. |
|
| 465 | - * @return array |
|
| 466 | - */ |
|
| 467 | - public function get_sections( $request ) { |
|
| 468 | - |
|
| 469 | - $tab = sanitize_title( $request['tab'] ); |
|
| 470 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 471 | - $prepared = array(); |
|
| 472 | - |
|
| 473 | - foreach ( $sections as $id => $section ) { |
|
| 474 | - |
|
| 475 | - $data = array( |
|
| 476 | - 'id' => sanitize_title( $id ), |
|
| 477 | - 'label' => sanitize_text_field( $section ), |
|
| 478 | - ); |
|
| 479 | - |
|
| 480 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 481 | - $response = rest_ensure_response( $data ); |
|
| 482 | - |
|
| 483 | - if ( ! is_wp_error( $response ) ) { |
|
| 484 | - $links = array( |
|
| 485 | - 'settings' => array( |
|
| 486 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 487 | - ), |
|
| 488 | - 'collection' => array( |
|
| 489 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 490 | - ), |
|
| 491 | - 'tabs' => array( |
|
| 492 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 493 | - ), |
|
| 494 | - ); |
|
| 495 | - $response->add_links( $links ); |
|
| 496 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 497 | - } |
|
| 498 | - |
|
| 499 | - $prepared[] = $response; |
|
| 500 | - |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - return rest_ensure_response( $prepared ); |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - /** |
|
| 507 | - * Get all settings. |
|
| 508 | - * |
|
| 509 | - * @return array |
|
| 510 | - */ |
|
| 511 | - public function get_settings() { |
|
| 512 | - |
|
| 513 | - if ( empty( $this->settings ) ) { |
|
| 514 | - $this->settings = wpinv_get_registered_settings(); |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - return $this->settings; |
|
| 518 | - |
|
| 519 | - } |
|
| 520 | - |
|
| 521 | - /** |
|
| 522 | - * Boolean for if a setting type is a valid supported setting type. |
|
| 523 | - * |
|
| 524 | - * @since 2.0.0 |
|
| 525 | - * @param string $type Type. |
|
| 526 | - * @return bool |
|
| 527 | - */ |
|
| 528 | - public function is_setting_type_valid( $type ) { |
|
| 529 | - |
|
| 530 | - return in_array( |
|
| 531 | - $type, |
|
| 415 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + /** |
|
| 419 | + * Get all tabs. |
|
| 420 | + * |
|
| 421 | + * @param WP_REST_Request $request Request data. |
|
| 422 | + * @return array |
|
| 423 | + */ |
|
| 424 | + public function get_tabs( $request ) { |
|
| 425 | + $tabs = wpinv_get_settings_tabs(); |
|
| 426 | + $prepared = array(); |
|
| 427 | + |
|
| 428 | + foreach ( $tabs as $id => $tab ) { |
|
| 429 | + |
|
| 430 | + $_request = $request; |
|
| 431 | + $_request['tab'] = sanitize_title( $id ); |
|
| 432 | + $data = array( |
|
| 433 | + 'id' => sanitize_title( $id ), |
|
| 434 | + 'label' => sanitize_text_field( $tab ), |
|
| 435 | + 'sections' => $this->get_sections( $_request ), |
|
| 436 | + ); |
|
| 437 | + |
|
| 438 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 439 | + $response = rest_ensure_response( $data ); |
|
| 440 | + |
|
| 441 | + if ( ! is_wp_error( $response ) ) { |
|
| 442 | + $links = array( |
|
| 443 | + 'sections' => array( |
|
| 444 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 445 | + ), |
|
| 446 | + 'collection' => array( |
|
| 447 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 448 | + ), |
|
| 449 | + ); |
|
| 450 | + $response->add_links( $links ); |
|
| 451 | + $response = $this->prepare_response_for_collection( $response ); |
|
| 452 | + } |
|
| 453 | + |
|
| 454 | + $prepared[] = $response; |
|
| 455 | + |
|
| 456 | + } |
|
| 457 | + |
|
| 458 | + return rest_ensure_response( $prepared ); |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + /** |
|
| 462 | + * Get all sections. |
|
| 463 | + * |
|
| 464 | + * @param WP_REST_Request $request Request data. |
|
| 465 | + * @return array |
|
| 466 | + */ |
|
| 467 | + public function get_sections( $request ) { |
|
| 468 | + |
|
| 469 | + $tab = sanitize_title( $request['tab'] ); |
|
| 470 | + $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 471 | + $prepared = array(); |
|
| 472 | + |
|
| 473 | + foreach ( $sections as $id => $section ) { |
|
| 474 | + |
|
| 475 | + $data = array( |
|
| 476 | + 'id' => sanitize_title( $id ), |
|
| 477 | + 'label' => sanitize_text_field( $section ), |
|
| 478 | + ); |
|
| 479 | + |
|
| 480 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 481 | + $response = rest_ensure_response( $data ); |
|
| 482 | + |
|
| 483 | + if ( ! is_wp_error( $response ) ) { |
|
| 484 | + $links = array( |
|
| 485 | + 'settings' => array( |
|
| 486 | + 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 487 | + ), |
|
| 488 | + 'collection' => array( |
|
| 489 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 490 | + ), |
|
| 491 | + 'tabs' => array( |
|
| 492 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 493 | + ), |
|
| 494 | + ); |
|
| 495 | + $response->add_links( $links ); |
|
| 496 | + $response = $this->prepare_response_for_collection( $response ); |
|
| 497 | + } |
|
| 498 | + |
|
| 499 | + $prepared[] = $response; |
|
| 500 | + |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + return rest_ensure_response( $prepared ); |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + /** |
|
| 507 | + * Get all settings. |
|
| 508 | + * |
|
| 509 | + * @return array |
|
| 510 | + */ |
|
| 511 | + public function get_settings() { |
|
| 512 | + |
|
| 513 | + if ( empty( $this->settings ) ) { |
|
| 514 | + $this->settings = wpinv_get_registered_settings(); |
|
| 515 | + } |
|
| 516 | + |
|
| 517 | + return $this->settings; |
|
| 518 | + |
|
| 519 | + } |
|
| 520 | + |
|
| 521 | + /** |
|
| 522 | + * Boolean for if a setting type is a valid supported setting type. |
|
| 523 | + * |
|
| 524 | + * @since 2.0.0 |
|
| 525 | + * @param string $type Type. |
|
| 526 | + * @return bool |
|
| 527 | + */ |
|
| 528 | + public function is_setting_type_valid( $type ) { |
|
| 529 | + |
|
| 530 | + return in_array( |
|
| 531 | + $type, |
|
| 532 | 532 | array( |
| 533 | - 'text', // Validates with validate_setting_text_field. |
|
| 534 | - 'email', // Validates with validate_setting_text_field. |
|
| 535 | - 'number', // Validates with validate_setting_text_field. |
|
| 536 | - 'color', // Validates with validate_setting_text_field. |
|
| 537 | - 'password', // Validates with validate_setting_text_field. |
|
| 538 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
| 539 | - 'select', // Validates with validate_setting_select_field. |
|
| 540 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 541 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 542 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 543 | - 'header', // Validates with validate_setting_text_field. |
|
| 544 | - ) |
|
| 545 | - ); |
|
| 546 | - |
|
| 547 | - } |
|
| 548 | - |
|
| 549 | - /** |
|
| 550 | - * Get the settings schema, conforming to JSON Schema. |
|
| 551 | - * |
|
| 552 | - * @return array |
|
| 553 | - */ |
|
| 554 | - public function get_item_schema() { |
|
| 555 | - |
|
| 556 | - // Maybe retrieve the schema from cache. |
|
| 557 | - if ( ! empty( $this->schema ) ) { |
|
| 558 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - $schema = array( |
|
| 562 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 563 | - 'title' => 'setting', |
|
| 564 | - 'type' => 'object', |
|
| 565 | - 'properties' => array( |
|
| 566 | - 'id' => array( |
|
| 567 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 568 | - 'type' => 'string', |
|
| 569 | - 'arg_options' => array( |
|
| 570 | - 'sanitize_callback' => 'sanitize_title', |
|
| 571 | - ), |
|
| 572 | - 'context' => array( 'view', 'edit' ), |
|
| 573 | - 'readonly' => true, |
|
| 574 | - ), |
|
| 575 | - 'tab' => array( |
|
| 576 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 577 | - 'type' => 'string', |
|
| 578 | - 'arg_options' => array( |
|
| 579 | - 'sanitize_callback' => 'sanitize_title', |
|
| 580 | - ), |
|
| 581 | - 'context' => array( 'view', 'edit' ), |
|
| 582 | - 'readonly' => true, |
|
| 583 | - ), |
|
| 584 | - 'section' => array( |
|
| 585 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 586 | - 'type' => 'string', |
|
| 587 | - 'arg_options' => array( |
|
| 588 | - 'sanitize_callback' => 'sanitize_title', |
|
| 589 | - ), |
|
| 590 | - 'context' => array( 'view', 'edit' ), |
|
| 591 | - 'readonly' => true, |
|
| 592 | - ), |
|
| 593 | - 'name' => array( |
|
| 594 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 595 | - 'type' => 'string', |
|
| 596 | - 'arg_options' => array( |
|
| 597 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 598 | - ), |
|
| 599 | - 'context' => array( 'view', 'edit' ), |
|
| 600 | - 'readonly' => true, |
|
| 601 | - ), |
|
| 602 | - 'desc' => array( |
|
| 603 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 604 | - 'type' => 'string', |
|
| 605 | - 'context' => array( 'view', 'edit' ), |
|
| 606 | - 'readonly' => true, |
|
| 607 | - ), |
|
| 608 | - 'value' => array( |
|
| 609 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 610 | - 'type' => 'mixed', |
|
| 611 | - 'context' => array( 'view', 'edit' ), |
|
| 612 | - ), |
|
| 613 | - 'default' => array( |
|
| 614 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 615 | - 'type' => 'mixed', |
|
| 616 | - 'context' => array( 'view', 'edit' ), |
|
| 617 | - 'readonly' => true, |
|
| 618 | - ), |
|
| 619 | - 'placeholder' => array( |
|
| 620 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 621 | - 'type' => 'string', |
|
| 622 | - 'arg_options' => array( |
|
| 623 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 624 | - ), |
|
| 625 | - 'context' => array( 'view', 'edit' ), |
|
| 626 | - 'readonly' => true, |
|
| 627 | - ), |
|
| 628 | - 'type' => array( |
|
| 629 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 630 | - 'type' => 'string', |
|
| 631 | - 'arg_options' => array( |
|
| 632 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 633 | - ), |
|
| 634 | - 'context' => array( 'view', 'edit' ), |
|
| 635 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 636 | - 'readonly' => true, |
|
| 637 | - ), |
|
| 638 | - 'options' => array( |
|
| 639 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 640 | - 'type' => 'object', |
|
| 641 | - 'context' => array( 'view', 'edit' ), |
|
| 642 | - 'readonly' => true, |
|
| 643 | - ), |
|
| 644 | - 'readonly' => array( |
|
| 645 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 646 | - 'type' => 'string', |
|
| 647 | - 'context' => array( 'view' ), |
|
| 648 | - 'readonly' => true, |
|
| 649 | - ), |
|
| 650 | - 'faux' => array( |
|
| 651 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 652 | - 'type' => 'string', |
|
| 653 | - 'context' => array( 'view' ), |
|
| 654 | - 'readonly' => true, |
|
| 655 | - ), |
|
| 656 | - ), |
|
| 657 | - ); |
|
| 658 | - |
|
| 659 | - // Filters the settings schema for the REST API. |
|
| 533 | + 'text', // Validates with validate_setting_text_field. |
|
| 534 | + 'email', // Validates with validate_setting_text_field. |
|
| 535 | + 'number', // Validates with validate_setting_text_field. |
|
| 536 | + 'color', // Validates with validate_setting_text_field. |
|
| 537 | + 'password', // Validates with validate_setting_text_field. |
|
| 538 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
| 539 | + 'select', // Validates with validate_setting_select_field. |
|
| 540 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 541 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 542 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 543 | + 'header', // Validates with validate_setting_text_field. |
|
| 544 | + ) |
|
| 545 | + ); |
|
| 546 | + |
|
| 547 | + } |
|
| 548 | + |
|
| 549 | + /** |
|
| 550 | + * Get the settings schema, conforming to JSON Schema. |
|
| 551 | + * |
|
| 552 | + * @return array |
|
| 553 | + */ |
|
| 554 | + public function get_item_schema() { |
|
| 555 | + |
|
| 556 | + // Maybe retrieve the schema from cache. |
|
| 557 | + if ( ! empty( $this->schema ) ) { |
|
| 558 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + $schema = array( |
|
| 562 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 563 | + 'title' => 'setting', |
|
| 564 | + 'type' => 'object', |
|
| 565 | + 'properties' => array( |
|
| 566 | + 'id' => array( |
|
| 567 | + 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 568 | + 'type' => 'string', |
|
| 569 | + 'arg_options' => array( |
|
| 570 | + 'sanitize_callback' => 'sanitize_title', |
|
| 571 | + ), |
|
| 572 | + 'context' => array( 'view', 'edit' ), |
|
| 573 | + 'readonly' => true, |
|
| 574 | + ), |
|
| 575 | + 'tab' => array( |
|
| 576 | + 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 577 | + 'type' => 'string', |
|
| 578 | + 'arg_options' => array( |
|
| 579 | + 'sanitize_callback' => 'sanitize_title', |
|
| 580 | + ), |
|
| 581 | + 'context' => array( 'view', 'edit' ), |
|
| 582 | + 'readonly' => true, |
|
| 583 | + ), |
|
| 584 | + 'section' => array( |
|
| 585 | + 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 586 | + 'type' => 'string', |
|
| 587 | + 'arg_options' => array( |
|
| 588 | + 'sanitize_callback' => 'sanitize_title', |
|
| 589 | + ), |
|
| 590 | + 'context' => array( 'view', 'edit' ), |
|
| 591 | + 'readonly' => true, |
|
| 592 | + ), |
|
| 593 | + 'name' => array( |
|
| 594 | + 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 595 | + 'type' => 'string', |
|
| 596 | + 'arg_options' => array( |
|
| 597 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 598 | + ), |
|
| 599 | + 'context' => array( 'view', 'edit' ), |
|
| 600 | + 'readonly' => true, |
|
| 601 | + ), |
|
| 602 | + 'desc' => array( |
|
| 603 | + 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 604 | + 'type' => 'string', |
|
| 605 | + 'context' => array( 'view', 'edit' ), |
|
| 606 | + 'readonly' => true, |
|
| 607 | + ), |
|
| 608 | + 'value' => array( |
|
| 609 | + 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 610 | + 'type' => 'mixed', |
|
| 611 | + 'context' => array( 'view', 'edit' ), |
|
| 612 | + ), |
|
| 613 | + 'default' => array( |
|
| 614 | + 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 615 | + 'type' => 'mixed', |
|
| 616 | + 'context' => array( 'view', 'edit' ), |
|
| 617 | + 'readonly' => true, |
|
| 618 | + ), |
|
| 619 | + 'placeholder' => array( |
|
| 620 | + 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 621 | + 'type' => 'string', |
|
| 622 | + 'arg_options' => array( |
|
| 623 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 624 | + ), |
|
| 625 | + 'context' => array( 'view', 'edit' ), |
|
| 626 | + 'readonly' => true, |
|
| 627 | + ), |
|
| 628 | + 'type' => array( |
|
| 629 | + 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 630 | + 'type' => 'string', |
|
| 631 | + 'arg_options' => array( |
|
| 632 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 633 | + ), |
|
| 634 | + 'context' => array( 'view', 'edit' ), |
|
| 635 | + 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 636 | + 'readonly' => true, |
|
| 637 | + ), |
|
| 638 | + 'options' => array( |
|
| 639 | + 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 640 | + 'type' => 'object', |
|
| 641 | + 'context' => array( 'view', 'edit' ), |
|
| 642 | + 'readonly' => true, |
|
| 643 | + ), |
|
| 644 | + 'readonly' => array( |
|
| 645 | + 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 646 | + 'type' => 'string', |
|
| 647 | + 'context' => array( 'view' ), |
|
| 648 | + 'readonly' => true, |
|
| 649 | + ), |
|
| 650 | + 'faux' => array( |
|
| 651 | + 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 652 | + 'type' => 'string', |
|
| 653 | + 'context' => array( 'view' ), |
|
| 654 | + 'readonly' => true, |
|
| 655 | + ), |
|
| 656 | + ), |
|
| 657 | + ); |
|
| 658 | + |
|
| 659 | + // Filters the settings schema for the REST API. |
|
| 660 | 660 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
| 661 | 661 | |
| 662 | - // Cache the settings schema. |
|
| 663 | - $this->schema = $schema; |
|
| 664 | - |
|
| 665 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 666 | - |
|
| 667 | - } |
|
| 668 | - |
|
| 669 | - /** |
|
| 670 | - * Validate a text value for a text based setting. |
|
| 671 | - * |
|
| 672 | - * @since 2.0.0 |
|
| 673 | - * @param string $value Value. |
|
| 674 | - * @param array $setting Setting. |
|
| 675 | - * @return string |
|
| 676 | - */ |
|
| 677 | - public function validate_setting_text_field( $value ) { |
|
| 678 | - $value = is_null( $value ) ? '' : $value; |
|
| 679 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 680 | - } |
|
| 681 | - |
|
| 682 | - /** |
|
| 683 | - * Validate select based settings. |
|
| 684 | - * |
|
| 685 | - * @since 2.0.0 |
|
| 686 | - * @param string $value Value. |
|
| 687 | - * @param array $setting Setting. |
|
| 688 | - * @return string|WP_Error |
|
| 689 | - */ |
|
| 690 | - public function validate_setting_select_field( $value, $setting ) { |
|
| 691 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 692 | - return $value; |
|
| 693 | - } else { |
|
| 694 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 695 | - } |
|
| 696 | - } |
|
| 697 | - |
|
| 698 | - /** |
|
| 699 | - * Validate multiselect based settings. |
|
| 700 | - * |
|
| 701 | - * @since 2.0.0 |
|
| 702 | - * @param array $values Values. |
|
| 703 | - * @param array $setting Setting. |
|
| 704 | - * @return array|WP_Error |
|
| 705 | - */ |
|
| 706 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 707 | - if ( empty( $values ) ) { |
|
| 708 | - return array(); |
|
| 709 | - } |
|
| 710 | - |
|
| 711 | - if ( ! is_array( $values ) ) { |
|
| 712 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 713 | - } |
|
| 714 | - |
|
| 715 | - $final_values = array(); |
|
| 716 | - foreach ( $values as $value ) { |
|
| 717 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 718 | - $final_values[] = $value; |
|
| 719 | - } |
|
| 720 | - } |
|
| 721 | - |
|
| 722 | - return $final_values; |
|
| 723 | - } |
|
| 724 | - |
|
| 725 | - /** |
|
| 726 | - * Validate radio based settings. |
|
| 727 | - * |
|
| 728 | - * @since 2.0.0 |
|
| 729 | - * @param string $value Value. |
|
| 730 | - * @param array $setting Setting. |
|
| 731 | - * @return string|WP_Error |
|
| 732 | - */ |
|
| 733 | - public function validate_setting_radio_field( $value, $setting ) { |
|
| 734 | - return $this->validate_setting_select_field( $value, $setting ); |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - /** |
|
| 738 | - * Validate checkbox based settings. |
|
| 739 | - * |
|
| 740 | - * @since 2.0.0 |
|
| 741 | - * @param string $value Value. |
|
| 742 | - * @return int |
|
| 743 | - */ |
|
| 744 | - public function validate_setting_checkbox_field( $value ) { |
|
| 745 | - return (int) ! empty( $value ); |
|
| 746 | - } |
|
| 747 | - |
|
| 748 | - /** |
|
| 749 | - * Validate textarea based settings. |
|
| 750 | - * |
|
| 751 | - * @since 2.0.0 |
|
| 752 | - * @param string $value Value. |
|
| 753 | - * @return string |
|
| 754 | - */ |
|
| 755 | - public function validate_setting_textarea_field( $value ) { |
|
| 756 | - $value = is_null( $value ) ? '' : $value; |
|
| 757 | - return wp_kses( |
|
| 758 | - trim( stripslashes( $value ) ), |
|
| 759 | - array_merge( |
|
| 760 | - array( |
|
| 761 | - 'iframe' => array( |
|
| 762 | - 'src' => true, |
|
| 763 | - 'style' => true, |
|
| 764 | - 'id' => true, |
|
| 765 | - 'class' => true, |
|
| 766 | - ), |
|
| 767 | - ), |
|
| 768 | - wp_kses_allowed_html( 'post' ) |
|
| 769 | - ) |
|
| 770 | - ); |
|
| 771 | - } |
|
| 662 | + // Cache the settings schema. |
|
| 663 | + $this->schema = $schema; |
|
| 664 | + |
|
| 665 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 666 | + |
|
| 667 | + } |
|
| 668 | + |
|
| 669 | + /** |
|
| 670 | + * Validate a text value for a text based setting. |
|
| 671 | + * |
|
| 672 | + * @since 2.0.0 |
|
| 673 | + * @param string $value Value. |
|
| 674 | + * @param array $setting Setting. |
|
| 675 | + * @return string |
|
| 676 | + */ |
|
| 677 | + public function validate_setting_text_field( $value ) { |
|
| 678 | + $value = is_null( $value ) ? '' : $value; |
|
| 679 | + return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + /** |
|
| 683 | + * Validate select based settings. |
|
| 684 | + * |
|
| 685 | + * @since 2.0.0 |
|
| 686 | + * @param string $value Value. |
|
| 687 | + * @param array $setting Setting. |
|
| 688 | + * @return string|WP_Error |
|
| 689 | + */ |
|
| 690 | + public function validate_setting_select_field( $value, $setting ) { |
|
| 691 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 692 | + return $value; |
|
| 693 | + } else { |
|
| 694 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 695 | + } |
|
| 696 | + } |
|
| 697 | + |
|
| 698 | + /** |
|
| 699 | + * Validate multiselect based settings. |
|
| 700 | + * |
|
| 701 | + * @since 2.0.0 |
|
| 702 | + * @param array $values Values. |
|
| 703 | + * @param array $setting Setting. |
|
| 704 | + * @return array|WP_Error |
|
| 705 | + */ |
|
| 706 | + public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 707 | + if ( empty( $values ) ) { |
|
| 708 | + return array(); |
|
| 709 | + } |
|
| 710 | + |
|
| 711 | + if ( ! is_array( $values ) ) { |
|
| 712 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 713 | + } |
|
| 714 | + |
|
| 715 | + $final_values = array(); |
|
| 716 | + foreach ( $values as $value ) { |
|
| 717 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 718 | + $final_values[] = $value; |
|
| 719 | + } |
|
| 720 | + } |
|
| 721 | + |
|
| 722 | + return $final_values; |
|
| 723 | + } |
|
| 724 | + |
|
| 725 | + /** |
|
| 726 | + * Validate radio based settings. |
|
| 727 | + * |
|
| 728 | + * @since 2.0.0 |
|
| 729 | + * @param string $value Value. |
|
| 730 | + * @param array $setting Setting. |
|
| 731 | + * @return string|WP_Error |
|
| 732 | + */ |
|
| 733 | + public function validate_setting_radio_field( $value, $setting ) { |
|
| 734 | + return $this->validate_setting_select_field( $value, $setting ); |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + /** |
|
| 738 | + * Validate checkbox based settings. |
|
| 739 | + * |
|
| 740 | + * @since 2.0.0 |
|
| 741 | + * @param string $value Value. |
|
| 742 | + * @return int |
|
| 743 | + */ |
|
| 744 | + public function validate_setting_checkbox_field( $value ) { |
|
| 745 | + return (int) ! empty( $value ); |
|
| 746 | + } |
|
| 747 | + |
|
| 748 | + /** |
|
| 749 | + * Validate textarea based settings. |
|
| 750 | + * |
|
| 751 | + * @since 2.0.0 |
|
| 752 | + * @param string $value Value. |
|
| 753 | + * @return string |
|
| 754 | + */ |
|
| 755 | + public function validate_setting_textarea_field( $value ) { |
|
| 756 | + $value = is_null( $value ) ? '' : $value; |
|
| 757 | + return wp_kses( |
|
| 758 | + trim( stripslashes( $value ) ), |
|
| 759 | + array_merge( |
|
| 760 | + array( |
|
| 761 | + 'iframe' => array( |
|
| 762 | + 'src' => true, |
|
| 763 | + 'style' => true, |
|
| 764 | + 'id' => true, |
|
| 765 | + 'class' => true, |
|
| 766 | + ), |
|
| 767 | + ), |
|
| 768 | + wp_kses_allowed_html( 'post' ) |
|
| 769 | + ) |
|
| 770 | + ); |
|
| 771 | + } |
|
| 772 | 772 | |
| 773 | 773 | } |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | * @since 2.0.0 |
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | -defined( 'ABSPATH' ) || exit; |
|
| 12 | +defined('ABSPATH') || exit; |
|
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * GetPaid REST Setting controller class. |
@@ -39,7 +39,7 @@ discard block |
||
| 39 | 39 | * |
| 40 | 40 | * @see register_rest_route() |
| 41 | 41 | */ |
| 42 | - public function register_namespace_routes( $namespace ) { |
|
| 42 | + public function register_namespace_routes($namespace) { |
|
| 43 | 43 | |
| 44 | 44 | // List all registered tabs. |
| 45 | 45 | register_rest_route( |
@@ -48,8 +48,8 @@ discard block |
||
| 48 | 48 | array( |
| 49 | 49 | array( |
| 50 | 50 | 'methods' => WP_REST_Server::READABLE, |
| 51 | - 'callback' => array( $this, 'get_tabs' ), |
|
| 52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 51 | + 'callback' => array($this, 'get_tabs'), |
|
| 52 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 53 | 53 | ), |
| 54 | 54 | 'schema' => '__return_empty_array', |
| 55 | 55 | ) |
@@ -62,23 +62,23 @@ discard block |
||
| 62 | 62 | array( |
| 63 | 63 | 'args' => array( |
| 64 | 64 | 'id' => array( |
| 65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
| 65 | + 'description' => __('Unique identifier for the setting.', 'invoicing'), |
|
| 66 | 66 | 'type' => 'string', |
| 67 | 67 | 'required' => true, |
| 68 | 68 | ), |
| 69 | 69 | ), |
| 70 | 70 | array( |
| 71 | 71 | 'methods' => WP_REST_Server::READABLE, |
| 72 | - 'callback' => array( $this, 'get_item' ), |
|
| 73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 72 | + 'callback' => array($this, 'get_item'), |
|
| 73 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 74 | 74 | ), |
| 75 | 75 | array( |
| 76 | 76 | 'methods' => WP_REST_Server::EDITABLE, |
| 77 | - 'callback' => array( $this, 'update_item' ), |
|
| 78 | - 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
| 79 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 77 | + 'callback' => array($this, 'update_item'), |
|
| 78 | + 'permission_callback' => array($this, 'update_items_permissions_check'), |
|
| 79 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE), |
|
| 80 | 80 | ), |
| 81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 81 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 82 | 82 | ) |
| 83 | 83 | ); |
| 84 | 84 | |
@@ -89,16 +89,16 @@ discard block |
||
| 89 | 89 | array( |
| 90 | 90 | 'args' => array( |
| 91 | 91 | 'tab' => array( |
| 92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
| 92 | + 'description' => __('Unique identifier for the tab whose sections should be retrieved.', 'invoicing'), |
|
| 93 | 93 | 'type' => 'string', |
| 94 | 94 | 'required' => true, |
| 95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 95 | + 'enum' => array_keys(wpinv_get_settings_tabs()), |
|
| 96 | 96 | ), |
| 97 | 97 | ), |
| 98 | 98 | array( |
| 99 | 99 | 'methods' => WP_REST_Server::READABLE, |
| 100 | - 'callback' => array( $this, 'get_sections' ), |
|
| 101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 100 | + 'callback' => array($this, 'get_sections'), |
|
| 101 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 102 | 102 | ), |
| 103 | 103 | 'schema' => '__return_empty_array', |
| 104 | 104 | ) |
@@ -111,23 +111,23 @@ discard block |
||
| 111 | 111 | array( |
| 112 | 112 | 'args' => array( |
| 113 | 113 | 'tab' => array( |
| 114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 114 | + 'description' => __('Unique identifier for the tab whose settings should be retrieved.', 'invoicing'), |
|
| 115 | 115 | 'type' => 'string', |
| 116 | 116 | 'required' => true, |
| 117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 117 | + 'enum' => array_keys(wpinv_get_settings_tabs()), |
|
| 118 | 118 | ), |
| 119 | 119 | 'section' => array( |
| 120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 120 | + 'description' => __('The section in the tab whose settings should be retrieved.', 'invoicing'), |
|
| 121 | 121 | 'type' => 'string', |
| 122 | 122 | 'required' => true, |
| 123 | 123 | ), |
| 124 | 124 | ), |
| 125 | 125 | array( |
| 126 | 126 | 'methods' => WP_REST_Server::READABLE, |
| 127 | - 'callback' => array( $this, 'get_items' ), |
|
| 128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 127 | + 'callback' => array($this, 'get_items'), |
|
| 128 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 129 | 129 | ), |
| 130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 130 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 131 | 131 | ) |
| 132 | 132 | ); |
| 133 | 133 | |
@@ -137,17 +137,17 @@ discard block |
||
| 137 | 137 | array( |
| 138 | 138 | 'args' => array( |
| 139 | 139 | 'id' => array( |
| 140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
| 140 | + 'description' => __('Setting ID.', 'invoicing'), |
|
| 141 | 141 | 'type' => 'string', |
| 142 | 142 | ), |
| 143 | 143 | ), |
| 144 | 144 | array( |
| 145 | 145 | 'methods' => WP_REST_Server::EDITABLE, |
| 146 | - 'callback' => array( $this, 'batch_items' ), |
|
| 147 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 148 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 146 | + 'callback' => array($this, 'batch_items'), |
|
| 147 | + 'permission_callback' => array($this, 'batch_items_permissions_check'), |
|
| 148 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE), |
|
| 149 | 149 | ), |
| 150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 150 | + 'schema' => array($this, 'get_public_batch_schema'), |
|
| 151 | 151 | ) |
| 152 | 152 | ); |
| 153 | 153 | |
@@ -160,33 +160,33 @@ discard block |
||
| 160 | 160 | * @param WP_REST_Request $request Request data. |
| 161 | 161 | * @return WP_Error|WP_REST_Response |
| 162 | 162 | */ |
| 163 | - public function get_items( $request ) { |
|
| 163 | + public function get_items($request) { |
|
| 164 | 164 | |
| 165 | 165 | $settings = $this->get_settings(); |
| 166 | 166 | |
| 167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
| 168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 167 | + if (!isset($settings[$request['tab']])) { |
|
| 168 | + return new WP_Error('rest_invalid_tab', __('Invalid tab.', 'invoicing'), array('status' => 400)); |
|
| 169 | 169 | } |
| 170 | 170 | |
| 171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
| 172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 171 | + if (!isset($settings[$request['tab']][$request['section']])) { |
|
| 172 | + return new WP_Error('rest_invalid_section', __('Invalid section.', 'invoicing'), array('status' => 400)); |
|
| 173 | 173 | } |
| 174 | 174 | |
| 175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
| 175 | + $settings = $settings[$request['tab']][$request['section']]; |
|
| 176 | 176 | $prepared = array(); |
| 177 | 177 | |
| 178 | - foreach ( $settings as $setting ) { |
|
| 178 | + foreach ($settings as $setting) { |
|
| 179 | 179 | |
| 180 | - $setting = $this->sanitize_setting( $setting ); |
|
| 181 | - $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
| 182 | - $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
| 180 | + $setting = $this->sanitize_setting($setting); |
|
| 181 | + $setting_data = $this->prepare_item_for_response($setting, $request); |
|
| 182 | + $setting_data = $this->prepare_response_for_collection($setting_data); |
|
| 183 | 183 | |
| 184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
| 185 | - $prepared[] = $setting_data; |
|
| 184 | + if ($this->is_setting_type_valid($setting['type'])) { |
|
| 185 | + $prepared[] = $setting_data; |
|
| 186 | 186 | } |
| 187 | 187 | } |
| 188 | 188 | |
| 189 | - return rest_ensure_response( $prepared ); |
|
| 189 | + return rest_ensure_response($prepared); |
|
| 190 | 190 | } |
| 191 | 191 | |
| 192 | 192 | /** |
@@ -196,16 +196,16 @@ discard block |
||
| 196 | 196 | * @param WP_REST_Request $request Request data. |
| 197 | 197 | * @return WP_Error|WP_REST_Response |
| 198 | 198 | */ |
| 199 | - public function get_item( $request ) { |
|
| 200 | - $setting = $this->get_setting( $request['id'] ); |
|
| 199 | + public function get_item($request) { |
|
| 200 | + $setting = $this->get_setting($request['id']); |
|
| 201 | 201 | |
| 202 | - if ( is_wp_error( $setting ) ) { |
|
| 202 | + if (is_wp_error($setting)) { |
|
| 203 | 203 | return $setting; |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - $setting = $this->sanitize_setting( $setting ); |
|
| 207 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 208 | - return rest_ensure_response( $response ); |
|
| 206 | + $setting = $this->sanitize_setting($setting); |
|
| 207 | + $response = $this->prepare_item_for_response($setting, $request); |
|
| 208 | + return rest_ensure_response($response); |
|
| 209 | 209 | } |
| 210 | 210 | |
| 211 | 211 | /** |
@@ -215,29 +215,29 @@ discard block |
||
| 215 | 215 | * @param WP_REST_Request $request Request data. |
| 216 | 216 | * @return WP_Error|WP_REST_Response |
| 217 | 217 | */ |
| 218 | - public function update_item( $request ) { |
|
| 219 | - $setting = $this->get_setting( $request['id'] ); |
|
| 218 | + public function update_item($request) { |
|
| 219 | + $setting = $this->get_setting($request['id']); |
|
| 220 | 220 | |
| 221 | - if ( is_wp_error( $setting ) ) { |
|
| 221 | + if (is_wp_error($setting)) { |
|
| 222 | 222 | return $setting; |
| 223 | 223 | } |
| 224 | 224 | |
| 225 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 226 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 225 | + if (is_callable(array($this, 'validate_setting_' . $setting['type'] . '_field'))) { |
|
| 226 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}($request['value'], $setting); |
|
| 227 | 227 | } else { |
| 228 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 228 | + $value = $this->validate_setting_text_field($request['value'], $setting); |
|
| 229 | 229 | } |
| 230 | 230 | |
| 231 | - if ( is_wp_error( $value ) ) { |
|
| 231 | + if (is_wp_error($value)) { |
|
| 232 | 232 | return $value; |
| 233 | 233 | } |
| 234 | 234 | |
| 235 | - wpinv_update_option( $request['id'], $value ); |
|
| 235 | + wpinv_update_option($request['id'], $value); |
|
| 236 | 236 | $setting['value'] = $value; |
| 237 | - $setting = $this->sanitize_setting( $setting ); |
|
| 238 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 237 | + $setting = $this->sanitize_setting($setting); |
|
| 238 | + $response = $this->prepare_item_for_response($setting, $request); |
|
| 239 | 239 | |
| 240 | - return rest_ensure_response( $response ); |
|
| 240 | + return rest_ensure_response($response); |
|
| 241 | 241 | } |
| 242 | 242 | |
| 243 | 243 | /** |
@@ -247,9 +247,9 @@ discard block |
||
| 247 | 247 | * @param WP_REST_Request $request Full data about the request. |
| 248 | 248 | * @return WP_Error|boolean |
| 249 | 249 | */ |
| 250 | - public function get_items_permissions_check( $request ) { |
|
| 251 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 252 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 250 | + public function get_items_permissions_check($request) { |
|
| 251 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
| 252 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | return true; |
@@ -262,9 +262,9 @@ discard block |
||
| 262 | 262 | * @param WP_REST_Request $request Full data about the request. |
| 263 | 263 | * @return WP_Error|boolean |
| 264 | 264 | */ |
| 265 | - public function update_items_permissions_check( $request ) { |
|
| 266 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 267 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 265 | + public function update_items_permissions_check($request) { |
|
| 266 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
| 267 | + return new WP_Error('rest_cannot_edit', __('Sorry, you cannot edit this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 268 | 268 | } |
| 269 | 269 | |
| 270 | 270 | return true; |
@@ -277,8 +277,8 @@ discard block |
||
| 277 | 277 | * |
| 278 | 278 | * @return boolean|WP_Error |
| 279 | 279 | */ |
| 280 | - public function batch_items_permissions_check( $request ) { |
|
| 281 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 280 | + public function batch_items_permissions_check($request) { |
|
| 281 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error('rest_cannot_batch', __('Sorry, you are not allowed to batch manipulate this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 282 | 282 | } |
| 283 | 283 | |
| 284 | 284 | /** |
@@ -287,14 +287,14 @@ discard block |
||
| 287 | 287 | * @param string $setting_id Setting ID. |
| 288 | 288 | * @return array Links for the given setting. |
| 289 | 289 | */ |
| 290 | - protected function prepare_links( $setting_id ) { |
|
| 290 | + protected function prepare_links($setting_id) { |
|
| 291 | 291 | |
| 292 | 292 | $links = array( |
| 293 | 293 | 'self' => array( |
| 294 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 294 | + 'href' => rest_url(sprintf('/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id)), |
|
| 295 | 295 | ), |
| 296 | 296 | 'collection' => array( |
| 297 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 297 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 298 | 298 | ), |
| 299 | 299 | ); |
| 300 | 300 | |
@@ -309,14 +309,14 @@ discard block |
||
| 309 | 309 | * @param WP_REST_Request $request Request object. |
| 310 | 310 | * @return WP_REST_Response $response Response data. |
| 311 | 311 | */ |
| 312 | - public function prepare_item_for_response( $item, $request ) { |
|
| 313 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 314 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 315 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 312 | + public function prepare_item_for_response($item, $request) { |
|
| 313 | + $context = empty($request['context']) ? 'view' : $request['context']; |
|
| 314 | + $data = $this->add_additional_fields_to_object($item, $request); |
|
| 315 | + $data = $this->filter_response_by_context($data, $context); |
|
| 316 | 316 | |
| 317 | - $response = rest_ensure_response( $data ); |
|
| 317 | + $response = rest_ensure_response($data); |
|
| 318 | 318 | |
| 319 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 319 | + $response->add_links($this->prepare_links($item['id'])); |
|
| 320 | 320 | |
| 321 | 321 | return $response; |
| 322 | 322 | } |
@@ -329,10 +329,10 @@ discard block |
||
| 329 | 329 | * @param array $setting Setting. |
| 330 | 330 | * @return array |
| 331 | 331 | */ |
| 332 | - public function filter_setting( $setting ) { |
|
| 332 | + public function filter_setting($setting) { |
|
| 333 | 333 | return array_intersect_key( |
| 334 | 334 | $setting, |
| 335 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 335 | + array_flip(array_filter(array_keys($setting), array($this, 'allowed_setting_keys'))) |
|
| 336 | 336 | ); |
| 337 | 337 | } |
| 338 | 338 | |
@@ -342,8 +342,8 @@ discard block |
||
| 342 | 342 | * @param string $key Key to check. |
| 343 | 343 | * @return boolean |
| 344 | 344 | */ |
| 345 | - public function allowed_setting_keys( $key ) { |
|
| 346 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 345 | + public function allowed_setting_keys($key) { |
|
| 346 | + return in_array($key, array_keys($this->setting_defaults()), true); |
|
| 347 | 347 | } |
| 348 | 348 | |
| 349 | 349 | /** |
@@ -375,11 +375,11 @@ discard block |
||
| 375 | 375 | * @param array $setting The setting to sanitize. |
| 376 | 376 | * @return array |
| 377 | 377 | */ |
| 378 | - public function sanitize_setting( $setting ) { |
|
| 378 | + public function sanitize_setting($setting) { |
|
| 379 | 379 | |
| 380 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 381 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 382 | - return $this->filter_setting( $setting ); |
|
| 380 | + $setting = wp_parse_args($setting, $this->setting_defaults()); |
|
| 381 | + $setting['value'] = wpinv_get_option($setting['id'], $setting['std']); |
|
| 382 | + return $this->filter_setting($setting); |
|
| 383 | 383 | |
| 384 | 384 | } |
| 385 | 385 | |
@@ -390,29 +390,29 @@ discard block |
||
| 390 | 390 | * @param string $setting_id Setting ID. |
| 391 | 391 | * @return array|WP_Error |
| 392 | 392 | */ |
| 393 | - public function get_setting( $setting_id ) { |
|
| 393 | + public function get_setting($setting_id) { |
|
| 394 | 394 | |
| 395 | - if ( empty( $setting_id ) ) { |
|
| 396 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 395 | + if (empty($setting_id)) { |
|
| 396 | + return new WP_Error('rest_setting_setting_invalid', __('Invalid setting.', 'invoicing'), array('status' => 404)); |
|
| 397 | 397 | } |
| 398 | 398 | |
| 399 | - $settings = $this->get_settings(); |
|
| 399 | + $settings = $this->get_settings(); |
|
| 400 | 400 | |
| 401 | - foreach ( $settings as $tabs ) { |
|
| 401 | + foreach ($settings as $tabs) { |
|
| 402 | 402 | |
| 403 | - foreach ( $tabs as $sections ) { |
|
| 403 | + foreach ($tabs as $sections) { |
|
| 404 | 404 | |
| 405 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
| 406 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 407 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 405 | + if (isset($sections[$setting_id])) { |
|
| 406 | + if (!$this->is_setting_type_valid($sections[$setting_id]['type'])) { |
|
| 407 | + return new WP_Error('rest_setting_setting_type_invalid', __('Invalid setting type.', 'invoicing'), array('status' => 404)); |
|
| 408 | 408 | } |
| 409 | 409 | |
| 410 | - return $sections[ $setting_id ]; |
|
| 410 | + return $sections[$setting_id]; |
|
| 411 | 411 | } |
| 412 | 412 | } |
| 413 | 413 | } |
| 414 | 414 | |
| 415 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 415 | + return new WP_Error('rest_setting_setting_invalid', __('Invalid setting.', 'invoicing'), array('status' => 404)); |
|
| 416 | 416 | } |
| 417 | 417 | |
| 418 | 418 | /** |
@@ -421,41 +421,41 @@ discard block |
||
| 421 | 421 | * @param WP_REST_Request $request Request data. |
| 422 | 422 | * @return array |
| 423 | 423 | */ |
| 424 | - public function get_tabs( $request ) { |
|
| 424 | + public function get_tabs($request) { |
|
| 425 | 425 | $tabs = wpinv_get_settings_tabs(); |
| 426 | 426 | $prepared = array(); |
| 427 | 427 | |
| 428 | - foreach ( $tabs as $id => $tab ) { |
|
| 428 | + foreach ($tabs as $id => $tab) { |
|
| 429 | 429 | |
| 430 | 430 | $_request = $request; |
| 431 | - $_request['tab'] = sanitize_title( $id ); |
|
| 431 | + $_request['tab'] = sanitize_title($id); |
|
| 432 | 432 | $data = array( |
| 433 | - 'id' => sanitize_title( $id ), |
|
| 434 | - 'label' => sanitize_text_field( $tab ), |
|
| 435 | - 'sections' => $this->get_sections( $_request ), |
|
| 433 | + 'id' => sanitize_title($id), |
|
| 434 | + 'label' => sanitize_text_field($tab), |
|
| 435 | + 'sections' => $this->get_sections($_request), |
|
| 436 | 436 | ); |
| 437 | 437 | |
| 438 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 439 | - $response = rest_ensure_response( $data ); |
|
| 438 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 439 | + $response = rest_ensure_response($data); |
|
| 440 | 440 | |
| 441 | - if ( ! is_wp_error( $response ) ) { |
|
| 441 | + if (!is_wp_error($response)) { |
|
| 442 | 442 | $links = array( |
| 443 | 443 | 'sections' => array( |
| 444 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 444 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $id)), |
|
| 445 | 445 | ), |
| 446 | 446 | 'collection' => array( |
| 447 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 447 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 448 | 448 | ), |
| 449 | 449 | ); |
| 450 | - $response->add_links( $links ); |
|
| 451 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 450 | + $response->add_links($links); |
|
| 451 | + $response = $this->prepare_response_for_collection($response); |
|
| 452 | 452 | } |
| 453 | 453 | |
| 454 | 454 | $prepared[] = $response; |
| 455 | 455 | |
| 456 | 456 | } |
| 457 | 457 | |
| 458 | - return rest_ensure_response( $prepared ); |
|
| 458 | + return rest_ensure_response($prepared); |
|
| 459 | 459 | } |
| 460 | 460 | |
| 461 | 461 | /** |
@@ -464,43 +464,43 @@ discard block |
||
| 464 | 464 | * @param WP_REST_Request $request Request data. |
| 465 | 465 | * @return array |
| 466 | 466 | */ |
| 467 | - public function get_sections( $request ) { |
|
| 467 | + public function get_sections($request) { |
|
| 468 | 468 | |
| 469 | - $tab = sanitize_title( $request['tab'] ); |
|
| 470 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 469 | + $tab = sanitize_title($request['tab']); |
|
| 470 | + $sections = wpinv_get_settings_tab_sections($tab); |
|
| 471 | 471 | $prepared = array(); |
| 472 | 472 | |
| 473 | - foreach ( $sections as $id => $section ) { |
|
| 473 | + foreach ($sections as $id => $section) { |
|
| 474 | 474 | |
| 475 | - $data = array( |
|
| 476 | - 'id' => sanitize_title( $id ), |
|
| 477 | - 'label' => sanitize_text_field( $section ), |
|
| 475 | + $data = array( |
|
| 476 | + 'id' => sanitize_title($id), |
|
| 477 | + 'label' => sanitize_text_field($section), |
|
| 478 | 478 | ); |
| 479 | 479 | |
| 480 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 481 | - $response = rest_ensure_response( $data ); |
|
| 480 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 481 | + $response = rest_ensure_response($data); |
|
| 482 | 482 | |
| 483 | - if ( ! is_wp_error( $response ) ) { |
|
| 483 | + if (!is_wp_error($response)) { |
|
| 484 | 484 | $links = array( |
| 485 | 485 | 'settings' => array( |
| 486 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 486 | + 'href' => rest_url(sprintf('/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id)), |
|
| 487 | 487 | ), |
| 488 | 488 | 'collection' => array( |
| 489 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 489 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $tab)), |
|
| 490 | 490 | ), |
| 491 | 491 | 'tabs' => array( |
| 492 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 492 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 493 | 493 | ), |
| 494 | 494 | ); |
| 495 | - $response->add_links( $links ); |
|
| 496 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 495 | + $response->add_links($links); |
|
| 496 | + $response = $this->prepare_response_for_collection($response); |
|
| 497 | 497 | } |
| 498 | 498 | |
| 499 | 499 | $prepared[] = $response; |
| 500 | 500 | |
| 501 | 501 | } |
| 502 | 502 | |
| 503 | - return rest_ensure_response( $prepared ); |
|
| 503 | + return rest_ensure_response($prepared); |
|
| 504 | 504 | } |
| 505 | 505 | |
| 506 | 506 | /** |
@@ -510,7 +510,7 @@ discard block |
||
| 510 | 510 | */ |
| 511 | 511 | public function get_settings() { |
| 512 | 512 | |
| 513 | - if ( empty( $this->settings ) ) { |
|
| 513 | + if (empty($this->settings)) { |
|
| 514 | 514 | $this->settings = wpinv_get_registered_settings(); |
| 515 | 515 | } |
| 516 | 516 | |
@@ -525,22 +525,22 @@ discard block |
||
| 525 | 525 | * @param string $type Type. |
| 526 | 526 | * @return bool |
| 527 | 527 | */ |
| 528 | - public function is_setting_type_valid( $type ) { |
|
| 528 | + public function is_setting_type_valid($type) { |
|
| 529 | 529 | |
| 530 | 530 | return in_array( |
| 531 | 531 | $type, |
| 532 | 532 | array( |
| 533 | - 'text', // Validates with validate_setting_text_field. |
|
| 534 | - 'email', // Validates with validate_setting_text_field. |
|
| 535 | - 'number', // Validates with validate_setting_text_field. |
|
| 536 | - 'color', // Validates with validate_setting_text_field. |
|
| 537 | - 'password', // Validates with validate_setting_text_field. |
|
| 538 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
| 539 | - 'select', // Validates with validate_setting_select_field. |
|
| 540 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 541 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 542 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 543 | - 'header', // Validates with validate_setting_text_field. |
|
| 533 | + 'text', // Validates with validate_setting_text_field. |
|
| 534 | + 'email', // Validates with validate_setting_text_field. |
|
| 535 | + 'number', // Validates with validate_setting_text_field. |
|
| 536 | + 'color', // Validates with validate_setting_text_field. |
|
| 537 | + 'password', // Validates with validate_setting_text_field. |
|
| 538 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
| 539 | + 'select', // Validates with validate_setting_select_field. |
|
| 540 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 541 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 542 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 543 | + 'header', // Validates with validate_setting_text_field. |
|
| 544 | 544 | ) |
| 545 | 545 | ); |
| 546 | 546 | |
@@ -554,8 +554,8 @@ discard block |
||
| 554 | 554 | public function get_item_schema() { |
| 555 | 555 | |
| 556 | 556 | // Maybe retrieve the schema from cache. |
| 557 | - if ( ! empty( $this->schema ) ) { |
|
| 558 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 557 | + if (!empty($this->schema)) { |
|
| 558 | + return $this->add_additional_fields_schema($this->schema); |
|
| 559 | 559 | } |
| 560 | 560 | |
| 561 | 561 | $schema = array( |
@@ -564,105 +564,105 @@ discard block |
||
| 564 | 564 | 'type' => 'object', |
| 565 | 565 | 'properties' => array( |
| 566 | 566 | 'id' => array( |
| 567 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 567 | + 'description' => __('A unique identifier for the setting.', 'invoicing'), |
|
| 568 | 568 | 'type' => 'string', |
| 569 | 569 | 'arg_options' => array( |
| 570 | 570 | 'sanitize_callback' => 'sanitize_title', |
| 571 | 571 | ), |
| 572 | - 'context' => array( 'view', 'edit' ), |
|
| 572 | + 'context' => array('view', 'edit'), |
|
| 573 | 573 | 'readonly' => true, |
| 574 | 574 | ), |
| 575 | 575 | 'tab' => array( |
| 576 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 576 | + 'description' => __('An identifier for the tab this setting belongs to.', 'invoicing'), |
|
| 577 | 577 | 'type' => 'string', |
| 578 | 578 | 'arg_options' => array( |
| 579 | 579 | 'sanitize_callback' => 'sanitize_title', |
| 580 | 580 | ), |
| 581 | - 'context' => array( 'view', 'edit' ), |
|
| 581 | + 'context' => array('view', 'edit'), |
|
| 582 | 582 | 'readonly' => true, |
| 583 | 583 | ), |
| 584 | 584 | 'section' => array( |
| 585 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 585 | + 'description' => __('An identifier for the section this setting belongs to.', 'invoicing'), |
|
| 586 | 586 | 'type' => 'string', |
| 587 | 587 | 'arg_options' => array( |
| 588 | 588 | 'sanitize_callback' => 'sanitize_title', |
| 589 | 589 | ), |
| 590 | - 'context' => array( 'view', 'edit' ), |
|
| 590 | + 'context' => array('view', 'edit'), |
|
| 591 | 591 | 'readonly' => true, |
| 592 | 592 | ), |
| 593 | 593 | 'name' => array( |
| 594 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 594 | + 'description' => __('A human readable label for the setting used in interfaces.', 'invoicing'), |
|
| 595 | 595 | 'type' => 'string', |
| 596 | 596 | 'arg_options' => array( |
| 597 | 597 | 'sanitize_callback' => 'sanitize_text_field', |
| 598 | 598 | ), |
| 599 | - 'context' => array( 'view', 'edit' ), |
|
| 599 | + 'context' => array('view', 'edit'), |
|
| 600 | 600 | 'readonly' => true, |
| 601 | 601 | ), |
| 602 | 602 | 'desc' => array( |
| 603 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 603 | + 'description' => __('A human readable description for the setting used in interfaces.', 'invoicing'), |
|
| 604 | 604 | 'type' => 'string', |
| 605 | - 'context' => array( 'view', 'edit' ), |
|
| 605 | + 'context' => array('view', 'edit'), |
|
| 606 | 606 | 'readonly' => true, |
| 607 | 607 | ), |
| 608 | 608 | 'value' => array( |
| 609 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 609 | + 'description' => __('The current value of this setting.', 'invoicing'), |
|
| 610 | 610 | 'type' => 'mixed', |
| 611 | - 'context' => array( 'view', 'edit' ), |
|
| 611 | + 'context' => array('view', 'edit'), |
|
| 612 | 612 | ), |
| 613 | 613 | 'default' => array( |
| 614 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 614 | + 'description' => __('Default value for the setting.', 'invoicing'), |
|
| 615 | 615 | 'type' => 'mixed', |
| 616 | - 'context' => array( 'view', 'edit' ), |
|
| 616 | + 'context' => array('view', 'edit'), |
|
| 617 | 617 | 'readonly' => true, |
| 618 | 618 | ), |
| 619 | 619 | 'placeholder' => array( |
| 620 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 620 | + 'description' => __('Placeholder text to be displayed in text inputs.', 'invoicing'), |
|
| 621 | 621 | 'type' => 'string', |
| 622 | 622 | 'arg_options' => array( |
| 623 | 623 | 'sanitize_callback' => 'sanitize_text_field', |
| 624 | 624 | ), |
| 625 | - 'context' => array( 'view', 'edit' ), |
|
| 625 | + 'context' => array('view', 'edit'), |
|
| 626 | 626 | 'readonly' => true, |
| 627 | 627 | ), |
| 628 | 628 | 'type' => array( |
| 629 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 629 | + 'description' => __('Type of setting.', 'invoicing'), |
|
| 630 | 630 | 'type' => 'string', |
| 631 | 631 | 'arg_options' => array( |
| 632 | 632 | 'sanitize_callback' => 'sanitize_text_field', |
| 633 | 633 | ), |
| 634 | - 'context' => array( 'view', 'edit' ), |
|
| 635 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 634 | + 'context' => array('view', 'edit'), |
|
| 635 | + 'enum' => array('text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html'), |
|
| 636 | 636 | 'readonly' => true, |
| 637 | 637 | ), |
| 638 | 638 | 'options' => array( |
| 639 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 639 | + 'description' => __('Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing'), |
|
| 640 | 640 | 'type' => 'object', |
| 641 | - 'context' => array( 'view', 'edit' ), |
|
| 641 | + 'context' => array('view', 'edit'), |
|
| 642 | 642 | 'readonly' => true, |
| 643 | 643 | ), |
| 644 | 644 | 'readonly' => array( |
| 645 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 645 | + 'description' => __('Whether or not this setting is readonly', 'invoicing'), |
|
| 646 | 646 | 'type' => 'string', |
| 647 | - 'context' => array( 'view' ), |
|
| 647 | + 'context' => array('view'), |
|
| 648 | 648 | 'readonly' => true, |
| 649 | 649 | ), |
| 650 | 650 | 'faux' => array( |
| 651 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 651 | + 'description' => __('Whether or not this setting is readonly/faux', 'invoicing'), |
|
| 652 | 652 | 'type' => 'string', |
| 653 | - 'context' => array( 'view' ), |
|
| 653 | + 'context' => array('view'), |
|
| 654 | 654 | 'readonly' => true, |
| 655 | 655 | ), |
| 656 | 656 | ), |
| 657 | 657 | ); |
| 658 | 658 | |
| 659 | 659 | // Filters the settings schema for the REST API. |
| 660 | - $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
|
| 660 | + $schema = apply_filters('getpaid_rest_settings_schema', $schema); |
|
| 661 | 661 | |
| 662 | 662 | // Cache the settings schema. |
| 663 | 663 | $this->schema = $schema; |
| 664 | 664 | |
| 665 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 665 | + return $this->add_additional_fields_schema($this->schema); |
|
| 666 | 666 | |
| 667 | 667 | } |
| 668 | 668 | |
@@ -674,9 +674,9 @@ discard block |
||
| 674 | 674 | * @param array $setting Setting. |
| 675 | 675 | * @return string |
| 676 | 676 | */ |
| 677 | - public function validate_setting_text_field( $value ) { |
|
| 678 | - $value = is_null( $value ) ? '' : $value; |
|
| 679 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 677 | + public function validate_setting_text_field($value) { |
|
| 678 | + $value = is_null($value) ? '' : $value; |
|
| 679 | + return wp_kses_post(trim(stripslashes($value))); |
|
| 680 | 680 | } |
| 681 | 681 | |
| 682 | 682 | /** |
@@ -687,11 +687,11 @@ discard block |
||
| 687 | 687 | * @param array $setting Setting. |
| 688 | 688 | * @return string|WP_Error |
| 689 | 689 | */ |
| 690 | - public function validate_setting_select_field( $value, $setting ) { |
|
| 691 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 690 | + public function validate_setting_select_field($value, $setting) { |
|
| 691 | + if (array_key_exists($value, $setting['options'])) { |
|
| 692 | 692 | return $value; |
| 693 | 693 | } else { |
| 694 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 694 | + return new WP_Error('rest_setting_value_invalid', __('An invalid setting value was passed.', 'invoicing'), array('status' => 400)); |
|
| 695 | 695 | } |
| 696 | 696 | } |
| 697 | 697 | |
@@ -703,18 +703,18 @@ discard block |
||
| 703 | 703 | * @param array $setting Setting. |
| 704 | 704 | * @return array|WP_Error |
| 705 | 705 | */ |
| 706 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 707 | - if ( empty( $values ) ) { |
|
| 706 | + public function validate_setting_multiselect_field($values, $setting) { |
|
| 707 | + if (empty($values)) { |
|
| 708 | 708 | return array(); |
| 709 | 709 | } |
| 710 | 710 | |
| 711 | - if ( ! is_array( $values ) ) { |
|
| 712 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 711 | + if (!is_array($values)) { |
|
| 712 | + return new WP_Error('rest_setting_value_invalid', __('An invalid setting value was passed.', 'invoicing'), array('status' => 400)); |
|
| 713 | 713 | } |
| 714 | 714 | |
| 715 | 715 | $final_values = array(); |
| 716 | - foreach ( $values as $value ) { |
|
| 717 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 716 | + foreach ($values as $value) { |
|
| 717 | + if (array_key_exists($value, $setting['options'])) { |
|
| 718 | 718 | $final_values[] = $value; |
| 719 | 719 | } |
| 720 | 720 | } |
@@ -730,8 +730,8 @@ discard block |
||
| 730 | 730 | * @param array $setting Setting. |
| 731 | 731 | * @return string|WP_Error |
| 732 | 732 | */ |
| 733 | - public function validate_setting_radio_field( $value, $setting ) { |
|
| 734 | - return $this->validate_setting_select_field( $value, $setting ); |
|
| 733 | + public function validate_setting_radio_field($value, $setting) { |
|
| 734 | + return $this->validate_setting_select_field($value, $setting); |
|
| 735 | 735 | } |
| 736 | 736 | |
| 737 | 737 | /** |
@@ -741,8 +741,8 @@ discard block |
||
| 741 | 741 | * @param string $value Value. |
| 742 | 742 | * @return int |
| 743 | 743 | */ |
| 744 | - public function validate_setting_checkbox_field( $value ) { |
|
| 745 | - return (int) ! empty( $value ); |
|
| 744 | + public function validate_setting_checkbox_field($value) { |
|
| 745 | + return (int) !empty($value); |
|
| 746 | 746 | } |
| 747 | 747 | |
| 748 | 748 | /** |
@@ -752,10 +752,10 @@ discard block |
||
| 752 | 752 | * @param string $value Value. |
| 753 | 753 | * @return string |
| 754 | 754 | */ |
| 755 | - public function validate_setting_textarea_field( $value ) { |
|
| 756 | - $value = is_null( $value ) ? '' : $value; |
|
| 755 | + public function validate_setting_textarea_field($value) { |
|
| 756 | + $value = is_null($value) ? '' : $value; |
|
| 757 | 757 | return wp_kses( |
| 758 | - trim( stripslashes( $value ) ), |
|
| 758 | + trim(stripslashes($value)), |
|
| 759 | 759 | array_merge( |
| 760 | 760 | array( |
| 761 | 761 | 'iframe' => array( |
@@ -765,7 +765,7 @@ discard block |
||
| 765 | 765 | 'class' => true, |
| 766 | 766 | ), |
| 767 | 767 | ), |
| 768 | - wp_kses_allowed_html( 'post' ) |
|
| 768 | + wp_kses_allowed_html('post') |
|
| 769 | 769 | ) |
| 770 | 770 | ); |
| 771 | 771 | } |
@@ -18,179 +18,179 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Top_Sellers_Controller extends GetPaid_REST_Report_Sales_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/top_sellers'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Get top sellers report. |
|
| 30 | - * |
|
| 31 | - * @param WP_REST_Request $request |
|
| 32 | - * @return array|WP_Error |
|
| 33 | - */ |
|
| 34 | - public function get_items( $request ) { |
|
| 35 | - |
|
| 36 | - // Prepare items. |
|
| 37 | - $this->report_range = $this->get_date_range( $request ); |
|
| 38 | - $report_data = $this->get_report_data(); |
|
| 39 | - |
|
| 40 | - $top_sellers = array(); |
|
| 41 | - |
|
| 42 | - foreach ( $report_data as $item ) { |
|
| 43 | - |
|
| 44 | - $item_obj = new WPInv_Item( $item ); |
|
| 45 | - $item_name = $item->invoice_item_name; |
|
| 46 | - $item_qty = floatval( $item->invoice_item_qty ); |
|
| 47 | - $item_id = absint( $item->invoice_item_id ); |
|
| 48 | - $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
| 49 | - |
|
| 50 | - $item_obj = new WPInv_Item( $item_id ); |
|
| 51 | - |
|
| 52 | - if ( $item_obj->exists() ) { |
|
| 53 | - $item_name = $item_obj->get_name(); |
|
| 54 | - } else { |
|
| 55 | - $item_id = 0; |
|
| 56 | - } |
|
| 57 | - |
|
| 58 | - $top_sellers[] = array( |
|
| 59 | - 'name' => sanitize_text_field( $item_name ), |
|
| 60 | - 'item_id' => $item_id, |
|
| 61 | - 'quantity' => $item_qty, |
|
| 62 | - 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
| 63 | - 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - $data = array(); |
|
| 69 | - foreach ( $top_sellers as $top_seller ) { |
|
| 70 | - $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
| 71 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - return rest_ensure_response( $data ); |
|
| 75 | - |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Prepare a report sales object for serialization. |
|
| 80 | - * |
|
| 81 | - * @param stdClass $top_seller |
|
| 82 | - * @param WP_REST_Request $request Request object. |
|
| 83 | - * @return WP_REST_Response $response Response data. |
|
| 84 | - */ |
|
| 85 | - public function prepare_item_for_response( $top_seller, $request ) { |
|
| 86 | - $data = (array) $top_seller; |
|
| 87 | - |
|
| 88 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 89 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 90 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 91 | - |
|
| 92 | - // Wrap the data in a response object. |
|
| 93 | - $response = rest_ensure_response( $data ); |
|
| 94 | - $links = array( |
|
| 95 | - 'about' => array( |
|
| 96 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 97 | - ), |
|
| 98 | - ); |
|
| 99 | - |
|
| 100 | - if ( ! empty( $top_seller->item_id ) ) { |
|
| 101 | - $links['item'] = array( |
|
| 102 | - 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
| 103 | - 'embeddable' => true, |
|
| 104 | - ); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - $response->add_links( $links ); |
|
| 108 | - return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * Get all data needed for this report and store in the class. |
|
| 113 | - */ |
|
| 114 | - protected function query_report_data() { |
|
| 115 | - |
|
| 116 | - $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 117 | - array( |
|
| 118 | - 'data' => array( |
|
| 119 | - 'quantity' => array( |
|
| 120 | - 'type' => 'invoice_item', |
|
| 121 | - 'function' => 'SUM', |
|
| 122 | - 'name' => 'invoice_item_qty', |
|
| 123 | - ), |
|
| 124 | - 'item_id' => array( |
|
| 125 | - 'type' => 'invoice_item', |
|
| 126 | - 'function' => '', |
|
| 127 | - 'name' => 'invoice_item_id', |
|
| 128 | - ), |
|
| 129 | - 'item_name' => array( |
|
| 130 | - 'type' => 'invoice_item', |
|
| 131 | - 'function' => '', |
|
| 132 | - 'name' => 'invoice_item_name', |
|
| 133 | - ), |
|
| 134 | - 'price' => array( |
|
| 135 | - 'type' => 'invoice_item', |
|
| 136 | - 'function' => 'SUM', |
|
| 137 | - 'name' => 'invoice_item_price', |
|
| 138 | - ), |
|
| 139 | - ), |
|
| 140 | - 'group_by' => 'invoice_item_id', |
|
| 141 | - 'order_by' => 'invoice_item_qty DESC', |
|
| 142 | - 'query_type' => 'get_results', |
|
| 143 | - 'limit' => 10, |
|
| 144 | - 'filter_range' => $this->report_range, |
|
| 145 | - ) |
|
| 146 | - ); |
|
| 147 | - |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 152 | - * |
|
| 153 | - * @return array |
|
| 154 | - */ |
|
| 155 | - public function get_item_schema() { |
|
| 156 | - $schema = array( |
|
| 157 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 158 | - 'title' => $this->rest_base, |
|
| 159 | - 'type' => 'object', |
|
| 160 | - 'properties' => array( |
|
| 161 | - 'name' => array( |
|
| 162 | - 'description' => __( 'Item name.', 'invoicing' ), |
|
| 163 | - 'type' => 'string', |
|
| 164 | - 'context' => array( 'view' ), |
|
| 165 | - 'readonly' => true, |
|
| 166 | - ), |
|
| 167 | - 'item_id' => array( |
|
| 168 | - 'description' => __( 'Item ID.', 'invoicing' ), |
|
| 169 | - 'type' => 'integer', |
|
| 170 | - 'context' => array( 'view' ), |
|
| 171 | - 'readonly' => true, |
|
| 172 | - ), |
|
| 173 | - 'quantity' => array( |
|
| 174 | - 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
| 175 | - 'type' => 'number', |
|
| 176 | - 'context' => array( 'view' ), |
|
| 177 | - 'readonly' => true, |
|
| 178 | - ), |
|
| 179 | - 'earnings' => array( |
|
| 180 | - 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
| 181 | - 'type' => 'number', |
|
| 182 | - 'context' => array( 'view' ), |
|
| 183 | - 'readonly' => true, |
|
| 184 | - ), |
|
| 185 | - 'earnings_formatted"' => array( |
|
| 186 | - 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
| 187 | - 'type' => 'string', |
|
| 188 | - 'context' => array( 'view' ), |
|
| 189 | - 'readonly' => true, |
|
| 190 | - ), |
|
| 191 | - ), |
|
| 192 | - ); |
|
| 193 | - |
|
| 194 | - return $this->add_additional_fields_schema( $schema ); |
|
| 195 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/top_sellers'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Get top sellers report. |
|
| 30 | + * |
|
| 31 | + * @param WP_REST_Request $request |
|
| 32 | + * @return array|WP_Error |
|
| 33 | + */ |
|
| 34 | + public function get_items( $request ) { |
|
| 35 | + |
|
| 36 | + // Prepare items. |
|
| 37 | + $this->report_range = $this->get_date_range( $request ); |
|
| 38 | + $report_data = $this->get_report_data(); |
|
| 39 | + |
|
| 40 | + $top_sellers = array(); |
|
| 41 | + |
|
| 42 | + foreach ( $report_data as $item ) { |
|
| 43 | + |
|
| 44 | + $item_obj = new WPInv_Item( $item ); |
|
| 45 | + $item_name = $item->invoice_item_name; |
|
| 46 | + $item_qty = floatval( $item->invoice_item_qty ); |
|
| 47 | + $item_id = absint( $item->invoice_item_id ); |
|
| 48 | + $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
| 49 | + |
|
| 50 | + $item_obj = new WPInv_Item( $item_id ); |
|
| 51 | + |
|
| 52 | + if ( $item_obj->exists() ) { |
|
| 53 | + $item_name = $item_obj->get_name(); |
|
| 54 | + } else { |
|
| 55 | + $item_id = 0; |
|
| 56 | + } |
|
| 57 | + |
|
| 58 | + $top_sellers[] = array( |
|
| 59 | + 'name' => sanitize_text_field( $item_name ), |
|
| 60 | + 'item_id' => $item_id, |
|
| 61 | + 'quantity' => $item_qty, |
|
| 62 | + 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
| 63 | + 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + $data = array(); |
|
| 69 | + foreach ( $top_sellers as $top_seller ) { |
|
| 70 | + $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
| 71 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + return rest_ensure_response( $data ); |
|
| 75 | + |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Prepare a report sales object for serialization. |
|
| 80 | + * |
|
| 81 | + * @param stdClass $top_seller |
|
| 82 | + * @param WP_REST_Request $request Request object. |
|
| 83 | + * @return WP_REST_Response $response Response data. |
|
| 84 | + */ |
|
| 85 | + public function prepare_item_for_response( $top_seller, $request ) { |
|
| 86 | + $data = (array) $top_seller; |
|
| 87 | + |
|
| 88 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 89 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 90 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 91 | + |
|
| 92 | + // Wrap the data in a response object. |
|
| 93 | + $response = rest_ensure_response( $data ); |
|
| 94 | + $links = array( |
|
| 95 | + 'about' => array( |
|
| 96 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 97 | + ), |
|
| 98 | + ); |
|
| 99 | + |
|
| 100 | + if ( ! empty( $top_seller->item_id ) ) { |
|
| 101 | + $links['item'] = array( |
|
| 102 | + 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
| 103 | + 'embeddable' => true, |
|
| 104 | + ); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + $response->add_links( $links ); |
|
| 108 | + return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * Get all data needed for this report and store in the class. |
|
| 113 | + */ |
|
| 114 | + protected function query_report_data() { |
|
| 115 | + |
|
| 116 | + $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 117 | + array( |
|
| 118 | + 'data' => array( |
|
| 119 | + 'quantity' => array( |
|
| 120 | + 'type' => 'invoice_item', |
|
| 121 | + 'function' => 'SUM', |
|
| 122 | + 'name' => 'invoice_item_qty', |
|
| 123 | + ), |
|
| 124 | + 'item_id' => array( |
|
| 125 | + 'type' => 'invoice_item', |
|
| 126 | + 'function' => '', |
|
| 127 | + 'name' => 'invoice_item_id', |
|
| 128 | + ), |
|
| 129 | + 'item_name' => array( |
|
| 130 | + 'type' => 'invoice_item', |
|
| 131 | + 'function' => '', |
|
| 132 | + 'name' => 'invoice_item_name', |
|
| 133 | + ), |
|
| 134 | + 'price' => array( |
|
| 135 | + 'type' => 'invoice_item', |
|
| 136 | + 'function' => 'SUM', |
|
| 137 | + 'name' => 'invoice_item_price', |
|
| 138 | + ), |
|
| 139 | + ), |
|
| 140 | + 'group_by' => 'invoice_item_id', |
|
| 141 | + 'order_by' => 'invoice_item_qty DESC', |
|
| 142 | + 'query_type' => 'get_results', |
|
| 143 | + 'limit' => 10, |
|
| 144 | + 'filter_range' => $this->report_range, |
|
| 145 | + ) |
|
| 146 | + ); |
|
| 147 | + |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 152 | + * |
|
| 153 | + * @return array |
|
| 154 | + */ |
|
| 155 | + public function get_item_schema() { |
|
| 156 | + $schema = array( |
|
| 157 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 158 | + 'title' => $this->rest_base, |
|
| 159 | + 'type' => 'object', |
|
| 160 | + 'properties' => array( |
|
| 161 | + 'name' => array( |
|
| 162 | + 'description' => __( 'Item name.', 'invoicing' ), |
|
| 163 | + 'type' => 'string', |
|
| 164 | + 'context' => array( 'view' ), |
|
| 165 | + 'readonly' => true, |
|
| 166 | + ), |
|
| 167 | + 'item_id' => array( |
|
| 168 | + 'description' => __( 'Item ID.', 'invoicing' ), |
|
| 169 | + 'type' => 'integer', |
|
| 170 | + 'context' => array( 'view' ), |
|
| 171 | + 'readonly' => true, |
|
| 172 | + ), |
|
| 173 | + 'quantity' => array( |
|
| 174 | + 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
| 175 | + 'type' => 'number', |
|
| 176 | + 'context' => array( 'view' ), |
|
| 177 | + 'readonly' => true, |
|
| 178 | + ), |
|
| 179 | + 'earnings' => array( |
|
| 180 | + 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
| 181 | + 'type' => 'number', |
|
| 182 | + 'context' => array( 'view' ), |
|
| 183 | + 'readonly' => true, |
|
| 184 | + ), |
|
| 185 | + 'earnings_formatted"' => array( |
|
| 186 | + 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
| 187 | + 'type' => 'string', |
|
| 188 | + 'context' => array( 'view' ), |
|
| 189 | + 'readonly' => true, |
|
| 190 | + ), |
|
| 191 | + ), |
|
| 192 | + ); |
|
| 193 | + |
|
| 194 | + return $this->add_additional_fields_schema( $schema ); |
|
| 195 | + } |
|
| 196 | 196 | } |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | * @since 2.0.0 |
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | -defined( 'ABSPATH' ) || exit; |
|
| 12 | +defined('ABSPATH') || exit; |
|
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * GetPaid REST top sellers controller class. |
@@ -31,47 +31,47 @@ discard block |
||
| 31 | 31 | * @param WP_REST_Request $request |
| 32 | 32 | * @return array|WP_Error |
| 33 | 33 | */ |
| 34 | - public function get_items( $request ) { |
|
| 34 | + public function get_items($request) { |
|
| 35 | 35 | |
| 36 | 36 | // Prepare items. |
| 37 | - $this->report_range = $this->get_date_range( $request ); |
|
| 37 | + $this->report_range = $this->get_date_range($request); |
|
| 38 | 38 | $report_data = $this->get_report_data(); |
| 39 | 39 | |
| 40 | 40 | $top_sellers = array(); |
| 41 | 41 | |
| 42 | - foreach ( $report_data as $item ) { |
|
| 42 | + foreach ($report_data as $item) { |
|
| 43 | 43 | |
| 44 | - $item_obj = new WPInv_Item( $item ); |
|
| 44 | + $item_obj = new WPInv_Item($item); |
|
| 45 | 45 | $item_name = $item->invoice_item_name; |
| 46 | - $item_qty = floatval( $item->invoice_item_qty ); |
|
| 47 | - $item_id = absint( $item->invoice_item_id ); |
|
| 48 | - $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
| 46 | + $item_qty = floatval($item->invoice_item_qty); |
|
| 47 | + $item_id = absint($item->invoice_item_id); |
|
| 48 | + $price = sanitize_text_field(wpinv_price($item->invoice_item_price)); |
|
| 49 | 49 | |
| 50 | - $item_obj = new WPInv_Item( $item_id ); |
|
| 50 | + $item_obj = new WPInv_Item($item_id); |
|
| 51 | 51 | |
| 52 | - if ( $item_obj->exists() ) { |
|
| 52 | + if ($item_obj->exists()) { |
|
| 53 | 53 | $item_name = $item_obj->get_name(); |
| 54 | 54 | } else { |
| 55 | 55 | $item_id = 0; |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | 58 | $top_sellers[] = array( |
| 59 | - 'name' => sanitize_text_field( $item_name ), |
|
| 59 | + 'name' => sanitize_text_field($item_name), |
|
| 60 | 60 | 'item_id' => $item_id, |
| 61 | 61 | 'quantity' => $item_qty, |
| 62 | - 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
| 63 | - 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
| 62 | + 'earnings' => wpinv_round_amount($item->invoice_item_price), |
|
| 63 | + 'earnings_formatted' => sanitize_text_field(wpinv_price($price)), |
|
| 64 | 64 | ); |
| 65 | 65 | |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | 68 | $data = array(); |
| 69 | - foreach ( $top_sellers as $top_seller ) { |
|
| 70 | - $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
| 71 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 69 | + foreach ($top_sellers as $top_seller) { |
|
| 70 | + $item = $this->prepare_item_for_response((object) $top_seller, $request); |
|
| 71 | + $data[] = $this->prepare_response_for_collection($item); |
|
| 72 | 72 | } |
| 73 | 73 | |
| 74 | - return rest_ensure_response( $data ); |
|
| 74 | + return rest_ensure_response($data); |
|
| 75 | 75 | |
| 76 | 76 | } |
| 77 | 77 | |
@@ -82,30 +82,30 @@ discard block |
||
| 82 | 82 | * @param WP_REST_Request $request Request object. |
| 83 | 83 | * @return WP_REST_Response $response Response data. |
| 84 | 84 | */ |
| 85 | - public function prepare_item_for_response( $top_seller, $request ) { |
|
| 85 | + public function prepare_item_for_response($top_seller, $request) { |
|
| 86 | 86 | $data = (array) $top_seller; |
| 87 | 87 | |
| 88 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 89 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 90 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 88 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
| 89 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 90 | + $data = $this->filter_response_by_context($data, $context); |
|
| 91 | 91 | |
| 92 | 92 | // Wrap the data in a response object. |
| 93 | - $response = rest_ensure_response( $data ); |
|
| 93 | + $response = rest_ensure_response($data); |
|
| 94 | 94 | $links = array( |
| 95 | 95 | 'about' => array( |
| 96 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 96 | + 'href' => rest_url(sprintf('%s/reports', $this->namespace)), |
|
| 97 | 97 | ), |
| 98 | 98 | ); |
| 99 | 99 | |
| 100 | - if ( ! empty( $top_seller->item_id ) ) { |
|
| 101 | - $links['item'] = array( |
|
| 102 | - 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
| 100 | + if (!empty($top_seller->item_id)) { |
|
| 101 | + $links['item'] = array( |
|
| 102 | + 'href' => rest_url(sprintf('/%s/items/%s', $this->namespace, $top_seller->item_id)), |
|
| 103 | 103 | 'embeddable' => true, |
| 104 | 104 | ); |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - $response->add_links( $links ); |
|
| 108 | - return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
| 107 | + $response->add_links($links); |
|
| 108 | + return apply_filters('getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request); |
|
| 109 | 109 | } |
| 110 | 110 | |
| 111 | 111 | /** |
@@ -159,38 +159,38 @@ discard block |
||
| 159 | 159 | 'type' => 'object', |
| 160 | 160 | 'properties' => array( |
| 161 | 161 | 'name' => array( |
| 162 | - 'description' => __( 'Item name.', 'invoicing' ), |
|
| 162 | + 'description' => __('Item name.', 'invoicing'), |
|
| 163 | 163 | 'type' => 'string', |
| 164 | - 'context' => array( 'view' ), |
|
| 164 | + 'context' => array('view'), |
|
| 165 | 165 | 'readonly' => true, |
| 166 | 166 | ), |
| 167 | 167 | 'item_id' => array( |
| 168 | - 'description' => __( 'Item ID.', 'invoicing' ), |
|
| 168 | + 'description' => __('Item ID.', 'invoicing'), |
|
| 169 | 169 | 'type' => 'integer', |
| 170 | - 'context' => array( 'view' ), |
|
| 170 | + 'context' => array('view'), |
|
| 171 | 171 | 'readonly' => true, |
| 172 | 172 | ), |
| 173 | 173 | 'quantity' => array( |
| 174 | - 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
| 174 | + 'description' => __('Total number of purchases.', 'invoicing'), |
|
| 175 | 175 | 'type' => 'number', |
| 176 | - 'context' => array( 'view' ), |
|
| 176 | + 'context' => array('view'), |
|
| 177 | 177 | 'readonly' => true, |
| 178 | 178 | ), |
| 179 | 179 | 'earnings' => array( |
| 180 | - 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
| 180 | + 'description' => __('Total earnings for the item.', 'invoicing'), |
|
| 181 | 181 | 'type' => 'number', |
| 182 | - 'context' => array( 'view' ), |
|
| 182 | + 'context' => array('view'), |
|
| 183 | 183 | 'readonly' => true, |
| 184 | 184 | ), |
| 185 | 185 | 'earnings_formatted"' => array( |
| 186 | - 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
| 186 | + 'description' => __('Total earnings (formatted) for the item.', 'invoicing'), |
|
| 187 | 187 | 'type' => 'string', |
| 188 | - 'context' => array( 'view' ), |
|
| 188 | + 'context' => array('view'), |
|
| 189 | 189 | 'readonly' => true, |
| 190 | 190 | ), |
| 191 | 191 | ), |
| 192 | 192 | ); |
| 193 | 193 | |
| 194 | - return $this->add_additional_fields_schema( $schema ); |
|
| 194 | + return $this->add_additional_fields_schema($schema); |
|
| 195 | 195 | } |
| 196 | 196 | } |
@@ -15,168 +15,168 @@ |
||
| 15 | 15 | class WPInv_REST_Items_Controller extends GetPaid_REST_Posts_Controller { |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | - * Post type. |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 22 | - protected $post_type = 'wpi_item'; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * The base of this controller's route. |
|
| 26 | - * |
|
| 27 | - * @since 1.0.13 |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $rest_base = 'items'; |
|
| 31 | - |
|
| 32 | - /** Contains this controller's class name. |
|
| 33 | - * |
|
| 34 | - * @var string |
|
| 35 | - */ |
|
| 36 | - public $crud_class = 'WPInv_Item'; |
|
| 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 . '/item-types', |
|
| 52 | - array( |
|
| 53 | - array( |
|
| 54 | - 'methods' => WP_REST_Server::READABLE, |
|
| 55 | - 'callback' => array( $this, 'get_item_types' ), |
|
| 56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 57 | - ), |
|
| 58 | - ) |
|
| 59 | - ); |
|
| 60 | - |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Handles rest requests for item 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_item_types() { |
|
| 72 | - return rest_ensure_response( wpinv_get_item_types() ); |
|
| 73 | - } |
|
| 18 | + * Post type. |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | + protected $post_type = 'wpi_item'; |
|
| 74 | 23 | |
| 75 | 24 | /** |
| 76 | - * Retrieves the query params for the items 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 | - parent::get_collection_params(), |
|
| 86 | - array( |
|
| 87 | - |
|
| 88 | - // Item types |
|
| 89 | - 'type' => array( |
|
| 90 | - 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
| 91 | - 'type' => array( 'array', 'string' ), |
|
| 92 | - 'default' => 'any', |
|
| 93 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 94 | - 'sanitize_callback' => 'wpinv_parse_list', |
|
| 95 | - 'items' => array( |
|
| 96 | - 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
| 97 | - 'type' => 'string', |
|
| 98 | - ), |
|
| 99 | - ), |
|
| 100 | - |
|
| 101 | - ) |
|
| 102 | - ); |
|
| 103 | - |
|
| 104 | - // Filter collection parameters for the items controller. |
|
| 105 | - return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
| 106 | - |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * Determine the allowed query_vars for a get_items() response and |
|
| 111 | - * prepare for WP_Query. |
|
| 112 | - * |
|
| 113 | - * @param array $prepared_args Prepared arguments. |
|
| 114 | - * @param WP_REST_Request $request Request object. |
|
| 115 | - * @return array $query_args |
|
| 116 | - */ |
|
| 117 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 118 | - |
|
| 119 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 120 | - |
|
| 121 | - // Retrieve items by type. |
|
| 122 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 123 | - |
|
| 124 | - if ( empty( $query_args['meta_query'] ) ) { |
|
| 125 | - $query_args['meta_query'] = array(); |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - $query_args['meta_query'][] = array( |
|
| 129 | - 'key' => '_wpinv_type', |
|
| 130 | - 'value' => implode( ',', $request['type'] ), |
|
| 131 | - 'compare' => 'IN', |
|
| 132 | - ); |
|
| 133 | - |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
| 137 | - |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * Retrieves a valid list of post statuses. |
|
| 142 | - * |
|
| 143 | - * @since 1.0.15 |
|
| 144 | - * |
|
| 145 | - * @return array A list of registered item statuses. |
|
| 146 | - */ |
|
| 147 | - public function get_post_statuses() { |
|
| 148 | - return array( 'draft', 'pending', 'publish' ); |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * Checks if a key should be included in a response. |
|
| 153 | - * |
|
| 154 | - * @since 1.0.19 |
|
| 155 | - * @param WPInv_Item $item Item object. |
|
| 156 | - * @param string $field_key The key to check for. |
|
| 157 | - * @return bool |
|
| 158 | - */ |
|
| 159 | - public function object_supports_field( $item, $field_key ) { |
|
| 160 | - |
|
| 161 | - if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
| 162 | - return false; |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
| 166 | - |
|
| 167 | - if ( $key == $field_key && ! $item->is_recurring() ) { |
|
| 168 | - return false; |
|
| 169 | - } |
|
| 25 | + * The base of this controller's route. |
|
| 26 | + * |
|
| 27 | + * @since 1.0.13 |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $rest_base = 'items'; |
|
| 31 | + |
|
| 32 | + /** Contains this controller's class name. |
|
| 33 | + * |
|
| 34 | + * @var string |
|
| 35 | + */ |
|
| 36 | + public $crud_class = 'WPInv_Item'; |
|
| 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 . '/item-types', |
|
| 52 | + array( |
|
| 53 | + array( |
|
| 54 | + 'methods' => WP_REST_Server::READABLE, |
|
| 55 | + 'callback' => array( $this, 'get_item_types' ), |
|
| 56 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 57 | + ), |
|
| 58 | + ) |
|
| 59 | + ); |
|
| 60 | + |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Handles rest requests for item 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_item_types() { |
|
| 72 | + return rest_ensure_response( wpinv_get_item_types() ); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * Retrieves the query params for the items 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 | + parent::get_collection_params(), |
|
| 86 | + array( |
|
| 87 | + |
|
| 88 | + // Item types |
|
| 89 | + 'type' => array( |
|
| 90 | + 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
| 91 | + 'type' => array( 'array', 'string' ), |
|
| 92 | + 'default' => 'any', |
|
| 93 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 94 | + 'sanitize_callback' => 'wpinv_parse_list', |
|
| 95 | + 'items' => array( |
|
| 96 | + 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
| 97 | + 'type' => 'string', |
|
| 98 | + ), |
|
| 99 | + ), |
|
| 100 | + |
|
| 101 | + ) |
|
| 102 | + ); |
|
| 103 | + |
|
| 104 | + // Filter collection parameters for the items controller. |
|
| 105 | + return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
| 106 | + |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * Determine the allowed query_vars for a get_items() response and |
|
| 111 | + * prepare for WP_Query. |
|
| 112 | + * |
|
| 113 | + * @param array $prepared_args Prepared arguments. |
|
| 114 | + * @param WP_REST_Request $request Request object. |
|
| 115 | + * @return array $query_args |
|
| 116 | + */ |
|
| 117 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 118 | + |
|
| 119 | + $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 120 | + |
|
| 121 | + // Retrieve items by type. |
|
| 122 | + if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 123 | + |
|
| 124 | + if ( empty( $query_args['meta_query'] ) ) { |
|
| 125 | + $query_args['meta_query'] = array(); |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + $query_args['meta_query'][] = array( |
|
| 129 | + 'key' => '_wpinv_type', |
|
| 130 | + 'value' => implode( ',', $request['type'] ), |
|
| 131 | + 'compare' => 'IN', |
|
| 132 | + ); |
|
| 133 | + |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
| 137 | + |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * Retrieves a valid list of post statuses. |
|
| 142 | + * |
|
| 143 | + * @since 1.0.15 |
|
| 144 | + * |
|
| 145 | + * @return array A list of registered item statuses. |
|
| 146 | + */ |
|
| 147 | + public function get_post_statuses() { |
|
| 148 | + return array( 'draft', 'pending', 'publish' ); |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * Checks if a key should be included in a response. |
|
| 153 | + * |
|
| 154 | + * @since 1.0.19 |
|
| 155 | + * @param WPInv_Item $item Item object. |
|
| 156 | + * @param string $field_key The key to check for. |
|
| 157 | + * @return bool |
|
| 158 | + */ |
|
| 159 | + public function object_supports_field( $item, $field_key ) { |
|
| 160 | + |
|
| 161 | + if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
| 162 | + return false; |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
| 166 | + |
|
| 167 | + if ( $key == $field_key && ! $item->is_recurring() ) { |
|
| 168 | + return false; |
|
| 169 | + } |
|
| 170 | 170 | } |
| 171 | 171 | |
| 172 | - foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
| 172 | + foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
| 173 | 173 | |
| 174 | - if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
| 175 | - return false; |
|
| 176 | - } |
|
| 174 | + if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
| 175 | + return false; |
|
| 176 | + } |
|
| 177 | 177 | } |
| 178 | 178 | |
| 179 | - return parent::object_supports_field( $item, $field_key ); |
|
| 180 | - } |
|
| 179 | + return parent::object_supports_field( $item, $field_key ); |
|
| 180 | + } |
|
| 181 | 181 | |
| 182 | 182 | } |
@@ -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 items 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_item_types' ), |
|
| 56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 55 | + 'callback' => array($this, 'get_item_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_item_types() { |
| 72 | - return rest_ensure_response( wpinv_get_item_types() ); |
|
| 72 | + return rest_ensure_response(wpinv_get_item_types()); |
|
| 73 | 73 | } |
| 74 | 74 | |
| 75 | 75 | /** |
@@ -87,13 +87,13 @@ discard block |
||
| 87 | 87 | |
| 88 | 88 | // Item types |
| 89 | 89 | 'type' => array( |
| 90 | - 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
| 91 | - 'type' => array( 'array', 'string' ), |
|
| 90 | + 'description' => __('Type of items to fetch.', 'invoicing'), |
|
| 91 | + 'type' => array('array', 'string'), |
|
| 92 | 92 | 'default' => 'any', |
| 93 | 93 | 'validate_callback' => 'rest_validate_request_arg', |
| 94 | 94 | 'sanitize_callback' => 'wpinv_parse_list', |
| 95 | 95 | 'items' => array( |
| 96 | - 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
| 96 | + 'enum' => array_merge(array('any'), wpinv_item_types()), |
|
| 97 | 97 | 'type' => 'string', |
| 98 | 98 | ), |
| 99 | 99 | ), |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | ); |
| 103 | 103 | |
| 104 | 104 | // Filter collection parameters for the items controller. |
| 105 | - return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
| 105 | + return apply_filters('getpaid_rest_items_collection_params', $params, $this); |
|
| 106 | 106 | |
| 107 | 107 | } |
| 108 | 108 | |
@@ -114,26 +114,26 @@ discard block |
||
| 114 | 114 | * @param WP_REST_Request $request Request object. |
| 115 | 115 | * @return array $query_args |
| 116 | 116 | */ |
| 117 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 117 | + protected function prepare_items_query($prepared_args = array(), $request = null) { |
|
| 118 | 118 | |
| 119 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 119 | + $query_args = parent::prepare_items_query($prepared_args); |
|
| 120 | 120 | |
| 121 | 121 | // Retrieve items by type. |
| 122 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 122 | + if (!in_array('any', $request['type'])) { |
|
| 123 | 123 | |
| 124 | - if ( empty( $query_args['meta_query'] ) ) { |
|
| 124 | + if (empty($query_args['meta_query'])) { |
|
| 125 | 125 | $query_args['meta_query'] = array(); |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | 128 | $query_args['meta_query'][] = array( |
| 129 | 129 | 'key' => '_wpinv_type', |
| 130 | - 'value' => implode( ',', $request['type'] ), |
|
| 130 | + 'value' => implode(',', $request['type']), |
|
| 131 | 131 | 'compare' => 'IN', |
| 132 | 132 | ); |
| 133 | 133 | |
| 134 | 134 | } |
| 135 | 135 | |
| 136 | - return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
| 136 | + return apply_filters('getpaid_rest_items_prepare_items_query', $query_args, $request, $this); |
|
| 137 | 137 | |
| 138 | 138 | } |
| 139 | 139 | |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | * @return array A list of registered item statuses. |
| 146 | 146 | */ |
| 147 | 147 | public function get_post_statuses() { |
| 148 | - return array( 'draft', 'pending', 'publish' ); |
|
| 148 | + return array('draft', 'pending', 'publish'); |
|
| 149 | 149 | } |
| 150 | 150 | |
| 151 | 151 | /** |
@@ -156,27 +156,27 @@ discard block |
||
| 156 | 156 | * @param string $field_key The key to check for. |
| 157 | 157 | * @return bool |
| 158 | 158 | */ |
| 159 | - public function object_supports_field( $item, $field_key ) { |
|
| 159 | + public function object_supports_field($item, $field_key) { |
|
| 160 | 160 | |
| 161 | - if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
| 161 | + if ('minimum_price' == $field_key && !$item->user_can_set_their_price()) { |
|
| 162 | 162 | return false; |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
| 165 | + foreach (wpinv_parse_list('initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date') as $key) { |
|
| 166 | 166 | |
| 167 | - if ( $key == $field_key && ! $item->is_recurring() ) { |
|
| 167 | + if ($key == $field_key && !$item->is_recurring()) { |
|
| 168 | 168 | return false; |
| 169 | 169 | } |
| 170 | 170 | } |
| 171 | 171 | |
| 172 | - foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
| 172 | + foreach (wpinv_parse_list('trial_period trial_interval') as $key) { |
|
| 173 | 173 | |
| 174 | - if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
| 174 | + if ($key == $field_key && !$item->has_free_trial()) { |
|
| 175 | 175 | return false; |
| 176 | 176 | } |
| 177 | 177 | } |
| 178 | 178 | |
| 179 | - return parent::object_supports_field( $item, $field_key ); |
|
| 179 | + return parent::object_supports_field($item, $field_key); |
|
| 180 | 180 | } |
| 181 | 181 | |
| 182 | 182 | } |
@@ -15,136 +15,136 @@ |
||
| 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 | - parent::get_collection_params(), |
|
| 86 | - array( |
|
| 87 | - |
|
| 88 | - // Discount types |
|
| 89 | - 'type' => array( |
|
| 90 | - 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
| 91 | - 'type' => array( 'array', 'string' ), |
|
| 92 | - 'default' => 'any', |
|
| 93 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 94 | - 'sanitize_callback' => 'wpinv_parse_list', |
|
| 95 | - 'items' => array( |
|
| 96 | - 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
| 97 | - 'type' => 'string', |
|
| 98 | - ), |
|
| 99 | - ), |
|
| 100 | - |
|
| 101 | - ) |
|
| 102 | - ); |
|
| 103 | - |
|
| 104 | - // Filter collection parameters for the discounts controller. |
|
| 105 | - return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Determine the allowed query_vars for a get_items() response and |
|
| 110 | - * prepare for WP_Query. |
|
| 111 | - * |
|
| 112 | - * @param array $prepared_args Prepared arguments. |
|
| 113 | - * @param WP_REST_Request $request Request object. |
|
| 114 | - * @return array $query_args |
|
| 115 | - */ |
|
| 116 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 117 | - |
|
| 118 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 119 | - |
|
| 120 | - // Retrieve items by type. |
|
| 121 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 122 | - |
|
| 123 | - if ( empty( $query_args['meta_query'] ) ) { |
|
| 124 | - $query_args['meta_query'] = array(); |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - $query_args['meta_query'][] = array( |
|
| 128 | - 'key' => '_wpi_discount_type', |
|
| 129 | - 'value' => implode( ',', $request['type'] ), |
|
| 130 | - 'compare' => 'IN', |
|
| 131 | - ); |
|
| 132 | - |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
| 136 | - |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * Retrieves a valid list of post statuses. |
|
| 141 | - * |
|
| 142 | - * @since 1.0.15 |
|
| 143 | - * |
|
| 144 | - * @return array A list of registered item statuses. |
|
| 145 | - */ |
|
| 146 | - public function get_post_statuses() { |
|
| 147 | - return array( 'publish', 'pending', 'draft', 'expired' ); |
|
| 148 | - } |
|
| 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 | + parent::get_collection_params(), |
|
| 86 | + array( |
|
| 87 | + |
|
| 88 | + // Discount types |
|
| 89 | + 'type' => array( |
|
| 90 | + 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
| 91 | + 'type' => array( 'array', 'string' ), |
|
| 92 | + 'default' => 'any', |
|
| 93 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 94 | + 'sanitize_callback' => 'wpinv_parse_list', |
|
| 95 | + 'items' => array( |
|
| 96 | + 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
| 97 | + 'type' => 'string', |
|
| 98 | + ), |
|
| 99 | + ), |
|
| 100 | + |
|
| 101 | + ) |
|
| 102 | + ); |
|
| 103 | + |
|
| 104 | + // Filter collection parameters for the discounts controller. |
|
| 105 | + return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Determine the allowed query_vars for a get_items() response and |
|
| 110 | + * prepare for WP_Query. |
|
| 111 | + * |
|
| 112 | + * @param array $prepared_args Prepared arguments. |
|
| 113 | + * @param WP_REST_Request $request Request object. |
|
| 114 | + * @return array $query_args |
|
| 115 | + */ |
|
| 116 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 117 | + |
|
| 118 | + $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 119 | + |
|
| 120 | + // Retrieve items by type. |
|
| 121 | + if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 122 | + |
|
| 123 | + if ( empty( $query_args['meta_query'] ) ) { |
|
| 124 | + $query_args['meta_query'] = array(); |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + $query_args['meta_query'][] = array( |
|
| 128 | + 'key' => '_wpi_discount_type', |
|
| 129 | + 'value' => implode( ',', $request['type'] ), |
|
| 130 | + 'compare' => 'IN', |
|
| 131 | + ); |
|
| 132 | + |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
| 136 | + |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * Retrieves a valid list of post statuses. |
|
| 141 | + * |
|
| 142 | + * @since 1.0.15 |
|
| 143 | + * |
|
| 144 | + * @return array A list of registered item statuses. |
|
| 145 | + */ |
|
| 146 | + public function get_post_statuses() { |
|
| 147 | + return array( 'publish', 'pending', 'draft', 'expired' ); |
|
| 148 | + } |
|
| 149 | 149 | |
| 150 | 150 | } |
@@ -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 | /** |
@@ -87,13 +87,13 @@ discard block |
||
| 87 | 87 | |
| 88 | 88 | // Discount types |
| 89 | 89 | 'type' => array( |
| 90 | - 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
| 91 | - 'type' => array( 'array', 'string' ), |
|
| 90 | + 'description' => __('Type of discounts to fetch.', 'invoicing'), |
|
| 91 | + 'type' => array('array', 'string'), |
|
| 92 | 92 | 'default' => 'any', |
| 93 | 93 | 'validate_callback' => 'rest_validate_request_arg', |
| 94 | 94 | 'sanitize_callback' => 'wpinv_parse_list', |
| 95 | 95 | 'items' => array( |
| 96 | - 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
| 96 | + 'enum' => array_merge(array('any'), array_keys(wpinv_get_discount_types())), |
|
| 97 | 97 | 'type' => 'string', |
| 98 | 98 | ), |
| 99 | 99 | ), |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | ); |
| 103 | 103 | |
| 104 | 104 | // Filter collection parameters for the discounts controller. |
| 105 | - return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
| 105 | + return apply_filters('getpaid_rest_discounts_collection_params', $params, $this); |
|
| 106 | 106 | } |
| 107 | 107 | |
| 108 | 108 | /** |
@@ -113,26 +113,26 @@ discard block |
||
| 113 | 113 | * @param WP_REST_Request $request Request object. |
| 114 | 114 | * @return array $query_args |
| 115 | 115 | */ |
| 116 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 116 | + protected function prepare_items_query($prepared_args = array(), $request = null) { |
|
| 117 | 117 | |
| 118 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 118 | + $query_args = parent::prepare_items_query($prepared_args); |
|
| 119 | 119 | |
| 120 | 120 | // Retrieve items by type. |
| 121 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
| 121 | + if (!in_array('any', $request['type'])) { |
|
| 122 | 122 | |
| 123 | - if ( empty( $query_args['meta_query'] ) ) { |
|
| 123 | + if (empty($query_args['meta_query'])) { |
|
| 124 | 124 | $query_args['meta_query'] = array(); |
| 125 | 125 | } |
| 126 | 126 | |
| 127 | 127 | $query_args['meta_query'][] = array( |
| 128 | 128 | 'key' => '_wpi_discount_type', |
| 129 | - 'value' => implode( ',', $request['type'] ), |
|
| 129 | + 'value' => implode(',', $request['type']), |
|
| 130 | 130 | 'compare' => 'IN', |
| 131 | 131 | ); |
| 132 | 132 | |
| 133 | 133 | } |
| 134 | 134 | |
| 135 | - return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
| 135 | + return apply_filters('getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this); |
|
| 136 | 136 | |
| 137 | 137 | } |
| 138 | 138 | |
@@ -144,7 +144,7 @@ discard block |
||
| 144 | 144 | * @return array A list of registered item statuses. |
| 145 | 145 | */ |
| 146 | 146 | public function get_post_statuses() { |
| 147 | - return array( 'publish', 'pending', 'draft', 'expired' ); |
|
| 147 | + return array('publish', 'pending', 'draft', 'expired'); |
|
| 148 | 148 | } |
| 149 | 149 | |
| 150 | 150 | } |
@@ -17,474 +17,474 @@ |
||
| 17 | 17 | */ |
| 18 | 18 | class GetPaid_REST_CRUD_Controller extends GetPaid_REST_Controller { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * Contains this controller's class name. |
|
| 22 | - * |
|
| 23 | - * @var string |
|
| 24 | - */ |
|
| 25 | - public $crud_class; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * Contains the current CRUD object. |
|
| 29 | - * |
|
| 30 | - * @var GetPaid_Data |
|
| 31 | - */ |
|
| 32 | - protected $data_object; |
|
| 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 | - register_rest_route( |
|
| 44 | - $namespace, |
|
| 45 | - '/' . $this->rest_base, |
|
| 46 | - array( |
|
| 47 | - array( |
|
| 48 | - 'methods' => WP_REST_Server::READABLE, |
|
| 49 | - 'callback' => array( $this, 'get_items' ), |
|
| 50 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 51 | - 'args' => $this->get_collection_params(), |
|
| 52 | - ), |
|
| 53 | - array( |
|
| 54 | - 'methods' => WP_REST_Server::CREATABLE, |
|
| 55 | - 'callback' => array( $this, 'create_item' ), |
|
| 56 | - 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
| 57 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
| 58 | - ), |
|
| 59 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 60 | - ) |
|
| 61 | - ); |
|
| 62 | - |
|
| 63 | - $get_item_args = array( |
|
| 64 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 65 | - ); |
|
| 66 | - |
|
| 67 | - register_rest_route( |
|
| 68 | - $namespace, |
|
| 69 | - '/' . $this->rest_base . '/(?P<id>[\d]+)', |
|
| 70 | - array( |
|
| 71 | - 'args' => array( |
|
| 72 | - 'id' => array( |
|
| 73 | - 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
| 74 | - 'type' => 'integer', |
|
| 75 | - ), |
|
| 76 | - ), |
|
| 77 | - array( |
|
| 78 | - 'methods' => WP_REST_Server::READABLE, |
|
| 79 | - 'callback' => array( $this, 'get_item' ), |
|
| 80 | - 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
| 81 | - 'args' => $get_item_args, |
|
| 82 | - ), |
|
| 83 | - array( |
|
| 84 | - 'methods' => WP_REST_Server::EDITABLE, |
|
| 85 | - 'callback' => array( $this, 'update_item' ), |
|
| 86 | - 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
| 87 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 88 | - ), |
|
| 89 | - array( |
|
| 90 | - 'methods' => WP_REST_Server::DELETABLE, |
|
| 91 | - 'callback' => array( $this, 'delete_item' ), |
|
| 92 | - 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
| 93 | - 'args' => array( |
|
| 94 | - 'force' => array( |
|
| 95 | - 'type' => 'boolean', |
|
| 96 | - 'default' => false, |
|
| 97 | - 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
| 98 | - ), |
|
| 99 | - ), |
|
| 100 | - ), |
|
| 101 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 102 | - ) |
|
| 103 | - ); |
|
| 104 | - |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Saves a single object. |
|
| 109 | - * |
|
| 110 | - * @param GetPaid_Data $object Object to save. |
|
| 111 | - * @return WP_Error|GetPaid_Data |
|
| 112 | - */ |
|
| 113 | - protected function save_object( $object ) { |
|
| 114 | - $object->save(); |
|
| 115 | - |
|
| 116 | - if ( ! empty( $object->last_error ) ) { |
|
| 117 | - return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - return new $this->crud_class( $object->get_id() ); |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Retrieves a single object. |
|
| 125 | - * |
|
| 126 | - * @since 1.0.13 |
|
| 127 | - * |
|
| 128 | - * @param int|WP_Post $object_id Supplied ID. |
|
| 129 | - * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
|
| 130 | - */ |
|
| 131 | - protected function get_object( $object_id ) { |
|
| 132 | - |
|
| 133 | - // Do we have an object? |
|
| 134 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 135 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - // Fetch the object. |
|
| 139 | - $object = new $this->crud_class( $object_id ); |
|
| 140 | - if ( ! empty( $object->last_error ) ) { |
|
| 141 | - return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - $this->data_object = $object; |
|
| 145 | - return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 146 | - |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - /** |
|
| 150 | - * Get a single object. |
|
| 151 | - * |
|
| 152 | - * @param WP_REST_Request $request Full details about the request. |
|
| 153 | - * @return WP_Error|WP_REST_Response |
|
| 154 | - */ |
|
| 155 | - public function get_item( $request ) { |
|
| 156 | - |
|
| 157 | - // Fetch the item. |
|
| 158 | - $object = $this->get_object( $request['id'] ); |
|
| 159 | - |
|
| 160 | - if ( is_wp_error( $object ) ) { |
|
| 161 | - return $object; |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - // Generate a response. |
|
| 165 | - return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
| 166 | - |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * Create a single object. |
|
| 171 | - * |
|
| 172 | - * @param WP_REST_Request $request Full details about the request. |
|
| 173 | - * @return WP_Error|WP_REST_Response |
|
| 174 | - */ |
|
| 175 | - public function create_item( $request ) { |
|
| 176 | - |
|
| 177 | - // Can not create an existing item. |
|
| 178 | - if ( ! empty( $request['id'] ) ) { |
|
| 179 | - /* translators: %s: post type */ |
|
| 180 | - return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - // Generate a GetPaid_Data object from the request. |
|
| 184 | - $object = $this->prepare_item_for_database( $request ); |
|
| 185 | - if ( is_wp_error( $object ) ) { |
|
| 186 | - return $object; |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - // Save the object. |
|
| 190 | - $object = $this->save_object( $object ); |
|
| 191 | - if ( is_wp_error( $object ) ) { |
|
| 192 | - return $object; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - // Save special fields. |
|
| 196 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 197 | - if ( is_wp_error( $save_special ) ) { |
|
| 198 | - $object->delete( true ); |
|
| 199 | - return $save_special; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - $request->set_param( 'context', 'edit' ); |
|
| 203 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 204 | - $response = rest_ensure_response( $response ); |
|
| 205 | - $response->set_status( 201 ); |
|
| 206 | - $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
| 207 | - |
|
| 208 | - return $response; |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * Update a single object. |
|
| 213 | - * |
|
| 214 | - * @param WP_REST_Request $request Full details about the request. |
|
| 215 | - * @return WP_Error|WP_REST_Response |
|
| 216 | - */ |
|
| 217 | - public function update_item( $request ) { |
|
| 218 | - |
|
| 219 | - // Fetch the item. |
|
| 220 | - $object = $this->get_object( $request['id'] ); |
|
| 221 | - if ( is_wp_error( $object ) ) { |
|
| 222 | - return $object; |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - // Prepare the item for saving. |
|
| 226 | - $object = $this->prepare_item_for_database( $request ); |
|
| 227 | - if ( is_wp_error( $object ) ) { |
|
| 228 | - return $object; |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - // Save the item. |
|
| 232 | - $object = $this->save_object( $object ); |
|
| 233 | - if ( is_wp_error( $object ) ) { |
|
| 234 | - return $object; |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - // Save special fields (those added via hooks). |
|
| 238 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 239 | - if ( is_wp_error( $save_special ) ) { |
|
| 240 | - return $save_special; |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - $request->set_param( 'context', 'edit' ); |
|
| 244 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 245 | - return rest_ensure_response( $response ); |
|
| 246 | - } |
|
| 247 | - |
|
| 248 | - /** |
|
| 249 | - * Prepare links for the request. |
|
| 250 | - * |
|
| 251 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 252 | - * @return array Links for the given object. |
|
| 253 | - */ |
|
| 254 | - protected function prepare_links( $object ) { |
|
| 255 | - |
|
| 256 | - $links = array( |
|
| 257 | - 'self' => array( |
|
| 258 | - 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
| 259 | - ), |
|
| 260 | - 'collection' => array( |
|
| 261 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 262 | - ), |
|
| 263 | - ); |
|
| 264 | - |
|
| 265 | - return $links; |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Get the query params for collections of attachments. |
|
| 270 | - * |
|
| 271 | - * @return array |
|
| 272 | - */ |
|
| 273 | - public function get_collection_params() { |
|
| 274 | - $params = parent::get_collection_params(); |
|
| 275 | - $params['context']['default'] = 'view'; |
|
| 276 | - return $params; |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * Only return writable props from schema. |
|
| 281 | - * |
|
| 282 | - * @param array $schema Schema. |
|
| 283 | - * @return bool |
|
| 284 | - */ |
|
| 285 | - public function filter_writable_props( $schema ) { |
|
| 286 | - return empty( $schema['readonly'] ); |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * Prepare a single object for create or update. |
|
| 291 | - * |
|
| 292 | - * @since 1.0.19 |
|
| 293 | - * @param WP_REST_Request $request Request object. |
|
| 294 | - * @return GetPaid_Data|WP_Error Data object or WP_Error. |
|
| 295 | - */ |
|
| 296 | - protected function prepare_item_for_database( $request ) { |
|
| 297 | - |
|
| 298 | - // Do we have an object? |
|
| 299 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 300 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - // Prepare the object. |
|
| 304 | - $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
| 305 | - $object = new $this->crud_class( $id ); |
|
| 306 | - |
|
| 307 | - // Abort if an error exists. |
|
| 308 | - if ( ! empty( $object->last_error ) ) { |
|
| 309 | - return new WP_Error( 'invalid_item', $object->last_error ); |
|
| 310 | - } |
|
| 311 | - |
|
| 312 | - $schema = $this->get_item_schema(); |
|
| 313 | - $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
| 314 | - |
|
| 315 | - // Handle all writable props. |
|
| 316 | - foreach ( $data_keys as $key ) { |
|
| 317 | - $value = $request[ $key ]; |
|
| 318 | - |
|
| 319 | - if ( ! is_null( $value ) ) { |
|
| 320 | - switch ( $key ) { |
|
| 321 | - |
|
| 322 | - case 'meta_data': |
|
| 323 | - if ( is_array( $value ) ) { |
|
| 324 | - foreach ( $value as $meta ) { |
|
| 325 | - $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
| 326 | - } |
|
| 327 | - } |
|
| 328 | - break; |
|
| 329 | - |
|
| 330 | - default: |
|
| 331 | - if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
| 332 | - $object->{"set_{$key}"}( $value ); |
|
| 333 | - } |
|
| 334 | - break; |
|
| 335 | - } |
|
| 336 | - } |
|
| 20 | + /** |
|
| 21 | + * Contains this controller's class name. |
|
| 22 | + * |
|
| 23 | + * @var string |
|
| 24 | + */ |
|
| 25 | + public $crud_class; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Contains the current CRUD object. |
|
| 29 | + * |
|
| 30 | + * @var GetPaid_Data |
|
| 31 | + */ |
|
| 32 | + protected $data_object; |
|
| 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 | + register_rest_route( |
|
| 44 | + $namespace, |
|
| 45 | + '/' . $this->rest_base, |
|
| 46 | + array( |
|
| 47 | + array( |
|
| 48 | + 'methods' => WP_REST_Server::READABLE, |
|
| 49 | + 'callback' => array( $this, 'get_items' ), |
|
| 50 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 51 | + 'args' => $this->get_collection_params(), |
|
| 52 | + ), |
|
| 53 | + array( |
|
| 54 | + 'methods' => WP_REST_Server::CREATABLE, |
|
| 55 | + 'callback' => array( $this, 'create_item' ), |
|
| 56 | + 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
| 57 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
| 58 | + ), |
|
| 59 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 60 | + ) |
|
| 61 | + ); |
|
| 62 | + |
|
| 63 | + $get_item_args = array( |
|
| 64 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 65 | + ); |
|
| 66 | + |
|
| 67 | + register_rest_route( |
|
| 68 | + $namespace, |
|
| 69 | + '/' . $this->rest_base . '/(?P<id>[\d]+)', |
|
| 70 | + array( |
|
| 71 | + 'args' => array( |
|
| 72 | + 'id' => array( |
|
| 73 | + 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
| 74 | + 'type' => 'integer', |
|
| 75 | + ), |
|
| 76 | + ), |
|
| 77 | + array( |
|
| 78 | + 'methods' => WP_REST_Server::READABLE, |
|
| 79 | + 'callback' => array( $this, 'get_item' ), |
|
| 80 | + 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
| 81 | + 'args' => $get_item_args, |
|
| 82 | + ), |
|
| 83 | + array( |
|
| 84 | + 'methods' => WP_REST_Server::EDITABLE, |
|
| 85 | + 'callback' => array( $this, 'update_item' ), |
|
| 86 | + 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
| 87 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 88 | + ), |
|
| 89 | + array( |
|
| 90 | + 'methods' => WP_REST_Server::DELETABLE, |
|
| 91 | + 'callback' => array( $this, 'delete_item' ), |
|
| 92 | + 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
| 93 | + 'args' => array( |
|
| 94 | + 'force' => array( |
|
| 95 | + 'type' => 'boolean', |
|
| 96 | + 'default' => false, |
|
| 97 | + 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
| 98 | + ), |
|
| 99 | + ), |
|
| 100 | + ), |
|
| 101 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 102 | + ) |
|
| 103 | + ); |
|
| 104 | + |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Saves a single object. |
|
| 109 | + * |
|
| 110 | + * @param GetPaid_Data $object Object to save. |
|
| 111 | + * @return WP_Error|GetPaid_Data |
|
| 112 | + */ |
|
| 113 | + protected function save_object( $object ) { |
|
| 114 | + $object->save(); |
|
| 115 | + |
|
| 116 | + if ( ! empty( $object->last_error ) ) { |
|
| 117 | + return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + return new $this->crud_class( $object->get_id() ); |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Retrieves a single object. |
|
| 125 | + * |
|
| 126 | + * @since 1.0.13 |
|
| 127 | + * |
|
| 128 | + * @param int|WP_Post $object_id Supplied ID. |
|
| 129 | + * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
|
| 130 | + */ |
|
| 131 | + protected function get_object( $object_id ) { |
|
| 132 | + |
|
| 133 | + // Do we have an object? |
|
| 134 | + if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 135 | + return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + // Fetch the object. |
|
| 139 | + $object = new $this->crud_class( $object_id ); |
|
| 140 | + if ( ! empty( $object->last_error ) ) { |
|
| 141 | + return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + $this->data_object = $object; |
|
| 145 | + return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 146 | + |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + /** |
|
| 150 | + * Get a single object. |
|
| 151 | + * |
|
| 152 | + * @param WP_REST_Request $request Full details about the request. |
|
| 153 | + * @return WP_Error|WP_REST_Response |
|
| 154 | + */ |
|
| 155 | + public function get_item( $request ) { |
|
| 156 | + |
|
| 157 | + // Fetch the item. |
|
| 158 | + $object = $this->get_object( $request['id'] ); |
|
| 159 | + |
|
| 160 | + if ( is_wp_error( $object ) ) { |
|
| 161 | + return $object; |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + // Generate a response. |
|
| 165 | + return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
| 166 | + |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * Create a single object. |
|
| 171 | + * |
|
| 172 | + * @param WP_REST_Request $request Full details about the request. |
|
| 173 | + * @return WP_Error|WP_REST_Response |
|
| 174 | + */ |
|
| 175 | + public function create_item( $request ) { |
|
| 176 | + |
|
| 177 | + // Can not create an existing item. |
|
| 178 | + if ( ! empty( $request['id'] ) ) { |
|
| 179 | + /* translators: %s: post type */ |
|
| 180 | + return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + // Generate a GetPaid_Data object from the request. |
|
| 184 | + $object = $this->prepare_item_for_database( $request ); |
|
| 185 | + if ( is_wp_error( $object ) ) { |
|
| 186 | + return $object; |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + // Save the object. |
|
| 190 | + $object = $this->save_object( $object ); |
|
| 191 | + if ( is_wp_error( $object ) ) { |
|
| 192 | + return $object; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + // Save special fields. |
|
| 196 | + $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 197 | + if ( is_wp_error( $save_special ) ) { |
|
| 198 | + $object->delete( true ); |
|
| 199 | + return $save_special; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + $request->set_param( 'context', 'edit' ); |
|
| 203 | + $response = $this->prepare_item_for_response( $object, $request ); |
|
| 204 | + $response = rest_ensure_response( $response ); |
|
| 205 | + $response->set_status( 201 ); |
|
| 206 | + $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
| 207 | + |
|
| 208 | + return $response; |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * Update a single object. |
|
| 213 | + * |
|
| 214 | + * @param WP_REST_Request $request Full details about the request. |
|
| 215 | + * @return WP_Error|WP_REST_Response |
|
| 216 | + */ |
|
| 217 | + public function update_item( $request ) { |
|
| 218 | + |
|
| 219 | + // Fetch the item. |
|
| 220 | + $object = $this->get_object( $request['id'] ); |
|
| 221 | + if ( is_wp_error( $object ) ) { |
|
| 222 | + return $object; |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + // Prepare the item for saving. |
|
| 226 | + $object = $this->prepare_item_for_database( $request ); |
|
| 227 | + if ( is_wp_error( $object ) ) { |
|
| 228 | + return $object; |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + // Save the item. |
|
| 232 | + $object = $this->save_object( $object ); |
|
| 233 | + if ( is_wp_error( $object ) ) { |
|
| 234 | + return $object; |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + // Save special fields (those added via hooks). |
|
| 238 | + $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 239 | + if ( is_wp_error( $save_special ) ) { |
|
| 240 | + return $save_special; |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + $request->set_param( 'context', 'edit' ); |
|
| 244 | + $response = $this->prepare_item_for_response( $object, $request ); |
|
| 245 | + return rest_ensure_response( $response ); |
|
| 246 | + } |
|
| 247 | + |
|
| 248 | + /** |
|
| 249 | + * Prepare links for the request. |
|
| 250 | + * |
|
| 251 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 252 | + * @return array Links for the given object. |
|
| 253 | + */ |
|
| 254 | + protected function prepare_links( $object ) { |
|
| 255 | + |
|
| 256 | + $links = array( |
|
| 257 | + 'self' => array( |
|
| 258 | + 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
| 259 | + ), |
|
| 260 | + 'collection' => array( |
|
| 261 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 262 | + ), |
|
| 263 | + ); |
|
| 264 | + |
|
| 265 | + return $links; |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Get the query params for collections of attachments. |
|
| 270 | + * |
|
| 271 | + * @return array |
|
| 272 | + */ |
|
| 273 | + public function get_collection_params() { |
|
| 274 | + $params = parent::get_collection_params(); |
|
| 275 | + $params['context']['default'] = 'view'; |
|
| 276 | + return $params; |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * Only return writable props from schema. |
|
| 281 | + * |
|
| 282 | + * @param array $schema Schema. |
|
| 283 | + * @return bool |
|
| 284 | + */ |
|
| 285 | + public function filter_writable_props( $schema ) { |
|
| 286 | + return empty( $schema['readonly'] ); |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * Prepare a single object for create or update. |
|
| 291 | + * |
|
| 292 | + * @since 1.0.19 |
|
| 293 | + * @param WP_REST_Request $request Request object. |
|
| 294 | + * @return GetPaid_Data|WP_Error Data object or WP_Error. |
|
| 295 | + */ |
|
| 296 | + protected function prepare_item_for_database( $request ) { |
|
| 297 | + |
|
| 298 | + // Do we have an object? |
|
| 299 | + if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 300 | + return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + // Prepare the object. |
|
| 304 | + $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
| 305 | + $object = new $this->crud_class( $id ); |
|
| 306 | + |
|
| 307 | + // Abort if an error exists. |
|
| 308 | + if ( ! empty( $object->last_error ) ) { |
|
| 309 | + return new WP_Error( 'invalid_item', $object->last_error ); |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + $schema = $this->get_item_schema(); |
|
| 313 | + $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
| 314 | + |
|
| 315 | + // Handle all writable props. |
|
| 316 | + foreach ( $data_keys as $key ) { |
|
| 317 | + $value = $request[ $key ]; |
|
| 318 | + |
|
| 319 | + if ( ! is_null( $value ) ) { |
|
| 320 | + switch ( $key ) { |
|
| 321 | + |
|
| 322 | + case 'meta_data': |
|
| 323 | + if ( is_array( $value ) ) { |
|
| 324 | + foreach ( $value as $meta ) { |
|
| 325 | + $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
| 326 | + } |
|
| 327 | + } |
|
| 328 | + break; |
|
| 329 | + |
|
| 330 | + default: |
|
| 331 | + if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
| 332 | + $object->{"set_{$key}"}( $value ); |
|
| 333 | + } |
|
| 334 | + break; |
|
| 335 | + } |
|
| 336 | + } |
|
| 337 | 337 | } |
| 338 | 338 | |
| 339 | - // Filters an object before it is inserted via the REST API.. |
|
| 340 | - return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - /** |
|
| 344 | - * Retrieves data from a GetPaid class. |
|
| 345 | - * |
|
| 346 | - * @since 1.0.19 |
|
| 347 | - * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
|
| 348 | - * @return array |
|
| 349 | - */ |
|
| 350 | - protected function prepare_object_meta_data( $meta_data ) { |
|
| 351 | - $meta = array(); |
|
| 352 | - |
|
| 353 | - foreach ( $meta_data as $object ) { |
|
| 354 | - $meta[] = $object->get_data(); |
|
| 355 | - } |
|
| 356 | - |
|
| 357 | - return $meta; |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * Retrieves invoice items. |
|
| 362 | - * |
|
| 363 | - * @since 1.0.19 |
|
| 364 | - * @param WPInv_Invoice $invoice Invoice items. |
|
| 365 | - * @param array $fields Fields to include. |
|
| 366 | - * @return array |
|
| 367 | - */ |
|
| 368 | - protected function prepare_invoice_items( $invoice ) { |
|
| 369 | - $items = array(); |
|
| 370 | - |
|
| 371 | - foreach ( $invoice->get_items() as $item ) { |
|
| 372 | - |
|
| 373 | - $item_data = $item->prepare_data_for_saving(); |
|
| 374 | - |
|
| 375 | - if ( 'amount' == $invoice->get_template() ) { |
|
| 376 | - $item_data['quantity'] = 1; |
|
| 377 | - } |
|
| 378 | - |
|
| 379 | - $items[] = $item_data; |
|
| 380 | - } |
|
| 381 | - |
|
| 382 | - return $items; |
|
| 383 | - } |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * Retrieves data from a GetPaid class. |
|
| 387 | - * |
|
| 388 | - * @since 1.0.19 |
|
| 389 | - * @param GetPaid_Data $object Data object. |
|
| 390 | - * @param array $fields Fields to include. |
|
| 391 | - * @param string $context either view or edit. |
|
| 392 | - * @return array |
|
| 393 | - */ |
|
| 394 | - protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
| 395 | - |
|
| 396 | - $data = array(); |
|
| 397 | - |
|
| 398 | - // Handle all writable props. |
|
| 399 | - foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
| 400 | - |
|
| 401 | - // Abort if it is not included. |
|
| 402 | - if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
| 403 | - continue; |
|
| 404 | - } |
|
| 405 | - |
|
| 406 | - // Or this current object does not support the field. |
|
| 407 | - if ( ! $this->object_supports_field( $object, $key ) ) { |
|
| 408 | - continue; |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - // Handle meta data. |
|
| 412 | - if ( $key == 'meta_data' ) { |
|
| 413 | - $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
| 414 | - continue; |
|
| 415 | - } |
|
| 416 | - |
|
| 417 | - // Handle items. |
|
| 418 | - if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 419 | - $data['items'] = $this->prepare_invoice_items( $object ); |
|
| 420 | - continue; |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - // Booleans. |
|
| 424 | - if ( is_callable( array( $object, $key ) ) ) { |
|
| 425 | - $data[ $key ] = $object->$key( $context ); |
|
| 426 | - continue; |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - // Get object value. |
|
| 430 | - if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
| 431 | - $value = $object->{"get_{$key}"}( $context ); |
|
| 432 | - |
|
| 433 | - // If the value is an instance of GetPaid_Data... |
|
| 434 | - if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
| 435 | - $value = $value->get_data( $context ); |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - // For objects, retrieves it's properties. |
|
| 439 | - $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value; |
|
| 440 | - continue; |
|
| 441 | - } |
|
| 339 | + // Filters an object before it is inserted via the REST API.. |
|
| 340 | + return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + /** |
|
| 344 | + * Retrieves data from a GetPaid class. |
|
| 345 | + * |
|
| 346 | + * @since 1.0.19 |
|
| 347 | + * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
|
| 348 | + * @return array |
|
| 349 | + */ |
|
| 350 | + protected function prepare_object_meta_data( $meta_data ) { |
|
| 351 | + $meta = array(); |
|
| 352 | + |
|
| 353 | + foreach ( $meta_data as $object ) { |
|
| 354 | + $meta[] = $object->get_data(); |
|
| 355 | + } |
|
| 356 | + |
|
| 357 | + return $meta; |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * Retrieves invoice items. |
|
| 362 | + * |
|
| 363 | + * @since 1.0.19 |
|
| 364 | + * @param WPInv_Invoice $invoice Invoice items. |
|
| 365 | + * @param array $fields Fields to include. |
|
| 366 | + * @return array |
|
| 367 | + */ |
|
| 368 | + protected function prepare_invoice_items( $invoice ) { |
|
| 369 | + $items = array(); |
|
| 370 | + |
|
| 371 | + foreach ( $invoice->get_items() as $item ) { |
|
| 372 | + |
|
| 373 | + $item_data = $item->prepare_data_for_saving(); |
|
| 374 | + |
|
| 375 | + if ( 'amount' == $invoice->get_template() ) { |
|
| 376 | + $item_data['quantity'] = 1; |
|
| 377 | + } |
|
| 378 | + |
|
| 379 | + $items[] = $item_data; |
|
| 380 | + } |
|
| 381 | + |
|
| 382 | + return $items; |
|
| 383 | + } |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * Retrieves data from a GetPaid class. |
|
| 387 | + * |
|
| 388 | + * @since 1.0.19 |
|
| 389 | + * @param GetPaid_Data $object Data object. |
|
| 390 | + * @param array $fields Fields to include. |
|
| 391 | + * @param string $context either view or edit. |
|
| 392 | + * @return array |
|
| 393 | + */ |
|
| 394 | + protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
| 395 | + |
|
| 396 | + $data = array(); |
|
| 397 | + |
|
| 398 | + // Handle all writable props. |
|
| 399 | + foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
| 400 | + |
|
| 401 | + // Abort if it is not included. |
|
| 402 | + if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
| 403 | + continue; |
|
| 404 | + } |
|
| 405 | + |
|
| 406 | + // Or this current object does not support the field. |
|
| 407 | + if ( ! $this->object_supports_field( $object, $key ) ) { |
|
| 408 | + continue; |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + // Handle meta data. |
|
| 412 | + if ( $key == 'meta_data' ) { |
|
| 413 | + $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
| 414 | + continue; |
|
| 415 | + } |
|
| 416 | + |
|
| 417 | + // Handle items. |
|
| 418 | + if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 419 | + $data['items'] = $this->prepare_invoice_items( $object ); |
|
| 420 | + continue; |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + // Booleans. |
|
| 424 | + if ( is_callable( array( $object, $key ) ) ) { |
|
| 425 | + $data[ $key ] = $object->$key( $context ); |
|
| 426 | + continue; |
|
| 427 | + } |
|
| 428 | + |
|
| 429 | + // Get object value. |
|
| 430 | + if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
| 431 | + $value = $object->{"get_{$key}"}( $context ); |
|
| 432 | + |
|
| 433 | + // If the value is an instance of GetPaid_Data... |
|
| 434 | + if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
| 435 | + $value = $value->get_data( $context ); |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + // For objects, retrieves it's properties. |
|
| 439 | + $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value; |
|
| 440 | + continue; |
|
| 441 | + } |
|
| 442 | 442 | } |
| 443 | 443 | |
| 444 | - return $data; |
|
| 445 | - } |
|
| 446 | - |
|
| 447 | - /** |
|
| 448 | - * Checks if a key should be included in a response. |
|
| 449 | - * |
|
| 450 | - * @since 1.0.19 |
|
| 451 | - * @param GetPaid_Data $object Data object. |
|
| 452 | - * @param string $field_key The key to check for. |
|
| 453 | - * @return bool |
|
| 454 | - */ |
|
| 455 | - public function object_supports_field( $object, $field_key ) { |
|
| 456 | - return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
| 457 | - } |
|
| 458 | - |
|
| 459 | - /** |
|
| 460 | - * Prepare a single object output for response. |
|
| 461 | - * |
|
| 462 | - * @since 1.0.19 |
|
| 463 | - * @param GetPaid_Data $object Data object. |
|
| 464 | - * @param WP_REST_Request $request Request object. |
|
| 465 | - * @return WP_REST_Response |
|
| 466 | - */ |
|
| 467 | - public function prepare_item_for_response( $object, $request ) { |
|
| 468 | - remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
| 469 | - |
|
| 470 | - $this->data_object = $object; |
|
| 471 | - |
|
| 472 | - // Fetch the fields to include in this response. |
|
| 473 | - $fields = $this->get_fields_for_response( $request ); |
|
| 474 | - |
|
| 475 | - // Prepare object data. |
|
| 476 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 477 | - $data = $this->prepare_object_data( $object, $fields, $context ); |
|
| 478 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 479 | - $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
| 480 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 481 | - |
|
| 482 | - // Prepare the response. |
|
| 483 | - $response = rest_ensure_response( $data ); |
|
| 484 | - $response->add_links( $this->prepare_links( $object, $request ) ); |
|
| 485 | - |
|
| 486 | - // Filter item response. |
|
| 487 | - return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
| 488 | - } |
|
| 444 | + return $data; |
|
| 445 | + } |
|
| 446 | + |
|
| 447 | + /** |
|
| 448 | + * Checks if a key should be included in a response. |
|
| 449 | + * |
|
| 450 | + * @since 1.0.19 |
|
| 451 | + * @param GetPaid_Data $object Data object. |
|
| 452 | + * @param string $field_key The key to check for. |
|
| 453 | + * @return bool |
|
| 454 | + */ |
|
| 455 | + public function object_supports_field( $object, $field_key ) { |
|
| 456 | + return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
| 457 | + } |
|
| 458 | + |
|
| 459 | + /** |
|
| 460 | + * Prepare a single object output for response. |
|
| 461 | + * |
|
| 462 | + * @since 1.0.19 |
|
| 463 | + * @param GetPaid_Data $object Data object. |
|
| 464 | + * @param WP_REST_Request $request Request object. |
|
| 465 | + * @return WP_REST_Response |
|
| 466 | + */ |
|
| 467 | + public function prepare_item_for_response( $object, $request ) { |
|
| 468 | + remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
| 469 | + |
|
| 470 | + $this->data_object = $object; |
|
| 471 | + |
|
| 472 | + // Fetch the fields to include in this response. |
|
| 473 | + $fields = $this->get_fields_for_response( $request ); |
|
| 474 | + |
|
| 475 | + // Prepare object data. |
|
| 476 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 477 | + $data = $this->prepare_object_data( $object, $fields, $context ); |
|
| 478 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 479 | + $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
| 480 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 481 | + |
|
| 482 | + // Prepare the response. |
|
| 483 | + $response = rest_ensure_response( $data ); |
|
| 484 | + $response->add_links( $this->prepare_links( $object, $request ) ); |
|
| 485 | + |
|
| 486 | + // Filter item response. |
|
| 487 | + return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
| 488 | + } |
|
| 489 | 489 | |
| 490 | 490 | } |
@@ -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 CRUD controller class. |
@@ -38,7 +38,7 @@ 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 | 43 | register_rest_route( |
| 44 | 44 | $namespace, |
@@ -46,22 +46,22 @@ discard block |
||
| 46 | 46 | array( |
| 47 | 47 | array( |
| 48 | 48 | 'methods' => WP_REST_Server::READABLE, |
| 49 | - 'callback' => array( $this, 'get_items' ), |
|
| 50 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 49 | + 'callback' => array($this, 'get_items'), |
|
| 50 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 51 | 51 | 'args' => $this->get_collection_params(), |
| 52 | 52 | ), |
| 53 | 53 | array( |
| 54 | 54 | 'methods' => WP_REST_Server::CREATABLE, |
| 55 | - 'callback' => array( $this, 'create_item' ), |
|
| 56 | - 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
| 57 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
| 55 | + 'callback' => array($this, 'create_item'), |
|
| 56 | + 'permission_callback' => array($this, 'create_item_permissions_check'), |
|
| 57 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::CREATABLE), |
|
| 58 | 58 | ), |
| 59 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 59 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 60 | 60 | ) |
| 61 | 61 | ); |
| 62 | 62 | |
| 63 | 63 | $get_item_args = array( |
| 64 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 64 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
| 65 | 65 | ); |
| 66 | 66 | |
| 67 | 67 | register_rest_route( |
@@ -70,35 +70,35 @@ discard block |
||
| 70 | 70 | array( |
| 71 | 71 | 'args' => array( |
| 72 | 72 | 'id' => array( |
| 73 | - 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
| 73 | + 'description' => __('Unique identifier for the object.', 'invoicing'), |
|
| 74 | 74 | 'type' => 'integer', |
| 75 | 75 | ), |
| 76 | 76 | ), |
| 77 | 77 | array( |
| 78 | 78 | 'methods' => WP_REST_Server::READABLE, |
| 79 | - 'callback' => array( $this, 'get_item' ), |
|
| 80 | - 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
| 79 | + 'callback' => array($this, 'get_item'), |
|
| 80 | + 'permission_callback' => array($this, 'get_item_permissions_check'), |
|
| 81 | 81 | 'args' => $get_item_args, |
| 82 | 82 | ), |
| 83 | 83 | array( |
| 84 | 84 | 'methods' => WP_REST_Server::EDITABLE, |
| 85 | - 'callback' => array( $this, 'update_item' ), |
|
| 86 | - 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
| 87 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 85 | + 'callback' => array($this, 'update_item'), |
|
| 86 | + 'permission_callback' => array($this, 'update_item_permissions_check'), |
|
| 87 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE), |
|
| 88 | 88 | ), |
| 89 | 89 | array( |
| 90 | 90 | 'methods' => WP_REST_Server::DELETABLE, |
| 91 | - 'callback' => array( $this, 'delete_item' ), |
|
| 92 | - 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
| 91 | + 'callback' => array($this, 'delete_item'), |
|
| 92 | + 'permission_callback' => array($this, 'delete_item_permissions_check'), |
|
| 93 | 93 | 'args' => array( |
| 94 | 94 | 'force' => array( |
| 95 | 95 | 'type' => 'boolean', |
| 96 | 96 | 'default' => false, |
| 97 | - 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
| 97 | + 'description' => __('Whether to bypass Trash and force deletion.', 'invoicing'), |
|
| 98 | 98 | ), |
| 99 | 99 | ), |
| 100 | 100 | ), |
| 101 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 101 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 102 | 102 | ) |
| 103 | 103 | ); |
| 104 | 104 | |
@@ -110,14 +110,14 @@ discard block |
||
| 110 | 110 | * @param GetPaid_Data $object Object to save. |
| 111 | 111 | * @return WP_Error|GetPaid_Data |
| 112 | 112 | */ |
| 113 | - protected function save_object( $object ) { |
|
| 113 | + protected function save_object($object) { |
|
| 114 | 114 | $object->save(); |
| 115 | 115 | |
| 116 | - if ( ! empty( $object->last_error ) ) { |
|
| 117 | - return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
| 116 | + if (!empty($object->last_error)) { |
|
| 117 | + return new WP_Error('rest_cannot_save', $object->last_error, array('status' => 400)); |
|
| 118 | 118 | } |
| 119 | 119 | |
| 120 | - return new $this->crud_class( $object->get_id() ); |
|
| 120 | + return new $this->crud_class($object->get_id()); |
|
| 121 | 121 | } |
| 122 | 122 | |
| 123 | 123 | /** |
@@ -128,21 +128,21 @@ discard block |
||
| 128 | 128 | * @param int|WP_Post $object_id Supplied ID. |
| 129 | 129 | * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
| 130 | 130 | */ |
| 131 | - protected function get_object( $object_id ) { |
|
| 131 | + protected function get_object($object_id) { |
|
| 132 | 132 | |
| 133 | 133 | // Do we have an object? |
| 134 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 135 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 134 | + if (empty($this->crud_class) || !class_exists($this->crud_class)) { |
|
| 135 | + return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing')); |
|
| 136 | 136 | } |
| 137 | 137 | |
| 138 | 138 | // Fetch the object. |
| 139 | - $object = new $this->crud_class( $object_id ); |
|
| 140 | - if ( ! empty( $object->last_error ) ) { |
|
| 141 | - return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
| 139 | + $object = new $this->crud_class($object_id); |
|
| 140 | + if (!empty($object->last_error)) { |
|
| 141 | + return new WP_Error('rest_object_invalid_id', $object->last_error, array('status' => 404)); |
|
| 142 | 142 | } |
| 143 | 143 | |
| 144 | 144 | $this->data_object = $object; |
| 145 | - return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 145 | + return $object->get_id() ? $object : new WP_Error('rest_object_invalid_id', __('Invalid ID.', 'invoicing'), array('status' => 404)); |
|
| 146 | 146 | |
| 147 | 147 | } |
| 148 | 148 | |
@@ -152,17 +152,17 @@ discard block |
||
| 152 | 152 | * @param WP_REST_Request $request Full details about the request. |
| 153 | 153 | * @return WP_Error|WP_REST_Response |
| 154 | 154 | */ |
| 155 | - public function get_item( $request ) { |
|
| 155 | + public function get_item($request) { |
|
| 156 | 156 | |
| 157 | 157 | // Fetch the item. |
| 158 | - $object = $this->get_object( $request['id'] ); |
|
| 158 | + $object = $this->get_object($request['id']); |
|
| 159 | 159 | |
| 160 | - if ( is_wp_error( $object ) ) { |
|
| 160 | + if (is_wp_error($object)) { |
|
| 161 | 161 | return $object; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | 164 | // Generate a response. |
| 165 | - return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
| 165 | + return rest_ensure_response($this->prepare_item_for_response($object, $request)); |
|
| 166 | 166 | |
| 167 | 167 | } |
| 168 | 168 | |
@@ -172,38 +172,38 @@ discard block |
||
| 172 | 172 | * @param WP_REST_Request $request Full details about the request. |
| 173 | 173 | * @return WP_Error|WP_REST_Response |
| 174 | 174 | */ |
| 175 | - public function create_item( $request ) { |
|
| 175 | + public function create_item($request) { |
|
| 176 | 176 | |
| 177 | 177 | // Can not create an existing item. |
| 178 | - if ( ! empty( $request['id'] ) ) { |
|
| 178 | + if (!empty($request['id'])) { |
|
| 179 | 179 | /* translators: %s: post type */ |
| 180 | - return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 180 | + return new WP_Error("getpaid_rest_{$this->rest_base}_exists", __('Cannot create existing resource.', 'invoicing'), array('status' => 400)); |
|
| 181 | 181 | } |
| 182 | 182 | |
| 183 | 183 | // Generate a GetPaid_Data object from the request. |
| 184 | - $object = $this->prepare_item_for_database( $request ); |
|
| 185 | - if ( is_wp_error( $object ) ) { |
|
| 184 | + $object = $this->prepare_item_for_database($request); |
|
| 185 | + if (is_wp_error($object)) { |
|
| 186 | 186 | return $object; |
| 187 | 187 | } |
| 188 | 188 | |
| 189 | 189 | // Save the object. |
| 190 | - $object = $this->save_object( $object ); |
|
| 191 | - if ( is_wp_error( $object ) ) { |
|
| 190 | + $object = $this->save_object($object); |
|
| 191 | + if (is_wp_error($object)) { |
|
| 192 | 192 | return $object; |
| 193 | 193 | } |
| 194 | 194 | |
| 195 | 195 | // Save special fields. |
| 196 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 197 | - if ( is_wp_error( $save_special ) ) { |
|
| 198 | - $object->delete( true ); |
|
| 196 | + $save_special = $this->update_additional_fields_for_object($object, $request); |
|
| 197 | + if (is_wp_error($save_special)) { |
|
| 198 | + $object->delete(true); |
|
| 199 | 199 | return $save_special; |
| 200 | 200 | } |
| 201 | 201 | |
| 202 | - $request->set_param( 'context', 'edit' ); |
|
| 203 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 204 | - $response = rest_ensure_response( $response ); |
|
| 205 | - $response->set_status( 201 ); |
|
| 206 | - $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
| 202 | + $request->set_param('context', 'edit'); |
|
| 203 | + $response = $this->prepare_item_for_response($object, $request); |
|
| 204 | + $response = rest_ensure_response($response); |
|
| 205 | + $response->set_status(201); |
|
| 206 | + $response->header('Location', rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id()))); |
|
| 207 | 207 | |
| 208 | 208 | return $response; |
| 209 | 209 | } |
@@ -214,35 +214,35 @@ discard block |
||
| 214 | 214 | * @param WP_REST_Request $request Full details about the request. |
| 215 | 215 | * @return WP_Error|WP_REST_Response |
| 216 | 216 | */ |
| 217 | - public function update_item( $request ) { |
|
| 217 | + public function update_item($request) { |
|
| 218 | 218 | |
| 219 | 219 | // Fetch the item. |
| 220 | - $object = $this->get_object( $request['id'] ); |
|
| 221 | - if ( is_wp_error( $object ) ) { |
|
| 220 | + $object = $this->get_object($request['id']); |
|
| 221 | + if (is_wp_error($object)) { |
|
| 222 | 222 | return $object; |
| 223 | 223 | } |
| 224 | 224 | |
| 225 | 225 | // Prepare the item for saving. |
| 226 | - $object = $this->prepare_item_for_database( $request ); |
|
| 227 | - if ( is_wp_error( $object ) ) { |
|
| 226 | + $object = $this->prepare_item_for_database($request); |
|
| 227 | + if (is_wp_error($object)) { |
|
| 228 | 228 | return $object; |
| 229 | 229 | } |
| 230 | 230 | |
| 231 | 231 | // Save the item. |
| 232 | - $object = $this->save_object( $object ); |
|
| 233 | - if ( is_wp_error( $object ) ) { |
|
| 232 | + $object = $this->save_object($object); |
|
| 233 | + if (is_wp_error($object)) { |
|
| 234 | 234 | return $object; |
| 235 | 235 | } |
| 236 | 236 | |
| 237 | 237 | // Save special fields (those added via hooks). |
| 238 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 239 | - if ( is_wp_error( $save_special ) ) { |
|
| 238 | + $save_special = $this->update_additional_fields_for_object($object, $request); |
|
| 239 | + if (is_wp_error($save_special)) { |
|
| 240 | 240 | return $save_special; |
| 241 | 241 | } |
| 242 | 242 | |
| 243 | - $request->set_param( 'context', 'edit' ); |
|
| 244 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 245 | - return rest_ensure_response( $response ); |
|
| 243 | + $request->set_param('context', 'edit'); |
|
| 244 | + $response = $this->prepare_item_for_response($object, $request); |
|
| 245 | + return rest_ensure_response($response); |
|
| 246 | 246 | } |
| 247 | 247 | |
| 248 | 248 | /** |
@@ -251,14 +251,14 @@ discard block |
||
| 251 | 251 | * @param GetPaid_Data $object GetPaid_Data object. |
| 252 | 252 | * @return array Links for the given object. |
| 253 | 253 | */ |
| 254 | - protected function prepare_links( $object ) { |
|
| 254 | + protected function prepare_links($object) { |
|
| 255 | 255 | |
| 256 | 256 | $links = array( |
| 257 | 257 | 'self' => array( |
| 258 | - 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
| 258 | + 'href' => rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id())), |
|
| 259 | 259 | ), |
| 260 | 260 | 'collection' => array( |
| 261 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 261 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 262 | 262 | ), |
| 263 | 263 | ); |
| 264 | 264 | |
@@ -282,8 +282,8 @@ discard block |
||
| 282 | 282 | * @param array $schema Schema. |
| 283 | 283 | * @return bool |
| 284 | 284 | */ |
| 285 | - public function filter_writable_props( $schema ) { |
|
| 286 | - return empty( $schema['readonly'] ); |
|
| 285 | + public function filter_writable_props($schema) { |
|
| 286 | + return empty($schema['readonly']); |
|
| 287 | 287 | } |
| 288 | 288 | |
| 289 | 289 | /** |
@@ -293,43 +293,43 @@ discard block |
||
| 293 | 293 | * @param WP_REST_Request $request Request object. |
| 294 | 294 | * @return GetPaid_Data|WP_Error Data object or WP_Error. |
| 295 | 295 | */ |
| 296 | - protected function prepare_item_for_database( $request ) { |
|
| 296 | + protected function prepare_item_for_database($request) { |
|
| 297 | 297 | |
| 298 | 298 | // Do we have an object? |
| 299 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 300 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 299 | + if (empty($this->crud_class) || !class_exists($this->crud_class)) { |
|
| 300 | + return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing')); |
|
| 301 | 301 | } |
| 302 | 302 | |
| 303 | 303 | // Prepare the object. |
| 304 | - $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
| 305 | - $object = new $this->crud_class( $id ); |
|
| 304 | + $id = isset($request['id']) ? absint($request['id']) : 0; |
|
| 305 | + $object = new $this->crud_class($id); |
|
| 306 | 306 | |
| 307 | 307 | // Abort if an error exists. |
| 308 | - if ( ! empty( $object->last_error ) ) { |
|
| 309 | - return new WP_Error( 'invalid_item', $object->last_error ); |
|
| 308 | + if (!empty($object->last_error)) { |
|
| 309 | + return new WP_Error('invalid_item', $object->last_error); |
|
| 310 | 310 | } |
| 311 | 311 | |
| 312 | 312 | $schema = $this->get_item_schema(); |
| 313 | - $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
| 313 | + $data_keys = array_keys(array_filter($schema['properties'], array($this, 'filter_writable_props'))); |
|
| 314 | 314 | |
| 315 | 315 | // Handle all writable props. |
| 316 | - foreach ( $data_keys as $key ) { |
|
| 317 | - $value = $request[ $key ]; |
|
| 316 | + foreach ($data_keys as $key) { |
|
| 317 | + $value = $request[$key]; |
|
| 318 | 318 | |
| 319 | - if ( ! is_null( $value ) ) { |
|
| 320 | - switch ( $key ) { |
|
| 319 | + if (!is_null($value)) { |
|
| 320 | + switch ($key) { |
|
| 321 | 321 | |
| 322 | 322 | case 'meta_data': |
| 323 | - if ( is_array( $value ) ) { |
|
| 324 | - foreach ( $value as $meta ) { |
|
| 325 | - $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
| 323 | + if (is_array($value)) { |
|
| 324 | + foreach ($value as $meta) { |
|
| 325 | + $object->update_meta_data($meta['key'], $meta['value'], isset($meta['id']) ? $meta['id'] : ''); |
|
| 326 | 326 | } |
| 327 | 327 | } |
| 328 | 328 | break; |
| 329 | 329 | |
| 330 | 330 | default: |
| 331 | - if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
| 332 | - $object->{"set_{$key}"}( $value ); |
|
| 331 | + if (is_callable(array($object, "set_{$key}"))) { |
|
| 332 | + $object->{"set_{$key}"}($value); |
|
| 333 | 333 | } |
| 334 | 334 | break; |
| 335 | 335 | } |
@@ -337,7 +337,7 @@ discard block |
||
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | // Filters an object before it is inserted via the REST API.. |
| 340 | - return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
| 340 | + return apply_filters("getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request); |
|
| 341 | 341 | } |
| 342 | 342 | |
| 343 | 343 | /** |
@@ -347,10 +347,10 @@ discard block |
||
| 347 | 347 | * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
| 348 | 348 | * @return array |
| 349 | 349 | */ |
| 350 | - protected function prepare_object_meta_data( $meta_data ) { |
|
| 350 | + protected function prepare_object_meta_data($meta_data) { |
|
| 351 | 351 | $meta = array(); |
| 352 | 352 | |
| 353 | - foreach ( $meta_data as $object ) { |
|
| 353 | + foreach ($meta_data as $object) { |
|
| 354 | 354 | $meta[] = $object->get_data(); |
| 355 | 355 | } |
| 356 | 356 | |
@@ -365,14 +365,14 @@ discard block |
||
| 365 | 365 | * @param array $fields Fields to include. |
| 366 | 366 | * @return array |
| 367 | 367 | */ |
| 368 | - protected function prepare_invoice_items( $invoice ) { |
|
| 368 | + protected function prepare_invoice_items($invoice) { |
|
| 369 | 369 | $items = array(); |
| 370 | 370 | |
| 371 | - foreach ( $invoice->get_items() as $item ) { |
|
| 371 | + foreach ($invoice->get_items() as $item) { |
|
| 372 | 372 | |
| 373 | 373 | $item_data = $item->prepare_data_for_saving(); |
| 374 | 374 | |
| 375 | - if ( 'amount' == $invoice->get_template() ) { |
|
| 375 | + if ('amount' == $invoice->get_template()) { |
|
| 376 | 376 | $item_data['quantity'] = 1; |
| 377 | 377 | } |
| 378 | 378 | |
@@ -391,52 +391,52 @@ discard block |
||
| 391 | 391 | * @param string $context either view or edit. |
| 392 | 392 | * @return array |
| 393 | 393 | */ |
| 394 | - protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
| 394 | + protected function prepare_object_data($object, $fields, $context = 'view') { |
|
| 395 | 395 | |
| 396 | 396 | $data = array(); |
| 397 | 397 | |
| 398 | 398 | // Handle all writable props. |
| 399 | - foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
| 399 | + foreach (array_keys($this->get_schema_properties()) as $key) { |
|
| 400 | 400 | |
| 401 | 401 | // Abort if it is not included. |
| 402 | - if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
| 402 | + if (!empty($fields) && !$this->is_field_included($key, $fields)) { |
|
| 403 | 403 | continue; |
| 404 | 404 | } |
| 405 | 405 | |
| 406 | 406 | // Or this current object does not support the field. |
| 407 | - if ( ! $this->object_supports_field( $object, $key ) ) { |
|
| 407 | + if (!$this->object_supports_field($object, $key)) { |
|
| 408 | 408 | continue; |
| 409 | 409 | } |
| 410 | 410 | |
| 411 | 411 | // Handle meta data. |
| 412 | - if ( $key == 'meta_data' ) { |
|
| 413 | - $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
| 412 | + if ($key == 'meta_data') { |
|
| 413 | + $data['meta_data'] = $this->prepare_object_meta_data($object->get_meta_data()); |
|
| 414 | 414 | continue; |
| 415 | 415 | } |
| 416 | 416 | |
| 417 | 417 | // Handle items. |
| 418 | - if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 419 | - $data['items'] = $this->prepare_invoice_items( $object ); |
|
| 418 | + if ($key == 'items' && is_a($object, 'WPInv_Invoice')) { |
|
| 419 | + $data['items'] = $this->prepare_invoice_items($object); |
|
| 420 | 420 | continue; |
| 421 | 421 | } |
| 422 | 422 | |
| 423 | 423 | // Booleans. |
| 424 | - if ( is_callable( array( $object, $key ) ) ) { |
|
| 425 | - $data[ $key ] = $object->$key( $context ); |
|
| 424 | + if (is_callable(array($object, $key))) { |
|
| 425 | + $data[$key] = $object->$key($context); |
|
| 426 | 426 | continue; |
| 427 | 427 | } |
| 428 | 428 | |
| 429 | 429 | // Get object value. |
| 430 | - if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
| 431 | - $value = $object->{"get_{$key}"}( $context ); |
|
| 430 | + if (is_callable(array($object, "get_{$key}"))) { |
|
| 431 | + $value = $object->{"get_{$key}"}($context); |
|
| 432 | 432 | |
| 433 | 433 | // If the value is an instance of GetPaid_Data... |
| 434 | - if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
| 435 | - $value = $value->get_data( $context ); |
|
| 434 | + if (is_a($value, 'GetPaid_Data')) { |
|
| 435 | + $value = $value->get_data($context); |
|
| 436 | 436 | } |
| 437 | 437 | |
| 438 | 438 | // For objects, retrieves it's properties. |
| 439 | - $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value; |
|
| 439 | + $data[$key] = is_object($value) ? get_object_vars($value) : $value; |
|
| 440 | 440 | continue; |
| 441 | 441 | } |
| 442 | 442 | } |
@@ -452,8 +452,8 @@ discard block |
||
| 452 | 452 | * @param string $field_key The key to check for. |
| 453 | 453 | * @return bool |
| 454 | 454 | */ |
| 455 | - public function object_supports_field( $object, $field_key ) { |
|
| 456 | - return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
| 455 | + public function object_supports_field($object, $field_key) { |
|
| 456 | + return apply_filters('getpaid_rest_object_supports_key', true, $object, $field_key); |
|
| 457 | 457 | } |
| 458 | 458 | |
| 459 | 459 | /** |
@@ -464,27 +464,27 @@ discard block |
||
| 464 | 464 | * @param WP_REST_Request $request Request object. |
| 465 | 465 | * @return WP_REST_Response |
| 466 | 466 | */ |
| 467 | - public function prepare_item_for_response( $object, $request ) { |
|
| 468 | - remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
| 467 | + public function prepare_item_for_response($object, $request) { |
|
| 468 | + remove_filter('rest_post_dispatch', 'rest_filter_response_fields', 10); |
|
| 469 | 469 | |
| 470 | 470 | $this->data_object = $object; |
| 471 | 471 | |
| 472 | 472 | // Fetch the fields to include in this response. |
| 473 | - $fields = $this->get_fields_for_response( $request ); |
|
| 473 | + $fields = $this->get_fields_for_response($request); |
|
| 474 | 474 | |
| 475 | 475 | // Prepare object data. |
| 476 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 477 | - $data = $this->prepare_object_data( $object, $fields, $context ); |
|
| 478 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 479 | - $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
| 480 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 476 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
| 477 | + $data = $this->prepare_object_data($object, $fields, $context); |
|
| 478 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 479 | + $data = $this->limit_object_to_requested_fields($data, $fields); |
|
| 480 | + $data = $this->filter_response_by_context($data, $context); |
|
| 481 | 481 | |
| 482 | 482 | // Prepare the response. |
| 483 | - $response = rest_ensure_response( $data ); |
|
| 484 | - $response->add_links( $this->prepare_links( $object, $request ) ); |
|
| 483 | + $response = rest_ensure_response($data); |
|
| 484 | + $response->add_links($this->prepare_links($object, $request)); |
|
| 485 | 485 | |
| 486 | 486 | // Filter item response. |
| 487 | - return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
| 487 | + return apply_filters("getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request); |
|
| 488 | 488 | } |
| 489 | 489 | |
| 490 | 490 | } |
@@ -15,132 +15,132 @@ |
||
| 15 | 15 | class WPInv_REST_Invoice_Controller extends GetPaid_REST_Posts_Controller { |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | - * Post type. |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 22 | - protected $post_type = 'wpi_invoice'; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * The base of this controller's route. |
|
| 26 | - * |
|
| 27 | - * @since 1.0.13 |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $rest_base = 'invoices'; |
|
| 31 | - |
|
| 32 | - /** Contains this controller's class name. |
|
| 33 | - * |
|
| 34 | - * @var string |
|
| 35 | - */ |
|
| 36 | - public $crud_class = 'WPInv_Invoice'; |
|
| 18 | + * Post type. |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | + protected $post_type = 'wpi_invoice'; |
|
| 37 | 23 | |
| 38 | 24 | /** |
| 39 | - * Retrieves the query params for the invoices collection. |
|
| 40 | - * |
|
| 41 | - * @since 1.0.13 |
|
| 42 | - * |
|
| 43 | - * @return array Collection parameters. |
|
| 44 | - */ |
|
| 45 | - public function get_collection_params() { |
|
| 46 | - |
|
| 47 | - $params = array_merge( |
|
| 48 | - parent::get_collection_params(), |
|
| 49 | - array( |
|
| 50 | - |
|
| 51 | - 'customers' => array( |
|
| 52 | - 'description' => __( 'Limit result set to invoices for specific user ids.', 'invoicing' ), |
|
| 53 | - 'type' => 'array', |
|
| 54 | - 'items' => array( |
|
| 55 | - 'type' => 'integer', |
|
| 56 | - ), |
|
| 57 | - 'default' => array(), |
|
| 58 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 59 | - ), |
|
| 60 | - |
|
| 61 | - 'exclude_customers' => array( |
|
| 62 | - 'description' => __( 'Exclude invoices to specific users.', 'invoicing' ), |
|
| 63 | - 'type' => 'array', |
|
| 64 | - 'items' => array( |
|
| 65 | - 'type' => 'integer', |
|
| 66 | - ), |
|
| 67 | - 'default' => array(), |
|
| 68 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 69 | - ), |
|
| 70 | - |
|
| 71 | - 'parent' => array( |
|
| 72 | - 'description' => __( 'Limit result set to those of particular parent IDs.', 'invoicing' ), |
|
| 73 | - 'type' => 'array', |
|
| 74 | - 'items' => array( |
|
| 75 | - 'type' => 'integer', |
|
| 76 | - ), |
|
| 77 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 78 | - 'default' => array(), |
|
| 79 | - ), |
|
| 80 | - |
|
| 81 | - 'parent_exclude' => array( |
|
| 82 | - 'description' => __( 'Limit result set to all items except those of a particular parent ID.', 'invoicing' ), |
|
| 83 | - 'type' => 'array', |
|
| 84 | - 'items' => array( |
|
| 85 | - 'type' => 'integer', |
|
| 86 | - ), |
|
| 87 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 88 | - 'default' => array(), |
|
| 89 | - ), |
|
| 90 | - |
|
| 91 | - ) |
|
| 92 | - ); |
|
| 93 | - |
|
| 94 | - // Filter collection parameters for the invoices controller. |
|
| 95 | - return apply_filters( 'getpaid_rest_invoices_collection_params', $params, $this ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Determine the allowed query_vars for a get_items() response and |
|
| 100 | - * prepare for WP_Query. |
|
| 101 | - * |
|
| 102 | - * @param array $prepared_args Prepared arguments. |
|
| 103 | - * @param WP_REST_Request $request Request object. |
|
| 104 | - * @return array $query_args |
|
| 105 | - */ |
|
| 106 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 107 | - |
|
| 108 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 109 | - |
|
| 110 | - // Retrieve invoices for specific customers. |
|
| 111 | - if ( ! empty( $request['customers'] ) ) { |
|
| 112 | - $query_args['author__in'] = $request['customers']; |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - // Skip invoices for specific customers. |
|
| 116 | - if ( ! empty( $request['exclude_customers'] ) ) { |
|
| 117 | - $query_args['author__not_in'] = $request['exclude_customers']; |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - return apply_filters( 'getpaid_rest_invoices_prepare_items_query', $query_args, $request, $this ); |
|
| 121 | - |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Retrieves a valid list of post statuses. |
|
| 126 | - * |
|
| 127 | - * @since 1.0.15 |
|
| 128 | - * |
|
| 129 | - * @return array A list of registered item statuses. |
|
| 130 | - */ |
|
| 131 | - public function get_post_statuses() { |
|
| 132 | - return array_keys( wpinv_get_invoice_statuses( true, false, $this->post_type ) ); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * Saves a single invoice. |
|
| 137 | - * |
|
| 138 | - * @param WPInv_Invoice $invoice Invoice to save. |
|
| 139 | - * @return WP_Error|WPInv_Invoice |
|
| 140 | - */ |
|
| 141 | - protected function save_object( $invoice ) { |
|
| 142 | - $invoice->recalculate_total(); |
|
| 143 | - return parent::save_object( $invoice ); |
|
| 144 | - } |
|
| 25 | + * The base of this controller's route. |
|
| 26 | + * |
|
| 27 | + * @since 1.0.13 |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $rest_base = 'invoices'; |
|
| 31 | + |
|
| 32 | + /** Contains this controller's class name. |
|
| 33 | + * |
|
| 34 | + * @var string |
|
| 35 | + */ |
|
| 36 | + public $crud_class = 'WPInv_Invoice'; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * Retrieves the query params for the invoices collection. |
|
| 40 | + * |
|
| 41 | + * @since 1.0.13 |
|
| 42 | + * |
|
| 43 | + * @return array Collection parameters. |
|
| 44 | + */ |
|
| 45 | + public function get_collection_params() { |
|
| 46 | + |
|
| 47 | + $params = array_merge( |
|
| 48 | + parent::get_collection_params(), |
|
| 49 | + array( |
|
| 50 | + |
|
| 51 | + 'customers' => array( |
|
| 52 | + 'description' => __( 'Limit result set to invoices for specific user ids.', 'invoicing' ), |
|
| 53 | + 'type' => 'array', |
|
| 54 | + 'items' => array( |
|
| 55 | + 'type' => 'integer', |
|
| 56 | + ), |
|
| 57 | + 'default' => array(), |
|
| 58 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 59 | + ), |
|
| 60 | + |
|
| 61 | + 'exclude_customers' => array( |
|
| 62 | + 'description' => __( 'Exclude invoices to specific users.', 'invoicing' ), |
|
| 63 | + 'type' => 'array', |
|
| 64 | + 'items' => array( |
|
| 65 | + 'type' => 'integer', |
|
| 66 | + ), |
|
| 67 | + 'default' => array(), |
|
| 68 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 69 | + ), |
|
| 70 | + |
|
| 71 | + 'parent' => array( |
|
| 72 | + 'description' => __( 'Limit result set to those of particular parent IDs.', 'invoicing' ), |
|
| 73 | + 'type' => 'array', |
|
| 74 | + 'items' => array( |
|
| 75 | + 'type' => 'integer', |
|
| 76 | + ), |
|
| 77 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 78 | + 'default' => array(), |
|
| 79 | + ), |
|
| 80 | + |
|
| 81 | + 'parent_exclude' => array( |
|
| 82 | + 'description' => __( 'Limit result set to all items except those of a particular parent ID.', 'invoicing' ), |
|
| 83 | + 'type' => 'array', |
|
| 84 | + 'items' => array( |
|
| 85 | + 'type' => 'integer', |
|
| 86 | + ), |
|
| 87 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 88 | + 'default' => array(), |
|
| 89 | + ), |
|
| 90 | + |
|
| 91 | + ) |
|
| 92 | + ); |
|
| 93 | + |
|
| 94 | + // Filter collection parameters for the invoices controller. |
|
| 95 | + return apply_filters( 'getpaid_rest_invoices_collection_params', $params, $this ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Determine the allowed query_vars for a get_items() response and |
|
| 100 | + * prepare for WP_Query. |
|
| 101 | + * |
|
| 102 | + * @param array $prepared_args Prepared arguments. |
|
| 103 | + * @param WP_REST_Request $request Request object. |
|
| 104 | + * @return array $query_args |
|
| 105 | + */ |
|
| 106 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 107 | + |
|
| 108 | + $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 109 | + |
|
| 110 | + // Retrieve invoices for specific customers. |
|
| 111 | + if ( ! empty( $request['customers'] ) ) { |
|
| 112 | + $query_args['author__in'] = $request['customers']; |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + // Skip invoices for specific customers. |
|
| 116 | + if ( ! empty( $request['exclude_customers'] ) ) { |
|
| 117 | + $query_args['author__not_in'] = $request['exclude_customers']; |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + return apply_filters( 'getpaid_rest_invoices_prepare_items_query', $query_args, $request, $this ); |
|
| 121 | + |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Retrieves a valid list of post statuses. |
|
| 126 | + * |
|
| 127 | + * @since 1.0.15 |
|
| 128 | + * |
|
| 129 | + * @return array A list of registered item statuses. |
|
| 130 | + */ |
|
| 131 | + public function get_post_statuses() { |
|
| 132 | + return array_keys( wpinv_get_invoice_statuses( true, false, $this->post_type ) ); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * Saves a single invoice. |
|
| 137 | + * |
|
| 138 | + * @param WPInv_Invoice $invoice Invoice to save. |
|
| 139 | + * @return WP_Error|WPInv_Invoice |
|
| 140 | + */ |
|
| 141 | + protected function save_object( $invoice ) { |
|
| 142 | + $invoice->recalculate_total(); |
|
| 143 | + return parent::save_object( $invoice ); |
|
| 144 | + } |
|
| 145 | 145 | |
| 146 | 146 | } |
@@ -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 invoices controller class. |
@@ -49,7 +49,7 @@ discard block |
||
| 49 | 49 | array( |
| 50 | 50 | |
| 51 | 51 | 'customers' => array( |
| 52 | - 'description' => __( 'Limit result set to invoices for specific user ids.', 'invoicing' ), |
|
| 52 | + 'description' => __('Limit result set to invoices for specific user ids.', 'invoicing'), |
|
| 53 | 53 | 'type' => 'array', |
| 54 | 54 | 'items' => array( |
| 55 | 55 | 'type' => 'integer', |
@@ -59,7 +59,7 @@ discard block |
||
| 59 | 59 | ), |
| 60 | 60 | |
| 61 | 61 | 'exclude_customers' => array( |
| 62 | - 'description' => __( 'Exclude invoices to specific users.', 'invoicing' ), |
|
| 62 | + 'description' => __('Exclude invoices to specific users.', 'invoicing'), |
|
| 63 | 63 | 'type' => 'array', |
| 64 | 64 | 'items' => array( |
| 65 | 65 | 'type' => 'integer', |
@@ -69,7 +69,7 @@ discard block |
||
| 69 | 69 | ), |
| 70 | 70 | |
| 71 | 71 | 'parent' => array( |
| 72 | - 'description' => __( 'Limit result set to those of particular parent IDs.', 'invoicing' ), |
|
| 72 | + 'description' => __('Limit result set to those of particular parent IDs.', 'invoicing'), |
|
| 73 | 73 | 'type' => 'array', |
| 74 | 74 | 'items' => array( |
| 75 | 75 | 'type' => 'integer', |
@@ -79,7 +79,7 @@ discard block |
||
| 79 | 79 | ), |
| 80 | 80 | |
| 81 | 81 | 'parent_exclude' => array( |
| 82 | - 'description' => __( 'Limit result set to all items except those of a particular parent ID.', 'invoicing' ), |
|
| 82 | + 'description' => __('Limit result set to all items except those of a particular parent ID.', 'invoicing'), |
|
| 83 | 83 | 'type' => 'array', |
| 84 | 84 | 'items' => array( |
| 85 | 85 | 'type' => 'integer', |
@@ -92,7 +92,7 @@ discard block |
||
| 92 | 92 | ); |
| 93 | 93 | |
| 94 | 94 | // Filter collection parameters for the invoices controller. |
| 95 | - return apply_filters( 'getpaid_rest_invoices_collection_params', $params, $this ); |
|
| 95 | + return apply_filters('getpaid_rest_invoices_collection_params', $params, $this); |
|
| 96 | 96 | } |
| 97 | 97 | |
| 98 | 98 | /** |
@@ -103,21 +103,21 @@ discard block |
||
| 103 | 103 | * @param WP_REST_Request $request Request object. |
| 104 | 104 | * @return array $query_args |
| 105 | 105 | */ |
| 106 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
| 106 | + protected function prepare_items_query($prepared_args = array(), $request = null) { |
|
| 107 | 107 | |
| 108 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
| 108 | + $query_args = parent::prepare_items_query($prepared_args); |
|
| 109 | 109 | |
| 110 | 110 | // Retrieve invoices for specific customers. |
| 111 | - if ( ! empty( $request['customers'] ) ) { |
|
| 111 | + if (!empty($request['customers'])) { |
|
| 112 | 112 | $query_args['author__in'] = $request['customers']; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | 115 | // Skip invoices for specific customers. |
| 116 | - if ( ! empty( $request['exclude_customers'] ) ) { |
|
| 116 | + if (!empty($request['exclude_customers'])) { |
|
| 117 | 117 | $query_args['author__not_in'] = $request['exclude_customers']; |
| 118 | 118 | } |
| 119 | 119 | |
| 120 | - return apply_filters( 'getpaid_rest_invoices_prepare_items_query', $query_args, $request, $this ); |
|
| 120 | + return apply_filters('getpaid_rest_invoices_prepare_items_query', $query_args, $request, $this); |
|
| 121 | 121 | |
| 122 | 122 | } |
| 123 | 123 | |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | * @return array A list of registered item statuses. |
| 130 | 130 | */ |
| 131 | 131 | public function get_post_statuses() { |
| 132 | - return array_keys( wpinv_get_invoice_statuses( true, false, $this->post_type ) ); |
|
| 132 | + return array_keys(wpinv_get_invoice_statuses(true, false, $this->post_type)); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | 135 | /** |
@@ -138,9 +138,9 @@ discard block |
||
| 138 | 138 | * @param WPInv_Invoice $invoice Invoice to save. |
| 139 | 139 | * @return WP_Error|WPInv_Invoice |
| 140 | 140 | */ |
| 141 | - protected function save_object( $invoice ) { |
|
| 141 | + protected function save_object($invoice) { |
|
| 142 | 142 | $invoice->recalculate_total(); |
| 143 | - return parent::save_object( $invoice ); |
|
| 143 | + return parent::save_object($invoice); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | } |
@@ -18,178 +18,178 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Reports_Controller extends GetPaid_REST_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Registers the routes for the objects of the controller. |
|
| 30 | - * |
|
| 31 | - * @since 2.0.0 |
|
| 32 | - * |
|
| 33 | - * @see register_rest_route() |
|
| 34 | - */ |
|
| 35 | - public function register_namespace_routes( $namespace ) { |
|
| 36 | - |
|
| 37 | - // List all available reports. |
|
| 38 | - register_rest_route( |
|
| 39 | - $namespace, |
|
| 40 | - $this->rest_base, |
|
| 41 | - array( |
|
| 42 | - array( |
|
| 43 | - 'methods' => WP_REST_Server::READABLE, |
|
| 44 | - 'callback' => array( $this, 'get_items' ), |
|
| 45 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | - 'args' => $this->get_collection_params(), |
|
| 47 | - ), |
|
| 48 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 49 | - ) |
|
| 50 | - ); |
|
| 51 | - |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Makes sure the current user has access to READ the report APIs. |
|
| 56 | - * |
|
| 57 | - * @since 2.0.0 |
|
| 58 | - * @param WP_REST_Request $request Full data about the request. |
|
| 59 | - * @return WP_Error|boolean |
|
| 60 | - */ |
|
| 61 | - public function get_items_permissions_check( $request ) { |
|
| 62 | - |
|
| 63 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - return true; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * Get reports list. |
|
| 72 | - * |
|
| 73 | - * @since 2.0.0 |
|
| 74 | - * @return array |
|
| 75 | - */ |
|
| 76 | - protected function get_reports() { |
|
| 77 | - |
|
| 78 | - $reports = array( |
|
| 79 | - array( |
|
| 80 | - 'slug' => 'sales', |
|
| 81 | - 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | - ), |
|
| 83 | - array( |
|
| 84 | - 'slug' => 'top_sellers', |
|
| 85 | - 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | - ), |
|
| 87 | - array( |
|
| 88 | - 'slug' => 'top_earners', |
|
| 89 | - 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | - ), |
|
| 91 | - array( |
|
| 92 | - 'slug' => 'invoices/counts', |
|
| 93 | - 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | - ), |
|
| 95 | - ); |
|
| 96 | - |
|
| 97 | - return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | - |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Get all reports. |
|
| 103 | - * |
|
| 104 | - * @since 2.0.0 |
|
| 105 | - * @param WP_REST_Request $request |
|
| 106 | - * @return array|WP_Error |
|
| 107 | - */ |
|
| 108 | - public function get_items( $request ) { |
|
| 109 | - $data = array(); |
|
| 110 | - $reports = $this->get_reports(); |
|
| 111 | - |
|
| 112 | - foreach ( $reports as $report ) { |
|
| 113 | - $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - return rest_ensure_response( $data ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Prepare a report object for serialization. |
|
| 122 | - * |
|
| 123 | - * @since 2.0.0 |
|
| 124 | - * @param stdClass $report Report data. |
|
| 125 | - * @param WP_REST_Request $request Request object. |
|
| 126 | - * @return WP_REST_Response $response Response data. |
|
| 127 | - */ |
|
| 128 | - public function prepare_item_for_response( $report, $request ) { |
|
| 129 | - $data = array( |
|
| 130 | - 'slug' => $report->slug, |
|
| 131 | - 'description' => $report->description, |
|
| 132 | - ); |
|
| 133 | - |
|
| 134 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | - |
|
| 138 | - // Wrap the data in a response object. |
|
| 139 | - $response = rest_ensure_response( $data ); |
|
| 140 | - $response->add_links( |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Registers the routes for the objects of the controller. |
|
| 30 | + * |
|
| 31 | + * @since 2.0.0 |
|
| 32 | + * |
|
| 33 | + * @see register_rest_route() |
|
| 34 | + */ |
|
| 35 | + public function register_namespace_routes( $namespace ) { |
|
| 36 | + |
|
| 37 | + // List all available reports. |
|
| 38 | + register_rest_route( |
|
| 39 | + $namespace, |
|
| 40 | + $this->rest_base, |
|
| 141 | 41 | array( |
| 142 | - 'self' => array( |
|
| 143 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 144 | - ), |
|
| 145 | - 'collection' => array( |
|
| 146 | - 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 147 | - ), |
|
| 42 | + array( |
|
| 43 | + 'methods' => WP_REST_Server::READABLE, |
|
| 44 | + 'callback' => array( $this, 'get_items' ), |
|
| 45 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | + 'args' => $this->get_collection_params(), |
|
| 47 | + ), |
|
| 48 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 148 | 49 | ) |
| 149 | 50 | ); |
| 150 | 51 | |
| 151 | - return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 156 | - * |
|
| 157 | - * @since 2.0.0 |
|
| 158 | - * @return array |
|
| 159 | - */ |
|
| 160 | - public function get_item_schema() { |
|
| 161 | - $schema = array( |
|
| 162 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 163 | - 'title' => 'report', |
|
| 164 | - 'type' => 'object', |
|
| 165 | - 'properties' => array( |
|
| 166 | - 'slug' => array( |
|
| 167 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 168 | - 'type' => 'string', |
|
| 169 | - 'context' => array( 'view' ), |
|
| 170 | - 'readonly' => true, |
|
| 171 | - ), |
|
| 172 | - 'description' => array( |
|
| 173 | - 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 174 | - 'type' => 'string', |
|
| 175 | - 'context' => array( 'view' ), |
|
| 176 | - 'readonly' => true, |
|
| 177 | - ), |
|
| 178 | - ), |
|
| 179 | - ); |
|
| 180 | - |
|
| 181 | - return $this->add_additional_fields_schema( $schema ); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - /** |
|
| 185 | - * Get the query params for collections. |
|
| 186 | - * |
|
| 187 | - * @since 2.0.0 |
|
| 188 | - * @return array |
|
| 189 | - */ |
|
| 190 | - public function get_collection_params() { |
|
| 191 | - return array( |
|
| 192 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 193 | - ); |
|
| 194 | - } |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Makes sure the current user has access to READ the report APIs. |
|
| 56 | + * |
|
| 57 | + * @since 2.0.0 |
|
| 58 | + * @param WP_REST_Request $request Full data about the request. |
|
| 59 | + * @return WP_Error|boolean |
|
| 60 | + */ |
|
| 61 | + public function get_items_permissions_check( $request ) { |
|
| 62 | + |
|
| 63 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + return true; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * Get reports list. |
|
| 72 | + * |
|
| 73 | + * @since 2.0.0 |
|
| 74 | + * @return array |
|
| 75 | + */ |
|
| 76 | + protected function get_reports() { |
|
| 77 | + |
|
| 78 | + $reports = array( |
|
| 79 | + array( |
|
| 80 | + 'slug' => 'sales', |
|
| 81 | + 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | + ), |
|
| 83 | + array( |
|
| 84 | + 'slug' => 'top_sellers', |
|
| 85 | + 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | + ), |
|
| 87 | + array( |
|
| 88 | + 'slug' => 'top_earners', |
|
| 89 | + 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | + ), |
|
| 91 | + array( |
|
| 92 | + 'slug' => 'invoices/counts', |
|
| 93 | + 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | + ), |
|
| 95 | + ); |
|
| 96 | + |
|
| 97 | + return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | + |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Get all reports. |
|
| 103 | + * |
|
| 104 | + * @since 2.0.0 |
|
| 105 | + * @param WP_REST_Request $request |
|
| 106 | + * @return array|WP_Error |
|
| 107 | + */ |
|
| 108 | + public function get_items( $request ) { |
|
| 109 | + $data = array(); |
|
| 110 | + $reports = $this->get_reports(); |
|
| 111 | + |
|
| 112 | + foreach ( $reports as $report ) { |
|
| 113 | + $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + return rest_ensure_response( $data ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Prepare a report object for serialization. |
|
| 122 | + * |
|
| 123 | + * @since 2.0.0 |
|
| 124 | + * @param stdClass $report Report data. |
|
| 125 | + * @param WP_REST_Request $request Request object. |
|
| 126 | + * @return WP_REST_Response $response Response data. |
|
| 127 | + */ |
|
| 128 | + public function prepare_item_for_response( $report, $request ) { |
|
| 129 | + $data = array( |
|
| 130 | + 'slug' => $report->slug, |
|
| 131 | + 'description' => $report->description, |
|
| 132 | + ); |
|
| 133 | + |
|
| 134 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | + |
|
| 138 | + // Wrap the data in a response object. |
|
| 139 | + $response = rest_ensure_response( $data ); |
|
| 140 | + $response->add_links( |
|
| 141 | + array( |
|
| 142 | + 'self' => array( |
|
| 143 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 144 | + ), |
|
| 145 | + 'collection' => array( |
|
| 146 | + 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 147 | + ), |
|
| 148 | + ) |
|
| 149 | + ); |
|
| 150 | + |
|
| 151 | + return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 156 | + * |
|
| 157 | + * @since 2.0.0 |
|
| 158 | + * @return array |
|
| 159 | + */ |
|
| 160 | + public function get_item_schema() { |
|
| 161 | + $schema = array( |
|
| 162 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 163 | + 'title' => 'report', |
|
| 164 | + 'type' => 'object', |
|
| 165 | + 'properties' => array( |
|
| 166 | + 'slug' => array( |
|
| 167 | + 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 168 | + 'type' => 'string', |
|
| 169 | + 'context' => array( 'view' ), |
|
| 170 | + 'readonly' => true, |
|
| 171 | + ), |
|
| 172 | + 'description' => array( |
|
| 173 | + 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 174 | + 'type' => 'string', |
|
| 175 | + 'context' => array( 'view' ), |
|
| 176 | + 'readonly' => true, |
|
| 177 | + ), |
|
| 178 | + ), |
|
| 179 | + ); |
|
| 180 | + |
|
| 181 | + return $this->add_additional_fields_schema( $schema ); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + /** |
|
| 185 | + * Get the query params for collections. |
|
| 186 | + * |
|
| 187 | + * @since 2.0.0 |
|
| 188 | + * @return array |
|
| 189 | + */ |
|
| 190 | + public function get_collection_params() { |
|
| 191 | + return array( |
|
| 192 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 193 | + ); |
|
| 194 | + } |
|
| 195 | 195 | } |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | * @since 2.0.0 |
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | -defined( 'ABSPATH' ) || exit; |
|
| 12 | +defined('ABSPATH') || exit; |
|
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * GetPaid REST reports controller class. |
@@ -32,7 +32,7 @@ discard block |
||
| 32 | 32 | * |
| 33 | 33 | * @see register_rest_route() |
| 34 | 34 | */ |
| 35 | - public function register_namespace_routes( $namespace ) { |
|
| 35 | + public function register_namespace_routes($namespace) { |
|
| 36 | 36 | |
| 37 | 37 | // List all available reports. |
| 38 | 38 | register_rest_route( |
@@ -41,11 +41,11 @@ discard block |
||
| 41 | 41 | array( |
| 42 | 42 | array( |
| 43 | 43 | 'methods' => WP_REST_Server::READABLE, |
| 44 | - 'callback' => array( $this, 'get_items' ), |
|
| 45 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 44 | + 'callback' => array($this, 'get_items'), |
|
| 45 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 46 | 46 | 'args' => $this->get_collection_params(), |
| 47 | 47 | ), |
| 48 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 48 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 49 | 49 | ) |
| 50 | 50 | ); |
| 51 | 51 | |
@@ -58,10 +58,10 @@ discard block |
||
| 58 | 58 | * @param WP_REST_Request $request Full data about the request. |
| 59 | 59 | * @return WP_Error|boolean |
| 60 | 60 | */ |
| 61 | - public function get_items_permissions_check( $request ) { |
|
| 61 | + public function get_items_permissions_check($request) { |
|
| 62 | 62 | |
| 63 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 63 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
| 64 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | 67 | return true; |
@@ -78,23 +78,23 @@ discard block |
||
| 78 | 78 | $reports = array( |
| 79 | 79 | array( |
| 80 | 80 | 'slug' => 'sales', |
| 81 | - 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 81 | + 'description' => __('List of sales reports.', 'invoicing'), |
|
| 82 | 82 | ), |
| 83 | 83 | array( |
| 84 | 84 | 'slug' => 'top_sellers', |
| 85 | - 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 85 | + 'description' => __('List of top selling items.', 'invoicing'), |
|
| 86 | 86 | ), |
| 87 | 87 | array( |
| 88 | 88 | 'slug' => 'top_earners', |
| 89 | - 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 89 | + 'description' => __('List of top earning items.', 'invoicing'), |
|
| 90 | 90 | ), |
| 91 | 91 | array( |
| 92 | 92 | 'slug' => 'invoices/counts', |
| 93 | - 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 93 | + 'description' => __('Invoice counts.', 'invoicing'), |
|
| 94 | 94 | ), |
| 95 | 95 | ); |
| 96 | 96 | |
| 97 | - return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 97 | + return apply_filters('getpaid_available_api_reports', $reports); |
|
| 98 | 98 | |
| 99 | 99 | } |
| 100 | 100 | |
@@ -105,16 +105,16 @@ discard block |
||
| 105 | 105 | * @param WP_REST_Request $request |
| 106 | 106 | * @return array|WP_Error |
| 107 | 107 | */ |
| 108 | - public function get_items( $request ) { |
|
| 108 | + public function get_items($request) { |
|
| 109 | 109 | $data = array(); |
| 110 | 110 | $reports = $this->get_reports(); |
| 111 | 111 | |
| 112 | - foreach ( $reports as $report ) { |
|
| 113 | - $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 112 | + foreach ($reports as $report) { |
|
| 113 | + $item = $this->prepare_item_for_response((object) $report, $request); |
|
| 114 | + $data[] = $this->prepare_response_for_collection($item); |
|
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - return rest_ensure_response( $data ); |
|
| 117 | + return rest_ensure_response($data); |
|
| 118 | 118 | } |
| 119 | 119 | |
| 120 | 120 | /** |
@@ -125,30 +125,30 @@ discard block |
||
| 125 | 125 | * @param WP_REST_Request $request Request object. |
| 126 | 126 | * @return WP_REST_Response $response Response data. |
| 127 | 127 | */ |
| 128 | - public function prepare_item_for_response( $report, $request ) { |
|
| 128 | + public function prepare_item_for_response($report, $request) { |
|
| 129 | 129 | $data = array( |
| 130 | 130 | 'slug' => $report->slug, |
| 131 | 131 | 'description' => $report->description, |
| 132 | 132 | ); |
| 133 | 133 | |
| 134 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 134 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
| 135 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 136 | + $data = $this->filter_response_by_context($data, $context); |
|
| 137 | 137 | |
| 138 | 138 | // Wrap the data in a response object. |
| 139 | - $response = rest_ensure_response( $data ); |
|
| 139 | + $response = rest_ensure_response($data); |
|
| 140 | 140 | $response->add_links( |
| 141 | 141 | array( |
| 142 | 142 | 'self' => array( |
| 143 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 143 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug)), |
|
| 144 | 144 | ), |
| 145 | 145 | 'collection' => array( |
| 146 | - 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 146 | + 'href' => rest_url(sprintf('%s/%s', $this->namespace, $this->rest_base)), |
|
| 147 | 147 | ), |
| 148 | 148 | ) |
| 149 | 149 | ); |
| 150 | 150 | |
| 151 | - return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 151 | + return apply_filters('getpaid_rest_prepare_report', $response, $report, $request); |
|
| 152 | 152 | } |
| 153 | 153 | |
| 154 | 154 | /** |
@@ -164,21 +164,21 @@ discard block |
||
| 164 | 164 | 'type' => 'object', |
| 165 | 165 | 'properties' => array( |
| 166 | 166 | 'slug' => array( |
| 167 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 167 | + 'description' => __('An alphanumeric identifier for the resource.', 'invoicing'), |
|
| 168 | 168 | 'type' => 'string', |
| 169 | - 'context' => array( 'view' ), |
|
| 169 | + 'context' => array('view'), |
|
| 170 | 170 | 'readonly' => true, |
| 171 | 171 | ), |
| 172 | 172 | 'description' => array( |
| 173 | - 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 173 | + 'description' => __('A human-readable description of the resource.', 'invoicing'), |
|
| 174 | 174 | 'type' => 'string', |
| 175 | - 'context' => array( 'view' ), |
|
| 175 | + 'context' => array('view'), |
|
| 176 | 176 | 'readonly' => true, |
| 177 | 177 | ), |
| 178 | 178 | ), |
| 179 | 179 | ); |
| 180 | 180 | |
| 181 | - return $this->add_additional_fields_schema( $schema ); |
|
| 181 | + return $this->add_additional_fields_schema($schema); |
|
| 182 | 182 | } |
| 183 | 183 | |
| 184 | 184 | /** |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | */ |
| 190 | 190 | public function get_collection_params() { |
| 191 | 191 | return array( |
| 192 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 192 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
| 193 | 193 | ); |
| 194 | 194 | } |
| 195 | 195 | } |
@@ -18,626 +18,626 @@ |
||
| 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 | - parent::get_collection_params(), |
|
| 497 | - array( |
|
| 498 | - 'status' => array( |
|
| 499 | - 'default' => $this->get_post_statuses(), |
|
| 500 | - 'description' => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ), |
|
| 501 | - 'type' => array( 'array', 'string' ), |
|
| 502 | - 'items' => array( |
|
| 503 | - 'enum' => $this->get_post_statuses(), |
|
| 504 | - 'type' => 'string', |
|
| 505 | - ), |
|
| 506 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 507 | - 'sanitize_callback' => array( $this, 'sanitize_post_statuses' ), |
|
| 508 | - ), |
|
| 509 | - 'after' => array( |
|
| 510 | - 'description' => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ), |
|
| 511 | - 'type' => 'string', |
|
| 512 | - 'format' => 'string', |
|
| 513 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 514 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 515 | - ), |
|
| 516 | - 'before' => array( |
|
| 517 | - 'description' => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ), |
|
| 518 | - 'type' => 'string', |
|
| 519 | - 'format' => 'string', |
|
| 520 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 521 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 522 | - ), |
|
| 523 | - 'exclude' => array( |
|
| 524 | - 'description' => __( 'Ensure result set excludes specific IDs.', 'invoicing' ), |
|
| 525 | - 'type' => 'array', |
|
| 526 | - 'items' => array( |
|
| 527 | - 'type' => 'integer', |
|
| 528 | - ), |
|
| 529 | - 'default' => array(), |
|
| 530 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 531 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 532 | - ), |
|
| 533 | - 'include' => array( |
|
| 534 | - 'description' => __( 'Limit result set to specific ids.', 'invoicing' ), |
|
| 535 | - 'type' => 'array', |
|
| 536 | - 'items' => array( |
|
| 537 | - 'type' => 'integer', |
|
| 538 | - ), |
|
| 539 | - 'default' => array(), |
|
| 540 | - 'sanitize_callback' => 'wp_parse_id_list', |
|
| 541 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 542 | - ), |
|
| 543 | - 'offset' => array( |
|
| 544 | - 'description' => __( 'Offset the result set by a specific number of items.', 'invoicing' ), |
|
| 545 | - 'type' => 'integer', |
|
| 546 | - 'sanitize_callback' => 'absint', |
|
| 547 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 548 | - ), |
|
| 549 | - 'order' => array( |
|
| 550 | - 'description' => __( 'Order sort attribute ascending or descending.', 'invoicing' ), |
|
| 551 | - 'type' => 'string', |
|
| 552 | - 'default' => 'desc', |
|
| 553 | - 'enum' => array( 'asc', 'desc' ), |
|
| 554 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 555 | - ), |
|
| 556 | - 'orderby' => array( |
|
| 557 | - 'description' => __( 'Sort collection by object attribute.', 'invoicing' ), |
|
| 558 | - 'type' => 'string', |
|
| 559 | - 'default' => 'date', |
|
| 560 | - 'enum' => array( |
|
| 561 | - 'date', |
|
| 562 | - 'id', |
|
| 563 | - 'include', |
|
| 564 | - 'title', |
|
| 565 | - 'slug', |
|
| 566 | - 'modified', |
|
| 567 | - ), |
|
| 568 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | - ), |
|
| 570 | - ) |
|
| 571 | - ); |
|
| 572 | - } |
|
| 573 | - |
|
| 574 | - /** |
|
| 575 | - * Retrieves the items's schema, conforming to JSON Schema. |
|
| 576 | - * |
|
| 577 | - * @since 1.0.19 |
|
| 578 | - * |
|
| 579 | - * @return array Item schema data. |
|
| 580 | - */ |
|
| 581 | - public function get_item_schema() { |
|
| 582 | - |
|
| 583 | - // Maybe retrieve the schema from cache. |
|
| 584 | - if ( ! empty( $this->schema ) ) { |
|
| 585 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 586 | - } |
|
| 587 | - |
|
| 588 | - $type = str_replace( 'wpi_', '', $this->post_type ); |
|
| 589 | - $schema = array( |
|
| 590 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 591 | - 'title' => $this->post_type, |
|
| 592 | - 'type' => 'object', |
|
| 593 | - 'properties' => wpinv_get_data( "$type-schema" ), |
|
| 594 | - ); |
|
| 595 | - |
|
| 596 | - // 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 | + parent::get_collection_params(), |
|
| 497 | + array( |
|
| 498 | + 'status' => array( |
|
| 499 | + 'default' => $this->get_post_statuses(), |
|
| 500 | + 'description' => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ), |
|
| 501 | + 'type' => array( 'array', 'string' ), |
|
| 502 | + 'items' => array( |
|
| 503 | + 'enum' => $this->get_post_statuses(), |
|
| 504 | + 'type' => 'string', |
|
| 505 | + ), |
|
| 506 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 507 | + 'sanitize_callback' => array( $this, 'sanitize_post_statuses' ), |
|
| 508 | + ), |
|
| 509 | + 'after' => array( |
|
| 510 | + 'description' => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ), |
|
| 511 | + 'type' => 'string', |
|
| 512 | + 'format' => 'string', |
|
| 513 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 514 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 515 | + ), |
|
| 516 | + 'before' => array( |
|
| 517 | + 'description' => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ), |
|
| 518 | + 'type' => 'string', |
|
| 519 | + 'format' => 'string', |
|
| 520 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 521 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 522 | + ), |
|
| 523 | + 'exclude' => array( |
|
| 524 | + 'description' => __( 'Ensure result set excludes specific IDs.', 'invoicing' ), |
|
| 525 | + 'type' => 'array', |
|
| 526 | + 'items' => array( |
|
| 527 | + 'type' => 'integer', |
|
| 528 | + ), |
|
| 529 | + 'default' => array(), |
|
| 530 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 531 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 532 | + ), |
|
| 533 | + 'include' => array( |
|
| 534 | + 'description' => __( 'Limit result set to specific ids.', 'invoicing' ), |
|
| 535 | + 'type' => 'array', |
|
| 536 | + 'items' => array( |
|
| 537 | + 'type' => 'integer', |
|
| 538 | + ), |
|
| 539 | + 'default' => array(), |
|
| 540 | + 'sanitize_callback' => 'wp_parse_id_list', |
|
| 541 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 542 | + ), |
|
| 543 | + 'offset' => array( |
|
| 544 | + 'description' => __( 'Offset the result set by a specific number of items.', 'invoicing' ), |
|
| 545 | + 'type' => 'integer', |
|
| 546 | + 'sanitize_callback' => 'absint', |
|
| 547 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 548 | + ), |
|
| 549 | + 'order' => array( |
|
| 550 | + 'description' => __( 'Order sort attribute ascending or descending.', 'invoicing' ), |
|
| 551 | + 'type' => 'string', |
|
| 552 | + 'default' => 'desc', |
|
| 553 | + 'enum' => array( 'asc', 'desc' ), |
|
| 554 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 555 | + ), |
|
| 556 | + 'orderby' => array( |
|
| 557 | + 'description' => __( 'Sort collection by object attribute.', 'invoicing' ), |
|
| 558 | + 'type' => 'string', |
|
| 559 | + 'default' => 'date', |
|
| 560 | + 'enum' => array( |
|
| 561 | + 'date', |
|
| 562 | + 'id', |
|
| 563 | + 'include', |
|
| 564 | + 'title', |
|
| 565 | + 'slug', |
|
| 566 | + 'modified', |
|
| 567 | + ), |
|
| 568 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | + ), |
|
| 570 | + ) |
|
| 571 | + ); |
|
| 572 | + } |
|
| 573 | + |
|
| 574 | + /** |
|
| 575 | + * Retrieves the items's schema, conforming to JSON Schema. |
|
| 576 | + * |
|
| 577 | + * @since 1.0.19 |
|
| 578 | + * |
|
| 579 | + * @return array Item schema data. |
|
| 580 | + */ |
|
| 581 | + public function get_item_schema() { |
|
| 582 | + |
|
| 583 | + // Maybe retrieve the schema from cache. |
|
| 584 | + if ( ! empty( $this->schema ) ) { |
|
| 585 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 586 | + } |
|
| 587 | + |
|
| 588 | + $type = str_replace( 'wpi_', '', $this->post_type ); |
|
| 589 | + $schema = array( |
|
| 590 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 591 | + 'title' => $this->post_type, |
|
| 592 | + 'type' => 'object', |
|
| 593 | + 'properties' => wpinv_get_data( "$type-schema" ), |
|
| 594 | + ); |
|
| 595 | + |
|
| 596 | + // Filters the invoice schema for the REST API. |
|
| 597 | 597 | $schema = apply_filters( "wpinv_rest_{$type}_schema", $schema ); |
| 598 | 598 | |
| 599 | - // Cache the invoice schema. |
|
| 600 | - $this->schema = $schema; |
|
| 601 | - |
|
| 602 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 603 | - } |
|
| 604 | - |
|
| 605 | - /** |
|
| 606 | - * Sanitizes and validates the list of post statuses. |
|
| 607 | - * |
|
| 608 | - * @since 1.0.13 |
|
| 609 | - * |
|
| 610 | - * @param string|array $statuses One or more post statuses. |
|
| 611 | - * @param WP_REST_Request $request Full details about the request. |
|
| 612 | - * @param string $parameter Additional parameter to pass to validation. |
|
| 613 | - * @return array|WP_Error A list of valid statuses, otherwise WP_Error object. |
|
| 614 | - */ |
|
| 615 | - public function sanitize_post_statuses( $statuses, $request, $parameter ) { |
|
| 616 | - return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() ); |
|
| 617 | - } |
|
| 618 | - |
|
| 619 | - /** |
|
| 620 | - * Retrieves a valid list of post statuses. |
|
| 621 | - * |
|
| 622 | - * @since 1.0.19 |
|
| 623 | - * |
|
| 624 | - * @return array A list of registered item statuses. |
|
| 625 | - */ |
|
| 626 | - public function get_post_statuses() { |
|
| 627 | - return get_post_stati(); |
|
| 628 | - } |
|
| 629 | - |
|
| 630 | - /** |
|
| 631 | - * Checks if a key should be included in a response. |
|
| 632 | - * |
|
| 633 | - * @since 1.0.19 |
|
| 634 | - * @param GetPaid_Data $object Data object. |
|
| 635 | - * @param string $field_key The key to check for. |
|
| 636 | - * @return bool |
|
| 637 | - */ |
|
| 638 | - public function object_supports_field( $object, $field_key ) { |
|
| 639 | - $supports = parent::object_supports_field( $object, $field_key ); |
|
| 640 | - return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key ); |
|
| 641 | - } |
|
| 599 | + // Cache the invoice schema. |
|
| 600 | + $this->schema = $schema; |
|
| 601 | + |
|
| 602 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 603 | + } |
|
| 604 | + |
|
| 605 | + /** |
|
| 606 | + * Sanitizes and validates the list of post statuses. |
|
| 607 | + * |
|
| 608 | + * @since 1.0.13 |
|
| 609 | + * |
|
| 610 | + * @param string|array $statuses One or more post statuses. |
|
| 611 | + * @param WP_REST_Request $request Full details about the request. |
|
| 612 | + * @param string $parameter Additional parameter to pass to validation. |
|
| 613 | + * @return array|WP_Error A list of valid statuses, otherwise WP_Error object. |
|
| 614 | + */ |
|
| 615 | + public function sanitize_post_statuses( $statuses, $request, $parameter ) { |
|
| 616 | + return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() ); |
|
| 617 | + } |
|
| 618 | + |
|
| 619 | + /** |
|
| 620 | + * Retrieves a valid list of post statuses. |
|
| 621 | + * |
|
| 622 | + * @since 1.0.19 |
|
| 623 | + * |
|
| 624 | + * @return array A list of registered item statuses. |
|
| 625 | + */ |
|
| 626 | + public function get_post_statuses() { |
|
| 627 | + return get_post_stati(); |
|
| 628 | + } |
|
| 629 | + |
|
| 630 | + /** |
|
| 631 | + * Checks if a key should be included in a response. |
|
| 632 | + * |
|
| 633 | + * @since 1.0.19 |
|
| 634 | + * @param GetPaid_Data $object Data object. |
|
| 635 | + * @param string $field_key The key to check for. |
|
| 636 | + * @return bool |
|
| 637 | + */ |
|
| 638 | + public function object_supports_field( $object, $field_key ) { |
|
| 639 | + $supports = parent::object_supports_field( $object, $field_key ); |
|
| 640 | + return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key ); |
|
| 641 | + } |
|
| 642 | 642 | |
| 643 | 643 | } |
@@ -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 | } |
@@ -497,31 +497,31 @@ discard block |
||
| 497 | 497 | array( |
| 498 | 498 | 'status' => array( |
| 499 | 499 | 'default' => $this->get_post_statuses(), |
| 500 | - 'description' => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ), |
|
| 501 | - 'type' => array( 'array', 'string' ), |
|
| 500 | + 'description' => __('Limit result set to resources assigned one or more statuses.', 'invoicing'), |
|
| 501 | + 'type' => array('array', 'string'), |
|
| 502 | 502 | 'items' => array( |
| 503 | 503 | 'enum' => $this->get_post_statuses(), |
| 504 | 504 | 'type' => 'string', |
| 505 | 505 | ), |
| 506 | 506 | 'validate_callback' => 'rest_validate_request_arg', |
| 507 | - 'sanitize_callback' => array( $this, 'sanitize_post_statuses' ), |
|
| 507 | + 'sanitize_callback' => array($this, 'sanitize_post_statuses'), |
|
| 508 | 508 | ), |
| 509 | 509 | 'after' => array( |
| 510 | - 'description' => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ), |
|
| 510 | + 'description' => __('Limit response to resources created after a given ISO8601 compliant date.', 'invoicing'), |
|
| 511 | 511 | 'type' => 'string', |
| 512 | 512 | 'format' => 'string', |
| 513 | 513 | 'validate_callback' => 'rest_validate_request_arg', |
| 514 | 514 | 'sanitize_callback' => 'sanitize_text_field', |
| 515 | 515 | ), |
| 516 | 516 | 'before' => array( |
| 517 | - 'description' => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ), |
|
| 517 | + 'description' => __('Limit response to resources created before a given ISO8601 compliant date.', 'invoicing'), |
|
| 518 | 518 | 'type' => 'string', |
| 519 | 519 | 'format' => 'string', |
| 520 | 520 | 'validate_callback' => 'rest_validate_request_arg', |
| 521 | 521 | 'sanitize_callback' => 'sanitize_text_field', |
| 522 | 522 | ), |
| 523 | 523 | 'exclude' => array( |
| 524 | - 'description' => __( 'Ensure result set excludes specific IDs.', 'invoicing' ), |
|
| 524 | + 'description' => __('Ensure result set excludes specific IDs.', 'invoicing'), |
|
| 525 | 525 | 'type' => 'array', |
| 526 | 526 | 'items' => array( |
| 527 | 527 | 'type' => 'integer', |
@@ -531,7 +531,7 @@ discard block |
||
| 531 | 531 | 'validate_callback' => 'rest_validate_request_arg', |
| 532 | 532 | ), |
| 533 | 533 | 'include' => array( |
| 534 | - 'description' => __( 'Limit result set to specific ids.', 'invoicing' ), |
|
| 534 | + 'description' => __('Limit result set to specific ids.', 'invoicing'), |
|
| 535 | 535 | 'type' => 'array', |
| 536 | 536 | 'items' => array( |
| 537 | 537 | 'type' => 'integer', |
@@ -541,20 +541,20 @@ discard block |
||
| 541 | 541 | 'validate_callback' => 'rest_validate_request_arg', |
| 542 | 542 | ), |
| 543 | 543 | 'offset' => array( |
| 544 | - 'description' => __( 'Offset the result set by a specific number of items.', 'invoicing' ), |
|
| 544 | + 'description' => __('Offset the result set by a specific number of items.', 'invoicing'), |
|
| 545 | 545 | 'type' => 'integer', |
| 546 | 546 | 'sanitize_callback' => 'absint', |
| 547 | 547 | 'validate_callback' => 'rest_validate_request_arg', |
| 548 | 548 | ), |
| 549 | 549 | 'order' => array( |
| 550 | - 'description' => __( 'Order sort attribute ascending or descending.', 'invoicing' ), |
|
| 550 | + 'description' => __('Order sort attribute ascending or descending.', 'invoicing'), |
|
| 551 | 551 | 'type' => 'string', |
| 552 | 552 | 'default' => 'desc', |
| 553 | - 'enum' => array( 'asc', 'desc' ), |
|
| 553 | + 'enum' => array('asc', 'desc'), |
|
| 554 | 554 | 'validate_callback' => 'rest_validate_request_arg', |
| 555 | 555 | ), |
| 556 | 556 | 'orderby' => array( |
| 557 | - 'description' => __( 'Sort collection by object attribute.', 'invoicing' ), |
|
| 557 | + 'description' => __('Sort collection by object attribute.', 'invoicing'), |
|
| 558 | 558 | 'type' => 'string', |
| 559 | 559 | 'default' => 'date', |
| 560 | 560 | 'enum' => array( |
@@ -581,25 +581,25 @@ discard block |
||
| 581 | 581 | public function get_item_schema() { |
| 582 | 582 | |
| 583 | 583 | // Maybe retrieve the schema from cache. |
| 584 | - if ( ! empty( $this->schema ) ) { |
|
| 585 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 584 | + if (!empty($this->schema)) { |
|
| 585 | + return $this->add_additional_fields_schema($this->schema); |
|
| 586 | 586 | } |
| 587 | 587 | |
| 588 | - $type = str_replace( 'wpi_', '', $this->post_type ); |
|
| 588 | + $type = str_replace('wpi_', '', $this->post_type); |
|
| 589 | 589 | $schema = array( |
| 590 | 590 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 591 | 591 | 'title' => $this->post_type, |
| 592 | 592 | 'type' => 'object', |
| 593 | - 'properties' => wpinv_get_data( "$type-schema" ), |
|
| 593 | + 'properties' => wpinv_get_data("$type-schema"), |
|
| 594 | 594 | ); |
| 595 | 595 | |
| 596 | 596 | // Filters the invoice schema for the REST API. |
| 597 | - $schema = apply_filters( "wpinv_rest_{$type}_schema", $schema ); |
|
| 597 | + $schema = apply_filters("wpinv_rest_{$type}_schema", $schema); |
|
| 598 | 598 | |
| 599 | 599 | // Cache the invoice schema. |
| 600 | 600 | $this->schema = $schema; |
| 601 | 601 | |
| 602 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 602 | + return $this->add_additional_fields_schema($this->schema); |
|
| 603 | 603 | } |
| 604 | 604 | |
| 605 | 605 | /** |
@@ -612,8 +612,8 @@ discard block |
||
| 612 | 612 | * @param string $parameter Additional parameter to pass to validation. |
| 613 | 613 | * @return array|WP_Error A list of valid statuses, otherwise WP_Error object. |
| 614 | 614 | */ |
| 615 | - public function sanitize_post_statuses( $statuses, $request, $parameter ) { |
|
| 616 | - return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() ); |
|
| 615 | + public function sanitize_post_statuses($statuses, $request, $parameter) { |
|
| 616 | + return array_intersect(wp_parse_slug_list($statuses), $this->get_post_statuses()); |
|
| 617 | 617 | } |
| 618 | 618 | |
| 619 | 619 | /** |
@@ -635,9 +635,9 @@ discard block |
||
| 635 | 635 | * @param string $field_key The key to check for. |
| 636 | 636 | * @return bool |
| 637 | 637 | */ |
| 638 | - public function object_supports_field( $object, $field_key ) { |
|
| 639 | - $supports = parent::object_supports_field( $object, $field_key ); |
|
| 640 | - return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key ); |
|
| 638 | + public function object_supports_field($object, $field_key) { |
|
| 639 | + $supports = parent::object_supports_field($object, $field_key); |
|
| 640 | + return apply_filters("getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key); |
|
| 641 | 641 | } |
| 642 | 642 | |
| 643 | 643 | } |
@@ -7,7 +7,7 @@ discard block |
||
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | 9 | // MUST have WordPress. |
| 10 | -if ( ! defined( 'WPINC' ) ) { |
|
| 10 | +if (!defined('WPINC')) { |
|
| 11 | 11 | exit; |
| 12 | 12 | } |
| 13 | 13 | |
@@ -24,40 +24,40 @@ discard block |
||
| 24 | 24 | * @param Array $assoc_args Key value arguments stored in associated array format. |
| 25 | 25 | * @since 1.0.13 |
| 26 | 26 | */ |
| 27 | - public function insert_invoice( $args, $assoc_args ) { |
|
| 27 | + public function insert_invoice($args, $assoc_args) { |
|
| 28 | 28 | |
| 29 | 29 | // Fetch invoice data from the args |
| 30 | - $invoice_data = wp_unslash( $assoc_args ); |
|
| 30 | + $invoice_data = wp_unslash($assoc_args); |
|
| 31 | 31 | |
| 32 | 32 | // Abort if no invoice data is provided |
| 33 | - if ( empty( $invoice_data ) ) { |
|
| 34 | - return WP_CLI::error( __( 'Invoice data not provided', 'invoicing' ) ); |
|
| 33 | + if (empty($invoice_data)) { |
|
| 34 | + return WP_CLI::error(__('Invoice data not provided', 'invoicing')); |
|
| 35 | 35 | } |
| 36 | 36 | |
| 37 | 37 | //Cart details |
| 38 | - if ( ! empty( $invoice_data['cart_details'] ) ) { |
|
| 39 | - $invoice_data['cart_details'] = json_decode( $invoice_data['cart_details'], true ); |
|
| 38 | + if (!empty($invoice_data['cart_details'])) { |
|
| 39 | + $invoice_data['cart_details'] = json_decode($invoice_data['cart_details'], true); |
|
| 40 | 40 | } |
| 41 | 41 | |
| 42 | 42 | //User details |
| 43 | - if ( ! empty( $invoice_data['user_info'] ) ) { |
|
| 44 | - $invoice_data['user_info'] = json_decode( $invoice_data['user_info'], true ); |
|
| 43 | + if (!empty($invoice_data['user_info'])) { |
|
| 44 | + $invoice_data['user_info'] = json_decode($invoice_data['user_info'], true); |
|
| 45 | 45 | } |
| 46 | 46 | |
| 47 | 47 | //Payment info |
| 48 | - if ( ! empty( $invoice_data['payment_details'] ) ) { |
|
| 49 | - $invoice_data['payment_details'] = json_decode( $invoice_data['payment_details'], true ); |
|
| 48 | + if (!empty($invoice_data['payment_details'])) { |
|
| 49 | + $invoice_data['payment_details'] = json_decode($invoice_data['payment_details'], true); |
|
| 50 | 50 | } |
| 51 | 51 | |
| 52 | 52 | // Try creating the invoice |
| 53 | - $invoice = wpinv_insert_invoice( $invoice_data, true ); |
|
| 53 | + $invoice = wpinv_insert_invoice($invoice_data, true); |
|
| 54 | 54 | |
| 55 | - if ( is_wp_error( $invoice ) ) { |
|
| 56 | - return WP_CLI::error( $invoice->get_error_message() ); |
|
| 55 | + if (is_wp_error($invoice)) { |
|
| 56 | + return WP_CLI::error($invoice->get_error_message()); |
|
| 57 | 57 | } |
| 58 | 58 | |
| 59 | - $message = sprintf( __( 'Invoice %s created', 'invoicing' ), $invoice->get_id() ); |
|
| 60 | - WP_CLI::success( $message ); |
|
| 59 | + $message = sprintf(__('Invoice %s created', 'invoicing'), $invoice->get_id()); |
|
| 60 | + WP_CLI::success($message); |
|
| 61 | 61 | } |
| 62 | 62 | |
| 63 | 63 | |