insideout10 / wordlift-plugin

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

Indentation +395 added lines, -395 removed lines

@@ -23,421 +23,421 @@
  */
 abstract class Wordlift_Abstract_Post_To_Jsonld_Converter implements Wordlift_Post_Converter {
 
-	/**
-	 * The JSON-LD context.
-	 *
-	 * @since 3.10.0
-	 */
-	const CONTEXT = 'http://schema.org';
-
-	/**
-	 * A {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access protected
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	protected $entity_type_service;
-
-	/**
-	 * A {@link Wordlift_User_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
-	 */
-	protected $user_service;
-
-	/**
-	 * A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 */
-	protected $attachment_service;
-
-	/**
-	 * @var Wordlift_Property_Getter
-	 */
-	private $property_getter;
-
-	/**
-	 * 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.
-	 * @param \Wordlift_Property_Getter     $property_getter
-	 *
-	 * @since 3.10.0
-	 */
-	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;
-		$this->property_getter     = $property_getter;
-	}
-
-	/**
-	 * 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 $references An array of entity references.
-	 * @param array $references_infos
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	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 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();
-		}
-
-		/*
+    /**
+     * The JSON-LD context.
+     *
+     * @since 3.10.0
+     */
+    const CONTEXT = 'http://schema.org';
+
+    /**
+     * A {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.10.0
+     * @access protected
+     * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     */
+    protected $entity_type_service;
+
+    /**
+     * A {@link Wordlift_User_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
+     */
+    protected $user_service;
+
+    /**
+     * A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     */
+    protected $attachment_service;
+
+    /**
+     * @var Wordlift_Property_Getter
+     */
+    private $property_getter;
+
+    /**
+     * 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.
+     * @param \Wordlift_Property_Getter     $property_getter
+     *
+     * @since 3.10.0
+     */
+    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;
+        $this->property_getter     = $property_getter;
+    }
+
+    /**
+     * 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 $references An array of entity references.
+     * @param array $references_infos
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    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 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();
+        }
+
+        /*
 		 * The `types` variable holds one or more entity types. The `type` variable isn't used anymore.
 		 *
 		 * @since 3.20.0 We support more than one entity type.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		// 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 );
-
-		// Prepare the response.
-		$jsonld = array(
-			'@context' => self::CONTEXT,
-			'@id'      => $id,
-			'@type'    => $type,
-		);
-
-		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.
-		/*
+        // 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 );
+
+        // Prepare the response.
+        $jsonld = array(
+            '@context' => self::CONTEXT,
+            '@id'      => $id,
+            '@type'    => $type,
+        );
+
+        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.
+        /*
 		 * Apply the `wl_post_content` filter, in case 3rd parties want to change the post content, e.g.
 		 * because the content is written elsewhere.
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) ) {
-			// 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
-			// with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
-			//
-			// See http://schema.org/mainEntityOfPage
-			//
-			// No need to specify `'@type' => 'WebPage'.
-			//
-			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
-
-			/**
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/1207
-			 *
-			 * @since 3.27.7
-			 */
-			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 ),
-				);
-			}
-		};
-
-		$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 );
-
-		/*
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+        if ( ! empty( $post_content ) ) {
+            // 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
+            // with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
+            //
+            // See http://schema.org/mainEntityOfPage
+            //
+            // No need to specify `'@type' => 'WebPage'.
+            //
+            // See https://github.com/insideout10/wordlift-plugin/issues/451.
+            $jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+
+            /**
+             * @see https://github.com/insideout10/wordlift-plugin/issues/1207
+             *
+             * @since 3.27.7
+             */
+            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 ),
+                );
+            }
+        };
+
+        $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 );
+
+        /*
 		 * Add the locations to the references.
 		 *
 		 * @since 3.19.5
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/858.
 		 */
