chore: Linter and compliance met

wp-graphql · May 17, 2024 · d503527 · d503527
1 parent d5f21de
commit d503527
Show file tree

Hide file tree

Showing 15 changed files with 47 additions and 40 deletions.
diff --git a/includes/data/connection/class-shipping-zone-connection-resolver.php b/includes/data/connection/class-shipping-zone-connection-resolver.php
@@ -62,7 +62,6 @@ public function get_query() {
 		/** @var \WC_Shipping_Zone $rest_of_the_world */
 		$rest_of_the_world = \WC_Shipping_Zones::get_zone_by( 'zone_id', 0 );
 
-
 		$zones = \WC_Shipping_Zones::get_zones();
 		array_unshift( $zones, $rest_of_the_world->get_data() );
 

diff --git a/includes/data/mutation/class-settings-mutation.php b/includes/data/mutation/class-settings-mutation.php
@@ -31,9 +31,9 @@ public static function validate_setting_text_field( $value, $setting ) {
 	 *
 	 * @param string $value Value.
 	 * @param array  $setting Setting.
-	 * 
+	 *
 	 * @throws \GraphQL\Error\UserError If an invalid setting value was passed.
-	 * 
+	 *
 	 * @return string
 	 */
 	public static function validate_setting_select_field( $value, $setting ) {
@@ -49,9 +49,9 @@ public static function validate_setting_select_field( $value, $setting ) {
 	 *
 	 * @param array $values Values.
 	 * @param array $setting Setting.
-	 * 
+	 *
 	 * @throws \GraphQL\Error\UserError If an invalid setting value was passed.
-	 * 
+	 *
 	 * @return array
 	 */
 	public static function validate_setting_multiselect_field( $values, $setting ) {
@@ -78,9 +78,9 @@ public static function validate_setting_multiselect_field( $values, $setting ) {
 	 *
 	 * @param array $values Values.
 	 * @param array $setting Setting.
-	 * 
+	 *
 	 * @throws \GraphQL\Error\UserError If an invalid setting value was passed.
-	 * 
+	 *
 	 * @return string
 	 */
 	public static function validate_setting_image_width_field( $values, $setting ) {
@@ -106,9 +106,9 @@ public static function validate_setting_image_width_field( $values, $setting ) {
 	 *
 	 * @param string $value Value.
 	 * @param array  $setting Setting.
-	 * 
+	 *
 	 * @throws \GraphQL\Error\UserError If an invalid setting value was passed.
-	 * 
+	 *
 	 * @return string
 	 */
 	public static function validate_setting_radio_field( $value, $setting ) {
@@ -120,9 +120,9 @@ public static function validate_setting_radio_field( $value, $setting ) {
 	 *
 	 * @param string $value Value.
 	 * @param array  $setting Setting.
-	 * 
+	 *
 	 * @throws \GraphQL\Error\UserError If an invalid setting value was passed.
-	 * 
+	 *
 	 * @return string
 	 */
 	public function validate_setting_checkbox_field( $value, $setting ) {
@@ -141,7 +141,7 @@ public function validate_setting_checkbox_field( $value, $setting ) {
 	 *
 	 * @param string $value Value.
 	 * @param array  $setting Setting.
-	 * 
+	 *
 	 * @return string
 	 */
 	public static function validate_setting_textarea_field( $value, $setting ) {

diff --git a/includes/data/mutation/class-shipping-mutation.php b/includes/data/mutation/class-shipping-mutation.php
@@ -16,7 +16,7 @@ class Shipping_Mutation {
 	 * Maps the settings input for insertion.
 	 *
 	 * @param array<array<string, string>> $settings_input  Settings input.
-	 * 
+	 *
 	 * @return array<string, string>
 	 */
 	private static function flatten_settings_input( $settings_input ) {
@@ -33,7 +33,7 @@ private static function flatten_settings_input( $settings_input ) {
 	 * @param int                 $instance_id     Instance ID.
 	 * @param \WC_Shipping_Method $method          Shipping method data.
 	 * @param array               $settings_input  Settings input.
-	 * 
+	 *
 	 * @return \WC_Shipping_Method
 	 */
 	public static function set_shipping_zone_method_settings( $instance_id, $method, $settings_input ) {
@@ -71,7 +71,7 @@ public static function set_shipping_zone_method_settings( $instance_id, $method,
 	 * @param int                 $instance_id  Instance ID.
 	 * @param \WC_Shipping_Method $method       Shipping method data.
 	 * @param int                 $order        Order.
-	 * 
+	 *
 	 * @return \WC_Shipping_Method
 	 */
 	public static function set_shipping_zone_method_order( $instance_id, $method, $order ) {
@@ -80,7 +80,7 @@ public static function set_shipping_zone_method_order( $instance_id, $method, $o
 		$wpdb->update( // phpcs:ignore WordPress.DB.DirectDatabaseQuery
 			"{$wpdb->prefix}woocommerce_shipping_zone_methods",
 			[ 'method_order' => $order ],
-			[ 'instance_id' => $instance_id ] 
+			[ 'instance_id' => $instance_id ]
 		);
 		$method->method_order = $order;
 
@@ -94,7 +94,7 @@ public static function set_shipping_zone_method_order( $instance_id, $method, $o
 	 * @param int                 $instance_id  Instance ID.
 	 * @param \WC_Shipping_Method $method       Shipping method data.
 	 * @param bool                $enabled      Enabled status.
-	 * 
+	 *
 	 * @return \WC_Shipping_Method
 	 */
 	public static function set_shipping_zone_method_enabled( $zone_id, $instance_id, $method, $enabled ) {

diff --git a/includes/model/class-shipping-zone.php b/includes/model/class-shipping-zone.php
@@ -1,9 +1,9 @@
 <?php
 /**
  * Model - Shipping_Zone
- * 
+ *
  * This model represents a Shipping Zone.
- * 
+ *
  * @package WPGraphQL\WooCommerce\Model
  * @since TBD
  */

diff --git a/includes/mutation/class-shipping-zone-create.php b/includes/mutation/class-shipping-zone-create.php
@@ -85,7 +85,7 @@ public static function mutate_and_get_payload() {
 
 			$zone = new \WC_Shipping_Zone( null );
 			$zone->set_zone_name( $input['name'] );
-			
+
 			if ( ! empty( $input['order'] ) ) {
 				$zone->set_zone_order( $input['order'] );
 			}

diff --git a/includes/mutation/class-shipping-zone-delete.php b/includes/mutation/class-shipping-zone-delete.php
@@ -78,7 +78,7 @@ public static function mutate_and_get_payload() {
 			if ( ! \wc_rest_check_manager_permissions( 'settings', 'delete' ) ) {
 				throw new UserError( __( 'Sorry, you are not allowed to delete shipping zones', 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
 			}
-	
+
 			$zone_id = $input['id'];
 			/** @var \WC_Shipping_Zone|false $zone */
 			$zone = \WC_Shipping_Zones::get_zone_by( 'zone_id', $zone_id );

diff --git a/includes/mutation/class-shipping-zone-method-add.php b/includes/mutation/class-shipping-zone-method-add.php
@@ -84,7 +84,7 @@ public static function get_output_fields() {
 				'resolve' => static function ( $payload, array $args, AppContext $context ) {
 					return [
 						// Call the Shipping_Method constructor directly because "$payload['method']" is a non-scalar value.
-						'node'   => new Shipping_Method( $payload['method'] ), 
+						'node'   => new Shipping_Method( $payload['method'] ),
 						'source' => $context->get_loader( 'shipping_zone' )->load( $payload['zone_id'] ),
 					];
 				},

diff --git a/includes/mutation/class-shipping-zone-method-remove.php b/includes/mutation/class-shipping-zone-method-remove.php
@@ -71,7 +71,7 @@ public static function get_output_fields() {
 				'resolve' => static function ( $payload, array $args, AppContext $context ) {
 					return [
 						// Call the Shipping_Method constructor directly because "$payload['method']" is a non-scalar value.
-						'node'   => new Shipping_Method( $payload['method'] ), 
+						'node'   => new Shipping_Method( $payload['method'] ),
 						'source' => $context->get_loader( 'shipping_zone' )->load( $payload['zone_id'] ),
 					];
 				},

diff --git a/includes/mutation/class-shipping-zone-method-update.php b/includes/mutation/class-shipping-zone-method-update.php
@@ -84,7 +84,7 @@ public static function get_output_fields() {
 				'resolve' => static function ( $payload, array $args, AppContext $context ) {
 					return [
 						// Call the Shipping_Method constructor directly because "$payload['method']" is a non-scalar value.
-						'node'   => new Shipping_Method( $payload['method'] ), 
+						'node'   => new Shipping_Method( $payload['method'] ),
 						'source' => $context->get_loader( 'shipping_zone' )->load( $payload['zone_id'] ),
 					];
 				},

diff --git a/includes/mutation/class-tax-class-create.php b/includes/mutation/class-tax-class-create.php
@@ -76,7 +76,7 @@ public static function get_output_fields() {
 	public static function mutate_and_get_payload() {
 		return static function ( $input, AppContext $context, ResolveInfo $info ) {
 			if ( ! \wc_rest_check_manager_permissions( 'settings', 'create' ) ) {
-				throw new UserError( __( "Sorry, you are not allowed to create tax classes.", 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
+				throw new UserError( __( 'Sorry, you are not allowed to create tax classes.', 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
 			}
 			$name = $input['name'];
 			$slug = ! empty( $input['slug'] ) ? $input['slug'] : '';
@@ -90,8 +90,8 @@ public static function mutate_and_get_payload() {
 			/**
 			 * Filter tax class object before responding.
 			 *
-			 * @param object $tax_class  The shipping method object.
-			 * @param array  $input   Request input.
+			 * @param array $tax_class  The shipping method object.
+			 * @param array $input   Request input.
 			 */
 			$tax_class = apply_filters( 'graphql_woocommerce_tax_class_create', $tax_class, $input );
 

diff --git a/includes/mutation/class-tax-class-delete.php b/includes/mutation/class-tax-class-delete.php
@@ -72,9 +72,10 @@ public static function get_output_fields() {
 	public static function mutate_and_get_payload() {
 		return static function ( $input, AppContext $context, ResolveInfo $info ) {
 			if ( ! \wc_rest_check_manager_permissions( 'settings', 'delete' ) ) {
-				throw new UserError( __( "Sorry, you are not allowed to delete tax classes.", 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
+				throw new UserError( __( 'Sorry, you are not allowed to delete tax classes.', 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
 			}
 			$slug      = $input['slug'];
+			/** @var array|false $tax_class */
 			$tax_class = \WC_Tax::get_tax_class_by( 'slug', $slug );
 			if ( ! $tax_class ) {
 				throw new UserError( __( 'Invalid tax class slug.', 'wp-graphql-woocommerce' ) );
@@ -83,8 +84,8 @@ public static function mutate_and_get_payload() {
 			/**
 			 * Action hook before deleting tax class.
 			 *
-			 * @param object $tax_class  The tax class object.
-			 * @param array  $input   Request input.
+			 * @param array $tax_class  The tax class object.
+			 * @param array $input   Request input.
 			 */
 			do_action( 'graphql_woocommerce_before_tax_class_delete', $tax_class, $input );
 
@@ -96,8 +97,8 @@ public static function mutate_and_get_payload() {
 			/**
 			 * Filter tax class object before responding.
 			 *
-			 * @param object $tax_class  The shipping method object.
-			 * @param array  $input   Request input.
+			 * @param array $tax_class  The shipping method object.
+			 * @param array $input   Request input.
 			 */
 			$tax_class = apply_filters( 'graphql_woocommerce_tax_class_delete', $tax_class, $input );
 

diff --git a/includes/mutation/class-tax-rate-create.php b/includes/mutation/class-tax-rate-create.php
@@ -10,6 +10,7 @@
 
 namespace WPGraphQL\WooCommerce\Mutation;
 
+use GraphQL\Error\UserError;
 use GraphQL\Type\Definition\ResolveInfo;
 use WPGraphQL\AppContext;
 
@@ -120,12 +121,19 @@ public static function mutate_and_get_payload( $input, AppContext $context, Reso
 		$action     = ! $id ? 'create' : 'update';
 		$permission = ! $id ? 'create' : 'edit';
 		if ( ! \wc_rest_check_manager_permissions( 'settings', $permission ) ) {
-			throw new UserError( __( "Sorry, you are not allowed to {$permission} tax rates.", 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
+			throw new UserError(
+				sprintf(
+					/* translators: %s: permission */
+					__( 'Sorry, you are not allowed to %s tax rates.', 'wp-graphql-woocommerce' ),
+					$permission
+				),
+				\rest_authorization_required_code()
+			);
 		}
-		
+
 		$current = null;
 		if ( ! empty( $id ) ) {
-			/** 
+			/**
 			 * @var object{
 			 *  tax_rate_id: int,
 			 *  tax_rate_class: string,
@@ -206,7 +214,6 @@ public static function mutate_and_get_payload( $input, AppContext $context, Reso
 			\WC_Tax::_update_tax_rate_postcodes( $id, join( ';', $input['postcodes'] ) );
 		}
 
-
 		/**
 		 * Filter tax rate object before responding.
 		 *

diff --git a/includes/mutation/class-tax-rate-delete.php b/includes/mutation/class-tax-rate-delete.php
@@ -101,7 +101,7 @@ public static function mutate_and_get_payload() {
 			 * @param object $tax_rate  The shipping method object.
 			 * @param array  $input     Request input.
 			 */
-			$tax = apply_filters( "graphql_woocommerce_tax_rate_delete", $tax, $input );
+			$tax = apply_filters( 'graphql_woocommerce_tax_rate_delete', $tax, $input );
 
 			return [
 				'taxRate' => $tax,

diff --git a/includes/type/object/class-root-query.php b/includes/type/object/class-root-query.php
@@ -416,7 +416,7 @@ public static function register_fields() {
 						if ( ! \wc_rest_check_manager_permissions( 'shipping_methods', 'read' ) ) {
 							throw new UserError( __( 'Sorry, you cannot view shipping methods.', 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
 						}
-				
+
 						$id      = isset( $args['id'] ) ? $args['id'] : null;
 						$id_type = isset( $args['idType'] ) ? $args['idType'] : 'global_id';
 
@@ -455,7 +455,7 @@ public static function register_fields() {
 						if ( ! \wc_shipping_enabled() ) {
 							throw new UserError( __( 'Shipping is disabled.', 'wp-graphql-woocommerce' ), 404 );
 						}
-			
+
 						if ( ! \wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
 							throw new UserError( __( 'Permission denied.', 'wp-graphql-woocommerce' ), \rest_authorization_required_code() );
 						}

diff --git a/includes/type/object/class-shipping-zone-type.php b/includes/type/object/class-shipping-zone-type.php
@@ -115,7 +115,7 @@ public static function register() {
 											$default_value = ! empty( $field['default'] ) ? $field['default'] : null;
 											$value         = ! empty( $instance_settings[ $key ] ) ? $instance_settings[ $key ] : $default_value;
 											$settings[]    = array_merge(
-												$field, 
+												$field,
 												[
 													'id' => $key,
 													'value' => $value,