insideout10 / wordlift-plugin

src/public/class-wordlift-term-jsonld-adapter.php

Indentation +213 added lines, -213 removed lines

@@ -16,218 +16,218 @@
  */
 class Wordlift_Term_JsonLd_Adapter {
 
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * The {@link Wordlift_Jsonld_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
-	 */
-	private $jsonld_service;
-
-	private static $instance;
-
-	/**
-	 * Wordlift_Term_JsonLd_Adapter constructor.
-	 *
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 * @param \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
-	 *
-	 * @since 3.20.0
-	 *
-	 */
-	public function __construct( $entity_uri_service, $jsonld_service ) {
-
-		add_action( 'wp_head', array( $this, 'wp_head' ) );
-
-		$this->entity_uri_service = $entity_uri_service;
-		$this->jsonld_service     = $jsonld_service;
-
-		self::$instance = $this;
-	}
-
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Adds carousel json ld data to term page if the conditions match
-	 *
-	 * @return array|boolean
-	 */
-	public function get_carousel_jsonld( $id = null ) {
-		$posts       = $this->get_posts( $id );
-		$post_jsonld = array();
-		if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
-			// Bail out if no posts are present.
-			return false;
-		}
-
-		if ( ! is_null( $id ) ) {
-			$term                       = get_term( $id );
-			$post_jsonld['description'] = $term->description;
-			$thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
-			if ( ! empty( $thumbnail_id ) ) {
-				$post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
-			}
-		}
-
-		// More than 2 items are present, so construct the post_jsonld data
-		$post_jsonld['@context']        = 'https://schema.org';
-		$post_jsonld['@type']           = 'ItemList';
-		$post_jsonld['url']             = $this->get_term_url( $id );
-		$post_jsonld['itemListElement'] = array();
-		$position                       = 1;
-
-		foreach ( $posts as $post_id ) {
-			$result = array(
-				'@type'    => 'ListItem',
-				'position' => $position,
-				/**
-				 * We can't use `item` here unless we change the URL for the item to point to the current page.
-				 *
-				 * See https://developers.google.com/search/docs/data-types/carousel
-				 */
-				'url'      => get_permalink( $post_id )
-			);
-			array_push( $post_jsonld['itemListElement'], $result );
-			$position += 1;
-		}
-
-		return $post_jsonld;
-	}
-
-	private function get_posts( $id ) {
-		global $wp_query;
-
-		if ( ! is_null( $wp_query->posts ) ) {
-			return array_map( function ( $post ) {
-				return $post->ID;
-			}, $wp_query->posts );
-		}
-
-		if ( is_null( $id ) ) {
-			return null;
-		}
-
-		$term = get_term( $id );
-
-		return get_objects_in_term( $id, $term->taxonomy );
-	}
-
-	/**
-	 * Hook to `wp_head` to print the JSON-LD.
-	 *
-	 * @since 3.20.0
-	 */
-	public function wp_head() {
-		$query_object = get_queried_object();
-
-		// Check if it is a term page.
-		if ( ! $query_object instanceof WP_Term ) {
-			return;
-		}
-
-		$term_id = $query_object->term_id;
-
-		$jsonld  = $this->get( $term_id );
-
-		// Bail out if the JSON-LD is empty.
-		if ( empty( $jsonld ) ) {
-			return;
-		}
-
-		$jsonld_string = wp_json_encode( $jsonld );
-
-		echo "<script type=\"application/ld+json\">$jsonld_string</script>";
-
-	}
-
-	public function get( $id ) {
-
-		/**
-		 * Support for carousel rich snippet, get jsonld data present
-		 * for all the posts shown in the term page, and add the jsonld data
-		 * to list
-		 *
-		 * see here: https://developers.google.com/search/docs/data-types/carousel
-		 *
-		 * @since 3.26.0
-		 */
-		$carousel_data = $this->get_carousel_jsonld( $id );
-		$jsonld_array  = array();
-		if ( $carousel_data ) {
-			$jsonld_array[] = $carousel_data;
-		}
-		$entities_jsonld_array = $this->get_entity_jsonld( $id );
-
-
-		$result = array(
-			'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
-			'references' => array()
-		);
-
-		/**
-		 * @since 3.26.3
-		 * Filter: wl_term_jsonld_array
-		 * @var $id int Term id
-		 * @var $jsonld_array array An array containing jsonld for term and entities.
-		 */
-		return apply_filters( 'wl_term_jsonld_array', $result, $id );
-
-	}
-
-	private function get_term_url( $id ) {
-
-		if ( is_null( $id ) ) {
-			return $_SERVER['REQUEST_URI'];
-		}
-
-		$maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
-		if ( ! empty( $maybe_url ) ) {
-			return $maybe_url;
-		}
-
-		return get_term_link( $id );
-	}
-
-	/**
-	 * Return jsonld for entities bound to terms.
-	 *
-	 * @param $id
-	 *
-	 * @return array
-	 */
-	private function get_entity_jsonld( $id ) {
-		// The `_wl_entity_id` are URIs.
-		$entity_ids         = get_term_meta( $id, '_wl_entity_id' );
-		$entity_uri_service = $this->entity_uri_service;
-
-		$local_entity_ids = array_filter( $entity_ids, function ( $uri ) use ( $entity_uri_service ) {
-			return $entity_uri_service->is_internal( $uri );
-		} );
-
-		// Bail out if there are no entities.
-		if ( empty( $local_entity_ids ) ) {
-			return array();
-		}
-
-		$post   = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
-		$jsonld = $this->jsonld_service->get_jsonld( false, $post->ID );
-		// Reset the `url` to the term page.
-		$jsonld[0]['url'] = get_term_link( $id );
-
-		return $jsonld;
-	}
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * The {@link Wordlift_Jsonld_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
+     */
+    private $jsonld_service;
+
+    private static $instance;
+
+    /**
+     * Wordlift_Term_JsonLd_Adapter constructor.
+     *
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     * @param \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
+     *
+     * @since 3.20.0
+     *
+     */
+    public function __construct( $entity_uri_service, $jsonld_service ) {
+
+        add_action( 'wp_head', array( $this, 'wp_head' ) );
+
+        $this->entity_uri_service = $entity_uri_service;
+        $this->jsonld_service     = $jsonld_service;
+
+        self::$instance = $this;
+    }
+
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Adds carousel json ld data to term page if the conditions match
+     *
+     * @return array|boolean
+     */
+    public function get_carousel_jsonld( $id = null ) {
+        $posts       = $this->get_posts( $id );
+        $post_jsonld = array();
+        if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
+            // Bail out if no posts are present.
+            return false;
+        }
+
+        if ( ! is_null( $id ) ) {
+            $term                       = get_term( $id );
+            $post_jsonld['description'] = $term->description;
+            $thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
+            if ( ! empty( $thumbnail_id ) ) {
+                $post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
+            }
+        }
+
+        // More than 2 items are present, so construct the post_jsonld data
+        $post_jsonld['@context']        = 'https://schema.org';
+        $post_jsonld['@type']           = 'ItemList';
+        $post_jsonld['url']             = $this->get_term_url( $id );
+        $post_jsonld['itemListElement'] = array();
+        $position                       = 1;
+
+        foreach ( $posts as $post_id ) {
+            $result = array(
+                '@type'    => 'ListItem',
+                'position' => $position,
+                /**
+                 * We can't use `item` here unless we change the URL for the item to point to the current page.
+                 *
+                 * See https://developers.google.com/search/docs/data-types/carousel
+                 */
+                'url'      => get_permalink( $post_id )
+            );
+            array_push( $post_jsonld['itemListElement'], $result );
+            $position += 1;
+        }
+
+        return $post_jsonld;
+    }
+
+    private function get_posts( $id ) {
+        global $wp_query;
+
+        if ( ! is_null( $wp_query->posts ) ) {
+            return array_map( function ( $post ) {
+                return $post->ID;
+            }, $wp_query->posts );
+        }
+
+        if ( is_null( $id ) ) {
+            return null;
+        }
+
+        $term = get_term( $id );
+
+        return get_objects_in_term( $id, $term->taxonomy );
+    }
+
+    /**
+     * Hook to `wp_head` to print the JSON-LD.
+     *
+     * @since 3.20.0
+     */
+    public function wp_head() {
+        $query_object = get_queried_object();
+
+        // Check if it is a term page.
+        if ( ! $query_object instanceof WP_Term ) {
+            return;
+        }
+
+        $term_id = $query_object->term_id;
+
+        $jsonld  = $this->get( $term_id );
+
+        // Bail out if the JSON-LD is empty.
+        if ( empty( $jsonld ) ) {
+            return;
+        }
+
+        $jsonld_string = wp_json_encode( $jsonld );
+
+        echo "<script type=\"application/ld+json\">$jsonld_string</script>";
+
+    }
+
+    public function get( $id ) {
+
+        /**
+         * Support for carousel rich snippet, get jsonld data present
+         * for all the posts shown in the term page, and add the jsonld data
+         * to list
+         *
+         * see here: https://developers.google.com/search/docs/data-types/carousel
+         *
+         * @since 3.26.0
+         */
+        $carousel_data = $this->get_carousel_jsonld( $id );
+        $jsonld_array  = array();
+        if ( $carousel_data ) {
+            $jsonld_array[] = $carousel_data;
+        }
+        $entities_jsonld_array = $this->get_entity_jsonld( $id );
+
+
+        $result = array(
+            'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
+            'references' => array()
+        );
+
+        /**
+         * @since 3.26.3
+         * Filter: wl_term_jsonld_array
+         * @var $id int Term id
+         * @var $jsonld_array array An array containing jsonld for term and entities.
+         */
+        return apply_filters( 'wl_term_jsonld_array', $result, $id );
+
+    }
+
+    private function get_term_url( $id ) {
+
+        if ( is_null( $id ) ) {
+            return $_SERVER['REQUEST_URI'];
+        }
+
+        $maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
+        if ( ! empty( $maybe_url ) ) {
+            return $maybe_url;
+        }
+
+        return get_term_link( $id );
+    }
+
+    /**
+     * Return jsonld for entities bound to terms.
+     *
+     * @param $id
+     *
+     * @return array
+     */
+    private function get_entity_jsonld( $id ) {
+        // The `_wl_entity_id` are URIs.
+        $entity_ids         = get_term_meta( $id, '_wl_entity_id' );
+        $entity_uri_service = $this->entity_uri_service;
+
+        $local_entity_ids = array_filter( $entity_ids, function ( $uri ) use ( $entity_uri_service ) {
+            return $entity_uri_service->is_internal( $uri );
+        } );
+
+        // Bail out if there are no entities.
+        if ( empty( $local_entity_ids ) ) {
+            return array();
+        }
+
+        $post   = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
+        $jsonld = $this->jsonld_service->get_jsonld( false, $post->ID );
+        // Reset the `url` to the term page.
+        $jsonld[0]['url'] = get_term_link( $id );
+
+        return $jsonld;
+    }
 
 }