-		// A reference to use in closure.
-		$entity_type_service = $this->entity_type_service;
-		$locations           = array_reduce(
-			$references_without_locations,
-			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' ) ) {
-
-					return $carry;
-				}
-				$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 );
-					},
-					$post_location_ids
-				);
-
-				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 );
-
-		return $jsonld;
-	}
-
-	/**
-	 * If the provided value starts with the schema.org context, we remove the schema.org
-	 * part since it is set with the '@context'.
-	 *
-	 * @param string $value The property value.
-	 *
-	 * @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;
-	}
-
-	/**
-	 * Set the images, by looking for embedded images, for images loaded via the
-	 * gallery and for the featured image.
-	 *
-	 * Uses the cache service to store the results of this function for a day.
-	 *
-	 * @param $attachment_service Wordlift_Attachment_Service
-	 * @param WP_Post                                        $post The target {@link WP_Post}.
-	 * @param array                                          $jsonld The JSON-LD array.
-	 *
-	 * @since 3.10.0
-	 */
-	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 ) {
-			$ids[] = $thumbnail_id;
-		}
-
-		// For the time being the following is being removed since the query
-		// initiated by `get_image_embeds` is consuming lots of CPU.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/689.
-		//
-		// 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 );
-		} else {
-			$embeds = array();
-		}
-
-		// Get the gallery, removing existing ids.
-		$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 ) {
-					/*
+        // A reference to use in closure.
+        $entity_type_service = $this->entity_type_service;
+        $locations           = array_reduce(
+            $references_without_locations,
+            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' ) ) {
+
+                    return $carry;
+                }
+                $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 );
+                    },
+                    $post_location_ids
+                );
+
+                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 );
+
+        return $jsonld;
+    }
+
+    /**
+     * If the provided value starts with the schema.org context, we remove the schema.org
+     * part since it is set with the '@context'.
+     *
+     * @param string $value The property value.
+     *
+     * @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;
+    }
+
+    /**
+     * Set the images, by looking for embedded images, for images loaded via the
+     * gallery and for the featured image.
+     *
+     * Uses the cache service to store the results of this function for a day.
+     *
+     * @param $attachment_service Wordlift_Attachment_Service
+     * @param WP_Post                                        $post The target {@link WP_Post}.
+     * @param array                                          $jsonld The JSON-LD array.
+     *
+     * @since 3.10.0
+     */
+    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 ) {
+            $ids[] = $thumbnail_id;
+        }
+
+        // For the time being the following is being removed since the query
+        // initiated by `get_image_embeds` is consuming lots of CPU.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/689.
+        //
+        // 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 );
+        } else {
+            $embeds = array();
+        }
+
+        // Get the gallery, removing existing ids.
+        $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 ) {
+                    /*
 					* @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' ) )
-					);
-
-					$sources_with_image = array_filter(
-						$sources,
-						function ( $source ) {
-							return ! empty( $source[0] );
-						}
-					);
-
-					// Get the attachment data.
-					// $attachment = wp_get_attachment_image_src( $item, 'full' );
-
-					// var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
-
-					// Bail if image is not found.
-					// In some cases, you can delete the image from the database
-					// 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 ) ) {
-						return $carry;
-					}
-
-					// Merge the arrays.
-					return array_merge(
-						$carry,
-						$sources_with_image
-					);
-				},
-				// Initial array.
-
-				array()
-			)
-		);
-
-		// Refactor data as per schema.org specifications.
-		$images = array_map(
-			function ( $attachment ) {
-				return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
-					array(
-						'@type' => 'ImageObject',
-						'url'   => $attachment[0],
-					),
-					$attachment
-				);
-			},
-			$images_with_sizes
-		);
-
-		// Add images if present.
-		if ( 0 < count( $images ) ) {
-			$jsonld['image'] = $images;
-		}
-
-	}
-
-	/**
-	 * If the provided array of values contains only one value, then one single
-	 * value is returned, otherwise the original array is returned.
-	 *
-	 * @param array $value An array of values.
-	 *
-	 * @return mixed|array A single value or the original array.
-	 * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
-	 *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
-	 * @since  3.8.0
-	 * @access private
-	 */
-	protected static function make_one( $value ) {
-
-		return 1 === count( $value ) ? $value[0] : $value;
-	}
-
-	/**
-	 * Process the provided array by adding the width / height if the values
-	 * are available and are greater than 0.
-	 *
-	 * @param array $image The `ImageObject` array.
-	 * @param array $attachment The attachment array.
-	 *
-	 * @return array The enriched `ImageObject` array.
-	 * @since 3.14.0
-	 */
-	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] ) {
-			$image['width'] = $attachment[1];
-		}
-
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
-			$image['height'] = $attachment[2];
-		}
-
-		return $image;
-	}
-
-	/**
-	 * Add data to the JSON-LD using the `custom_fields` array which contains the definitions of property
-	 * for the post entity type.
-	 *
-	 * @param array   $jsonld The JSON-LD array.
-	 * @param array   $fields The entity types field array.
-	 * @param WP_Post $post The target {@link WP_Post} instance.
-	 * @param array   $references The references array.
-	 *
-	 * @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 ) {
-
-		// Set a reference to use in closures.
-		$converter = $this;
-
-		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
-
-			// Get the 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 );
-
-			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(
-				array_map(
-					function ( $item ) use ( $converter, &$references, &$references_infos ) {
-
-						if ( $item instanceof Wordlift_Property_Entity_Reference ) {
-
-							$url = $item->get_url();
-
-							// The refactored converters require the entity id.
-							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							$references[] = $item->to_reference();
-
-							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							$references_infos[] = array( 'reference' => $item );
-
-							return array( '@id' => $url );
-						}
-
-						return $converter->relative_to_context( $item );
-					},
-					$value
-				)
-			);
-
-		}
-
-	}
+                    $sources = array_merge(
+                        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] );
+                        }
+                    );
+
+                    // Get the attachment data.
+                    // $attachment = wp_get_attachment_image_src( $item, 'full' );
+
+                    // var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
+
+                    // Bail if image is not found.
+                    // In some cases, you can delete the image from the database
+                    // 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 ) ) {
+                        return $carry;
+                    }
+
+                    // Merge the arrays.
+                    return array_merge(
+                        $carry,
+                        $sources_with_image
+                    );
+                },
+                // Initial array.
+
+                array()
+            )
+        );
+
+        // Refactor data as per schema.org specifications.
+        $images = array_map(
+            function ( $attachment ) {
+                return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
+                    array(
+                        '@type' => 'ImageObject',
+                        'url'   => $attachment[0],
+                    ),
+                    $attachment
+                );
+            },
+            $images_with_sizes
+        );
+
+        // Add images if present.
+        if ( 0 < count( $images ) ) {
+            $jsonld['image'] = $images;
+        }
+
+    }
+
+    /**
+     * If the provided array of values contains only one value, then one single
+     * value is returned, otherwise the original array is returned.
+     *
+     * @param array $value An array of values.
+     *
+     * @return mixed|array A single value or the original array.
+     * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
+     *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
+     * @since  3.8.0
+     * @access private
+     */
+    protected static function make_one( $value ) {
+
+        return 1 === count( $value ) ? $value[0] : $value;
+    }
+
+    /**
+     * Process the provided array by adding the width / height if the values
+     * are available and are greater than 0.
+     *
+     * @param array $image The `ImageObject` array.
+     * @param array $attachment The attachment array.
+     *
+     * @return array The enriched `ImageObject` array.
+     * @since 3.14.0
+     */
+    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] ) {
+            $image['width'] = $attachment[1];
+        }
+
+        if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+            $image['height'] = $attachment[2];
+        }
+
+        return $image;
+    }
+
+    /**
+     * Add data to the JSON-LD using the `custom_fields` array which contains the definitions of property
+     * for the post entity type.
+     *
+     * @param array   $jsonld The JSON-LD array.
+     * @param array   $fields The entity types field array.
+     * @param WP_Post $post The target {@link WP_Post} instance.
+     * @param array   $references The references array.
+     *
+     * @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 ) {
+
+        // Set a reference to use in closures.
+        $converter = $this;
+
+        // Try each field on the entity.
+        foreach ( $fields as $key => $value ) {
+
+            // Get the 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 );
+
+            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(
+                array_map(
+                    function ( $item ) use ( $converter, &$references, &$references_infos ) {
+
+                        if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+
+                            $url = $item->get_url();
+
+                            // The refactored converters require the entity id.
+                            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                            $references[] = $item->to_reference();
+
+                            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                            $references_infos[] = array( 'reference' => $item );
+
+                            return array( '@id' => $url );
+                        }
+
+                        return $converter->relative_to_context( $item );
+                    },
+                    $value
+                )
+            );
+
+        }
+
+    }
 
 }

Spacing +60 added lines, -60 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 ) ) {
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		if ( ! empty($post_content)) {
 			// 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,28 +148,28 @@ 
 			// 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( $type, array( 'Occupation', 'OccupationAggregationByEmployer' ), true ) ) {
+			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.
@@ -182,33 +182,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;
 	}
@@ -222,8 +222,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;
 	}
 
 	/**
@@ -238,14 +238,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;
 		}
 
@@ -256,34 +256,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]);
 						}
 					);
 
@@ -297,7 +297,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;
 					}
 
@@ -315,7 +315,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',
@@ -328,7 +328,7 @@ 
 		);
 
 		// Add images if present.
-		if ( 0 < count( $images ) ) {
+		if (0 < count($images)) {
 			$jsonld['image'] = $images;
 		}
 
@@ -346,9 +346,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;
 	}
 
 	/**
@@ -361,17 +361,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];
 		}
 
@@ -390,33 +390,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();
 
@@ -425,12 +425,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/class-wordlift-entity-post-type-service.php

Indentation +170 added lines, -170 removed lines

@@ -16,175 +16,175 @@
  */
 class Wordlift_Entity_Post_Type_Service {
 
-	/**
-	 * The entity post type.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var string $post_type The entity post type.
-	 */
-	private $post_type;
-
-	/**
-	 * The entity type slug.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var string $slug The entity type slug.
-	 */
-	private $slug;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * A singleton instance of the entity type service.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var Wordlift_Entity_Post_Type_Service
-	 */
-	private static $instance;
-
-	/**
-	 * Create an entity type service instance.
-	 *
-	 * @param string $post_type The post type, e.g. entity.
-	 * @param string $slug The entity type slug, if the slug is empty, the default slug will be used.
-	 *
-	 * @since 3.6.0
-	 */
-	public function __construct( $post_type, $slug ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->post_type = $post_type;
-
-		// We cannot assign an empty slug to the register_post_type function, therefore if the slug is empty we default
-		// to the type name.
-		$this->slug = $slug ? $slug : $post_type;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the entity type service singleton instance.
-	 *
-	 * @return Wordlift_Entity_Post_Type_Service The entity type service singleton instance.
-	 * @since 3.6.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get the entity type slug.
-	 *
-	 * @return string The entity type slug.
-	 * @since 3.6.0
-	 */
-	public function get_slug() {
-
-		return $this->slug;
-	}
-
-	/**
-	 * Get the entity post type name.
-	 *
-	 * @return string The entity post type.
-	 * @since 3.6.0
-	 */
-	public function get_post_type() {
-
-		return $this->post_type;
-	}
-
-	/**
-	 * Register the WordLift entity post type. This method is hooked to WordPress' init action.
-	 *
-	 * @since 3.6.0
-	 */
-	public function register() {
-
-		$this->log->debug( "Registering post type $this->post_type..." );
-
-		$labels = array(
-			'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
-			'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
-			'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
-			'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
-			'edit_item'          => __( 'Edit Entity', 'wordlift' ),
-			'new_item'           => __( 'New Entity', 'wordlift' ),
-			'all_items'          => __( 'All Entities', 'wordlift' ),
-			'view_item'          => __( 'View Entity', 'wordlift' ),
-			'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
-			'not_found'          => __( 'No entities found', 'wordlift' ),
-			'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
-			'parent_item_colon'  => '',
-			'menu_name'          => __( 'Vocabulary', 'wordlift' ),
-		);
-
-		$args = array(
-			'labels'          => $labels,
-			'description'     => 'Holds our vocabulary (set of entities) and entity specific data',
-			'public'          => true,
-			'menu_position'   => 20,
-			// after the pages menu.
-			// Add support for 'authors' and 'revisions':
-			// * see https://github.com/insideout10/wordlift-plugin/issues/395
-			// * see https://github.com/insideout10/wordlift-plugin/issues/376
-			'supports'        => array(
-				'title',
-				'editor',
-				'thumbnail',
-				'excerpt',
-				'comments',
-				'author',
-				'revisions',
-				'custom-fields',
-			),
-			'menu_icon'       => WP_CONTENT_URL . '/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
-			// Although we define our slug here, we further manage linking to entities using the Wordlift_Entity_Link_Service.
-			'rewrite'         => array( 'slug' => $this->slug ),
-			'capability_type' => array(
-				'wordlift_entity',
-				'wordlift_entities',
-			),
-			'capabilities'    => array(
-				'delete_posts' => 'delete_wordlift_entities',
-			),
-			'rest_base'       => 'entities',
-			'show_in_rest'    => true,
-			/**
-			 * Filter: wl_feature__enable__vocabulary.
-			 *
-			 * @param bool whether the vocabulary needs to be shown in menu.
-			 *
-			 * @return bool
-			 * @since 3.27.6
-			 */
-			'show_in_menu'    => apply_filters( 'wl_feature__enable__vocabulary', true ),
-		);
-
-		register_post_type( $this->post_type, $args );
-
-		// Enable WP's standard `category` taxonomy for entities.
-		//
-		// While this enables editors to bind entities to the WP posts' category
-		// taxonomy, in Wordlift_Category_Taxonomy_Service we also need to alter
-		// WP's main category query to include the `entity` post type.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/442
-		register_taxonomy_for_object_type( 'category', $this->post_type );
-
-	}
+    /**
+     * The entity post type.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var string $post_type The entity post type.
+     */
+    private $post_type;
+
+    /**
+     * The entity type slug.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var string $slug The entity type slug.
+     */
+    private $slug;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * A singleton instance of the entity type service.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var Wordlift_Entity_Post_Type_Service
+     */
+    private static $instance;
+
+    /**
+     * Create an entity type service instance.
+     *
+     * @param string $post_type The post type, e.g. entity.
+     * @param string $slug The entity type slug, if the slug is empty, the default slug will be used.
+     *
+     * @since 3.6.0
+     */
+    public function __construct( $post_type, $slug ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->post_type = $post_type;
+
+        // We cannot assign an empty slug to the register_post_type function, therefore if the slug is empty we default
+        // to the type name.
+        $this->slug = $slug ? $slug : $post_type;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the entity type service singleton instance.
+     *
+     * @return Wordlift_Entity_Post_Type_Service The entity type service singleton instance.
+     * @since 3.6.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Get the entity type slug.
+     *
+     * @return string The entity type slug.
+     * @since 3.6.0
+     */
+    public function get_slug() {
+
+        return $this->slug;
+    }
+
+    /**
+     * Get the entity post type name.
+     *
+     * @return string The entity post type.
+     * @since 3.6.0
+     */
+    public function get_post_type() {
+
+        return $this->post_type;
+    }
+
+    /**
+     * Register the WordLift entity post type. This method is hooked to WordPress' init action.
+     *
+     * @since 3.6.0
+     */
+    public function register() {
+
+        $this->log->debug( "Registering post type $this->post_type..." );
+
+        $labels = array(
+            'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
+            'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
+            'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
+            'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
+            'edit_item'          => __( 'Edit Entity', 'wordlift' ),
+            'new_item'           => __( 'New Entity', 'wordlift' ),
+            'all_items'          => __( 'All Entities', 'wordlift' ),
+            'view_item'          => __( 'View Entity', 'wordlift' ),
+            'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
+            'not_found'          => __( 'No entities found', 'wordlift' ),
+            'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
+            'parent_item_colon'  => '',
+            'menu_name'          => __( 'Vocabulary', 'wordlift' ),
+        );
+
+        $args = array(
+            'labels'          => $labels,
+            'description'     => 'Holds our vocabulary (set of entities) and entity specific data',
+            'public'          => true,
+            'menu_position'   => 20,
+            // after the pages menu.
+            // Add support for 'authors' and 'revisions':
+            // * see https://github.com/insideout10/wordlift-plugin/issues/395
+            // * see https://github.com/insideout10/wordlift-plugin/issues/376
+            'supports'        => array(
+                'title',
+                'editor',
+                'thumbnail',
+                'excerpt',
+                'comments',
+                'author',
+                'revisions',
+                'custom-fields',
+            ),
+            'menu_icon'       => WP_CONTENT_URL . '/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
+            // Although we define our slug here, we further manage linking to entities using the Wordlift_Entity_Link_Service.
+            'rewrite'         => array( 'slug' => $this->slug ),
+            'capability_type' => array(
+                'wordlift_entity',
+                'wordlift_entities',
+            ),
+            'capabilities'    => array(
+                'delete_posts' => 'delete_wordlift_entities',
+            ),
+            'rest_base'       => 'entities',
+            'show_in_rest'    => true,
+            /**
+             * Filter: wl_feature__enable__vocabulary.
+             *
+             * @param bool whether the vocabulary needs to be shown in menu.
+             *
+             * @return bool
+             * @since 3.27.6
+             */
+            'show_in_menu'    => apply_filters( 'wl_feature__enable__vocabulary', true ),
+        );
+
+        register_post_type( $this->post_type, $args );
+
+        // Enable WP's standard `category` taxonomy for entities.
+        //
+        // While this enables editors to bind entities to the WP posts' category
+        // taxonomy, in Wordlift_Category_Taxonomy_Service we also need to alter
+        // WP's main category query to include the `entity` post type.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/442
+        register_taxonomy_for_object_type( 'category', $this->post_type );
+
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -60,9 +60,9 @@ 
 	 *
 	 * @since 3.6.0
 	 */
-	public function __construct( $post_type, $slug ) {
+	public function __construct($post_type, $slug) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->post_type = $post_type;
 
@@ -114,22 +114,22 @@ 
 	 */
 	public function register() {
 
-		$this->log->debug( "Registering post type $this->post_type..." );
+		$this->log->debug("Registering post type $this->post_type...");
 
 		$labels = array(
-			'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
-			'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
-			'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
-			'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
-			'edit_item'          => __( 'Edit Entity', 'wordlift' ),
-			'new_item'           => __( 'New Entity', 'wordlift' ),
-			'all_items'          => __( 'All Entities', 'wordlift' ),
-			'view_item'          => __( 'View Entity', 'wordlift' ),
-			'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
-			'not_found'          => __( 'No entities found', 'wordlift' ),
-			'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
+			'name'               => _x('Vocabulary', 'post type general name', 'wordlift'),
+			'singular_name'      => _x('Entity', 'post type singular name', 'wordlift'),
+			'add_new'            => _x('Add New Entity', 'entity', 'wordlift'),
+			'add_new_item'       => __('Add New Entity', 'wordlift'),
+			'edit_item'          => __('Edit Entity', 'wordlift'),
+			'new_item'           => __('New Entity', 'wordlift'),
+			'all_items'          => __('All Entities', 'wordlift'),
+			'view_item'          => __('View Entity', 'wordlift'),
+			'search_items'       => __('Search in Vocabulary', 'wordlift'),
+			'not_found'          => __('No entities found', 'wordlift'),
+			'not_found_in_trash' => __('No entities found in the Trash', 'wordlift'),
 			'parent_item_colon'  => '',
-			'menu_name'          => __( 'Vocabulary', 'wordlift' ),
+			'menu_name'          => __('Vocabulary', 'wordlift'),
 		);
 
 		$args = array(
@@ -151,9 +151,9 @@ 
 				'revisions',
 				'custom-fields',
 			),
-			'menu_icon'       => WP_CONTENT_URL . '/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
+			'menu_icon'       => WP_CONTENT_URL.'/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
 			// Although we define our slug here, we further manage linking to entities using the Wordlift_Entity_Link_Service.
-			'rewrite'         => array( 'slug' => $this->slug ),
+			'rewrite'         => array('slug' => $this->slug),
 			'capability_type' => array(
 				'wordlift_entity',
 				'wordlift_entities',
@@ -171,10 +171,10 @@ 
 			 * @return bool
 			 * @since 3.27.6
 			 */
-			'show_in_menu'    => apply_filters( 'wl_feature__enable__vocabulary', true ),
+			'show_in_menu'    => apply_filters('wl_feature__enable__vocabulary', true),
 		);
 
-		register_post_type( $this->post_type, $args );
+		register_post_type($this->post_type, $args);
 
 		// Enable WP's standard `category` taxonomy for entities.
 		//
@@ -183,7 +183,7 @@ 
 		// WP's main category query to include the `entity` post type.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/442
-		register_taxonomy_for_object_type( 'category', $this->post_type );
+		register_taxonomy_for_object_type('category', $this->post_type);
 
 	}
 

src/install/class-wordlift-install-service.php

Indentation +172 added lines, -172 removed lines

@@ -18,179 +18,179 @@
  */
 class Wordlift_Install_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.18.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The singleton instance.
-	 *
-	 * @since  3.18.0
-	 * @access private
-	 * @var \Wordlift_Install_Service $instance A {@link Wordlift_Install_Service} instance.
-	 */
-	private static $instance;
-
-	/**
-	 * @var array
-	 */
-	private $installs;
-
-	/**
-	 * Wordlift_Install_Service constructor.
-	 *
-	 * @since 3.18.0
-	 */
-	public function __construct() {
-
-		/** Installs. */
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-1-0-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-10-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-12-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-14-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-15-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-18-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-18-3.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-19-5.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-20-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-23-4.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-24-2.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-all-entity-types.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-package-type.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-25-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-27-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-27-1.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-28-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-32-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-33-9.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-36-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-38-5.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-39-1.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-40-1.php';
-
-		// Get the install services.
-		$this->installs = array(
-			new Wordlift_Install_1_0_0(),
-			new Wordlift_Install_3_10_0(),
-			new Wordlift_Install_3_12_0(),
-			new Wordlift_Install_3_14_0(),
-			new Wordlift_Install_3_15_0(),
-			new Wordlift_Install_3_18_0(),
-			new Wordlift_Install_3_18_3(),
-			new Wordlift_Install_3_19_5(),
-			new Wordlift_Install_3_20_0(),
-
-			/*
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.18.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The singleton instance.
+     *
+     * @since  3.18.0
+     * @access private
+     * @var \Wordlift_Install_Service $instance A {@link Wordlift_Install_Service} instance.
+     */
+    private static $instance;
+
+    /**
+     * @var array
+     */
+    private $installs;
+
+    /**
+     * Wordlift_Install_Service constructor.
+     *
+     * @since 3.18.0
+     */
+    public function __construct() {
+
+        /** Installs. */
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-1-0-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-10-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-12-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-14-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-15-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-18-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-18-3.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-19-5.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-20-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-23-4.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-24-2.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-all-entity-types.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-package-type.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-25-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-27-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-27-1.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-28-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-32-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-33-9.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-36-0.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-38-5.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-39-1.php';
+        require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-40-1.php';
+
+        // Get the install services.
+        $this->installs = array(
+            new Wordlift_Install_1_0_0(),
+            new Wordlift_Install_3_10_0(),
+            new Wordlift_Install_3_12_0(),
+            new Wordlift_Install_3_14_0(),
+            new Wordlift_Install_3_15_0(),
+            new Wordlift_Install_3_18_0(),
+            new Wordlift_Install_3_18_3(),
+            new Wordlift_Install_3_19_5(),
+            new Wordlift_Install_3_20_0(),
+
+            /*
 			 * This should be enabled with #852.
 			 */
-			new Wordlift_Install_Package_Type(),
-			new Wordlift_Install_3_23_4(),
-			new Wordlift_Install_3_24_2(),
-			new Wordlift_Install_3_25_0(),
-			new Wordlift_Install_3_27_0(),
-			new Wordlift_Install_3_27_1(),
-			new Wordlift_Install_3_28_0(),
-			// Add column to represent term
-			new Wordlift_Install_3_32_0(),
-			// Add the entities table.
-			new Wordlift_Install_3_33_9(),
-			// When woocommerce extension installed, acf4so should be installed automatically.
-			new Wordlift_Install_3_36_0(),
-
-			new Wordlift_Install_3_38_5(),
-			new Wordlift_Install_3_39_1(),
-
-			// See #1621.
-			new Wordlift_Install_3_40_1(),
-		);
-		self::$instance = $this;
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'init', array( $this, 'install' ) );
-
-	}
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @since 3.18.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Loop thought all versions and install the updates.
-	 *
-	 * @return void
-	 * @since 3.18.0
-	 *
-	 * @since 3.20.0 use a transient to avoid concurrent installation calls.
-	 */
-	public function install() {
-
-		$version = null;
-
-		if ( $this->install_required() && false === get_transient( '_wl_installing' ) ) {
-			set_transient( '_wl_installing', true, 5 * MINUTE_IN_SECONDS );
-			/** @var Wordlift_Install $install */
-			foreach ( $this->installs as $install ) {
-				// Get the install version.
-				$version = $install->get_version();
-
-				if ( version_compare( $version, $this->get_current_version(), '>' )
-					 || $install->must_install() ) {
-					$class_name = get_class( $install );
-
-					$this->log->info( "Current version is {$this->get_current_version()}, installing $class_name..." );
-					// Install version.
-					$install->install();
-
-					$this->log->info( "$class_name installed." );
-
-					// Bump the version.
-					update_option( 'wl_db_version', $version );
-				}
-			}
-
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@delete_transient( '_wl_installing' );
-
-		}
-
-	}
-
-	private function install_required() {
-
-		/** @var Wordlift_Install $install */
-		foreach ( $this->installs as $install ) {
-			// Get the install version.
-			$version = $install->get_version();
-
-			if ( version_compare( $version, $this->get_current_version(), '>' )
-				 || $install->must_install() ) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Retrieve the current db version.
-	 *
-	 * @return type
-	 */
-	private function get_current_version() {
-		return get_option( 'wl_db_version', '0.0.0' );
-	}
+            new Wordlift_Install_Package_Type(),
+            new Wordlift_Install_3_23_4(),
+            new Wordlift_Install_3_24_2(),
+            new Wordlift_Install_3_25_0(),
+            new Wordlift_Install_3_27_0(),
+            new Wordlift_Install_3_27_1(),
+            new Wordlift_Install_3_28_0(),
+            // Add column to represent term
+            new Wordlift_Install_3_32_0(),
+            // Add the entities table.
+            new Wordlift_Install_3_33_9(),
+            // When woocommerce extension installed, acf4so should be installed automatically.
+            new Wordlift_Install_3_36_0(),
+
+            new Wordlift_Install_3_38_5(),
+            new Wordlift_Install_3_39_1(),
+
+            // See #1621.
+            new Wordlift_Install_3_40_1(),
+        );
+        self::$instance = $this;
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'init', array( $this, 'install' ) );
+
+    }
+
+    /**
+     * Get the singleton instance.
+     *
+     * @since 3.18.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Loop thought all versions and install the updates.
+     *
+     * @return void
+     * @since 3.18.0
+     *
+     * @since 3.20.0 use a transient to avoid concurrent installation calls.
+     */
+    public function install() {
+
+        $version = null;
+
+        if ( $this->install_required() && false === get_transient( '_wl_installing' ) ) {
+            set_transient( '_wl_installing', true, 5 * MINUTE_IN_SECONDS );
+            /** @var Wordlift_Install $install */
+            foreach ( $this->installs as $install ) {
+                // Get the install version.
+                $version = $install->get_version();
+
+                if ( version_compare( $version, $this->get_current_version(), '>' )
+                     || $install->must_install() ) {
+                    $class_name = get_class( $install );
+
+                    $this->log->info( "Current version is {$this->get_current_version()}, installing $class_name..." );
+                    // Install version.
+                    $install->install();
+
+                    $this->log->info( "$class_name installed." );
+
+                    // Bump the version.
+                    update_option( 'wl_db_version', $version );
+                }
+            }
+
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @delete_transient( '_wl_installing' );
+
+        }
+
+    }
+
+    private function install_required() {
+
+        /** @var Wordlift_Install $install */
+        foreach ( $this->installs as $install ) {
+            // Get the install version.
+            $version = $install->get_version();
+
+            if ( version_compare( $version, $this->get_current_version(), '>' )
+                 || $install->must_install() ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Retrieve the current db version.
+     *
+     * @return type
+     */
+    private function get_current_version() {
+        return get_option( 'wl_db_version', '0.0.0' );
+    }
 
 }

Spacing +40 added lines, -40 removed lines

@@ -49,30 +49,30 @@ 
 	public function __construct() {
 
 		/** Installs. */
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-1-0-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-10-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-12-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-14-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-15-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-18-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-18-3.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-19-5.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-20-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-23-4.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-24-2.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-all-entity-types.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-package-type.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-25-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-27-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-27-1.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-28-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-32-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-33-9.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-36-0.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-38-5.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-39-1.php';
-		require_once plugin_dir_path( __DIR__ ) . 'install/class-wordlift-install-3-40-1.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-1-0-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-10-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-12-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-14-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-15-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-18-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-18-3.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-19-5.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-20-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-23-4.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-24-2.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-all-entity-types.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-package-type.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-25-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-27-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-27-1.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-28-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-32-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-33-9.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-36-0.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-38-5.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-39-1.php';
+		require_once plugin_dir_path(__DIR__).'install/class-wordlift-install-3-40-1.php';
 
 		// Get the install services.
 		$this->installs = array(
@@ -111,9 +111,9 @@ 
 		);
 		self::$instance = $this;
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'init', array( $this, 'install' ) );
+		add_action('init', array($this, 'install'));
 
 	}
 
@@ -139,30 +139,30 @@ 
 
 		$version = null;
 
-		if ( $this->install_required() && false === get_transient( '_wl_installing' ) ) {
-			set_transient( '_wl_installing', true, 5 * MINUTE_IN_SECONDS );
+		if ($this->install_required() && false === get_transient('_wl_installing')) {
+			set_transient('_wl_installing', true, 5 * MINUTE_IN_SECONDS);
 			/** @var Wordlift_Install $install */
-			foreach ( $this->installs as $install ) {
+			foreach ($this->installs as $install) {
 				// Get the install version.
 				$version = $install->get_version();
 
-				if ( version_compare( $version, $this->get_current_version(), '>' )
-					 || $install->must_install() ) {
-					$class_name = get_class( $install );
+				if (version_compare($version, $this->get_current_version(), '>')
+					 || $install->must_install()) {
+					$class_name = get_class($install);
 
-					$this->log->info( "Current version is {$this->get_current_version()}, installing $class_name..." );
+					$this->log->info("Current version is {$this->get_current_version()}, installing $class_name...");
 					// Install version.
 					$install->install();
 
-					$this->log->info( "$class_name installed." );
+					$this->log->info("$class_name installed.");
 
 					// Bump the version.
-					update_option( 'wl_db_version', $version );
+					update_option('wl_db_version', $version);
 				}
 			}
 
 			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@delete_transient( '_wl_installing' );
+			@delete_transient('_wl_installing');
 
 		}
 
@@ -171,12 +171,12 @@ 
 	private function install_required() {
 
 		/** @var Wordlift_Install $install */
-		foreach ( $this->installs as $install ) {
+		foreach ($this->installs as $install) {
 			// Get the install version.
 			$version = $install->get_version();
 
-			if ( version_compare( $version, $this->get_current_version(), '>' )
-				 || $install->must_install() ) {
+			if (version_compare($version, $this->get_current_version(), '>')
+				 || $install->must_install()) {
 				return true;
 			}
 		}
@@ -190,7 +190,7 @@ 
 	 * @return type
 	 */
 	private function get_current_version() {
-		return get_option( 'wl_db_version', '0.0.0' );
+		return get_option('wl_db_version', '0.0.0');
 	}
 
 }

src/install/class-wordlift-install-3-40-1.php

Indentation +8 added lines, -8 removed lines

@@ -7,13 +7,13 @@
  */
 class Wordlift_Install_3_40_1 extends Wordlift_Install {
 
-	/**
-	 * {@inheritdoc}
-	 */
-	protected static $version = '3.40.1';
+    /**
+     * {@inheritdoc}
+     */
+    protected static $version = '3.40.1';
 
-	public function install() {
-		// Flush the rewrite rules.
-		flush_rewrite_rules();
-	}
+    public function install() {
+        // Flush the rewrite rules.
+        flush_rewrite_rules();
+    }
 }