insideout10 / wordlift-plugin

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

Spacing +61 added lines, -61 removed lines

@@ -72,7 +72,7 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $property_getter ) {
+	public function __construct($entity_type_service, $user_service, $attachment_service, $property_getter) {
 		$this->entity_type_service = $entity_type_service;
 		$this->user_service        = $user_service;
 		$this->attachment_service  = $attachment_service;
@@ -91,19 +91,19 @@ 
 	 * @since 3.10.0
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	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 post URI @id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-		if ( $id === null ) {
-			$id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
+		$id = Wordlift_Entity_Service::get_instance()->get_uri($post->ID);
+		if ($id === null) {
+			$id = 'get_uri returned null, dataset is '.wl_configuration_get_redlink_dataset_uri();
 		}
 
 		/*
@@ -115,8 +115,8 @@ 
 		 */
 		// Get the entity @type. We consider `post` BlogPostings.
 		// $type = $this->entity_type_service->get( $post_id );
-		$types = $this->entity_type_service->get_names( $post_id );
-		$type  = self::make_one( $types );
+		$types = $this->entity_type_service->get_names($post_id);
+		$type  = self::make_one($types);
 
 		// Prepare the response.
 		$jsonld = array(
@@ -125,8 +125,8 @@ 
 			'@type'    => $type,
 		);
 
-		if ( post_type_supports( $post->post_type, 'excerpt' ) ) {
-			$jsonld['description'] = Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post );
+		if (post_type_supports($post->post_type, 'excerpt')) {
+			$jsonld['description'] = Wordlift_Post_Excerpt_Helper::get_text_excerpt($post);
 		}
 
 		// Set the `mainEntityOfPage` property if the post has some contents.
@@ -136,8 +136,8 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) || in_array( 'Product', (array) $type, true ) ) {
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		if ( ! empty($post_content) || in_array('Product', (array) $type, true)) {
 			// We're setting the `mainEntityOfPage` to signal which one is the
 			// main entity for the specified URL. It might be however that the
 			// post/page is actually about another specific entity. How WL deals
@@ -148,35 +148,35 @@ 
 			// No need to specify `'@type' => 'WebPage'.
 			//
 			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+			$jsonld['mainEntityOfPage'] = get_the_permalink($post->ID);
 
 			/**
 			 * @see https://github.com/insideout10/wordlift-plugin/issues/1207
 			 *
 			 * @since 3.27.7
 			 */
-			if ( in_array(
+			if (in_array(
 				$type,
 				array(
 					'Occupation',
 					'OccupationAggregationByEmployer',
 				),
 				true
-			) ) {
+			)) {
 				$jsonld['mainEntityOfPage'] = array(
 					'@type'        => 'WebPage',
-					'lastReviewed' => get_post_time( 'Y-m-d\TH:i:sP', true, $post, false ),
+					'lastReviewed' => get_post_time('Y-m-d\TH:i:sP', true, $post, false),
 				);
 			}
 		};
 
-		$this->set_images( $this->attachment_service, $post, $jsonld );
+		$this->set_images($this->attachment_service, $post, $jsonld);
 
 		// Get the entities referenced by this post and set it to the `references`
 		// array so that the caller can do further processing, such as printing out
 		// more of those references.
 		$references_without_locations = Object_Relation_Service::get_instance()
-															   ->get_references( $post_id, Object_Type_Enum::POST );
+															   ->get_references($post_id, Object_Type_Enum::POST);
 
 		/*
 		 * Add the locations to the references.
@@ -189,33 +189,33 @@ 
 		$entity_type_service = $this->entity_type_service;
 		$locations           = array_reduce(
 			$references_without_locations,
-			function ( $carry, $reference ) use ( $entity_type_service ) {
+			function($carry, $reference) use ($entity_type_service) {
 				/**
 				 * @var $reference Reference
 				 */
 				// @see https://schema.org/location for the schema.org types using the `location` property.
-				if ( ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Action' )
-					 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Event' )
-					 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Organization' ) ) {
+				if ( ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Action')
+					 && ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Event')
+					 && ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Organization')) {
 
 					return $carry;
 				}
-				$post_location_ids        = get_post_meta( $reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION );
+				$post_location_ids        = get_post_meta($reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION);
 				$post_location_references = array_map(
-					function ( $post_id ) {
-						return new Post_Reference( $post_id );
+					function($post_id) {
+						return new Post_Reference($post_id);
 					},
 					$post_location_ids
 				);
 
-				return array_merge( $carry, $post_location_references );
+				return array_merge($carry, $post_location_references);
 			},
 			array()
 		);
 
 		// Merge the references with the referenced locations if any.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = array_merge( $references_without_locations, $locations );
+		$references = array_merge($references_without_locations, $locations);
 
 		return $jsonld;
 	}
@@ -229,8 +229,8 @@ 
 	 * @return string The property value without the context.
 	 * @since 3.10.0
 	 */
-	public function relative_to_context( $value ) {
-		return ! is_array( $value ) && 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+	public function relative_to_context($value) {
+		return ! is_array($value) && 0 === strpos($value, self::CONTEXT.'/') ? substr($value, strlen(self::CONTEXT) + 1) : $value;
 	}
 
 	/**
@@ -245,14 +245,14 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public static function set_images( $attachment_service, $post, &$jsonld ) {
+	public static function set_images($attachment_service, $post, &$jsonld) {
 
 		// Prepare the attachment ids array.
 		$ids = array();
 
 		// Set the thumbnail id as first attachment id, if any.
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
+		$thumbnail_id = get_post_thumbnail_id($post->ID);
+		if ('' !== $thumbnail_id && 0 !== $thumbnail_id) {
 			$ids[] = $thumbnail_id;
 		}
 
@@ -263,34 +263,34 @@ 
 		//
 		// Get the embeds, removing existing ids.
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__image-embeds', false ) ) {
-			$embeds = array_diff( $attachment_service->get_image_embeds( $post->post_content ), $ids );
+		if (apply_filters('wl_feature__enable__image-embeds', false)) {
+			$embeds = array_diff($attachment_service->get_image_embeds($post->post_content), $ids);
 		} else {
 			$embeds = array();
 		}
 
 		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $attachment_service->get_gallery( $post ), $ids, $embeds );
+		$gallery = array_diff($attachment_service->get_gallery($post), $ids, $embeds);
 
 		// Map the attachment ids to images' data structured for schema.org use.
 		$images_with_sizes = array_filter(
 			array_reduce(
-				array_merge( $ids, $embeds, $gallery ),
-				function ( $carry, $item ) {
+				array_merge($ids, $embeds, $gallery),
+				function($carry, $item) {
 					/*
 					* @todo: we're not sure that we're getting attachment data here, we
 					* should filter `false`s.
 					*/
 
 					$sources = array_merge(
-						Wordlift_Image_Service::get_sources( $item ),
-						array( wp_get_attachment_image_src( $item, 'full' ) )
+						Wordlift_Image_Service::get_sources($item),
+						array(wp_get_attachment_image_src($item, 'full'))
 					);
 
 					$sources_with_image = array_filter(
 						$sources,
-						function ( $source ) {
-							return ! empty( $source[0] );
+						function($source) {
+							return ! empty($source[0]);
 						}
 					);
 
@@ -304,7 +304,7 @@ 
 					// or from uploads dir, but the image id still exists as featured image
 					// or in [gallery] shortcode.
 					// if ( empty( $attachment[0] ) ) {
-					if ( empty( $sources_with_image ) ) {
+					if (empty($sources_with_image)) {
 						return $carry;
 					}
 
@@ -322,7 +322,7 @@ 
 
 		// Refactor data as per schema.org specifications.
 		$images = array_map(
-			function ( $attachment ) {
+			function($attachment) {
 				return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
 					array(
 						'@type' => 'ImageObject',
@@ -335,7 +335,7 @@ 
 		);
 
 		// Add images if present.
-		if ( 0 < count( $images ) ) {
+		if (0 < count($images)) {
 			$jsonld['image'] = $images;
 		}
 
@@ -353,9 +353,9 @@ 
 	 * @since  3.8.0
 	 * @access private
 	 */
-	protected static function make_one( $value ) {
+	protected static function make_one($value) {
 
-		return 1 === count( $value ) ? $value[0] : $value;
+		return 1 === count($value) ? $value[0] : $value;
 	}
 
 	/**
@@ -368,17 +368,17 @@ 
 	 * @return array The enriched `ImageObject` array.
 	 * @since 3.14.0
 	 */
-	public static function set_image_size( $image, $attachment ) {
+	public static function set_image_size($image, $attachment) {
 
 		// 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.
-		if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
+		if (isset($attachment[1]) && is_numeric($attachment[1]) && 0 < $attachment[1]) {
 			$image['width'] = $attachment[1];
 		}
 
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+		if (isset($attachment[2]) && is_numeric($attachment[2]) && 0 < $attachment[2]) {
 			$image['height'] = $attachment[2];
 		}
 
@@ -397,33 +397,33 @@ 
 	 * @since 3.20.0 This code moved from the above function `convert`, used for entity types defined in
 	 *  the {@link Wordlift_Schema_Service} class.
 	 */
-	protected function process_type_custom_fields( &$jsonld, $fields, $post, &$references, &$references_infos ) {
+	protected function process_type_custom_fields(&$jsonld, $fields, $post, &$references, &$references_infos) {
 
 		// Set a reference to use in closures.
 		$converter = $this;
 
 		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
+		foreach ($fields as $key => $value) {
 
 			// Get the predicate.
-			$name = $this->relative_to_context( $value['predicate'] );
+			$name = $this->relative_to_context($value['predicate']);
 
 			// Get the value, the property service will get the right extractor
 			// for that property.
-			$value = $this->property_getter->get( $post->ID, $key, Object_Type_Enum::POST );
+			$value = $this->property_getter->get($post->ID, $key, Object_Type_Enum::POST);
 
-			if ( empty( $value ) ) {
+			if (empty($value)) {
 				continue;
 			}
 
 			// Map the value to the property name.
 			// If we got an array with just one value, we return that one value.
 			// If we got a Wordlift_Property_Entity_Reference we get the URL.
-			$jsonld[ $name ] = self::make_one(
+			$jsonld[$name] = self::make_one(
 				array_map(
-					function ( $item ) use ( $converter, &$references, &$references_infos ) {
+					function($item) use ($converter, &$references, &$references_infos) {
 
-						if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+						if ($item instanceof Wordlift_Property_Entity_Reference) {
 
 							$url = $item->get_url();
 
@@ -432,12 +432,12 @@ 
 							$references[] = $item->to_reference();
 
 							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							$references_infos[] = array( 'reference' => $item );
+							$references_infos[] = array('reference' => $item);
 
-							return array( '@id' => $url );
+							return array('@id' => $url);
 						}
 
-						return $converter->relative_to_context( $item );
+						return $converter->relative_to_context($item);
 					},
 					$value
 				)

src/includes/cache/class-wordlift-cached-post-converter.php

Spacing +44 added lines, -44 removed lines

@@ -68,9 +68,9 @@ 
 	 * @param \Wordlift_Post_Converter $converter The {@link Wordlift_Post_Converter} implementation.
 	 * @param Ttl_Cache                $cache The {@link Ttl_Cache} cache instance.
 	 */
-	public function __construct( $converter, $cache ) {
+	public function __construct($converter, $cache) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->cache               = $cache;
 		$this->converter           = $converter;
@@ -87,7 +87,7 @@ 
 	private function init_hooks() {
 
 		// Hook on post save to flush relevant cache.
-		add_action( 'save_post', array( $this, 'save_post' ) );
+		add_action('save_post', array($this, 'save_post'));
 
 		add_action(
 			'added_post_meta',
@@ -136,8 +136,8 @@ 
 		);
 
 		// Invalid cache on relationship change.
-		add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
-		add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
+		add_action('wl_relation_added', array($this, 'relation_changed'));
+		add_action('wl_relation_deleted', array($this, 'relation_changed'));
 
 	}
 
@@ -148,25 +148,25 @@ 
 	 * @inheritdoc
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), &$cache = false ) {
+	public function convert($post_id, &$references = array(), &$references_infos = array(), &$cache = false) {
 
 		// Ensure post ID is `int`. Otherwise we may have issues with caching, since caching is strict about
 		// key var types.
 		$post_id = (int) $post_id;
 
-		$this->log->trace( "Converting post $post_id..." );
+		$this->log->trace("Converting post $post_id...");
 
 		// Try to get a cached result.
-		$contents = $this->get_cache( $post_id, $references );
+		$contents = $this->get_cache($post_id, $references);
 
 		// Return the cached contents if any.
-		if ( false !== $contents ) {
-			$this->log->debug( "Cached contents found for post $post_id." );
+		if (false !== $contents) {
+			$this->log->debug("Cached contents found for post $post_id.");
 
 			// Inform the caller that this is cached result.
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 			$cache = true;
-			$this->add_http_header( $post_id, true );
+			$this->add_http_header($post_id, true);
 
 			// Return the contents.
 			return $contents;
@@ -175,10 +175,10 @@ 
 		// Set cached to false.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		$cache = false;
-		$this->add_http_header( $post_id, false );
+		$this->add_http_header($post_id, false);
 
 		// Convert the post.
-		$jsonld = $this->converter->convert( $post_id, $references, $references_infos );
+		$jsonld = $this->converter->convert($post_id, $references, $references_infos);
 
 		/**
 		 * @since 3.32.0
@@ -186,7 +186,7 @@ 
 		 * it here before saving it on cache.
 		 */
 		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld );
+		$this->set_cache($post_id, $references, $jsonld);
 
 		// Finally return the JSON-LD.
 		return $jsonld;
@@ -202,28 +202,28 @@ 
 	 * @since 3.16.0
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	private function get_cache( $post_id, &$references = array() ) {
+	private function get_cache($post_id, &$references = array()) {
 
 		// Ensure post ID is int, because cache is strict about var types.
 		$post_id = (int) $post_id;
 
-		$this->log->trace( "Getting cached contents for post $post_id..." );
+		$this->log->trace("Getting cached contents for post $post_id...");
 
 		// Get the cache.
-		$modified_date_time = get_post_datetime( $post_id, 'modified', 'gmt' );
-		$contents           = $this->cache->get( $post_id, $modified_date_time->getTimestamp() );
+		$modified_date_time = get_post_datetime($post_id, 'modified', 'gmt');
+		$contents           = $this->cache->get($post_id, $modified_date_time->getTimestamp());
 
 		// Bail out if we don't have cached contents or the cached contents are
 		// invalid.
-		if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
+		if (null === $contents || ! isset($contents['jsonld']) || ! isset($contents['references'])) {
+			$this->log->debug("Cached contents for post $post_id not found.");
 
 			return false;
 		}
 
 		// Remap the cache.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = $this->reference_processor->deserialize_references( $contents['references'] );
+		$references = $this->reference_processor->deserialize_references($contents['references']);
 
 		return $contents['jsonld'];
 	}
@@ -239,14 +239,14 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function set_cache( $post_id, $references, $jsonld ) {
+	private function set_cache($post_id, $references, $jsonld) {
 
-		$this->log->trace( "Caching result for post $post_id..." );
+		$this->log->trace("Caching result for post $post_id...");
 
 		$this->cache->put(
 			$post_id,
 			array(
-				'references' => $this->reference_processor->serialize_references( $references ),
+				'references' => $this->reference_processor->serialize_references($references),
 				'jsonld'     => $jsonld,
 			)
 		);
@@ -260,13 +260,13 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function save_post( $post_id ) {
+	public function save_post($post_id) {
 
-		$this->log->trace( "Post $post_id saved, invalidating cache..." );
+		$this->log->trace("Post $post_id saved, invalidating cache...");
 
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -280,21 +280,21 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function changed_post_meta( $id, $post_id, $meta_key ) {
+	public function changed_post_meta($id, $post_id, $meta_key) {
 
-		if ( in_array( $meta_key, self::$ignored_meta_keys, true ) ) {
-			$this->log->trace( "Post $post_id meta $meta_key ignored." );
+		if (in_array($meta_key, self::$ignored_meta_keys, true)) {
+			$this->log->trace("Post $post_id meta $meta_key ignored.");
 
 			return;
 		}
 
-		$this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
+		$this->log->trace("Post $post_id meta $meta_key changed, invalidating cache...");
 
 		// Delete the single cache file.
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 
 		// Flush the cache if it's the publisher.
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -304,7 +304,7 @@ 
 	 * @since 3.16.0
 	 */
 	public function update_option_wl_general_settings() {
-		$this->log->trace( 'WordLift options changed, flushing cache...' );
+		$this->log->trace('WordLift options changed, flushing cache...');
 
 		$this->cache->flush();
 	}
@@ -315,7 +315,7 @@ 
 	 * @since 3.17.0
 	 */
 	public function permalinks_structure_changed() {
-		$this->log->trace( 'Permalinks structure changed, flushing cache...' );
+		$this->log->trace('Permalinks structure changed, flushing cache...');
 
 		$this->cache->flush();
 	}
@@ -327,10 +327,10 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function relation_changed( $post_id ) {
-		$this->log->trace( "Post $post_id relations changed, invalidating cache..." );
+	public function relation_changed($post_id) {
+		$this->log->trace("Post $post_id relations changed, invalidating cache...");
 
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 	}
 
 	/**
@@ -342,13 +342,13 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function add_http_header( $post_id, $cache ) {
+	private function add_http_header($post_id, $cache) {
 
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || headers_sent()) {
 			return;
 		}
 
-		header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
+		header("X-WordLift-JsonLd-Cache-$post_id: ".($cache ? 'HIT' : 'MISS'));
 
 	}
 
@@ -360,10 +360,10 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function flush_cache_if_publisher( $post_id ) {
+	private function flush_cache_if_publisher($post_id) {
 
 		// Bail out if it's not the publisher.
-		if ( Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id ) {
+		if (Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id) {
 			return;
 		}