Spacing +44 added lines, -44 removed lines

@@ -45,9 +45,9 @@ 
 	 * @since 3.20.0
 	 *
 	 */
-	public function __construct( $entity_uri_service, $jsonld_service ) {
+	public function __construct($entity_uri_service, $jsonld_service) {
 
-		add_action( 'wp_head', array( $this, 'wp_head' ) );
+		add_action('wp_head', array($this, 'wp_head'));
 
 		$this->entity_uri_service = $entity_uri_service;
 		$this->jsonld_service     = $jsonld_service;
@@ -65,31 +65,31 @@ 
 	 *
 	 * @return array|boolean
 	 */
-	public function get_carousel_jsonld( $id = null ) {
-		$posts       = $this->get_posts( $id );
+	public function get_carousel_jsonld($id = null) {
+		$posts       = $this->get_posts($id);
 		$post_jsonld = array();
-		if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
+		if ( ! is_array($posts) || count($posts) < 2) {
 			// Bail out if no posts are present.
 			return false;
 		}
 
-		if ( ! is_null( $id ) ) {
-			$term                       = get_term( $id );
+		if ( ! is_null($id)) {
+			$term                       = get_term($id);
 			$post_jsonld['description'] = $term->description;
-			$thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
-			if ( ! empty( $thumbnail_id ) ) {
-				$post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
+			$thumbnail_id               = get_term_meta($id, 'thumbnail_id', true);
+			if ( ! empty($thumbnail_id)) {
+				$post_jsonld['image'] = wp_get_attachment_url($thumbnail_id);
 			}
 		}
 
 		// More than 2 items are present, so construct the post_jsonld data
 		$post_jsonld['@context']        = 'https://schema.org';
 		$post_jsonld['@type']           = 'ItemList';
-		$post_jsonld['url']             = $this->get_term_url( $id );
+		$post_jsonld['url']             = $this->get_term_url($id);
 		$post_jsonld['itemListElement'] = array();
 		$position                       = 1;
 
-		foreach ( $posts as $post_id ) {
+		foreach ($posts as $post_id) {
 			$result = array(
 				'@type'    => 'ListItem',
 				'position' => $position,
@@ -98,31 +98,31 @@ 
 				 *
 				 * See https://developers.google.com/search/docs/data-types/carousel
 				 */
-				'url'      => get_permalink( $post_id )
+				'url'      => get_permalink($post_id)
 			);
-			array_push( $post_jsonld['itemListElement'], $result );
+			array_push($post_jsonld['itemListElement'], $result);
 			$position += 1;
 		}
 
 		return $post_jsonld;
 	}
 
-	private function get_posts( $id ) {
+	private function get_posts($id) {
 		global $wp_query;
 
-		if ( ! is_null( $wp_query->posts ) ) {
-			return array_map( function ( $post ) {
+		if ( ! is_null($wp_query->posts)) {
+			return array_map(function($post) {
 				return $post->ID;
-			}, $wp_query->posts );
+			}, $wp_query->posts);
 		}
 
-		if ( is_null( $id ) ) {
+		if (is_null($id)) {
 			return null;
 		}
 
-		$term = get_term( $id );
+		$term = get_term($id);
 
-		return get_objects_in_term( $id, $term->taxonomy );
+		return get_objects_in_term($id, $term->taxonomy);
 	}
 
 	/**
@@ -134,26 +134,26 @@ 
 		$query_object = get_queried_object();
 
 		// Check if it is a term page.
-		if ( ! $query_object instanceof WP_Term ) {
+		if ( ! $query_object instanceof WP_Term) {
 			return;
 		}
 
 		$term_id = $query_object->term_id;
 
-		$jsonld  = $this->get( $term_id );
+		$jsonld  = $this->get($term_id);
 
 		// Bail out if the JSON-LD is empty.
-		if ( empty( $jsonld ) ) {
+		if (empty($jsonld)) {
 			return;
 		}
 
-		$jsonld_string = wp_json_encode( $jsonld );
+		$jsonld_string = wp_json_encode($jsonld);
 
 		echo "<script type=\"application/ld+json\">$jsonld_string</script>";
 
 	}
 
-	public function get( $id ) {
+	public function get($id) {
 
 		/**
 		 * Support for carousel rich snippet, get jsonld data present
@@ -164,16 +164,16 @@ 
 		 *
 		 * @since 3.26.0
 		 */
-		$carousel_data = $this->get_carousel_jsonld( $id );
+		$carousel_data = $this->get_carousel_jsonld($id);
 		$jsonld_array  = array();
-		if ( $carousel_data ) {
+		if ($carousel_data) {
 			$jsonld_array[] = $carousel_data;
 		}
-		$entities_jsonld_array = $this->get_entity_jsonld( $id );
+		$entities_jsonld_array = $this->get_entity_jsonld($id);
 
 
 		$result = array(
-			'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
+			'jsonld'     => array_merge($jsonld_array, $entities_jsonld_array),
 			'references' => array()
 		);
 
@@ -183,22 +183,22 @@ 
 		 * @var $id int Term id
 		 * @var $jsonld_array array An array containing jsonld for term and entities.
 		 */
-		return apply_filters( 'wl_term_jsonld_array', $result, $id );
+		return apply_filters('wl_term_jsonld_array', $result, $id);
 
 	}
 
-	private function get_term_url( $id ) {
+	private function get_term_url($id) {
 
-		if ( is_null( $id ) ) {
+		if (is_null($id)) {
 			return $_SERVER['REQUEST_URI'];
 		}
 
-		$maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
-		if ( ! empty( $maybe_url ) ) {
+		$maybe_url = get_term_meta($id, Wordlift_Url_Property_Service::META_KEY, true);
+		if ( ! empty($maybe_url)) {
 			return $maybe_url;
 		}
 
-		return get_term_link( $id );
+		return get_term_link($id);
 	}
 
 	/**
@@ -208,24 +208,24 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_entity_jsonld( $id ) {
+	private function get_entity_jsonld($id) {
 		// The `_wl_entity_id` are URIs.
-		$entity_ids         = get_term_meta( $id, '_wl_entity_id' );
+		$entity_ids         = get_term_meta($id, '_wl_entity_id');
 		$entity_uri_service = $this->entity_uri_service;
 
-		$local_entity_ids = array_filter( $entity_ids, function ( $uri ) use ( $entity_uri_service ) {
-			return $entity_uri_service->is_internal( $uri );
+		$local_entity_ids = array_filter($entity_ids, function($uri) use ($entity_uri_service) {
+			return $entity_uri_service->is_internal($uri);
 		} );
 
 		// Bail out if there are no entities.
-		if ( empty( $local_entity_ids ) ) {
+		if (empty($local_entity_ids)) {
 			return array();
 		}
 
-		$post   = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
-		$jsonld = $this->jsonld_service->get_jsonld( false, $post->ID );
+		$post   = $this->entity_uri_service->get_entity(array_shift($local_entity_ids));
+		$jsonld = $this->jsonld_service->get_jsonld(false, $post->ID);
 		// Reset the `url` to the term page.
-		$jsonld[0]['url'] = get_term_link( $id );
+		$jsonld[0]['url'] = get_term_link($id);
 
 		return $jsonld;
 	}

src/wordlift/mappings/class-jsonld-converter.php

Indentation +187 added lines, -187 removed lines

@@ -18,192 +18,192 @@
  * @since 3.25.0
  */
 class Jsonld_Converter {
-	/**
-	 * Enumerations for the field types.
-	 */
-	const FIELD_TYPE_TEXT_FIELD = 'text';
-	const FIELD_TYPE_CUSTOM_FIELD = 'custom_field';
-	const FIELD_TYPE_ACF = 'acf';
-	/**
-	 * The {@link Mappings_Validator} instance to test.
-	 *
-	 * @since  3.25.0
-	 * @access private
-	 * @var Mappings_Validator $validator The {@link Mappings_Validator} instance.
-	 */
-	private $validator;
-
-	/**
-	 * The {@link Mappings_Transform_Functions_Registry} instance.
-	 *
-	 * @since  3.25.0
-	 * @access private
-	 * @var Mappings_Transform_Functions_Registry $transform_functions_registry The {@link Mappings_Transform_Functions_Registry} instance.
-	 */
-	private $transform_functions_registry;
-
-	/**
-	 * Initialize all dependencies required.
-	 *
-	 * @param Mappings_Validator $validator A {@link Mappings_Validator} instance.
-	 * @param Mappings_Transform_Functions_Registry $transform_functions_registry
-	 */
-	public function __construct( $validator, $transform_functions_registry ) {
-
-		$this->validator                    = $validator;
-		$this->transform_functions_registry = $transform_functions_registry;
-
-		// Hook to refactor the JSON-LD.
-		add_filter( 'wl_post_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 2 );
-		add_filter( 'wl_entity_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 3 );
-		add_filter( 'wl_term_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 2 );
-	}
-
-	/**
-	 * Hook to `wl_post_jsonld_array` and `wl_entity_jsonld_array`.
-	 *
-	 * Receive the JSON-LD and the references in the array along with the post ID and transform them according to
-	 * the configuration.
-	 *
-	 * @param array $value {
-	 *      The array containing the JSON-LD and the references.
-	 *
-	 * @type array $jsonld The JSON-LD array.
-	 * @type int[] $references An array of post ID referenced by the JSON-LD (will be expanded by the converter).
-	 * }
-	 *
-	 * @param int $post_id The post ID.
-	 *
-	 * @return array An array with the updated JSON-LD and references.
-	 */
-	public function wl_post_jsonld_array( $value, $post_id ) {
-
-		$jsonld     = $value['jsonld'];
-		$references = $value['references'];
-
-		return array(
-			'jsonld'     => $this->wl_post_jsonld( $jsonld, $post_id, $references ),
-			'references' => $references,
-		);
-	}
-
-	/**
-	 * Returns JSON-LD data after applying transformation functions.
-	 *
-	 * @param array $jsonld The JSON-LD structure.
-	 * @param int $post_id The {@link WP_Post} id.
-	 * @param array $references An array of post references.
-	 *
-	 * @return array the new refactored array structure.
-	 * @since 3.25.0
-	 */
-	private function wl_post_jsonld( $jsonld, $post_id, &$references ) {
-
-		// @@todo I think there's an issue here with the Validator, because you're changing the instance state and the
-		// instance may be reused afterwards.
-
-		$properties        = $this->validator->validate( $post_id );
-		$nested_properties = array();
-
-		foreach ( $properties as $property ) {
-			// If the property has the character '/' in the property name then it is a nested property.
-			if ( strpos( $property['property_name'], '/' ) !== false ) {
-				$nested_properties[] = $property;
-				continue;
-			}
-			$property_transformed_data = $this->get_property_data( $property, $jsonld, $post_id, $references );
-			if ( false !== $property_transformed_data ) {
-				$jsonld[ $property['property_name'] ] = $property_transformed_data;
-			}
-		}
-
-		$jsonld = $this->process_nested_properties( $nested_properties, $jsonld, $post_id, $references );
-
-		return $jsonld;
-	}
-
-	/**
-	 * Get the property data by applying the transformation function
-	 *
-	 * @param $property
-	 * @param $jsonld
-	 * @param $post_id
-	 * @param $references
-	 *
-	 * @return array|bool|null
-	 */
-	public function get_property_data( $property, $jsonld, $post_id, &$references ) {
-		$transform_instance = $this->transform_functions_registry->get_transform_function( $property['transform_function'] );
-		$data               = Data_Source_Factory::get_instance()->get_data( $post_id, $property );
-		if ( null !== $transform_instance ) {
-			$transform_data = $transform_instance->transform_data( $data, $jsonld, $references, $post_id );
-			if ( null !== $transform_data ) {
-				return $this->make_single( $transform_data );
-			}
-		} else {
-			return $this->make_single( $data );
-		}
-
-		return false;
-	}
-
-	/**
-	 * Process all the nested properties.
-	 *
-	 * @param $nested_properties array
-	 * @param $jsonld array
-	 *
-	 * @return array
-	 */
-	public function process_nested_properties( $nested_properties, $jsonld, $post_id, &$references ) {
-		foreach ( $nested_properties as $property ) {
-			$property_data = $this->get_property_data( $property, $jsonld, $post_id, $references );
-			if ( false === $property_data ) {
-				// No need to create nested levels.
-				continue;
-			}
-
-			$keys = explode( '/', $property['property_name'] );
-			// end is the last level of the nested property.
-			$end                      = array_pop( $keys );
-			$current_property_pointer = &$jsonld;
-
-			/**
-			 * Once we find all the nested levels from the property name
-			 * loop through it and create associative array if the levels
-			 * didnt exist.
-			 */
-			while ( count( $keys ) > 0 ) {
-				$key = array_shift( $keys );
-				if ( $key === "" ) {
-					continue;
-				}
-				if ( ! array_key_exists( $key, $current_property_pointer ) ) {
-					$current_property_pointer[ $key ] = array();
-				}
-				// We are setting the pointer to the current key, so that at the end
-				// we can add the data at last level.
-				$current_property_pointer = &$current_property_pointer[ $key ];
-			}
-			$current_property_pointer[ $end ] = $property_data;
-		}
-
-		return $jsonld;
-	}
-
-	private function make_single( $value ) {
-
-		$values = (array) $value;
-
-		if ( empty( $values ) ) {
-			return false;
-		}
-
-		if ( 1 === count( $values ) && 0 === key( $values ) ) {
-			return current( $values );
-		}
-
-		return $values;
-	}
+    /**
+     * Enumerations for the field types.
+     */
+    const FIELD_TYPE_TEXT_FIELD = 'text';
+    const FIELD_TYPE_CUSTOM_FIELD = 'custom_field';
+    const FIELD_TYPE_ACF = 'acf';
+    /**
+     * The {@link Mappings_Validator} instance to test.
+     *
+     * @since  3.25.0
+     * @access private
+     * @var Mappings_Validator $validator The {@link Mappings_Validator} instance.
+     */
+    private $validator;
+
+    /**
+     * The {@link Mappings_Transform_Functions_Registry} instance.
+     *
+     * @since  3.25.0
+     * @access private
+     * @var Mappings_Transform_Functions_Registry $transform_functions_registry The {@link Mappings_Transform_Functions_Registry} instance.
+     */
+    private $transform_functions_registry;
+
+    /**
+     * Initialize all dependencies required.
+     *
+     * @param Mappings_Validator $validator A {@link Mappings_Validator} instance.
+     * @param Mappings_Transform_Functions_Registry $transform_functions_registry
+     */
+    public function __construct( $validator, $transform_functions_registry ) {
+
+        $this->validator                    = $validator;
+        $this->transform_functions_registry = $transform_functions_registry;
+
+        // Hook to refactor the JSON-LD.
+        add_filter( 'wl_post_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 2 );
+        add_filter( 'wl_entity_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 3 );
+        add_filter( 'wl_term_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 2 );
+    }
+
+    /**
+     * Hook to `wl_post_jsonld_array` and `wl_entity_jsonld_array`.
+     *
+     * Receive the JSON-LD and the references in the array along with the post ID and transform them according to
+     * the configuration.
+     *
+     * @param array $value {
+     *      The array containing the JSON-LD and the references.
+     *
+     * @type array $jsonld The JSON-LD array.
+     * @type int[] $references An array of post ID referenced by the JSON-LD (will be expanded by the converter).
+     * }
+     *
+     * @param int $post_id The post ID.
+     *
+     * @return array An array with the updated JSON-LD and references.
+     */
+    public function wl_post_jsonld_array( $value, $post_id ) {
+
+        $jsonld     = $value['jsonld'];
+        $references = $value['references'];
+
+        return array(
+            'jsonld'     => $this->wl_post_jsonld( $jsonld, $post_id, $references ),
+            'references' => $references,
+        );
+    }
+
+    /**
+     * Returns JSON-LD data after applying transformation functions.
+     *
+     * @param array $jsonld The JSON-LD structure.
+     * @param int $post_id The {@link WP_Post} id.
+     * @param array $references An array of post references.
+     *
+     * @return array the new refactored array structure.
+     * @since 3.25.0
+     */
+    private function wl_post_jsonld( $jsonld, $post_id, &$references ) {
+
+        // @@todo I think there's an issue here with the Validator, because you're changing the instance state and the
+        // instance may be reused afterwards.
+
+        $properties        = $this->validator->validate( $post_id );
+        $nested_properties = array();
+
+        foreach ( $properties as $property ) {
+            // If the property has the character '/' in the property name then it is a nested property.
+            if ( strpos( $property['property_name'], '/' ) !== false ) {
+                $nested_properties[] = $property;
+                continue;
+            }
+            $property_transformed_data = $this->get_property_data( $property, $jsonld, $post_id, $references );
+            if ( false !== $property_transformed_data ) {
+                $jsonld[ $property['property_name'] ] = $property_transformed_data;
+            }
+        }
+
+        $jsonld = $this->process_nested_properties( $nested_properties, $jsonld, $post_id, $references );
+
+        return $jsonld;
+    }
+
+    /**
+     * Get the property data by applying the transformation function
+     *
+     * @param $property
+     * @param $jsonld
+     * @param $post_id
+     * @param $references
+     *
+     * @return array|bool|null
+     */
+    public function get_property_data( $property, $jsonld, $post_id, &$references ) {
+        $transform_instance = $this->transform_functions_registry->get_transform_function( $property['transform_function'] );
+        $data               = Data_Source_Factory::get_instance()->get_data( $post_id, $property );
+        if ( null !== $transform_instance ) {
+            $transform_data = $transform_instance->transform_data( $data, $jsonld, $references, $post_id );
+            if ( null !== $transform_data ) {
+                return $this->make_single( $transform_data );
+            }
+        } else {
+            return $this->make_single( $data );
+        }
+
+        return false;
+    }
+
+    /**
+     * Process all the nested properties.
+     *
+     * @param $nested_properties array
+     * @param $jsonld array
+     *
+     * @return array
+     */
+    public function process_nested_properties( $nested_properties, $jsonld, $post_id, &$references ) {
+        foreach ( $nested_properties as $property ) {
+            $property_data = $this->get_property_data( $property, $jsonld, $post_id, $references );
+            if ( false === $property_data ) {
+                // No need to create nested levels.
+                continue;
+            }
+
+            $keys = explode( '/', $property['property_name'] );
+            // end is the last level of the nested property.
+            $end                      = array_pop( $keys );
+            $current_property_pointer = &$jsonld;
+
+            /**
+             * Once we find all the nested levels from the property name
+             * loop through it and create associative array if the levels
+             * didnt exist.
+             */
+            while ( count( $keys ) > 0 ) {
+                $key = array_shift( $keys );
+                if ( $key === "" ) {
+                    continue;
+                }
+                if ( ! array_key_exists( $key, $current_property_pointer ) ) {
+                    $current_property_pointer[ $key ] = array();
+                }
+                // We are setting the pointer to the current key, so that at the end
+                // we can add the data at last level.
+                $current_property_pointer = &$current_property_pointer[ $key ];
+            }
+            $current_property_pointer[ $end ] = $property_data;
+        }
+
+        return $jsonld;
+    }
+
+    private function make_single( $value ) {
+
+        $values = (array) $value;
+
+        if ( empty( $values ) ) {
+            return false;
+        }
+
+        if ( 1 === count( $values ) && 0 === key( $values ) ) {
+            return current( $values );
+        }
+
+        return $values;
+    }
 
 }

Spacing +39 added lines, -39 removed lines

@@ -48,15 +48,15 @@ 
 	 * @param Mappings_Validator $validator A {@link Mappings_Validator} instance.
 	 * @param Mappings_Transform_Functions_Registry $transform_functions_registry
 	 */
-	public function __construct( $validator, $transform_functions_registry ) {
+	public function __construct($validator, $transform_functions_registry) {
 
 		$this->validator                    = $validator;
 		$this->transform_functions_registry = $transform_functions_registry;
 
 		// Hook to refactor the JSON-LD.
-		add_filter( 'wl_post_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 2 );
-		add_filter( 'wl_entity_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 3 );
-		add_filter( 'wl_term_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 11, 2 );
+		add_filter('wl_post_jsonld_array', array($this, 'wl_post_jsonld_array'), 11, 2);
+		add_filter('wl_entity_jsonld_array', array($this, 'wl_post_jsonld_array'), 11, 3);
+		add_filter('wl_term_jsonld_array', array($this, 'wl_post_jsonld_array'), 11, 2);
 	}
 
 	/**
@@ -76,13 +76,13 @@ 
 	 *
 	 * @return array An array with the updated JSON-LD and references.
 	 */
-	public function wl_post_jsonld_array( $value, $post_id ) {
+	public function wl_post_jsonld_array($value, $post_id) {
 
 		$jsonld     = $value['jsonld'];
 		$references = $value['references'];
 
 		return array(
-			'jsonld'     => $this->wl_post_jsonld( $jsonld, $post_id, $references ),
+			'jsonld'     => $this->wl_post_jsonld($jsonld, $post_id, $references),
 			'references' => $references,
 		);
 	}
@@ -97,27 +97,27 @@ 
 	 * @return array the new refactored array structure.
 	 * @since 3.25.0
 	 */
-	private function wl_post_jsonld( $jsonld, $post_id, &$references ) {
+	private function wl_post_jsonld($jsonld, $post_id, &$references) {
 
 		// @@todo I think there's an issue here with the Validator, because you're changing the instance state and the
 		// instance may be reused afterwards.
 
-		$properties        = $this->validator->validate( $post_id );
+		$properties        = $this->validator->validate($post_id);
 		$nested_properties = array();
 
-		foreach ( $properties as $property ) {
+		foreach ($properties as $property) {
 			// If the property has the character '/' in the property name then it is a nested property.
-			if ( strpos( $property['property_name'], '/' ) !== false ) {
+			if (strpos($property['property_name'], '/') !== false) {
 				$nested_properties[] = $property;
 				continue;
 			}
-			$property_transformed_data = $this->get_property_data( $property, $jsonld, $post_id, $references );
-			if ( false !== $property_transformed_data ) {
-				$jsonld[ $property['property_name'] ] = $property_transformed_data;
+			$property_transformed_data = $this->get_property_data($property, $jsonld, $post_id, $references);
+			if (false !== $property_transformed_data) {
+				$jsonld[$property['property_name']] = $property_transformed_data;
 			}
 		}
 
-		$jsonld = $this->process_nested_properties( $nested_properties, $jsonld, $post_id, $references );
+		$jsonld = $this->process_nested_properties($nested_properties, $jsonld, $post_id, $references);
 
 		return $jsonld;
 	}
@@ -132,16 +132,16 @@ 
 	 *
 	 * @return array|bool|null
 	 */
-	public function get_property_data( $property, $jsonld, $post_id, &$references ) {
-		$transform_instance = $this->transform_functions_registry->get_transform_function( $property['transform_function'] );
-		$data               = Data_Source_Factory::get_instance()->get_data( $post_id, $property );
-		if ( null !== $transform_instance ) {
-			$transform_data = $transform_instance->transform_data( $data, $jsonld, $references, $post_id );
-			if ( null !== $transform_data ) {
-				return $this->make_single( $transform_data );
+	public function get_property_data($property, $jsonld, $post_id, &$references) {
+		$transform_instance = $this->transform_functions_registry->get_transform_function($property['transform_function']);
+		$data               = Data_Source_Factory::get_instance()->get_data($post_id, $property);
+		if (null !== $transform_instance) {
+			$transform_data = $transform_instance->transform_data($data, $jsonld, $references, $post_id);
+			if (null !== $transform_data) {
+				return $this->make_single($transform_data);
 			}
 		} else {
-			return $this->make_single( $data );
+			return $this->make_single($data);
 		}
 
 		return false;
@@ -155,17 +155,17 @@ 
 	 *
 	 * @return array
 	 */
-	public function process_nested_properties( $nested_properties, $jsonld, $post_id, &$references ) {
-		foreach ( $nested_properties as $property ) {
-			$property_data = $this->get_property_data( $property, $jsonld, $post_id, $references );
-			if ( false === $property_data ) {
+	public function process_nested_properties($nested_properties, $jsonld, $post_id, &$references) {
+		foreach ($nested_properties as $property) {
+			$property_data = $this->get_property_data($property, $jsonld, $post_id, $references);
+			if (false === $property_data) {
 				// No need to create nested levels.
 				continue;
 			}
 
-			$keys = explode( '/', $property['property_name'] );
+			$keys = explode('/', $property['property_name']);
 			// end is the last level of the nested property.
-			$end                      = array_pop( $keys );
+			$end                      = array_pop($keys);
 			$current_property_pointer = &$jsonld;
 
 			/**
@@ -173,34 +173,34 @@ 
 			 * loop through it and create associative array if the levels
 			 * didnt exist.
 			 */
-			while ( count( $keys ) > 0 ) {
-				$key = array_shift( $keys );
-				if ( $key === "" ) {
+			while (count($keys) > 0) {
+				$key = array_shift($keys);
+				if ($key === "") {
 					continue;
 				}
-				if ( ! array_key_exists( $key, $current_property_pointer ) ) {
-					$current_property_pointer[ $key ] = array();
+				if ( ! array_key_exists($key, $current_property_pointer)) {
+					$current_property_pointer[$key] = array();
 				}
 				// We are setting the pointer to the current key, so that at the end
 				// we can add the data at last level.
-				$current_property_pointer = &$current_property_pointer[ $key ];
+				$current_property_pointer = &$current_property_pointer[$key];
 			}
-			$current_property_pointer[ $end ] = $property_data;
+			$current_property_pointer[$end] = $property_data;
 		}
 
 		return $jsonld;
 	}
 
-	private function make_single( $value ) {
+	private function make_single($value) {
 
 		$values = (array) $value;
 
-		if ( empty( $values ) ) {
+		if (empty($values)) {
 			return false;
 		}
 
-		if ( 1 === count( $values ) && 0 === key( $values ) ) {
-			return current( $values );
+		if (1 === count($values) && 0 === key($values)) {
+			return current($values);
 		}
 
 		return $values;