Replacing a heredoc encoded JSON schema with a JSON file

1984hosting · Jul 18, 2024 · 734529c · 734529c
1 parent 16c5daa
commit 734529c
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 34 deletions.
diff --git a/json_schemas/rest/settings.json b/json_schemas/rest/settings.json
@@ -0,0 +1,28 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+        "api_key": { "type": "string" },
+        "product_price_sync": { "type": "boolean" },
+        "product_quantity_sync": { "type": "boolean" },
+        "product_name_sync": { "type": "boolean" },
+        "default_kennitala": { "type": "string" },
+        "shipping_sku": { "type": "string" },
+        "kennitala_classic_field_enabled": { "type": "boolean" },
+        "kennitala_block_field_enabled": { "type": "boolean" },
+        "default_sales_person": { "type": "string" },
+        "fetch_products": { "type": "boolean" },
+        "payment_methods": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "woo_id": { "type": "string" },
+                    "dk_id": { "type": "number" },
+                    "dk_term": { "type": "string" }
+                },
+                "required": ["woo_id", "dk_id" ]
+            }
+        }
+    }
+}
diff --git a/src/Rest/Settings.php b/src/Rest/Settings.php
@@ -20,37 +20,6 @@
  * Handles the `NineteenEightyWoo/v1/settings/` REST endpoint.
  */
 class Settings {
-	const JSON_SCHEMA = <<<'JSON'
-	{
-		"$schema": "http://json-schema.org/draft-07/schema#",
-		"type": "object",
-		"properties": {
-			"api_key": { "type": "string" },
-			"product_price_sync": { "type": "boolean" },
-			"product_quantity_sync": { "type": "boolean" },
-			"product_name_sync": { "type": "boolean" },
-			"default_kennitala": { "type": "string" },
-			"shipping_sku": { "type": "string" },
-			"kennitala_classic_field_enabled": { "type": "boolean" },
-			"kennitala_block_field_enabled": { "type": "boolean" },
-			"default_sales_person": { "type": "string" },
-			"fetch_products": { "type": "boolean" },
-			"payment_methods": {
-				"type": "array",
-				"items": {
-					"type": "object",
-					"properties": {
-						"woo_id": { "type": "string" },
-						"dk_id": { "type": "number" },
-						"dk_term": { "type": "string" }
-					},
-					"required": ["woo_id", "dk_id" ]
-				}
-			}
-		}
-	}
-	JSON;
-
 	/**
 	 * The Constructor for the Settings REST endpoint
 	 *
@@ -94,7 +63,7 @@ public static function rest_api_callback(
 		$rest_json = json_decode( $rest_body );
 
 		$validator  = new Validator();
-		$validation = $validator->validate( $rest_json, self::JSON_SCHEMA );
+		$validation = $validator->validate( $rest_json, self::json_schema() );
 
 		if ( $validation->hasError() ) {
 			return new WP_Error(
@@ -314,7 +283,7 @@ public static function permission_check(): bool {
 	 * @return object The schema as a standard PHP object.
 	 */
 	public static function get_schema(): object {
-		return json_decode( self::JSON_SCHEMA );
+		return json_decode( self::json_schema() );
 	}
 
 	/**
@@ -331,12 +300,22 @@ public static function validate_request( WP_REST_Request $request ): bool {
 		$rest_json = json_decode( $rest_body );
 
 		$validator  = new Validator();
-		$validation = $validator->validate( $rest_json, self::JSON_SCHEMA );
+		$validation = $validator->validate( $rest_json, self::json_schema() );
 
 		if ( $validation->hasError() ) {
 			return false;
 		}
 
 		return true;
 	}
+
+	/**
+	 * Get the JSON schema for POST requests to the settings endpoint
+	 */
+	public static function json_schema(): string {
+		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+		return file_get_contents(
+			dirname( __DIR__, 2 ) . '/json_schemas/rest/settings.json'
+		);
+	}
 }