insideout10 / wordlift-plugin

src/includes/class-wordlift-post-to-jsonld-converter.php

Indentation +518 added lines, -518 removed lines

@@ -19,542 +19,542 @@
  */
 class Wordlift_Post_To_Jsonld_Converter extends Wordlift_Abstract_Post_To_Jsonld_Converter {
 
-	/**
-	 * @var Wordlift_Post_To_Jsonld_Converter
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * @var false
-	 */
-	private $disable_convert_filters;
-	/**
-	 * @var Object_Relation_Service
-	 */
-	private $object_relation_service;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
-	 * @param \Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since 3.10.0
-	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
-		parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
-		$this->disable_convert_filters = $disable_convert_filters;
-		$this->object_relation_service = Object_Relation_Service::get_instance();
-		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
-
-		self::$instance = $this;
-
-	}
-
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	public function new_instance_with_filters_disabled() {
-		return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int              $post_id The post id.
-	 * @param array<Reference> $references An array of entity references.
-	 * @param array            $references_infos
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 */
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references, $references_infos );
-
-		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
-			$jsonld['@type'] = 'WebPage';
-		}
-
-		// Get the entity name.
-		$jsonld['headline'] = $post->post_title;
-
-		$custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
-
-		if ( isset( $custom_fields ) ) {
-			$this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
-		}
-
-		// Set the published and modified dates.
-		/*
+    /**
+     * @var Wordlift_Post_To_Jsonld_Converter
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * @var false
+     */
+    private $disable_convert_filters;
+    /**
+     * @var Object_Relation_Service
+     */
+    private $object_relation_service;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
+     * @param \Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since 3.10.0
+     */
+    public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
+        parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
+        $this->disable_convert_filters = $disable_convert_filters;
+        $this->object_relation_service = Object_Relation_Service::get_instance();
+        // Set a reference to the logger.
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+
+        self::$instance = $this;
+
+    }
+
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    public function new_instance_with_filters_disabled() {
+        return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int              $post_id The post id.
+     * @param array<Reference> $references An array of entity references.
+     * @param array            $references_infos
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     */
+    public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the base JSON-LD and the list of entities referenced by this entity.
+        $jsonld = parent::convert( $post_id, $references, $references_infos );
+
+        // Set WebPage by default.
+        if ( empty( $jsonld['@type'] ) ) {
+            $jsonld['@type'] = 'WebPage';
+        }
+
+        // Get the entity name.
+        $jsonld['headline'] = $post->post_title;
+
+        $custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
+
+        if ( isset( $custom_fields ) ) {
+            $this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
+        }
+
+        // Set the published and modified dates.
+        /*
 		 * Set the `datePublished` and `dateModified` using the local timezone.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/887
 		 *
 		 * @since 3.20.0
 		 */
-		try {
-			$default_timezone = date_default_timezone_get();
-			$timezone         = get_option( 'timezone_string' );
-			if ( ! empty( $timezone ) ) {
-				date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-				date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-			} else {
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-			}
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-		}
-
-		// Get the word count for the post.
-		/*
+        try {
+            $default_timezone = date_default_timezone_get();
+            $timezone         = get_option( 'timezone_string' );
+            if ( ! empty( $timezone ) ) {
+                date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
+                date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+            } else {
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+            }
+        } catch ( Exception $e ) {
+            $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+            $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+        }
+
+        // Get the word count for the post.
+        /*
 		 * Do not display the `wordCount` on a `WebPage`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/888
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
-			$jsonld['wordCount'] = $post_adapter->word_count();
-		}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter        = new Wordlift_Post_Adapter( $post_id );
+            $jsonld['wordCount'] = $post_adapter->word_count();
+        }
 
-		/*
+        /*
 		 * Add keywords, articleSection, commentCount and inLanguage properties to `Article` JSON-LD
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/1140
 		 *
 		 * @since 3.27.2
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter    = new Wordlift_Post_Adapter( $post_id );
-			$keywords        = $post_adapter->keywords();
-			$article_section = $post_adapter->article_section();
-			$comment_count   = $post_adapter->comment_count();
-			$locale          = $post_adapter->locale();
-
-			if ( isset( $keywords ) ) {
-				$jsonld['keywords'] = $keywords;
-			}
-			if ( ! empty( $article_section ) ) {
-				$jsonld['articleSection'] = $article_section;
-			}
-			$jsonld['commentCount'] = $comment_count;
-			$jsonld['inLanguage']   = $locale;
-			$post_adapter->add_references( $post_id, $references );
-		}
-
-		// Set the publisher.
-		$this->set_publisher( $jsonld );
-
-		$references = $this->convert_references( $references );
-
-		// Process the references if any.
-		$this->set_mentions_and_about( $references, $post, $jsonld );
-
-		// Finally set the author.
-		$jsonld['author'] = $this->get_author( $post->post_author, $references );
-
-		// Return the JSON-LD if filters are disabled by the client.
-		if ( $this->disable_convert_filters ) {
-			return $jsonld;
-		}
-
-		/**
-		 * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
-		 *
-		 * @param array $value {
-		 *
-		 * @type array $jsonld The JSON-LD structure.
-		 * @type int[] $references An array of post IDs.
-		 * }
-		 * @since 3.25.0
-		 *
-		 * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
-		 *
-		 * @api
-		 */
-		$ret_val = apply_filters(
-			'wl_post_jsonld_array',
-			array(
-				'jsonld'     => $jsonld,
-				'references' => $references,
-			),
-			$post_id
-		);
-
-		$jsonld     = $ret_val['jsonld'];
-		$references = $ret_val['references'];
-
-		/**
-		 * Call the `wl_post_jsonld` filter.
-		 *
-		 * @param array $jsonld The JSON-LD structure.
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 * @param array $references The array of referenced entities.
-		 *
-		 * @since 3.14.0
-		 *
-		 * @api
-		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
-	}
-
-	/**
-	 * Get the author's JSON-LD fragment.
-	 *
-	 * The JSON-LD fragment is generated using the {@link WP_User}'s data or
-	 * the referenced entity if configured for the {@link WP_User}.
-	 *
-	 * @param int   $author_id The author {@link WP_User}'s `id`.
-	 * @param array $references An array of referenced entities.
-	 *
-	 * @return string|array A JSON-LD structure.
-	 * @since 3.14.0
-	 */
-	public function get_author( $author_id, &$references ) {
-
-		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
-
-		// If there's no entity bound return a simple author structure.
-		if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
-
-			$author            = get_the_author_meta( 'display_name', $author_id );
-			$author_first_name = get_the_author_meta( 'first_name', $author_id );
-			$author_last_name  = get_the_author_meta( 'last_name', $author_id );
-			$author_uri        = $this->user_service->get_uri( $author_id );
-
-			return array(
-				'@type'      => 'Person',
-				'@id'        => $author_uri,
-				'name'       => $author,
-				'givenName'  => $author_first_name,
-				'familyName' => $author_last_name,
-				'url'        => get_author_posts_url( $author_id ),
-			);
-		}
-
-		// Add the author to the references.
-		$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
-		$references[] = $entity_id;
-
-		// Return the JSON-LD for the referenced entity.
-		return array(
-			'@id' => $author_uri,
-		);
-	}
-
-	/**
-	 * Enrich the provided params array with publisher data, if available.
-	 *
-	 * @param array $params The parameters array.
-	 *
-	 * @since 3.10.0
-	 */
-	protected function set_publisher( &$params ) {
-
-		// If the publisher id isn't set don't do anything.
-		$publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
-		if ( null === $publisher_id ) {
-			return;
-		}
-
-		// Get the post instance.
-		$post = get_post( $publisher_id );
-		if ( null === $post ) {
-			// Publisher not found.
-			return;
-		}
-
-		// Get the item id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
-
-		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
-
-		// Get the name.
-		$name = $post->post_title;
-
-		// Set the publisher data.
-		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
-			'@id'   => $id,
-			'name'  => $name,
-		);
-
-		// Add the sameAs values associated with the publisher.
-		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
-			$params['publisher']['sameAs'] = $sameas;
-		}
-
-		// Set the logo, only for http://schema.org/Organization as Person doesn't
-		// support the logo property.
-		//
-		// See http://schema.org/logo.
-		if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
-			return;
-		}
-
-		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
-
-		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
-			return;
-		}
-
-		// Copy over some useful properties.
-		//
-		// See https://developers.google.com/search/docs/data-types/articles.
-		$params['publisher']['logo']['@type'] = 'ImageObject';
-		$params['publisher']['logo']['url']   = $publisher_logo['url'];
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		$params['publisher']['logo']['width']  = $publisher_logo['width'];
-		$params['publisher']['logo']['height'] = $publisher_logo['height'];
-
-	}
-
-	/**
-	 * Get the publisher logo structure.
-	 *
-	 * The function returns false when the publisher logo cannot be determined, i.e.:
-	 *  - the post has no featured image.
-	 *  - the featured image has no file.
-	 *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
-	 *  of errors.
-	 * @since 3.19.2
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
-	 */
-	private function get_publisher_logo( $post_id ) {
-
-		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
-
-		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
-
-			return false;
-		}
-
-		// Get the uploads base URL.
-		$uploads_dir = wp_upload_dir();
-
-		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
-
-		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
-
-			return false;
-		}
-
-		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
-
-		// Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
-
-			$attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
-			if ( $attachment_image_src ) {
-				return array(
-					'url'    => $attachment_image_src[0],
-					'width'  => $attachment_image_src[1],
-					'height' => $attachment_image_src[2],
-				);
-			}
-
-			// Bail out if we cant fetch wp_get_attachment_image_src
-			return false;
-
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
-
-			return false;
-		}
-
-		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
-		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
-
-		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
-
-			return false;
-		}
-
-		// Get the actual size.
-		$size = $publisher_logo_editor->get_size();
-
-		// Finally return the array with data.
-		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
-			'width'  => $size['width'],
-			'height' => $size['height'],
-		);
-	}
-
-	/**
-	 * @param $references
-	 * @param $post
-	 * @param $jsonld
-	 *
-	 * @return void
-	 */
-	private function set_mentions_and_about( $references, $post, &$jsonld ) {
-
-		if ( count( $references ) === 0 ) {
-			return;
-		}
-
-		// Prepare the `about` and `mentions` array.
-		$mentions = array();
-		$about    = array();
-
-		// If the entity is in the title, then it should be an `about`.
-		foreach ( $references as $reference ) {
-
-			if ( ! $reference instanceof Reference ) {
-				// This condition should never be reached.
-				continue;
-			}
-
-			// Get the entity labels.
-			$labels = Wordlift_Entity_Service::get_instance()->get_labels( $reference->get_id(), $reference->get_type() );
-			// Get the entity URI.
-			$item = array(
-				'@id' => Wordlift_Entity_Service::get_instance()->get_uri( $reference->get_id(), $reference->get_type() ),
-			);
-
-			$escaped_labels = array_map(
-				function ( $value ) {
-					return preg_quote( $value, '/' );
-				},
-				$labels
-			);
-
-			$matches = false;
-
-			// When the title is empty, then we shouldn't yield a match to about section.
-			if ( array_filter( $escaped_labels ) ) {
-				// Check if the labels match any part of the title.
-				$matches = $this->check_title_match( $escaped_labels, $post->post_title );
-			}
-
-			// If the title matches, assign the entity to the about, otherwise to the mentions.
-			if ( $matches ) {
-				$about[] = $item;
-			} else {
-				$mentions[] = $item;
-			}
-		}
-
-		// If we have abouts, assign them to the JSON-LD.
-		if ( 0 < count( $about ) ) {
-			$jsonld['about'] = $about;
-		}
-
-		// If we have mentions, assign them to the JSON-LD.
-		if ( 0 < count( $mentions ) ) {
-			$jsonld['mentions'] = $mentions;
-		}
-
-		return $jsonld;
-	}
-
-	/**
-	 * Check if the labels match any part of the title.
-	 *
-	 * @param $labels array The labels to check.
-	 * @param $title string The title to check.
-	 *
-	 * @return boolean
-	 */
-	public function check_title_match( $labels, $title ) {
-
-		// If the title is empty, then we shouldn't yield a match to about section.
-		if ( empty( $title ) ) {
-			return false;
-		}
-
-		// Check if the labels match any part of the title.
-		return 1 === preg_match( '/\b(' . implode( '|', $labels ) . ')\b/iu', $title );
-
-	}
-
-	/**
-	 * Convert references to abstract data type if we find any.
-	 *
-	 * @param $references array<int|Reference>
-	 *
-	 * @return Reference[]
-	 */
-	private function convert_references( $references ) {
-		return array_map(
-			function ( $reference ) {
-				// Legacy code may still push numerical references to this
-				// $references variable, so convert it to post references.
-				if ( is_numeric( $reference ) ) {
-					  return new Post_Reference( $reference );
-				}
-
-				return $reference;
-
-			},
-			$references
-		);
-	}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter    = new Wordlift_Post_Adapter( $post_id );
+            $keywords        = $post_adapter->keywords();
+            $article_section = $post_adapter->article_section();
+            $comment_count   = $post_adapter->comment_count();
+            $locale          = $post_adapter->locale();
+
+            if ( isset( $keywords ) ) {
+                $jsonld['keywords'] = $keywords;
+            }
+            if ( ! empty( $article_section ) ) {
+                $jsonld['articleSection'] = $article_section;
+            }
+            $jsonld['commentCount'] = $comment_count;
+            $jsonld['inLanguage']   = $locale;
+            $post_adapter->add_references( $post_id, $references );
+        }
+
+        // Set the publisher.
+        $this->set_publisher( $jsonld );
+
+        $references = $this->convert_references( $references );
+
+        // Process the references if any.
+        $this->set_mentions_and_about( $references, $post, $jsonld );
+
+        // Finally set the author.
+        $jsonld['author'] = $this->get_author( $post->post_author, $references );
+
+        // Return the JSON-LD if filters are disabled by the client.
+        if ( $this->disable_convert_filters ) {
+            return $jsonld;
+        }
+
+        /**
+         * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
+         *
+         * @param array $value {
+         *
+         * @type array $jsonld The JSON-LD structure.
+         * @type int[] $references An array of post IDs.
+         * }
+         * @since 3.25.0
+         *
+         * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
+         *
+         * @api
+         */
+        $ret_val = apply_filters(
+            'wl_post_jsonld_array',
+            array(
+                'jsonld'     => $jsonld,
+                'references' => $references,
+            ),
+            $post_id
+        );
+
+        $jsonld     = $ret_val['jsonld'];
+        $references = $ret_val['references'];
+
+        /**
+         * Call the `wl_post_jsonld` filter.
+         *
+         * @param array $jsonld The JSON-LD structure.
+         * @param int $post_id The {@link WP_Post} `id`.
+         * @param array $references The array of referenced entities.
+         *
+         * @since 3.14.0
+         *
+         * @api
+         */
+        return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+    }
+
+    /**
+     * Get the author's JSON-LD fragment.
+     *
+     * The JSON-LD fragment is generated using the {@link WP_User}'s data or
+     * the referenced entity if configured for the {@link WP_User}.
+     *
+     * @param int   $author_id The author {@link WP_User}'s `id`.
+     * @param array $references An array of referenced entities.
+     *
+     * @return string|array A JSON-LD structure.
+     * @since 3.14.0
+     */
+    public function get_author( $author_id, &$references ) {
+
+        // Get the entity bound to this user.
+        $entity_id = $this->user_service->get_entity( $author_id );
+
+        // If there's no entity bound return a simple author structure.
+        if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
+
+            $author            = get_the_author_meta( 'display_name', $author_id );
+            $author_first_name = get_the_author_meta( 'first_name', $author_id );
+            $author_last_name  = get_the_author_meta( 'last_name', $author_id );
+            $author_uri        = $this->user_service->get_uri( $author_id );
+
+            return array(
+                '@type'      => 'Person',
+                '@id'        => $author_uri,
+                'name'       => $author,
+                'givenName'  => $author_first_name,
+                'familyName' => $author_last_name,
+                'url'        => get_author_posts_url( $author_id ),
+            );
+        }
+
+        // Add the author to the references.
+        $author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
+        $references[] = $entity_id;
+
+        // Return the JSON-LD for the referenced entity.
+        return array(
+            '@id' => $author_uri,
+        );
+    }
+
+    /**
+     * Enrich the provided params array with publisher data, if available.
+     *
+     * @param array $params The parameters array.
+     *
+     * @since 3.10.0
+     */
+    protected function set_publisher( &$params ) {
+
+        // If the publisher id isn't set don't do anything.
+        $publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
+        if ( null === $publisher_id ) {
+            return;
+        }
+
+        // Get the post instance.
+        $post = get_post( $publisher_id );
+        if ( null === $post ) {
+            // Publisher not found.
+            return;
+        }
+
+        // Get the item id.
+        $id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
+
+        // Get the type.
+        $type = $this->entity_type_service->get( $publisher_id );
+
+        // Get the name.
+        $name = $post->post_title;
+
+        // Set the publisher data.
+        $params['publisher'] = array(
+            '@type' => $this->relative_to_context( $type['uri'] ),
+            '@id'   => $id,
+            'name'  => $name,
+        );
+
+        // Add the sameAs values associated with the publisher.
+        $storage_factory = Wordlift_Storage_Factory::get_instance();
+        $sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
+        if ( ! empty( $sameas ) ) {
+            $params['publisher']['sameAs'] = $sameas;
+        }
+
+        // Set the logo, only for http://schema.org/Organization as Person doesn't
+        // support the logo property.
+        //
+        // See http://schema.org/logo.
+        if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
+            return;
+        }
+
+        // Get the publisher logo.
+        $publisher_logo = $this->get_publisher_logo( $post->ID );
+
+        // Bail out if the publisher logo isn't set.
+        if ( false === $publisher_logo ) {
+            return;
+        }
+
+        // Copy over some useful properties.
+        //
+        // See https://developers.google.com/search/docs/data-types/articles.
+        $params['publisher']['logo']['@type'] = 'ImageObject';
+        $params['publisher']['logo']['url']   = $publisher_logo['url'];
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        $params['publisher']['logo']['width']  = $publisher_logo['width'];
+        $params['publisher']['logo']['height'] = $publisher_logo['height'];
+
+    }
+
+    /**
+     * Get the publisher logo structure.
+     *
+     * The function returns false when the publisher logo cannot be determined, i.e.:
+     *  - the post has no featured image.
+     *  - the featured image has no file.
+     *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
+     *  of errors.
+     * @since 3.19.2
+     * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
+     */
+    private function get_publisher_logo( $post_id ) {
+
+        // Get the featured image for the post.
+        $thumbnail_id = get_post_thumbnail_id( $post_id );
+
+        // Bail out if thumbnail not available.
+        if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
+            $this->log->info( "Featured image not set for post $post_id." );
+
+            return false;
+        }
+
+        // Get the uploads base URL.
+        $uploads_dir = wp_upload_dir();
+
+        // Get the attachment metadata.
+        $metadata = wp_get_attachment_metadata( $thumbnail_id );
+
+        // Bail out if the file isn't set.
+        if ( ! isset( $metadata['file'] ) ) {
+            $this->log->warn( "Featured image file not found for post $post_id." );
+
+            return false;
+        }
+
+        // Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
+        $path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+
+        // Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
+        if ( ! file_exists( $path ) ) {
+            $this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+
+            $attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
+            if ( $attachment_image_src ) {
+                return array(
+                    'url'    => $attachment_image_src[0],
+                    'width'  => $attachment_image_src[1],
+                    'height' => $attachment_image_src[2],
+                );
+            }
+
+            // Bail out if we cant fetch wp_get_attachment_image_src
+            return false;
+
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $original_file_editor = wp_get_image_editor( $path );
+        if ( is_wp_error( $original_file_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+
+            return false;
+        }
+
+        // Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
+        // and we don't actually know the end values.
+        $publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+
+        // If the file doesn't exist yet, create it.
+        if ( ! file_exists( $publisher_logo_path ) ) {
+            $original_file_editor->resize( 600, 60 );
+            $original_file_editor->save( $publisher_logo_path );
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
+        if ( is_wp_error( $publisher_logo_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+
+            return false;
+        }
+
+        // Get the actual size.
+        $size = $publisher_logo_editor->get_size();
+
+        // Finally return the array with data.
+        return array(
+            'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+            'width'  => $size['width'],
+            'height' => $size['height'],
+        );
+    }
+
+    /**
+     * @param $references
+     * @param $post
+     * @param $jsonld
+     *
+     * @return void
+     */
+    private function set_mentions_and_about( $references, $post, &$jsonld ) {
+
+        if ( count( $references ) === 0 ) {
+            return;
+        }
+
+        // Prepare the `about` and `mentions` array.
+        $mentions = array();
+        $about    = array();
+
+        // If the entity is in the title, then it should be an `about`.
+        foreach ( $references as $reference ) {
+
+            if ( ! $reference instanceof Reference ) {
+                // This condition should never be reached.
+                continue;
+            }
+
+            // Get the entity labels.
+            $labels = Wordlift_Entity_Service::get_instance()->get_labels( $reference->get_id(), $reference->get_type() );
+            // Get the entity URI.
+            $item = array(
+                '@id' => Wordlift_Entity_Service::get_instance()->get_uri( $reference->get_id(), $reference->get_type() ),
+            );
+
+            $escaped_labels = array_map(
+                function ( $value ) {
+                    return preg_quote( $value, '/' );
+                },
+                $labels
+            );
+
+            $matches = false;
+
+            // When the title is empty, then we shouldn't yield a match to about section.
+            if ( array_filter( $escaped_labels ) ) {
+                // Check if the labels match any part of the title.
+                $matches = $this->check_title_match( $escaped_labels, $post->post_title );
+            }
+
+            // If the title matches, assign the entity to the about, otherwise to the mentions.
+            if ( $matches ) {
+                $about[] = $item;
+            } else {
+                $mentions[] = $item;
+            }
+        }
+
+        // If we have abouts, assign them to the JSON-LD.
+        if ( 0 < count( $about ) ) {
+            $jsonld['about'] = $about;
+        }
+
+        // If we have mentions, assign them to the JSON-LD.
+        if ( 0 < count( $mentions ) ) {
+            $jsonld['mentions'] = $mentions;
+        }
+
+        return $jsonld;
+    }
+
+    /**
+     * Check if the labels match any part of the title.
+     *
+     * @param $labels array The labels to check.
+     * @param $title string The title to check.
+     *
+     * @return boolean
+     */
+    public function check_title_match( $labels, $title ) {
+
+        // If the title is empty, then we shouldn't yield a match to about section.
+        if ( empty( $title ) ) {
+            return false;
+        }
+
+        // Check if the labels match any part of the title.
+        return 1 === preg_match( '/\b(' . implode( '|', $labels ) . ')\b/iu', $title );
+
+    }
+
+    /**
+     * Convert references to abstract data type if we find any.
+     *
+     * @param $references array<int|Reference>
+     *
+     * @return Reference[]
+     */
+    private function convert_references( $references ) {
+        return array_map(
+            function ( $reference ) {
+                // Legacy code may still push numerical references to this
+                // $references variable, so convert it to post references.
+                if ( is_numeric( $reference ) ) {
+                        return new Post_Reference( $reference );
+                }
+
+                return $reference;
+
+            },
+            $references
+        );
+    }
 
 }

Spacing +100 added lines, -100 removed lines

@@ -51,12 +51,12 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
-		parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
+	public function __construct($entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false) {
+		parent::__construct($entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create());
 		$this->disable_convert_filters = $disable_convert_filters;
 		$this->object_relation_service = Object_Relation_Service::get_instance();
 		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Post_To_Jsonld_Converter');
 
 		self::$instance = $this;
 
@@ -68,7 +68,7 @@ 
 	}
 
 	public function new_instance_with_filters_disabled() {
-		return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
+		return new static($this->entity_type_service, $this->user_service, $this->attachment_service, true);
 	}
 
 	/**
@@ -82,30 +82,30 @@ 
 	 * @return array A JSON-LD array.
 	 * @since 3.10.0
 	 */
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+	public function convert($post_id, &$references = array(), &$references_infos = array()) {
 
 		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
+		$post = get_post($post_id);
+		if (null === $post) {
 			// Post not found.
 			return null;
 		}
 
 		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references, $references_infos );
+		$jsonld = parent::convert($post_id, $references, $references_infos);
 
 		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
+		if (empty($jsonld['@type'])) {
 			$jsonld['@type'] = 'WebPage';
 		}
 
 		// Get the entity name.
 		$jsonld['headline'] = $post->post_title;
 
-		$custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
+		$custom_fields = $this->entity_type_service->get_custom_fields_for_post($post_id);
 
-		if ( isset( $custom_fields ) ) {
-			$this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
+		if (isset($custom_fields)) {
+			$this->process_type_custom_fields($jsonld, $custom_fields, $post, $references, $references_infos);
 		}
 
 		// Set the published and modified dates.
@@ -118,19 +118,19 @@ 
 		 */
 		try {
 			$default_timezone = date_default_timezone_get();
-			$timezone         = get_option( 'timezone_string' );
-			if ( ! empty( $timezone ) ) {
-				date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-				date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+			$timezone         = get_option('timezone_string');
+			if ( ! empty($timezone)) {
+				date_default_timezone_set($timezone); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+				$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i:sP', false, $post);
+				$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i:sP', false, $post);
+				date_default_timezone_set($default_timezone); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
 			} else {
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+				$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i', true, $post, false);
+				$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i', true, $post, false);
 			}
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+		} catch (Exception $e) {
+			$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i', true, $post, false);
+			$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i', true, $post, false);
 		}
 
 		// Get the word count for the post.
@@ -141,8 +141,8 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
+		if ( ! empty($jsonld['@type']) && 'WebPage' !== $jsonld['@type']) {
+			$post_adapter        = new Wordlift_Post_Adapter($post_id);
 			$jsonld['wordCount'] = $post_adapter->word_count();
 		}
 
@@ -153,37 +153,37 @@ 
 		 *
 		 * @since 3.27.2
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter    = new Wordlift_Post_Adapter( $post_id );
+		if ( ! empty($jsonld['@type']) && 'WebPage' !== $jsonld['@type']) {
+			$post_adapter    = new Wordlift_Post_Adapter($post_id);
 			$keywords        = $post_adapter->keywords();
 			$article_section = $post_adapter->article_section();
 			$comment_count   = $post_adapter->comment_count();
 			$locale          = $post_adapter->locale();
 
-			if ( isset( $keywords ) ) {
+			if (isset($keywords)) {
 				$jsonld['keywords'] = $keywords;
 			}
-			if ( ! empty( $article_section ) ) {
+			if ( ! empty($article_section)) {
 				$jsonld['articleSection'] = $article_section;
 			}
 			$jsonld['commentCount'] = $comment_count;
 			$jsonld['inLanguage']   = $locale;
-			$post_adapter->add_references( $post_id, $references );
+			$post_adapter->add_references($post_id, $references);
 		}
 
 		// Set the publisher.
-		$this->set_publisher( $jsonld );
+		$this->set_publisher($jsonld);
 
-		$references = $this->convert_references( $references );
+		$references = $this->convert_references($references);
 
 		// Process the references if any.
-		$this->set_mentions_and_about( $references, $post, $jsonld );
+		$this->set_mentions_and_about($references, $post, $jsonld);
 
 		// Finally set the author.
-		$jsonld['author'] = $this->get_author( $post->post_author, $references );
+		$jsonld['author'] = $this->get_author($post->post_author, $references);
 
 		// Return the JSON-LD if filters are disabled by the client.
-		if ( $this->disable_convert_filters ) {
+		if ($this->disable_convert_filters) {
 			return $jsonld;
 		}
 
@@ -224,7 +224,7 @@ 
 		 *
 		 * @api
 		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+		return apply_filters('wl_post_jsonld', $jsonld, $post_id, $references);
 	}
 
 	/**
@@ -239,18 +239,18 @@ 
 	 * @return string|array A JSON-LD structure.
 	 * @since 3.14.0
 	 */
-	public function get_author( $author_id, &$references ) {
+	public function get_author($author_id, &$references) {
 
 		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
+		$entity_id = $this->user_service->get_entity($author_id);
 
 		// If there's no entity bound return a simple author structure.
-		if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
+		if (empty($entity_id) || 'publish' !== get_post_status($entity_id)) {
 
-			$author            = get_the_author_meta( 'display_name', $author_id );
-			$author_first_name = get_the_author_meta( 'first_name', $author_id );
-			$author_last_name  = get_the_author_meta( 'last_name', $author_id );
-			$author_uri        = $this->user_service->get_uri( $author_id );
+			$author            = get_the_author_meta('display_name', $author_id);
+			$author_first_name = get_the_author_meta('first_name', $author_id);
+			$author_last_name  = get_the_author_meta('last_name', $author_id);
+			$author_uri        = $this->user_service->get_uri($author_id);
 
 			return array(
 				'@type'      => 'Person',
@@ -258,12 +258,12 @@ 
 				'name'       => $author,
 				'givenName'  => $author_first_name,
 				'familyName' => $author_last_name,
-				'url'        => get_author_posts_url( $author_id ),
+				'url'        => get_author_posts_url($author_id),
 			);
 		}
 
 		// Add the author to the references.
-		$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
+		$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri($entity_id);
 		$references[] = $entity_id;
 
 		// Return the JSON-LD for the referenced entity.
@@ -279,41 +279,41 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	protected function set_publisher( &$params ) {
+	protected function set_publisher(&$params) {
 
 		// If the publisher id isn't set don't do anything.
 		$publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
-		if ( null === $publisher_id ) {
+		if (null === $publisher_id) {
 			return;
 		}
 
 		// Get the post instance.
-		$post = get_post( $publisher_id );
-		if ( null === $post ) {
+		$post = get_post($publisher_id);
+		if (null === $post) {
 			// Publisher not found.
 			return;
 		}
 
 		// Get the item id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
+		$id = Wordlift_Entity_Service::get_instance()->get_uri($publisher_id);
 
 		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
+		$type = $this->entity_type_service->get($publisher_id);
 
 		// Get the name.
 		$name = $post->post_title;
 
 		// Set the publisher data.
 		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
+			'@type' => $this->relative_to_context($type['uri']),
 			'@id'   => $id,
 			'name'  => $name,
 		);
 
 		// Add the sameAs values associated with the publisher.
 		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
+		$sameas          = $storage_factory->post_meta(Wordlift_Schema_Service::FIELD_SAME_AS)->get($publisher_id);
+		if ( ! empty($sameas)) {
 			$params['publisher']['sameAs'] = $sameas;
 		}
 
@@ -321,15 +321,15 @@ 
 		// support the logo property.
 		//
 		// See http://schema.org/logo.
-		if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
+		if (1 !== preg_match('~Organization$~', $type['uri'])) {
 			return;
 		}
 
 		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
+		$publisher_logo = $this->get_publisher_logo($post->ID);
 
 		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
+		if (false === $publisher_logo) {
 			return;
 		}
 
@@ -363,14 +363,14 @@ 
 	 * @since 3.19.2
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
 	 */
-	private function get_publisher_logo( $post_id ) {
+	private function get_publisher_logo($post_id) {
 
 		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
+		$thumbnail_id = get_post_thumbnail_id($post_id);
 
 		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
+		if (empty($thumbnail_id) || 0 === $thumbnail_id) {
+			$this->log->info("Featured image not set for post $post_id.");
 
 			return false;
 		}
@@ -379,24 +379,24 @@ 
 		$uploads_dir = wp_upload_dir();
 
 		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
+		$metadata = wp_get_attachment_metadata($thumbnail_id);
 
 		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
+		if ( ! isset($metadata['file'])) {
+			$this->log->warn("Featured image file not found for post $post_id.");
 
 			return false;
 		}
 
 		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+		$path = $uploads_dir['basedir'].DIRECTORY_SEPARATOR.$metadata['file'];
 
 		// Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+		if ( ! file_exists($path)) {
+			$this->log->warn("Featured image file $path doesn't exist for post $post_id.");
 
-			$attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
-			if ( $attachment_image_src ) {
+			$attachment_image_src = wp_get_attachment_image_src($thumbnail_id, '');
+			if ($attachment_image_src) {
 				return array(
 					'url'    => $attachment_image_src[0],
 					'width'  => $attachment_image_src[1],
@@ -410,27 +410,27 @@ 
 		}
 
 		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+		$original_file_editor = wp_get_image_editor($path);
+		if (is_wp_error($original_file_editor)) {
+			$this->log->warn("Cannot instantiate WP Image Editor on file $path for post $post_id.");
 
 			return false;
 		}
 
 		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
 		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+		$publisher_logo_path = $original_file_editor->generate_filename('-publisher-logo');
 
 		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
+		if ( ! file_exists($publisher_logo_path)) {
+			$original_file_editor->resize(600, 60);
+			$original_file_editor->save($publisher_logo_path);
 		}
 
 		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+		$publisher_logo_editor = wp_get_image_editor($publisher_logo_path);
+		if (is_wp_error($publisher_logo_editor)) {
+			$this->log->warn("Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id.");
 
 			return false;
 		}
@@ -440,7 +440,7 @@ 
 
 		// Finally return the array with data.
 		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+			'url'    => $uploads_dir['baseurl'].substr($publisher_logo_path, strlen($uploads_dir['basedir'])),
 			'width'  => $size['width'],
 			'height' => $size['height'],
 		);
@@ -453,9 +453,9 @@ 
 	 *
 	 * @return void
 	 */
-	private function set_mentions_and_about( $references, $post, &$jsonld ) {
+	private function set_mentions_and_about($references, $post, &$jsonld) {
 
-		if ( count( $references ) === 0 ) {
+		if (count($references) === 0) {
 			return;
 		}
 
@@ -464,23 +464,23 @@ 
 		$about    = array();
 
 		// If the entity is in the title, then it should be an `about`.
-		foreach ( $references as $reference ) {
+		foreach ($references as $reference) {
 
-			if ( ! $reference instanceof Reference ) {
+			if ( ! $reference instanceof Reference) {
 				// This condition should never be reached.
 				continue;
 			}
 
 			// Get the entity labels.
-			$labels = Wordlift_Entity_Service::get_instance()->get_labels( $reference->get_id(), $reference->get_type() );
+			$labels = Wordlift_Entity_Service::get_instance()->get_labels($reference->get_id(), $reference->get_type());
 			// Get the entity URI.
 			$item = array(
-				'@id' => Wordlift_Entity_Service::get_instance()->get_uri( $reference->get_id(), $reference->get_type() ),
+				'@id' => Wordlift_Entity_Service::get_instance()->get_uri($reference->get_id(), $reference->get_type()),
 			);
 
 			$escaped_labels = array_map(
-				function ( $value ) {
-					return preg_quote( $value, '/' );
+				function($value) {
+					return preg_quote($value, '/');
 				},
 				$labels
 			);
@@ -488,13 +488,13 @@ 
 			$matches = false;
 
 			// When the title is empty, then we shouldn't yield a match to about section.
-			if ( array_filter( $escaped_labels ) ) {
+			if (array_filter($escaped_labels)) {
 				// Check if the labels match any part of the title.
-				$matches = $this->check_title_match( $escaped_labels, $post->post_title );
+				$matches = $this->check_title_match($escaped_labels, $post->post_title);
 			}
 
 			// If the title matches, assign the entity to the about, otherwise to the mentions.
-			if ( $matches ) {
+			if ($matches) {
 				$about[] = $item;
 			} else {
 				$mentions[] = $item;
@@ -502,12 +502,12 @@ 
 		}
 
 		// If we have abouts, assign them to the JSON-LD.
-		if ( 0 < count( $about ) ) {
+		if (0 < count($about)) {
 			$jsonld['about'] = $about;
 		}
 
 		// If we have mentions, assign them to the JSON-LD.
-		if ( 0 < count( $mentions ) ) {
+		if (0 < count($mentions)) {
 			$jsonld['mentions'] = $mentions;
 		}
 
@@ -522,15 +522,15 @@ 
 	 *
 	 * @return boolean
 	 */
-	public function check_title_match( $labels, $title ) {
+	public function check_title_match($labels, $title) {
 
 		// If the title is empty, then we shouldn't yield a match to about section.
-		if ( empty( $title ) ) {
+		if (empty($title)) {
 			return false;
 		}
 
 		// Check if the labels match any part of the title.
-		return 1 === preg_match( '/\b(' . implode( '|', $labels ) . ')\b/iu', $title );
+		return 1 === preg_match('/\b('.implode('|', $labels).')\b/iu', $title);
 
 	}
 
@@ -541,13 +541,13 @@ 
 	 *
 	 * @return Reference[]
 	 */
-	private function convert_references( $references ) {
+	private function convert_references($references) {
 		return array_map(
-			function ( $reference ) {
+			function($reference) {
 				// Legacy code may still push numerical references to this
 				// $references variable, so convert it to post references.
-				if ( is_numeric( $reference ) ) {
-					  return new Post_Reference( $reference );
+				if (is_numeric($reference)) {
+					  return new Post_Reference($reference);
 				}
 
 				return $reference;

src/wordlift/metabox/field/class-wl-metabox-field-sameas.php

Indentation +177 added lines, -177 removed lines

@@ -23,102 +23,102 @@ 
 // phpcs:ignore PEAR.NamingConventions.ValidClassName.Invalid
 class Wl_Metabox_Field_sameas extends Wl_Metabox_Field {
 
-	/**
-	 * @inheritdoc
-	 */
-	public function __construct( $args, $id, $type ) {
-		parent::__construct( $args['sameas'], $id, $type );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function save_data( $values ) {
-		// The autocomplete select may send JSON arrays in input values.
-
-		// Only use mb_* functions when mbstring is available.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/693.
-		if ( extension_loaded( 'mbstring' ) ) {
-			mb_regex_encoding( 'UTF-8' );
-
-			$merged = array_reduce(
-				(array) $values,
-				function ( $carry, $item ) {
-					return array_merge( $carry, mb_split( "\x{2063}", wp_unslash( $item ) ) );
-				},
-				array()
-			);
-		} else {
-			$merged = array_reduce(
-				(array) $values,
-				function ( $carry, $item ) {
-					return array_merge( $carry, preg_split( "/\x{2063}/u", wp_unslash( $item ) ) );
-				},
-				array()
-			);
-		}
-
-		// Convert all escaped special characters to their original.
-		$merged = array_map( 'urldecode', $merged );
-
-		$merged = $this->filter_urls( $merged );
-
-		parent::save_data( $merged );
-	}
-
-	/**
-	 * Encode URL Path to fix non ASCII characters.
-	 *
-	 * @param string $url URL to check.
-	 *
-	 * @return string Encoded URL.
-	 */
-	public function encode_path( $url ) {
-		$path         = wp_parse_url( $url, PHP_URL_PATH );
-		$encoded_path = array_map( 'urlencode', explode( '/', $path ) );
-		return str_replace( $path, implode( '/', $encoded_path ), $url );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function sanitize_data_filter( $value ) {
-
-		// Call our sanitizer helper.
-		return Wordlift_Sanitizer::sanitize_url( $value );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_heading_html() {
-
-		// Add the select html fragment after the heading.
-		return parent::get_heading_html()
-			   . $this->get_select_html();
-	}
-
-	/**
-	 * Get the select html fragment.
-	 *
-	 * @return string The html fragment.
-	 * @since 3.15.0
-	 */
-	private function get_select_html() {
-		// Return an element where the new Autocomplete Select will attach to.
-		return '<p>'
-			   . esc_html__( 'Use the search below to link this entity with equivalent entities in the linked data cloud.', 'wordlift' )
-			   . '<div id="wl-metabox-field-sameas"></div></p>';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_add_button_html( $count ) {
-
-		return sprintf(
-			'
+    /**
+     * @inheritdoc
+     */
+    public function __construct( $args, $id, $type ) {
+        parent::__construct( $args['sameas'], $id, $type );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function save_data( $values ) {
+        // The autocomplete select may send JSON arrays in input values.
+
+        // Only use mb_* functions when mbstring is available.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/693.
+        if ( extension_loaded( 'mbstring' ) ) {
+            mb_regex_encoding( 'UTF-8' );
+
+            $merged = array_reduce(
+                (array) $values,
+                function ( $carry, $item ) {
+                    return array_merge( $carry, mb_split( "\x{2063}", wp_unslash( $item ) ) );
+                },
+                array()
+            );
+        } else {
+            $merged = array_reduce(
+                (array) $values,
+                function ( $carry, $item ) {
+                    return array_merge( $carry, preg_split( "/\x{2063}/u", wp_unslash( $item ) ) );
+                },
+                array()
+            );
+        }
+
+        // Convert all escaped special characters to their original.
+        $merged = array_map( 'urldecode', $merged );
+
+        $merged = $this->filter_urls( $merged );
+
+        parent::save_data( $merged );
+    }
+
+    /**
+     * Encode URL Path to fix non ASCII characters.
+     *
+     * @param string $url URL to check.
+     *
+     * @return string Encoded URL.
+     */
+    public function encode_path( $url ) {
+        $path         = wp_parse_url( $url, PHP_URL_PATH );
+        $encoded_path = array_map( 'urlencode', explode( '/', $path ) );
+        return str_replace( $path, implode( '/', $encoded_path ), $url );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function sanitize_data_filter( $value ) {
+
+        // Call our sanitizer helper.
+        return Wordlift_Sanitizer::sanitize_url( $value );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_heading_html() {
+
+        // Add the select html fragment after the heading.
+        return parent::get_heading_html()
+                . $this->get_select_html();
+    }
+
+    /**
+     * Get the select html fragment.
+     *
+     * @return string The html fragment.
+     * @since 3.15.0
+     */
+    private function get_select_html() {
+        // Return an element where the new Autocomplete Select will attach to.
+        return '<p>'
+                . esc_html__( 'Use the search below to link this entity with equivalent entities in the linked data cloud.', 'wordlift' )
+                . '<div id="wl-metabox-field-sameas"></div></p>';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_add_button_html( $count ) {
+
+        return sprintf(
+            '
             <button type="button" class="wl-add-input wl-add-input--link">%1$s</button>
 	        <div style="display: none;">
 	            <div class="wl-input-wrapper">
@@ -128,60 +128,60 @@ 
             </div>
             <fieldset id="wl-input-container">%4$s</fieldset>
             ',
-			esc_html__( 'Click here to manually add URLs', 'wordlift' ),
-			esc_attr( $this->meta_name ),
-			esc_attr_x( 'Type here the URL of an equivalent entity from another dataset.', 'sameAs metabox input', 'wordlift' ),
-			$this->get_stored_values_html( $count )
-		) .
-			   parent::get_add_custom_button_html( $count, 'Add Another URL', 'hide' );
-
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function html() {
-
-		/**
-		 * Filter: wl_feature__enable__metabox-sameas.
-		 *
-		 * @param bool whether the sameAs metabox should be shown, defaults to true.
-		 *
-		 * @return bool
-		 * @since 3.29.1
-		 */
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__metabox-sameas', true ) ) {
-
-			// Open main <div> for the Field.
-			$html = $this->html_wrapper_open();
-
-			// Label.
-			$html .= $this->get_heading_html();
-
-			// print nonce.
-			$html .= $this->html_nonce();
-
-			// print data loaded from DB.
-			$count = 0;
-
-			// If cardinality allows it, print button to add new values.
-			$html .= $this->get_add_button_html( $count );
-
-			// Close the HTML wrapper.
-			$html .= $this->html_wrapper_close();
-
-			return $html;
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function html_input( $value ) {
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@ob_start();
-		?>
+            esc_html__( 'Click here to manually add URLs', 'wordlift' ),
+            esc_attr( $this->meta_name ),
+            esc_attr_x( 'Type here the URL of an equivalent entity from another dataset.', 'sameAs metabox input', 'wordlift' ),
+            $this->get_stored_values_html( $count )
+        ) .
+                parent::get_add_custom_button_html( $count, 'Add Another URL', 'hide' );
+
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function html() {
+
+        /**
+         * Filter: wl_feature__enable__metabox-sameas.
+         *
+         * @param bool whether the sameAs metabox should be shown, defaults to true.
+         *
+         * @return bool
+         * @since 3.29.1
+         */
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( apply_filters( 'wl_feature__enable__metabox-sameas', true ) ) {
+
+            // Open main <div> for the Field.
+            $html = $this->html_wrapper_open();
+
+            // Label.
+            $html .= $this->get_heading_html();
+
+            // print nonce.
+            $html .= $this->html_nonce();
+
+            // print data loaded from DB.
+            $count = 0;
+
+            // If cardinality allows it, print button to add new values.
+            $html .= $this->get_add_button_html( $count );
+
+            // Close the HTML wrapper.
+            $html .= $this->html_wrapper_close();
+
+            return $html;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function html_input( $value ) {
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @ob_start();
+        ?>
 		<div class="wl-input-wrapper wl-input-wrapper-readonly">
 			<input
 					type="text"
@@ -195,32 +195,32 @@ 
 		</div>
 		<?php
 
-		$html = ob_get_clean();
-
-		return $html;
-	}
-
-	/**
-	 * @param array $urls
-	 *
-	 * @return array
-	 */
-	private function filter_urls( $urls ) {
-		$configuration_service = Wordlift_Configuration_Service::get_instance();
-		$dataset_uri           = $configuration_service->get_dataset_uri();
-
-		return array_filter(
-			$urls,
-			function ( $url ) use ( $dataset_uri ) {
-				$url_validation = filter_var( $this->encode_path( $url ), FILTER_VALIDATE_URL );
-				if ( null === $dataset_uri ) {
-					return $url_validation;
-				}
-
-				// URLs should not start with local dataset uri.
-				return $url_validation && ( empty( $dataset_uri ) || 0 !== strpos( $url, $dataset_uri ) );
-			}
-		);
-	}
+        $html = ob_get_clean();
+
+        return $html;
+    }
+
+    /**
+     * @param array $urls
+     *
+     * @return array
+     */
+    private function filter_urls( $urls ) {
+        $configuration_service = Wordlift_Configuration_Service::get_instance();
+        $dataset_uri           = $configuration_service->get_dataset_uri();
+
+        return array_filter(
+            $urls,
+            function ( $url ) use ( $dataset_uri ) {
+                $url_validation = filter_var( $this->encode_path( $url ), FILTER_VALIDATE_URL );
+                if ( null === $dataset_uri ) {
+                    return $url_validation;
+                }
+
+                // URLs should not start with local dataset uri.
+                return $url_validation && ( empty( $dataset_uri ) || 0 !== strpos( $url, $dataset_uri ) );
+            }
+        );
+    }
 
 }

Spacing +37 added lines, -37 removed lines

@@ -26,45 +26,45 @@ 
 	/**
 	 * @inheritdoc
 	 */
-	public function __construct( $args, $id, $type ) {
-		parent::__construct( $args['sameas'], $id, $type );
+	public function __construct($args, $id, $type) {
+		parent::__construct($args['sameas'], $id, $type);
 	}
 
 	/**
 	 * @inheritdoc
 	 */
-	public function save_data( $values ) {
+	public function save_data($values) {
 		// The autocomplete select may send JSON arrays in input values.
 
 		// Only use mb_* functions when mbstring is available.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/693.
-		if ( extension_loaded( 'mbstring' ) ) {
-			mb_regex_encoding( 'UTF-8' );
+		if (extension_loaded('mbstring')) {
+			mb_regex_encoding('UTF-8');
 
 			$merged = array_reduce(
 				(array) $values,
-				function ( $carry, $item ) {
-					return array_merge( $carry, mb_split( "\x{2063}", wp_unslash( $item ) ) );
+				function($carry, $item) {
+					return array_merge($carry, mb_split("\x{2063}", wp_unslash($item)));
 				},
 				array()
 			);
 		} else {
 			$merged = array_reduce(
 				(array) $values,
-				function ( $carry, $item ) {
-					return array_merge( $carry, preg_split( "/\x{2063}/u", wp_unslash( $item ) ) );
+				function($carry, $item) {
+					return array_merge($carry, preg_split("/\x{2063}/u", wp_unslash($item)));
 				},
 				array()
 			);
 		}
 
 		// Convert all escaped special characters to their original.
-		$merged = array_map( 'urldecode', $merged );
+		$merged = array_map('urldecode', $merged);
 
-		$merged = $this->filter_urls( $merged );
+		$merged = $this->filter_urls($merged);
 
-		parent::save_data( $merged );
+		parent::save_data($merged);
 	}
 
 	/**
@@ -74,19 +74,19 @@ 
 	 *
 	 * @return string Encoded URL.
 	 */
-	public function encode_path( $url ) {
-		$path         = wp_parse_url( $url, PHP_URL_PATH );
-		$encoded_path = array_map( 'urlencode', explode( '/', $path ) );
-		return str_replace( $path, implode( '/', $encoded_path ), $url );
+	public function encode_path($url) {
+		$path         = wp_parse_url($url, PHP_URL_PATH);
+		$encoded_path = array_map('urlencode', explode('/', $path));
+		return str_replace($path, implode('/', $encoded_path), $url);
 	}
 
 	/**
 	 * @inheritdoc
 	 */
-	public function sanitize_data_filter( $value ) {
+	public function sanitize_data_filter($value) {
 
 		// Call our sanitizer helper.
-		return Wordlift_Sanitizer::sanitize_url( $value );
+		return Wordlift_Sanitizer::sanitize_url($value);
 	}
 
 	/**
@@ -108,14 +108,14 @@ 
 	private function get_select_html() {
 		// Return an element where the new Autocomplete Select will attach to.
 		return '<p>'
-			   . esc_html__( 'Use the search below to link this entity with equivalent entities in the linked data cloud.', 'wordlift' )
+			   . esc_html__('Use the search below to link this entity with equivalent entities in the linked data cloud.', 'wordlift')
 			   . '<div id="wl-metabox-field-sameas"></div></p>';
 	}
 
 	/**
 	 * @inheritdoc
 	 */
-	protected function get_add_button_html( $count ) {
+	protected function get_add_button_html($count) {
 
 		return sprintf(
 			'
@@ -128,12 +128,12 @@ 
             </div>
             <fieldset id="wl-input-container">%4$s</fieldset>
             ',
-			esc_html__( 'Click here to manually add URLs', 'wordlift' ),
-			esc_attr( $this->meta_name ),
-			esc_attr_x( 'Type here the URL of an equivalent entity from another dataset.', 'sameAs metabox input', 'wordlift' ),
-			$this->get_stored_values_html( $count )
-		) .
-			   parent::get_add_custom_button_html( $count, 'Add Another URL', 'hide' );
+			esc_html__('Click here to manually add URLs', 'wordlift'),
+			esc_attr($this->meta_name),
+			esc_attr_x('Type here the URL of an equivalent entity from another dataset.', 'sameAs metabox input', 'wordlift'),
+			$this->get_stored_values_html($count)
+		).
+			   parent::get_add_custom_button_html($count, 'Add Another URL', 'hide');
 
 	}
 
@@ -151,7 +151,7 @@ 
 		 * @since 3.29.1
 		 */
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__metabox-sameas', true ) ) {
+		if (apply_filters('wl_feature__enable__metabox-sameas', true)) {
 
 			// Open main <div> for the Field.
 			$html = $this->html_wrapper_open();
@@ -166,7 +166,7 @@ 
 			$count = 0;
 
 			// If cardinality allows it, print button to add new values.
-			$html .= $this->get_add_button_html( $count );
+			$html .= $this->get_add_button_html($count);
 
 			// Close the HTML wrapper.
 			$html .= $this->html_wrapper_close();
@@ -178,7 +178,7 @@ 
 	/**
 	 * @inheritdoc
 	 */
-	public function html_input( $value ) {
+	public function html_input($value) {
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
 		@ob_start();
 		?>
@@ -186,9 +186,9 @@ 
 			<input
 					type="text"
 					readonly="readonly"
-					id="<?php echo esc_attr( $this->meta_name ); ?>"
-					name="wl_metaboxes[<?php echo esc_attr( $this->meta_name ); ?>][]"
-					value="<?php echo esc_attr( $value ); ?>"
+					id="<?php echo esc_attr($this->meta_name); ?>"
+					name="wl_metaboxes[<?php echo esc_attr($this->meta_name); ?>][]"
+					value="<?php echo esc_attr($value); ?>"
 			/>
 
 			<button class="wl-remove-input wl-remove-input--sameas"></button>
@@ -205,20 +205,20 @@ 
 	 *
 	 * @return array
 	 */
-	private function filter_urls( $urls ) {
+	private function filter_urls($urls) {
 		$configuration_service = Wordlift_Configuration_Service::get_instance();
 		$dataset_uri           = $configuration_service->get_dataset_uri();
 
 		return array_filter(
 			$urls,
-			function ( $url ) use ( $dataset_uri ) {
-				$url_validation = filter_var( $this->encode_path( $url ), FILTER_VALIDATE_URL );
-				if ( null === $dataset_uri ) {
+			function($url) use ($dataset_uri) {
+				$url_validation = filter_var($this->encode_path($url), FILTER_VALIDATE_URL);
+				if (null === $dataset_uri) {
 					return $url_validation;
 				}
 
 				// URLs should not start with local dataset uri.
-				return $url_validation && ( empty( $dataset_uri ) || 0 !== strpos( $url, $dataset_uri ) );
+				return $url_validation && (empty($dataset_uri) || 0 !== strpos($url, $dataset_uri));
 			}
 		);
 	}

src/wordlift/jsonld/class-mentions.php

Indentation +222 added lines, -222 removed lines

@@ -16,242 +16,242 @@
 
 class Mentions {
 
-	private static $schema_descendants = array(
-		'AmpStory',
-		'ArchiveComponent',
-		'Article',
-		'Atlas',
-		'Blog',
-		'Book',
-		'Chapter',
-		'Claim',
-		'Clip',
-		'Code',
-		'Collection',
-		'ComicStory',
-		'Comment',
-		'Conversation',
-		'Course',
-		'CreativeWorkSeason',
-		'CreativeWorkSeries',
-		'DataCatalog',
-		'Dataset',
-		'DefinedTermSet',
-		'Diet',
-		'DigitalDocument',
-		'Drawing',
-		'EducationalOccupationalCredential',
-		'Episode',
-		'ExercisePlan',
-		'Game',
-		'Guide',
-		'HowTo',
-		'HowToDirection',
-		'HowToSection',
-		'HowToStep',
-		'HowToTip',
-		'HyperToc',
-		'HyperTocEntry',
-		'LearningResource',
-		'Legislation',
-		'Manuscript',
-		'Map',
-		'MathSolver',
-		'MediaObject',
-		'Menu',
-		'MenuSection',
-		'Message',
-		'Movie',
-		'MusicComposition',
-		'MusicPlaylist',
-		'MusicRecording',
-		'Painting',
-		'Photograph',
-		'Play',
-		'Poster',
-		'PublicationIssue',
-		'PublicationVolume',
-		'Quotation',
-		'Review',
-		'Sculpture',
-		'Season',
-		'SheetMusic',
-		'ShortStory',
-		'SoftwareApplication',
-		'SoftwareSourceCode',
-		'SpecialAnnouncement',
-		'Thesis',
-		'TvSeason',
-		'TvSeries',
-		'VisualArtwork',
-		'WebContent',
-		'WebPage',
-		'WebPageElement',
-		'WebSite',
-		'AdvertiserContentArticle',
-		'NewsArticle',
-		'Report',
-		'SatiricalArticle',
-		'ScholarlyArticle',
-		'SocialMediaPosting',
-		'TechArticle',
-		'AnalysisNewsArticle',
-		'AskPublicNewsArticle',
-		'BackgroundNewsArticle',
-		'OpinionNewsArticle',
-		'ReportageNewsArticle',
-		'ReviewNewsArticle',
-		'MedicalScholarlyArticle',
-		'BlogPosting',
-		'DiscussionForumPosting',
-		'LiveBlogPosting',
-		'ApiReference',
-		'Audiobook',
-		'MovieClip',
-		'RadioClip',
-		'TvClip',
-		'VideoGameClip',
-		'ProductCollection',
-		'ComicCoverArt',
-		'Answer',
-		'CorrectionComment',
-		'Question',
-		'PodcastSeason',
-		'RadioSeason',
-		'TvSeason',
-		'BookSeries',
-		'MovieSeries',
-		'Periodical',
-		'PodcastSeries',
-		'RadioSeries',
-		'TvSeries',
-		'VideoGameSeries',
-		'ComicSeries',
-		'Newspaper',
-		'DataFeed',
-		'CompleteDataFeed',
-		'CategoryCodeSet',
-		'NoteDigitalDocument',
-		'PresentationDigitalDocument',
-		'SpreadsheetDigitalDocument',
-		'TextDigitalDocument',
-		'PodcastEpisode',
-		'RadioEpisode',
-		'TvEpisode',
-		'VideoGame',
-		'Recipe',
-		'Course',
-		'Quiz',
-		'LegislationObject',
-		'AudioObject',
-		'DModel',
-		'DataDownload',
-		'ImageObject',
-		'LegislationObject',
-		'MusicVideoObject',
-		'VideoObject',
-		'Audiobook',
-		'Barcode',
-		'EmailMessage',
-		'MusicAlbum',
-		'MusicRelease',
-		'ComicIssue',
-		'ClaimReview',
-		'CriticReview',
-		'EmployerReview',
-		'MediaReview',
-		'Recommendation',
-		'UserReview',
-		'ReviewNewsArticle',
-		'MobileApplication',
-		'VideoGame',
-		'WebApplication',
-		'CoverArt',
-		'ComicCoverArt',
-		'HealthTopicContent',
-		'AboutPage',
-		'CheckoutPage',
-		'CollectionPage',
-		'ContactPage',
-		'FaqPage',
-		'ItemPage',
-		'MedicalWebPage',
-		'ProfilePage',
-		'QaPage',
-		'RealEstateListing',
-		'SearchResultsPage',
-		'MediaGallery',
-		'ImageGallery',
-		'VideoGallery',
-		'SiteNavigationElement',
-		'Table',
-		'WpAdBlock',
-		'WpFooter',
-		'WpHeader',
-		'WpSideBar',
-	);
+    private static $schema_descendants = array(
+        'AmpStory',
+        'ArchiveComponent',
+        'Article',
+        'Atlas',
+        'Blog',
+        'Book',
+        'Chapter',
+        'Claim',
+        'Clip',
+        'Code',
+        'Collection',
+        'ComicStory',
+        'Comment',
+        'Conversation',
+        'Course',
+        'CreativeWorkSeason',
+        'CreativeWorkSeries',
+        'DataCatalog',
+        'Dataset',
+        'DefinedTermSet',
+        'Diet',
+        'DigitalDocument',
+        'Drawing',
+        'EducationalOccupationalCredential',
+        'Episode',
+        'ExercisePlan',
+        'Game',
+        'Guide',
+        'HowTo',
+        'HowToDirection',
+        'HowToSection',
+        'HowToStep',
+        'HowToTip',
+        'HyperToc',
+        'HyperTocEntry',
+        'LearningResource',
+        'Legislation',
+        'Manuscript',
+        'Map',
+        'MathSolver',
+        'MediaObject',
+        'Menu',
+        'MenuSection',
+        'Message',
+        'Movie',
+        'MusicComposition',
+        'MusicPlaylist',
+        'MusicRecording',
+        'Painting',
+        'Photograph',
+        'Play',
+        'Poster',
+        'PublicationIssue',
+        'PublicationVolume',
+        'Quotation',
+        'Review',
+        'Sculpture',
+        'Season',
+        'SheetMusic',
+        'ShortStory',
+        'SoftwareApplication',
+        'SoftwareSourceCode',
+        'SpecialAnnouncement',
+        'Thesis',
+        'TvSeason',
+        'TvSeries',
+        'VisualArtwork',
+        'WebContent',
+        'WebPage',
+        'WebPageElement',
+        'WebSite',
+        'AdvertiserContentArticle',
+        'NewsArticle',
+        'Report',
+        'SatiricalArticle',
+        'ScholarlyArticle',
+        'SocialMediaPosting',
+        'TechArticle',
+        'AnalysisNewsArticle',
+        'AskPublicNewsArticle',
+        'BackgroundNewsArticle',
+        'OpinionNewsArticle',
+        'ReportageNewsArticle',
+        'ReviewNewsArticle',
+        'MedicalScholarlyArticle',
+        'BlogPosting',
+        'DiscussionForumPosting',
+        'LiveBlogPosting',
+        'ApiReference',
+        'Audiobook',
+        'MovieClip',
+        'RadioClip',
+        'TvClip',
+        'VideoGameClip',
+        'ProductCollection',
+        'ComicCoverArt',
+        'Answer',
+        'CorrectionComment',
+        'Question',
+        'PodcastSeason',
+        'RadioSeason',
+        'TvSeason',
+        'BookSeries',
+        'MovieSeries',
+        'Periodical',
+        'PodcastSeries',
+        'RadioSeries',
+        'TvSeries',
+        'VideoGameSeries',
+        'ComicSeries',
+        'Newspaper',
+        'DataFeed',
+        'CompleteDataFeed',
+        'CategoryCodeSet',
+        'NoteDigitalDocument',
+        'PresentationDigitalDocument',
+        'SpreadsheetDigitalDocument',
+        'TextDigitalDocument',
+        'PodcastEpisode',
+        'RadioEpisode',
+        'TvEpisode',
+        'VideoGame',
+        'Recipe',
+        'Course',
+        'Quiz',
+        'LegislationObject',
+        'AudioObject',
+        'DModel',
+        'DataDownload',
+        'ImageObject',
+        'LegislationObject',
+        'MusicVideoObject',
+        'VideoObject',
+        'Audiobook',
+        'Barcode',
+        'EmailMessage',
+        'MusicAlbum',
+        'MusicRelease',
+        'ComicIssue',
+        'ClaimReview',
+        'CriticReview',
+        'EmployerReview',
+        'MediaReview',
+        'Recommendation',
+        'UserReview',
+        'ReviewNewsArticle',
+        'MobileApplication',
+        'VideoGame',
+        'WebApplication',
+        'CoverArt',
+        'ComicCoverArt',
+        'HealthTopicContent',
+        'AboutPage',
+        'CheckoutPage',
+        'CollectionPage',
+        'ContactPage',
+        'FaqPage',
+        'ItemPage',
+        'MedicalWebPage',
+        'ProfilePage',
+        'QaPage',
+        'RealEstateListing',
+        'SearchResultsPage',
+        'MediaGallery',
+        'ImageGallery',
+        'VideoGallery',
+        'SiteNavigationElement',
+        'Table',
+        'WpAdBlock',
+        'WpFooter',
+        'WpHeader',
+        'WpSideBar',
+    );
 
-	public function __construct() {
-		add_filter( 'wl_after_get_jsonld', array( $this, 'wl_after_get_jsonld' ), 10, 2 );
-	}
+    public function __construct() {
+        add_filter( 'wl_after_get_jsonld', array( $this, 'wl_after_get_jsonld' ), 10, 2 );
+    }
 
-	public function wl_after_get_jsonld( $jsonld, $post_id ) {
+    public function wl_after_get_jsonld( $jsonld, $post_id ) {
 
-		if ( count( $jsonld ) === 0 || ! is_array( $jsonld[0] ) || ! array_key_exists( '@type', $jsonld[0] ) || array_key_exists( 'mentions', $jsonld[0] ) ) {
-			return $jsonld;
-		}
+        if ( count( $jsonld ) === 0 || ! is_array( $jsonld[0] ) || ! array_key_exists( '@type', $jsonld[0] ) || array_key_exists( 'mentions', $jsonld[0] ) ) {
+            return $jsonld;
+        }
 
-		$type = $jsonld[0]['@type'];
+        $type = $jsonld[0]['@type'];
 
-		if ( ! $this->entity_is_descendant_of_creative_work( $type ) && ! $this->entity_is_creative_work( $type ) ) {
-			return $jsonld;
-		}
+        if ( ! $this->entity_is_descendant_of_creative_work( $type ) && ! $this->entity_is_creative_work( $type ) ) {
+            return $jsonld;
+        }
 
-		$entity_references = Object_Relation_Service::get_instance()
-													->get_references( $post_id, Object_Type_Enum::POST );
+        $entity_references = Object_Relation_Service::get_instance()
+                                                    ->get_references( $post_id, Object_Type_Enum::POST );
 
-		$about_id = array();
-		if ( array_key_exists( 'about', $jsonld[0] ) ) {
-			foreach ( $jsonld[0]['about'] as $about ) {
-				$about_id[] = $about['@id'];
-			}
-		}
+        $about_id = array();
+        if ( array_key_exists( 'about', $jsonld[0] ) ) {
+            foreach ( $jsonld[0]['about'] as $about ) {
+                $about_id[] = $about['@id'];
+            }
+        }
 
-		$jsonld[0]['mentions'] = array_values(
-			array_filter(
-				array_map(
-					function ( $item ) use ( $about_id ) {
-						$id = \Wordlift_Entity_Service::get_instance()->get_uri( $item->get_id() );
-						if ( ! $id || in_array( $id, $about_id, true ) ) {
-							return false;
-						}
+        $jsonld[0]['mentions'] = array_values(
+            array_filter(
+                array_map(
+                    function ( $item ) use ( $about_id ) {
+                        $id = \Wordlift_Entity_Service::get_instance()->get_uri( $item->get_id() );
+                        if ( ! $id || in_array( $id, $about_id, true ) ) {
+                            return false;
+                        }
 
-						return array( '@id' => $id );
+                        return array( '@id' => $id );
 
-					},
-					$entity_references
-				)
-			)
-		);
+                    },
+                    $entity_references
+                )
+            )
+        );
 
-		// Remove mentions if the count is zero.
-		if ( count( $jsonld[0]['mentions'] ) === 0 ) {
-			unset( $jsonld[0]['mentions'] );
-		}
+        // Remove mentions if the count is zero.
+        if ( count( $jsonld[0]['mentions'] ) === 0 ) {
+            unset( $jsonld[0]['mentions'] );
+        }
 
-		return $jsonld;
-	}
+        return $jsonld;
+    }
 
-	private function entity_is_descendant_of_creative_work( $type ) {
-		if ( is_string( $type ) ) {
-			$type = array( $type );
-		}
+    private function entity_is_descendant_of_creative_work( $type ) {
+        if ( is_string( $type ) ) {
+            $type = array( $type );
+        }
 
-		return count( array_intersect( $type, $this::$schema_descendants ) ) > 0;
-	}
+        return count( array_intersect( $type, $this::$schema_descendants ) ) > 0;
+    }
 
-	private function entity_is_creative_work( $type ) {
-		return ( 'CreativeWork' === $type ) || ( is_array( $type ) && in_array( 'CreativeWork', $type, true ) );
-	}
+    private function entity_is_creative_work( $type ) {
+        return ( 'CreativeWork' === $type ) || ( is_array( $type ) && in_array( 'CreativeWork', $type, true ) );
+    }
 
 }

Spacing +19 added lines, -19 removed lines

@@ -192,27 +192,27 @@ 
 	);
 
 	public function __construct() {
-		add_filter( 'wl_after_get_jsonld', array( $this, 'wl_after_get_jsonld' ), 10, 2 );
+		add_filter('wl_after_get_jsonld', array($this, 'wl_after_get_jsonld'), 10, 2);
 	}
 
-	public function wl_after_get_jsonld( $jsonld, $post_id ) {
+	public function wl_after_get_jsonld($jsonld, $post_id) {
 
-		if ( count( $jsonld ) === 0 || ! is_array( $jsonld[0] ) || ! array_key_exists( '@type', $jsonld[0] ) || array_key_exists( 'mentions', $jsonld[0] ) ) {
+		if (count($jsonld) === 0 || ! is_array($jsonld[0]) || ! array_key_exists('@type', $jsonld[0]) || array_key_exists('mentions', $jsonld[0])) {
 			return $jsonld;
 		}
 
 		$type = $jsonld[0]['@type'];
 
-		if ( ! $this->entity_is_descendant_of_creative_work( $type ) && ! $this->entity_is_creative_work( $type ) ) {
+		if ( ! $this->entity_is_descendant_of_creative_work($type) && ! $this->entity_is_creative_work($type)) {
 			return $jsonld;
 		}
 
 		$entity_references = Object_Relation_Service::get_instance()
-													->get_references( $post_id, Object_Type_Enum::POST );
+													->get_references($post_id, Object_Type_Enum::POST);
 
 		$about_id = array();
-		if ( array_key_exists( 'about', $jsonld[0] ) ) {
-			foreach ( $jsonld[0]['about'] as $about ) {
+		if (array_key_exists('about', $jsonld[0])) {
+			foreach ($jsonld[0]['about'] as $about) {
 				$about_id[] = $about['@id'];
 			}
 		}
@@ -220,13 +220,13 @@ 
 		$jsonld[0]['mentions'] = array_values(
 			array_filter(
 				array_map(
-					function ( $item ) use ( $about_id ) {
-						$id = \Wordlift_Entity_Service::get_instance()->get_uri( $item->get_id() );
-						if ( ! $id || in_array( $id, $about_id, true ) ) {
+					function($item) use ($about_id) {
+						$id = \Wordlift_Entity_Service::get_instance()->get_uri($item->get_id());
+						if ( ! $id || in_array($id, $about_id, true)) {
 							return false;
 						}
 
-						return array( '@id' => $id );
+						return array('@id' => $id);
 
 					},
 					$entity_references
@@ -235,23 +235,23 @@ 
 		);
 
 		// Remove mentions if the count is zero.
-		if ( count( $jsonld[0]['mentions'] ) === 0 ) {
-			unset( $jsonld[0]['mentions'] );
+		if (count($jsonld[0]['mentions']) === 0) {
+			unset($jsonld[0]['mentions']);
 		}
 
 		return $jsonld;
 	}
 
-	private function entity_is_descendant_of_creative_work( $type ) {
-		if ( is_string( $type ) ) {
-			$type = array( $type );
+	private function entity_is_descendant_of_creative_work($type) {
+		if (is_string($type)) {
+			$type = array($type);
 		}
 
-		return count( array_intersect( $type, $this::$schema_descendants ) ) > 0;
+		return count(array_intersect($type, $this::$schema_descendants)) > 0;
 	}
 
-	private function entity_is_creative_work( $type ) {
-		return ( 'CreativeWork' === $type ) || ( is_array( $type ) && in_array( 'CreativeWork', $type, true ) );
+	private function entity_is_creative_work($type) {
+		return ('CreativeWork' === $type) || (is_array($type) && in_array('CreativeWork', $type, true));
 	}
 
 }

src/wordlift/configuration/class-config.php

Indentation +183 added lines, -183 removed lines

@@ -3,191 +3,191 @@
 namespace Wordlift\Configuration;
 
 class Config {
-	/**
-	 * @var \Wordlift_Admin_Setup
-	 */
-	private $admin_setup;
-	/**
-	 * @var \Wordlift_Key_Validation_Service
-	 */
-	private $key_validation_service;
-
-	/**
-	 * Config constructor.
-	 *
-	 * @param $admin_setup \Wordlift_Admin_Setup
-	 * @param $key_validation_service \Wordlift_Key_Validation_Service
-	 */
-	public function __construct( $admin_setup, $key_validation_service ) {
-
-		$this->admin_setup            = $admin_setup;
-		$this->key_validation_service = $key_validation_service;
-		add_action( 'wp_ajax_nopriv_wl_config_plugin', array( $this, 'config' ) );
-
-	}
-
-	/**
-	 * Check if the key is valid and also not bound to any domain.
-	 *
-	 * @param $key string
-	 *
-	 * @return bool
-	 */
-	private function is_key_valid_and_not_bound_to_any_domain( $key ) {
-		$account_info = $this->key_validation_service->get_account_info( $key );
-
-		/**
-		 * we need to check if the key is not associated with any account
-		 * before setting it, we should check if the url is null.
-		 */
-		if ( is_wp_error( $account_info )
-			 || wp_remote_retrieve_response_code( $account_info ) !== 200 ) {
-			return false;
-		}
-
-		$account_info_json = $account_info['body'];
-
-		$account_info_data = json_decode( $account_info_json, true );
-
-		if ( ! $account_info_data ) {
-			// Invalid json returned by api.
-			return false;
-		}
-
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( get_option( 'home' ) ) );
-
-		if ( null === $account_info_data['url'] ) {
-			return true;
-		}
-
-		// Check if the key belongs to same site.
-		if ( untrailingslashit( $account_info_data['url'] ) !== $site_url ) {
-			// key already associated with another account.
-			return false;
-		}
-
-		// Return true if the key domain and site domain are the same.
-		return true;
-	}
-
-	public function config() {
-
-		// Perform validation check for all the parameters.
-		$required_fields = array(
-			'diagnostic',
-			'vocabulary',
-			// Don't ask for language from webapp.
-			// 'language',
-				'country',
-			'publisherName',
-			'publisher',
-			'license',
-		);
-
-		header( 'Access-Control-Allow-Origin: *' );
-
-		// validate all the fields before processing
-		foreach ( $required_fields as $field ) {
-			if ( ! array_key_exists( $field, $_POST ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
-				/* translators: %s: field name */
-				wp_send_json_error( sprintf( __( 'Field %s is required', 'wordlift' ), $field ), 422 );
-
-				return;
-			}
-		}
-
-		$key = isset( $_POST['license'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['license'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
-
-		if ( ! $this->is_key_valid_and_not_bound_to_any_domain( $key ) ) {
-			wp_send_json_error( __( 'Key is not valid or associated with other domain', 'wordlift' ), 403 );
-
-			// exit if not valid.
-			return;
-		}
-
-		// check if key is already configured, if yes then dont save settings.
-		if ( \Wordlift_Configuration_Service::get_instance()->get_key() ) {
-			wp_send_json_error( __( 'Key already configured.', 'wordlift' ), 403 );
-
-			// key already configured
-			return;
-		}
-
-		$this->admin_setup->save_configuration( $this->get_params() );
-
-		// This prevents invalid key issue with automatic installation in sites which have redis cache enabled.
-		wp_cache_flush();
-
-		wp_send_json_success( __( 'Configuration Saved', 'wordlift' ) );
-	}
-
-	/**
-	 *
-	 * @return array
-	 */
-	private function get_params() {
-
-		$attachment_id = $this->may_be_get_attachment_id();
-
-		$params = array(
-			'key'             => isset( $_POST['license'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['license'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'vocabulary'      => isset( $_POST['vocabulary'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['vocabulary'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'wl-country-code' => isset( $_POST['country'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['country'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'name'            => isset( $_POST['publisherName'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['publisherName'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'user_type'       => isset( $_POST['publisher'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['publisher'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'logo'            => $attachment_id,
-		);
-
-		$diagnostic = isset( $_POST['diagnostic'] ) ? (bool) $_POST['diagnostic'] : false; // phpcs:ignore WordPress.Security.NonceVerification.Missing
-		if ( $diagnostic ) {
-			$params['share-diagnostic'] = 'on';
-		}
+    /**
+     * @var \Wordlift_Admin_Setup
+     */
+    private $admin_setup;
+    /**
+     * @var \Wordlift_Key_Validation_Service
+     */
+    private $key_validation_service;
+
+    /**
+     * Config constructor.
+     *
+     * @param $admin_setup \Wordlift_Admin_Setup
+     * @param $key_validation_service \Wordlift_Key_Validation_Service
+     */
+    public function __construct( $admin_setup, $key_validation_service ) {
+
+        $this->admin_setup            = $admin_setup;
+        $this->key_validation_service = $key_validation_service;
+        add_action( 'wp_ajax_nopriv_wl_config_plugin', array( $this, 'config' ) );
+
+    }
+
+    /**
+     * Check if the key is valid and also not bound to any domain.
+     *
+     * @param $key string
+     *
+     * @return bool
+     */
+    private function is_key_valid_and_not_bound_to_any_domain( $key ) {
+        $account_info = $this->key_validation_service->get_account_info( $key );
+
+        /**
+         * we need to check if the key is not associated with any account
+         * before setting it, we should check if the url is null.
+         */
+        if ( is_wp_error( $account_info )
+             || wp_remote_retrieve_response_code( $account_info ) !== 200 ) {
+            return false;
+        }
+
+        $account_info_json = $account_info['body'];
+
+        $account_info_data = json_decode( $account_info_json, true );
+
+        if ( ! $account_info_data ) {
+            // Invalid json returned by api.
+            return false;
+        }
+
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( get_option( 'home' ) ) );
+
+        if ( null === $account_info_data['url'] ) {
+            return true;
+        }
+
+        // Check if the key belongs to same site.
+        if ( untrailingslashit( $account_info_data['url'] ) !== $site_url ) {
+            // key already associated with another account.
+            return false;
+        }
+
+        // Return true if the key domain and site domain are the same.
+        return true;
+    }
+
+    public function config() {
+
+        // Perform validation check for all the parameters.
+        $required_fields = array(
+            'diagnostic',
+            'vocabulary',
+            // Don't ask for language from webapp.
+            // 'language',
+                'country',
+            'publisherName',
+            'publisher',
+            'license',
+        );
+
+        header( 'Access-Control-Allow-Origin: *' );
+
+        // validate all the fields before processing
+        foreach ( $required_fields as $field ) {
+            if ( ! array_key_exists( $field, $_POST ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+                /* translators: %s: field name */
+                wp_send_json_error( sprintf( __( 'Field %s is required', 'wordlift' ), $field ), 422 );
+
+                return;
+            }
+        }
+
+        $key = isset( $_POST['license'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['license'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+        if ( ! $this->is_key_valid_and_not_bound_to_any_domain( $key ) ) {
+            wp_send_json_error( __( 'Key is not valid or associated with other domain', 'wordlift' ), 403 );
+
+            // exit if not valid.
+            return;
+        }
+
+        // check if key is already configured, if yes then dont save settings.
+        if ( \Wordlift_Configuration_Service::get_instance()->get_key() ) {
+            wp_send_json_error( __( 'Key already configured.', 'wordlift' ), 403 );
+
+            // key already configured
+            return;
+        }
+
+        $this->admin_setup->save_configuration( $this->get_params() );
+
+        // This prevents invalid key issue with automatic installation in sites which have redis cache enabled.
+        wp_cache_flush();
+
+        wp_send_json_success( __( 'Configuration Saved', 'wordlift' ) );
+    }
+
+    /**
+     *
+     * @return array
+     */
+    private function get_params() {
+
+        $attachment_id = $this->may_be_get_attachment_id();
+
+        $params = array(
+            'key'             => isset( $_POST['license'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['license'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+            'vocabulary'      => isset( $_POST['vocabulary'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['vocabulary'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+            'wl-country-code' => isset( $_POST['country'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['country'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+            'name'            => isset( $_POST['publisherName'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['publisherName'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+            'user_type'       => isset( $_POST['publisher'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['publisher'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+            'logo'            => $attachment_id,
+        );
+
+        $diagnostic = isset( $_POST['diagnostic'] ) ? (bool) $_POST['diagnostic'] : false; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+        if ( $diagnostic ) {
+            $params['share-diagnostic'] = 'on';
+        }
 
-		return $params;
-	}
-
-	/**
-	 * @return int | bool
-	 */
-	private function may_be_get_attachment_id() {
-
-		// if image or image extension not posted then return false.
-		if ( ! isset( $_POST['image'] ) || ! isset( $_POST['imageExtension'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			return false;
-		}
-
-		$allowed_extensions = array( 'png', 'jpeg', 'jpg' );
-		$image_string       = sanitize_text_field( wp_unslash( (string) $_POST['image'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
-		$image_ext          = sanitize_text_field( wp_unslash( (string) $_POST['imageExtension'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
-
-		if ( ! in_array( $image_ext, $allowed_extensions, true ) ) {
-			return false;
-		}
-
-		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
-		$image_decoded_string = base64_decode( $image_string );
-
-		$upload_dir = wp_upload_dir();
-
-		$file_path = $upload_dir['path'] . DIRECTORY_SEPARATOR . md5( $image_string ) . '.' . $image_ext;
-
-		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		file_put_contents( $file_path, $image_decoded_string );
-
-		$attachment_id = wp_insert_attachment(
-			array(
-				'post_status'    => 'inherit',
-				'post_mime_type' => "image/$image_ext",
-			),
-			$file_path
-		);
+        return $params;
+    }
+
+    /**
+     * @return int | bool
+     */
+    private function may_be_get_attachment_id() {
+
+        // if image or image extension not posted then return false.
+        if ( ! isset( $_POST['image'] ) || ! isset( $_POST['imageExtension'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+            return false;
+        }
+
+        $allowed_extensions = array( 'png', 'jpeg', 'jpg' );
+        $image_string       = sanitize_text_field( wp_unslash( (string) $_POST['image'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
+        $image_ext          = sanitize_text_field( wp_unslash( (string) $_POST['imageExtension'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+        if ( ! in_array( $image_ext, $allowed_extensions, true ) ) {
+            return false;
+        }
+
+        // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
+        $image_decoded_string = base64_decode( $image_string );
+
+        $upload_dir = wp_upload_dir();
+
+        $file_path = $upload_dir['path'] . DIRECTORY_SEPARATOR . md5( $image_string ) . '.' . $image_ext;
+
+        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
+        file_put_contents( $file_path, $image_decoded_string );
+
+        $attachment_id = wp_insert_attachment(
+            array(
+                'post_status'    => 'inherit',
+                'post_mime_type' => "image/$image_ext",
+            ),
+            $file_path
+        );
 
-		// Generate the metadata for the attachment, and update the database record.
-		$attachment_data = wp_generate_attachment_metadata( $attachment_id, $file_path );
-		// Update the attachment metadata.
-		wp_update_attachment_metadata( $attachment_id, $attachment_data );
+        // Generate the metadata for the attachment, and update the database record.
+        $attachment_data = wp_generate_attachment_metadata( $attachment_id, $file_path );
+        // Update the attachment metadata.
+        wp_update_attachment_metadata( $attachment_id, $attachment_data );
 
-		return $attachment_id;
-	}
+        return $attachment_id;
+    }
 
 }

Spacing +39 added lines, -39 removed lines

@@ -18,11 +18,11 @@ 
 	 * @param $admin_setup \Wordlift_Admin_Setup
 	 * @param $key_validation_service \Wordlift_Key_Validation_Service
 	 */
-	public function __construct( $admin_setup, $key_validation_service ) {
+	public function __construct($admin_setup, $key_validation_service) {
 
 		$this->admin_setup            = $admin_setup;
 		$this->key_validation_service = $key_validation_service;
-		add_action( 'wp_ajax_nopriv_wl_config_plugin', array( $this, 'config' ) );
+		add_action('wp_ajax_nopriv_wl_config_plugin', array($this, 'config'));
 
 	}
 
@@ -33,35 +33,35 @@ 
 	 *
 	 * @return bool
 	 */
-	private function is_key_valid_and_not_bound_to_any_domain( $key ) {
-		$account_info = $this->key_validation_service->get_account_info( $key );
+	private function is_key_valid_and_not_bound_to_any_domain($key) {
+		$account_info = $this->key_validation_service->get_account_info($key);
 
 		/**
 		 * we need to check if the key is not associated with any account
 		 * before setting it, we should check if the url is null.
 		 */
-		if ( is_wp_error( $account_info )
-			 || wp_remote_retrieve_response_code( $account_info ) !== 200 ) {
+		if (is_wp_error($account_info)
+			 || wp_remote_retrieve_response_code($account_info) !== 200) {
 			return false;
 		}
 
 		$account_info_json = $account_info['body'];
 
-		$account_info_data = json_decode( $account_info_json, true );
+		$account_info_data = json_decode($account_info_json, true);
 
-		if ( ! $account_info_data ) {
+		if ( ! $account_info_data) {
 			// Invalid json returned by api.
 			return false;
 		}
 
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( get_option( 'home' ) ) );
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit(get_option('home')));
 
-		if ( null === $account_info_data['url'] ) {
+		if (null === $account_info_data['url']) {
 			return true;
 		}
 
 		// Check if the key belongs to same site.
-		if ( untrailingslashit( $account_info_data['url'] ) !== $site_url ) {
+		if (untrailingslashit($account_info_data['url']) !== $site_url) {
 			// key already associated with another account.
 			return false;
 		}
@@ -84,41 +84,41 @@ 
 			'license',
 		);
 
-		header( 'Access-Control-Allow-Origin: *' );
+		header('Access-Control-Allow-Origin: *');
 
 		// validate all the fields before processing
-		foreach ( $required_fields as $field ) {
-			if ( ! array_key_exists( $field, $_POST ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+		foreach ($required_fields as $field) {
+			if ( ! array_key_exists($field, $_POST)) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
 				/* translators: %s: field name */
-				wp_send_json_error( sprintf( __( 'Field %s is required', 'wordlift' ), $field ), 422 );
+				wp_send_json_error(sprintf(__('Field %s is required', 'wordlift'), $field), 422);
 
 				return;
 			}
 		}
 
-		$key = isset( $_POST['license'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['license'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+		$key = isset($_POST['license']) ? sanitize_text_field(wp_unslash((string) $_POST['license'])) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
 
-		if ( ! $this->is_key_valid_and_not_bound_to_any_domain( $key ) ) {
-			wp_send_json_error( __( 'Key is not valid or associated with other domain', 'wordlift' ), 403 );
+		if ( ! $this->is_key_valid_and_not_bound_to_any_domain($key)) {
+			wp_send_json_error(__('Key is not valid or associated with other domain', 'wordlift'), 403);
 
 			// exit if not valid.
 			return;
 		}
 
 		// check if key is already configured, if yes then dont save settings.
-		if ( \Wordlift_Configuration_Service::get_instance()->get_key() ) {
-			wp_send_json_error( __( 'Key already configured.', 'wordlift' ), 403 );
+		if (\Wordlift_Configuration_Service::get_instance()->get_key()) {
+			wp_send_json_error(__('Key already configured.', 'wordlift'), 403);
 
 			// key already configured
 			return;
 		}
 
-		$this->admin_setup->save_configuration( $this->get_params() );
+		$this->admin_setup->save_configuration($this->get_params());
 
 		// This prevents invalid key issue with automatic installation in sites which have redis cache enabled.
 		wp_cache_flush();
 
-		wp_send_json_success( __( 'Configuration Saved', 'wordlift' ) );
+		wp_send_json_success(__('Configuration Saved', 'wordlift'));
 	}
 
 	/**
@@ -130,16 +130,16 @@ 
 		$attachment_id = $this->may_be_get_attachment_id();
 
 		$params = array(
-			'key'             => isset( $_POST['license'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['license'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'vocabulary'      => isset( $_POST['vocabulary'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['vocabulary'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'wl-country-code' => isset( $_POST['country'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['country'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'name'            => isset( $_POST['publisherName'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['publisherName'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			'user_type'       => isset( $_POST['publisher'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['publisher'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+			'key'             => isset($_POST['license']) ? sanitize_text_field(wp_unslash((string) $_POST['license'])) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+			'vocabulary'      => isset($_POST['vocabulary']) ? sanitize_text_field(wp_unslash((string) $_POST['vocabulary'])) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+			'wl-country-code' => isset($_POST['country']) ? sanitize_text_field(wp_unslash((string) $_POST['country'])) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+			'name'            => isset($_POST['publisherName']) ? sanitize_text_field(wp_unslash((string) $_POST['publisherName'])) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+			'user_type'       => isset($_POST['publisher']) ? sanitize_text_field(wp_unslash((string) $_POST['publisher'])) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
 			'logo'            => $attachment_id,
 		);
 
-		$diagnostic = isset( $_POST['diagnostic'] ) ? (bool) $_POST['diagnostic'] : false; // phpcs:ignore WordPress.Security.NonceVerification.Missing
-		if ( $diagnostic ) {
+		$diagnostic = isset($_POST['diagnostic']) ? (bool) $_POST['diagnostic'] : false; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+		if ($diagnostic) {
 			$params['share-diagnostic'] = 'on';
 		}
 
@@ -152,27 +152,27 @@ 
 	private function may_be_get_attachment_id() {
 
 		// if image or image extension not posted then return false.
-		if ( ! isset( $_POST['image'] ) || ! isset( $_POST['imageExtension'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+		if ( ! isset($_POST['image']) || ! isset($_POST['imageExtension'])) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
 			return false;
 		}
 
-		$allowed_extensions = array( 'png', 'jpeg', 'jpg' );
-		$image_string       = sanitize_text_field( wp_unslash( (string) $_POST['image'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
-		$image_ext          = sanitize_text_field( wp_unslash( (string) $_POST['imageExtension'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
+		$allowed_extensions = array('png', 'jpeg', 'jpg');
+		$image_string       = sanitize_text_field(wp_unslash((string) $_POST['image'])); // phpcs:ignore WordPress.Security.NonceVerification.Missing
+		$image_ext          = sanitize_text_field(wp_unslash((string) $_POST['imageExtension'])); // phpcs:ignore WordPress.Security.NonceVerification.Missing
 
-		if ( ! in_array( $image_ext, $allowed_extensions, true ) ) {
+		if ( ! in_array($image_ext, $allowed_extensions, true)) {
 			return false;
 		}
 
 		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
-		$image_decoded_string = base64_decode( $image_string );
+		$image_decoded_string = base64_decode($image_string);
 
 		$upload_dir = wp_upload_dir();
 
-		$file_path = $upload_dir['path'] . DIRECTORY_SEPARATOR . md5( $image_string ) . '.' . $image_ext;
+		$file_path = $upload_dir['path'].DIRECTORY_SEPARATOR.md5($image_string).'.'.$image_ext;
 
 		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		file_put_contents( $file_path, $image_decoded_string );
+		file_put_contents($file_path, $image_decoded_string);
 
 		$attachment_id = wp_insert_attachment(
 			array(
@@ -183,9 +183,9 @@ 
 		);
 
 		// Generate the metadata for the attachment, and update the database record.
-		$attachment_data = wp_generate_attachment_metadata( $attachment_id, $file_path );
+		$attachment_data = wp_generate_attachment_metadata($attachment_id, $file_path);
 		// Update the attachment metadata.
-		wp_update_attachment_metadata( $attachment_id, $attachment_data );
+		wp_update_attachment_metadata($attachment_id, $attachment_data);
 
 		return $attachment_id;
 	}

src/modules/food-kg/includes/Preconditions.php

Indentation +34 added lines, -34 removed lines

@@ -4,39 +4,39 @@
 
 class Preconditions {
 
-	/**
-	 * @var Notices
-	 */
-	private $notices;
-
-	public function __construct( Notices $notices ) {
-		$this->notices = $notices;
-	}
-
-	public function pass() {
-		return $this->has_prerequisites() && $this->check_version();
-	}
-
-	private function has_prerequisites() {
-		return defined( 'WPRM_VERSION' )
-			   && class_exists( 'WP_Recipe_Maker' )
-		       // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			   && apply_filters( 'wl_feature__enable__food-kg', false );
-	}
-
-	private function check_version() {
-		$check = version_compare( WPRM_VERSION, '8.1.0', '>=' )
-				&& version_compare( WPRM_VERSION, '8.7.0', '<' );
-
-		if ( ! $check ) {
-			$this->notices->queue(
-				'warning',
-				/* translators: 1: minimum supported WPRM version, 2: maximum supported WPRM version, 3: Detected WP Recipe Maker version. */
-				sprintf( __( 'WordLift Food KG support requires WP Recipe Maker %1$s-%2$s, %3$s found.', 'wordlift' ), '8.1.0', '8.5.0', WPRM_VERSION )
-			);
-		}
-
-		return $check;
-	}
+    /**
+     * @var Notices
+     */
+    private $notices;
+
+    public function __construct( Notices $notices ) {
+        $this->notices = $notices;
+    }
+
+    public function pass() {
+        return $this->has_prerequisites() && $this->check_version();
+    }
+
+    private function has_prerequisites() {
+        return defined( 'WPRM_VERSION' )
+               && class_exists( 'WP_Recipe_Maker' )
+                // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+               && apply_filters( 'wl_feature__enable__food-kg', false );
+    }
+
+    private function check_version() {
+        $check = version_compare( WPRM_VERSION, '8.1.0', '>=' )
+                && version_compare( WPRM_VERSION, '8.7.0', '<' );
+
+        if ( ! $check ) {
+            $this->notices->queue(
+                'warning',
+                /* translators: 1: minimum supported WPRM version, 2: maximum supported WPRM version, 3: Detected WP Recipe Maker version. */
+                sprintf( __( 'WordLift Food KG support requires WP Recipe Maker %1$s-%2$s, %3$s found.', 'wordlift' ), '8.1.0', '8.5.0', WPRM_VERSION )
+            );
+        }
+
+        return $check;
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -9,7 +9,7 @@ 
 	 */
 	private $notices;
 
-	public function __construct( Notices $notices ) {
+	public function __construct(Notices $notices) {
 		$this->notices = $notices;
 	}
 
@@ -18,21 +18,21 @@ 
 	}
 
 	private function has_prerequisites() {
-		return defined( 'WPRM_VERSION' )
-			   && class_exists( 'WP_Recipe_Maker' )
+		return defined('WPRM_VERSION')
+			   && class_exists('WP_Recipe_Maker')
 		       // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			   && apply_filters( 'wl_feature__enable__food-kg', false );
+			   && apply_filters('wl_feature__enable__food-kg', false);
 	}
 
 	private function check_version() {
-		$check = version_compare( WPRM_VERSION, '8.1.0', '>=' )
-				&& version_compare( WPRM_VERSION, '8.7.0', '<' );
+		$check = version_compare(WPRM_VERSION, '8.1.0', '>=')
+				&& version_compare(WPRM_VERSION, '8.7.0', '<');
 
-		if ( ! $check ) {
+		if ( ! $check) {
 			$this->notices->queue(
 				'warning',
 				/* translators: 1: minimum supported WPRM version, 2: maximum supported WPRM version, 3: Detected WP Recipe Maker version. */
-				sprintf( __( 'WordLift Food KG support requires WP Recipe Maker %1$s-%2$s, %3$s found.', 'wordlift' ), '8.1.0', '8.5.0', WPRM_VERSION )
+				sprintf(__('WordLift Food KG support requires WP Recipe Maker %1$s-%2$s, %3$s found.', 'wordlift'), '8.1.0', '8.5.0', WPRM_VERSION)
 			);
 		}
 

src/wordlift.php

Indentation +142 added lines, -142 removed lines

@@ -33,7 +33,7 @@ 
 
 // If this file is called directly, abort.
 if ( ! defined( 'WPINC' ) ) {
-	die;
+    die;
 }
 
 define( 'WORDLIFT_VERSION', '3.40.0' );
@@ -47,7 +47,7 @@ 
  * @since 3.33.6
  */
 if ( ! apply_filters( 'wl_is_enabled', true ) ) {
-	return;
+    return;
 }
 
 require_once plugin_dir_path( __FILE__ ) . 'vendor/autoload.php';
@@ -76,29 +76,29 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
-
-	$log->info( 'Activating WordLift...' );
-
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
-	Wordlift_Activator::activate();
-
-	/**
-	 * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
-	 * @since 3.19.2
-	 */
-	Wordlift_Http_Api::activate();
-
-	// Ensure the post type is registered before flushing the rewrite rules.
-	Wordlift_Entity_Post_Type_Service::get_instance()->register();
-	flush_rewrite_rules();
-	/**
-	 * @since 3.27.7
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1214
-	 */
-	Top_Entities::activate();
+    $log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+
+    $log->info( 'Activating WordLift...' );
+
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+    Wordlift_Activator::activate();
+
+    /**
+     * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
+     * @since 3.19.2
+     */
+    Wordlift_Http_Api::activate();
+
+    // Ensure the post type is registered before flushing the rewrite rules.
+    Wordlift_Entity_Post_Type_Service::get_instance()->register();
+    flush_rewrite_rules();
+    /**
+     * @since 3.27.7
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1214
+     */
+    Top_Entities::activate();
 }
 
 /**
@@ -107,21 +107,21 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
-	Wordlift_Deactivator::deactivate();
-	Wordlift_Http_Api::deactivate();
-	Ttl_Cache_Cleaner::deactivate();
-	/**
-	 * @since 3.27.7
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1214
-	 */
-	Top_Entities::deactivate();
-	/**
-	 * @since 3.27.8
-	 * Remove notification flag on deactivation.
-	 */
-	Key_Validation_Notice::remove_notification_flag();
-	flush_rewrite_rules();
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+    Wordlift_Deactivator::deactivate();
+    Wordlift_Http_Api::deactivate();
+    Ttl_Cache_Cleaner::deactivate();
+    /**
+     * @since 3.27.7
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1214
+     */
+    Top_Entities::deactivate();
+    /**
+     * @since 3.27.8
+     * Remove notification flag on deactivation.
+     */
+    Key_Validation_Notice::remove_notification_flag();
+    flush_rewrite_rules();
 
 }
 
@@ -144,84 +144,84 @@ 
  * @since    1.0.0
  */
 function run_wordlift() {
-	/**
-	 * Filter: wl_feature__enable__widgets.
-	 *
-	 * @param bool whether the widgets needed to be registered, defaults to true.
-	 *
-	 * @return bool
-	 * @since 3.27.6
-	 */
-	if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
-		add_action( 'widgets_init', 'wl_register_chord_widget' );
-		add_action( 'widgets_init', 'wl_register_geo_widget' );
-		add_action( 'widgets_init', 'wl_register_timeline_widget' );
-	}
-	add_filter( 'widget_text', 'do_shortcode' );
-
-	/**
-	 * Filter: wl_feature__enable__analysis
-	 *
-	 * @param bool Whether to send api request to analysis or not
-	 *
-	 * @return bool
-	 * @since 3.27.6
-	 */
-	if ( apply_filters( 'wl_feature__enable__analysis', true ) ) {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_action' );
-	} else {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action' );
-	}
-
-	$plugin = new Wordlift();
-	$plugin->run();
-
-	// Initialize the TTL Cache Cleaner.
-	new Ttl_Cache_Cleaner();
-
-	// Load the new Post Adapter.
-	new Post_Adapter();
-
-	// Load the API Data Hooks.
-	new Api_Data_Hooks();
-
-	add_action(
-		'plugins_loaded',
-		function () {
-			// All features from registry should be initialized here.
-			$features_registry = Features_Registry::get_instance();
-			$features_registry->initialize_all_features();
-		},
-		5
-	);
-
-	add_action(
-		'plugins_loaded',
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		function () use ( $plugin ) {
-
-			new Wordlift_Products_Navigator_Shortcode_REST();
-
-			// Register the Dataset module, requires `$api_service`.
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/dataset/index.php';
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/shipping-data/index.php';
-
-			/*
+    /**
+     * Filter: wl_feature__enable__widgets.
+     *
+     * @param bool whether the widgets needed to be registered, defaults to true.
+     *
+     * @return bool
+     * @since 3.27.6
+     */
+    if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
+        add_action( 'widgets_init', 'wl_register_chord_widget' );
+        add_action( 'widgets_init', 'wl_register_geo_widget' );
+        add_action( 'widgets_init', 'wl_register_timeline_widget' );
+    }
+    add_filter( 'widget_text', 'do_shortcode' );
+
+    /**
+     * Filter: wl_feature__enable__analysis
+     *
+     * @param bool Whether to send api request to analysis or not
+     *
+     * @return bool
+     * @since 3.27.6
+     */
+    if ( apply_filters( 'wl_feature__enable__analysis', true ) ) {
+        add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_action' );
+    } else {
+        add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action' );
+    }
+
+    $plugin = new Wordlift();
+    $plugin->run();
+
+    // Initialize the TTL Cache Cleaner.
+    new Ttl_Cache_Cleaner();
+
+    // Load the new Post Adapter.
+    new Post_Adapter();
+
+    // Load the API Data Hooks.
+    new Api_Data_Hooks();
+
+    add_action(
+        'plugins_loaded',
+        function () {
+            // All features from registry should be initialized here.
+            $features_registry = Features_Registry::get_instance();
+            $features_registry->initialize_all_features();
+        },
+        5
+    );
+
+    add_action(
+        'plugins_loaded',
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        function () use ( $plugin ) {
+
+            new Wordlift_Products_Navigator_Shortcode_REST();
+
+            // Register the Dataset module, requires `$api_service`.
+            require_once plugin_dir_path( __FILE__ ) . 'wordlift/dataset/index.php';
+            require_once plugin_dir_path( __FILE__ ) . 'wordlift/shipping-data/index.php';
+
+            /*
 			* Require the Entity annotation cleanup module.
 			*
 			* @since 3.34.6
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/cleanup/index.php';
+            require_once plugin_dir_path( __FILE__ ) . 'wordlift/cleanup/index.php';
 
-			/*
+            /*
 			* Import LOD entities.
 			*
 			* @since 3.35.0
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/lod-import/index.php';
+            require_once plugin_dir_path( __FILE__ ) . 'wordlift/lod-import/index.php';
 
-		}
-	);
+        }
+    );
 
 }
 
@@ -235,45 +235,45 @@ 
  */
 function wordlift_plugin_autoload_register() {
 
-	spl_autoload_register(
-		function ( $class_name ) {
+    spl_autoload_register(
+        function ( $class_name ) {
 
-			// Bail out if these are not our classes.
-			if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
-				return false;
-			}
+            // Bail out if these are not our classes.
+            if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
+                return false;
+            }
 
-			$class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
+            $class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
 
-			preg_match( '|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
+            preg_match( '|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
 
-			$path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
-			$file = 'class-' . $matches[2] . '.php';
+            $path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
+            $file = 'class-' . $matches[2] . '.php';
 
-			$full_path = plugin_dir_path( __FILE__ ) . $path . DIRECTORY_SEPARATOR . $file;
+            $full_path = plugin_dir_path( __FILE__ ) . $path . DIRECTORY_SEPARATOR . $file;
 
-			if ( ! file_exists( $full_path ) ) {
-				return false;
-			}
+            if ( ! file_exists( $full_path ) ) {
+                return false;
+            }
 
-			require_once $full_path;
+            require_once $full_path;
 
-			return true;
-		}
-	);
+            return true;
+        }
+    );
 
 }
 
 function wl_block_categories( $categories ) {
-	return array_merge(
-		$categories,
-		array(
-			array(
-				'slug'  => 'wordlift',
-				'title' => __( 'WordLift', 'wordlift' ),
-			),
-		)
-	);
+    return array_merge(
+        $categories,
+        array(
+            array(
+                'slug'  => 'wordlift',
+                'title' => __( 'WordLift', 'wordlift' ),
+            ),
+        )
+    );
 }
 
 /**
@@ -281,19 +281,19 @@ 
  * this has to be removed when removing the legacy fields from the ui.
  */
 function wl_enqueue_leaflet( $in_footer = false ) {
-	// Leaflet.
-	wp_enqueue_style( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.css', array(), '1.6.0' );
-	wp_enqueue_script( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer );
+    // Leaflet.
+    wp_enqueue_style( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.css', array(), '1.6.0' );
+    wp_enqueue_script( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer );
 }
 
 add_filter( 'block_categories', 'wl_block_categories', 10 );
 
 // Temporary fix for a typo in WooCommerce Extension.
 add_filter(
-	'wl_feature__enable__dataset',
-	function ( $value ) {
-		return apply_filters( 'wl_features__enable__dataset', $value );
-	}
+    'wl_feature__enable__dataset',
+    function ( $value ) {
+        return apply_filters( 'wl_features__enable__dataset', $value );
+    }
 );
 
 require_once __DIR__ . '/modules/food-kg/load.php';

Spacing +50 added lines, -50 removed lines

@@ -32,25 +32,25 @@ 
 use Wordlift\Post\Post_Adapter;
 
 // If this file is called directly, abort.
-if ( ! defined( 'WPINC' ) ) {
+if ( ! defined('WPINC')) {
 	die;
 }
 
-define( 'WORDLIFT_VERSION', '3.40.0' );
+define('WORDLIFT_VERSION', '3.40.0');
 
-require_once __DIR__ . '/modules/common/load.php';
-require_once __DIR__ . '/modules/include-exclude/load.php';
+require_once __DIR__.'/modules/common/load.php';
+require_once __DIR__.'/modules/include-exclude/load.php';
 
 /**
  * Filter to disable WLP on any request, defaults to true.
  *
  * @since 3.33.6
  */
-if ( ! apply_filters( 'wl_is_enabled', true ) ) {
+if ( ! apply_filters('wl_is_enabled', true)) {
 	return;
 }
 
-require_once plugin_dir_path( __FILE__ ) . 'vendor/autoload.php';
+require_once plugin_dir_path(__FILE__).'vendor/autoload.php';
 
 /*
 	 * We introduce the WordLift autoloader, since we start using classes in namespaces, i.e. Wordlift\Http.
@@ -60,15 +60,15 @@ 
 wordlift_plugin_autoload_register();
 
 // Include WordLift constants.
-require_once plugin_dir_path( __FILE__ ) . 'wordlift-constants.php';
+require_once plugin_dir_path(__FILE__).'wordlift-constants.php';
 
 // Load modules.
-require_once plugin_dir_path( __FILE__ ) . 'modules/core/wordlift-core.php';
+require_once plugin_dir_path(__FILE__).'modules/core/wordlift-core.php';
 
-require_once plugin_dir_path( __FILE__ ) . 'deprecations.php';
+require_once plugin_dir_path(__FILE__).'deprecations.php';
 
 // Load early to enable/disable features.
-require_once plugin_dir_path( __FILE__ ) . 'wordlift/features/index.php';
+require_once plugin_dir_path(__FILE__).'wordlift/features/index.php';
 
 /**
  * The code that runs during plugin activation.
@@ -76,11 +76,11 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+	$log = Wordlift_Log_Service::get_logger('activate_wordlift');
 
-	$log->info( 'Activating WordLift...' );
+	$log->info('Activating WordLift...');
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-activator.php';
 	Wordlift_Activator::activate();
 
 	/**
@@ -107,7 +107,7 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-deactivator.php';
 	Wordlift_Deactivator::deactivate();
 	Wordlift_Http_Api::deactivate();
 	Ttl_Cache_Cleaner::deactivate();
@@ -125,14 +125,14 @@ 
 
 }
 
-register_activation_hook( __FILE__, 'activate_wordlift' );
-register_deactivation_hook( __FILE__, 'deactivate_wordlift' );
+register_activation_hook(__FILE__, 'activate_wordlift');
+register_deactivation_hook(__FILE__, 'deactivate_wordlift');
 
 /**
  * The core plugin class that is used to define internationalization,
  * admin-specific hooks, and public-facing site hooks.
  */
-require plugin_dir_path( __FILE__ ) . 'includes/class-wordlift.php';
+require plugin_dir_path(__FILE__).'includes/class-wordlift.php';
 
 /**
  * Begins execution of the plugin.
@@ -152,12 +152,12 @@ 
 	 * @return bool
 	 * @since 3.27.6
 	 */
-	if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
-		add_action( 'widgets_init', 'wl_register_chord_widget' );
-		add_action( 'widgets_init', 'wl_register_geo_widget' );
-		add_action( 'widgets_init', 'wl_register_timeline_widget' );
+	if (apply_filters('wl_feature__enable__widgets', true)) {
+		add_action('widgets_init', 'wl_register_chord_widget');
+		add_action('widgets_init', 'wl_register_geo_widget');
+		add_action('widgets_init', 'wl_register_timeline_widget');
 	}
-	add_filter( 'widget_text', 'do_shortcode' );
+	add_filter('widget_text', 'do_shortcode');
 
 	/**
 	 * Filter: wl_feature__enable__analysis
@@ -167,10 +167,10 @@ 
 	 * @return bool
 	 * @since 3.27.6
 	 */
-	if ( apply_filters( 'wl_feature__enable__analysis', true ) ) {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_action' );
+	if (apply_filters('wl_feature__enable__analysis', true)) {
+		add_action('wp_ajax_wl_analyze', 'wl_ajax_analyze_action');
 	} else {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action' );
+		add_action('wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action');
 	}
 
 	$plugin = new Wordlift();
@@ -187,7 +187,7 @@ 
 
 	add_action(
 		'plugins_loaded',
-		function () {
+		function() {
 			// All features from registry should be initialized here.
 			$features_registry = Features_Registry::get_instance();
 			$features_registry->initialize_all_features();
@@ -198,27 +198,27 @@ 
 	add_action(
 		'plugins_loaded',
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		function () use ( $plugin ) {
+		function() use ($plugin) {
 
 			new Wordlift_Products_Navigator_Shortcode_REST();
 
 			// Register the Dataset module, requires `$api_service`.
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/dataset/index.php';
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/shipping-data/index.php';
+			require_once plugin_dir_path(__FILE__).'wordlift/dataset/index.php';
+			require_once plugin_dir_path(__FILE__).'wordlift/shipping-data/index.php';
 
 			/*
 			* Require the Entity annotation cleanup module.
 			*
 			* @since 3.34.6
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/cleanup/index.php';
+			require_once plugin_dir_path(__FILE__).'wordlift/cleanup/index.php';
 
 			/*
 			* Import LOD entities.
 			*
 			* @since 3.35.0
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'wordlift/lod-import/index.php';
+			require_once plugin_dir_path(__FILE__).'wordlift/lod-import/index.php';
 
 		}
 	);
@@ -236,23 +236,23 @@ 
 function wordlift_plugin_autoload_register() {
 
 	spl_autoload_register(
-		function ( $class_name ) {
+		function($class_name) {
 
 			// Bail out if these are not our classes.
-			if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
+			if (0 !== strpos($class_name, 'Wordlift\\')) {
 				return false;
 			}
 
-			$class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
+			$class_name_lc = strtolower(str_replace('_', '-', $class_name));
 
-			preg_match( '|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
+			preg_match('|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches);
 
-			$path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
-			$file = 'class-' . $matches[2] . '.php';
+			$path = str_replace('\\', DIRECTORY_SEPARATOR, $matches[1]);
+			$file = 'class-'.$matches[2].'.php';
 
-			$full_path = plugin_dir_path( __FILE__ ) . $path . DIRECTORY_SEPARATOR . $file;
+			$full_path = plugin_dir_path(__FILE__).$path.DIRECTORY_SEPARATOR.$file;
 
-			if ( ! file_exists( $full_path ) ) {
+			if ( ! file_exists($full_path)) {
 				return false;
 			}
 
@@ -264,13 +264,13 @@ 
 
 }
 
-function wl_block_categories( $categories ) {
+function wl_block_categories($categories) {
 	return array_merge(
 		$categories,
 		array(
 			array(
 				'slug'  => 'wordlift',
-				'title' => __( 'WordLift', 'wordlift' ),
+				'title' => __('WordLift', 'wordlift'),
 			),
 		)
 	);
@@ -280,22 +280,22 @@ 
  * This function is created temporarily to handle the legacy library,
  * this has to be removed when removing the legacy fields from the ui.
  */
-function wl_enqueue_leaflet( $in_footer = false ) {
+function wl_enqueue_leaflet($in_footer = false) {
 	// Leaflet.
-	wp_enqueue_style( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.css', array(), '1.6.0' );
-	wp_enqueue_script( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer );
+	wp_enqueue_style('wl-leaflet', plugin_dir_url(__FILE__).'js/leaflet/leaflet.css', array(), '1.6.0');
+	wp_enqueue_script('wl-leaflet', plugin_dir_url(__FILE__).'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer);
 }
 
-add_filter( 'block_categories', 'wl_block_categories', 10 );
+add_filter('block_categories', 'wl_block_categories', 10);
 
 // Temporary fix for a typo in WooCommerce Extension.
 add_filter(
 	'wl_feature__enable__dataset',
-	function ( $value ) {
-		return apply_filters( 'wl_features__enable__dataset', $value );
+	function($value) {
+		return apply_filters('wl_features__enable__dataset', $value);
 	}
 );
 
-require_once __DIR__ . '/modules/food-kg/load.php';
-require_once __DIR__ . '/modules/acf4so/load.php';
-require_once __DIR__ . '/modules/pods/load.php';
+require_once __DIR__.'/modules/food-kg/load.php';
+require_once __DIR__.'/modules/acf4so/load.php';
+require_once __DIR__.'/modules/pods/load.php';