insideout10 / wordlift-plugin

src/wordlift/post/class-post-adapter.php

Indentation +364 added lines, -364 removed lines

@@ -20,369 +20,369 @@
 
 class Post_Adapter {
 
-	/**
-	 * A {@link Wordlift_Log_Service} logging instance.
-	 *
-	 * @access private
-	 * @var \Wordlift_Log_Service A {@link Wordlift_Log_Service} logging instance.
-	 */
-	private $log;
-
-	public function __construct() {
-
-		// Bail out if block editor's functions aren't available.
-		if ( ! function_exists( 'register_block_type' ) || ! function_exists( 'parse_blocks' ) ) {
-			return;
-		}
-
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'init', array( $this, 'init' ) );
-		add_filter( 'wp_insert_post_data', array( $this, 'wp_insert_post_data' ), 10, 2 );
-
-	}
-
-	/**
-	 * Initialize by registering our block type `wordlift/classification`, required for {@link parse_blocks) to work
-	 * correctly.
-	 */
-	public function init() {
-
-		register_block_type( 'wordlift/classification', array(
-			'editor_script' => 'wl-block-editor',
-			'attributes'    => array(
-				'entities' => array( 'type' => 'array' ),
-			),
-		) );
-
-	}
-
-	/**
-	 * A sample structure:
-	 *
-	 * {
-	 *   "entities": [
-	 *     {
-	 *       "annotations": {
-	 *         "urn:enhancement-7e8e66fc": {
-	 *           "start": 3480,
-	 *           "end": 3486,
-	 *           "text": "libero"
-	 *         }
-	 *       },
-	 *       "description": "Le libero ou libéro est un poste défensif du volley-ball. Des règles particulières le concernant ont été introduites à la fin des années 1990. De par sa spécificité, le libéro a un statut à part au sein d’une équipe de volley-ball. Pour être identifié, il doit porter un uniforme qui contraste avec ceux des autres membres de son équipe, titulaires ou remplaçants.",
-	 *       "id": "http://fr.dbpedia.org/resource/Libero_(volley-ball)",
-	 *       "label": "Libero (volley-ball)",
-	 *       "mainType": "other",
-	 *       "occurrences": ["urn:enhancement-7e8e66fc"],
-	 *       "sameAs": null,
-	 *       "synonyms": [],
-	 *       "types": ["other"]
-	 *     }
-	 *   ]
-	 * }
-	 *
-	 * @param array $data An array of slashed post data.
-	 * @param array $postarr An array of sanitized, but otherwise unmodified post data.
-	 *
-	 * @return array The data array.
-	 */
-	public function wp_insert_post_data( $data, $postarr ) {
-
-		$post_status = $data['post_status'];
-		if ( 'auto-draft' === $post_status || 'inherit' === $post_status ) {
-			return $data;
-		}
-
-		$this->log->trace( "The following data has been received by `wp_insert_post_data`:\n"
-		                   . var_export( $data, true ) );
-
-
-		try {
-			$entities = $this->parse_content( wp_unslash( $data['post_content'] ) );
-
-			foreach ( $entities as $entity ) {
-
-				$entity_id = array_key_exists( 'id', $entity ) ? $entity['id'] : '';
-
-				if ( ! $this->entity_id_valid( $entity_id ) ) {
-					continue;
-				}
-
-				$entity_uris = $this->get_entity_uris( $entity );
-
-				if ( $this->get_first_matching_entity_by_uri( $entity_uris ) === null &&
-				     Post_Entities_Validator::is_local_entity_uri_exist( Wordlift_Entity_Uri_Service::get_instance(), $entity_uris ) ) {
-					// Skip the entity
-					continue;
-				}
-
-				// If 'entity auto publish' is false, we set the status to `draft` by default.
-				$post_status = apply_filters( 'wl_feature__enable__entity-auto-publish', true )
-					? $data['post_status'] : 'draft';
-				$this->create_or_update_entity( $entity, $post_status );
-
-			}
-
-		} catch ( \Exception $e ) {
-			$this->log->error( $e->getMessage() );
-		}
-
-
-		return $data;
-	}
-
-	/**
-	 * Parse the post content to find the `wordlift/classification` block and return the entities' data.
-	 *
-	 * @param string $post_content The post content.
-	 *
-	 * @return array An array of entities' structures.
-	 * @throws \Exception
-	 */
-	private function parse_content( $post_content ) {
-
-		$all_blocks = parse_blocks( $post_content );
-		$this->log->trace( "The following blocks have been parsed while in `wp_insert_post`:\n"
-		                   . var_export( $all_blocks, true ) );
-
-		$blocks = array_filter( $all_blocks, function ( $item ) {
-			return ! empty( $item['blockName'] ) && 'wordlift/classification' === $item['blockName'];
-		} );
-
-		// Bail out if the blocks' array is empty.
-		if ( empty( $blocks ) ) {
-			return array();
-		}
-
-		$block = current( $blocks );
-		$this->log->trace( "The following block has been found while in `wp_insert_post`:\n"
-		                   . var_export( $block, true ) );
-
-		// Bail out if the entities array is empty.
-		if ( empty( $block['attrs'] ) && empty( $block['attrs']['entities'] ) ) {
-			return array();
-		}
-
-		return $block['attrs']['entities'];
-	}
-
-	/**
-	 * Collect entity labels from the entity array.
-	 *
-	 * This function expects an array with the following keys:
-	 *
-	 * array(
-	 *   'label'       => ...,
-	 *   'synonyms'    => array( ... ),
-	 *   'annotations' => array(
-	 *     ...id...      => array( text => ... ),
-	 *   ),
-	 *   'occurrences' => array( ... ),
-	 * )
-	 *
-	 * and it is going to output an array with all the labels, keeping the `label` at first position:
-	 *
-	 * array(
-	 *   ...label...,
-	 *   ...synonyms...,
-	 *   ...texts...,
-	 * )
-	 *
-	 * This function is going to collect the label from the `label` property, from the `synonyms` property and from
-	 * `annotations` property. Since the `annotations` property contains all the annotations including those that
-	 * haven't been selected, this function is going to only get the `text` for the annotations property listed in
-	 * `occurrences`.
-	 *
-	 * @param array $entity {
-	 *  The entity data.
-	 *
-	 * @type string $label The entity label.
-	 * @type array $synonyms The entity synonyms.
-	 * @type array $occurrences The selected occurrences.
-	 * @type array $annotations The annotations.
-	 * }
-	 *
-	 * @return array An array of labels.
-	 */
-	public function get_labels( $entity ) {
-
-		$args = wp_parse_args( $entity, array(
-			'label'       => array(),
-			'synonyms'    => array(),
-			'annotations' => array(),
-			'occurrences' => array(),
-		) );
-
-		// We gather all the labels, occurrences texts and synonyms into one array.
-		$initial = array_merge(
-			(array) $args['label'],
-			(array) $args['synonyms']
-		);
-
-		$annotations = $args['annotations'];
-
-		return array_reduce( $args['occurrences'], function ( $carry, $item ) use ( $annotations ) {
-
-			// Bail out if occurrences->$item->text isn't set or its contents are already
-			// in `$carry`.
-			if ( ! isset( $annotations[ $item ]['text'] )
-			     || in_array( $annotations[ $item ]['text'], $carry ) ) {
-				return $carry;
-			}
-
-			// Push the label.
-			$carry[] = $annotations[ $item ]['text'];
-
-			return $carry;
-		}, $initial );
-	}
-
-	/**
-	 * Create or update the entity.
-	 *
-	 * An entity lookup is performed on the local vocabulary using the `id` and `sameAs` URIs. If an entity is found
-	 * the {@link Entity_Store} update function is called to update the `labels` and the `sameAs` values.
-	 *
-	 * If an entity is not found the {@link Entity_Store} create function is called to create a new entity.
-	 *
-	 * @param array $entity {
-	 * The entity parameters.
-	 *
-	 * @type string The entity item id URI.
-	 * @type string|array The entity sameAs URI(s).
-	 * @type string $description The entity description.
-	 * }
-	 *
-	 * @param       $string $post_status The post status, default 'draft'.
-	 *
-	 * @return int|\WP_Error
-	 * @throws \Exception
-	 */
-	private function create_or_update_entity( $entity, $post_status = 'draft' ) {
-
-		// Get only valid IDs.
-		$uris = $this->get_entity_uris( $entity );
-
-		$post = $this->get_first_matching_entity_by_uri( $uris );
-
-		$this->log->trace( 'Entity' . ( empty( $post ) ? ' not' : '' ) . " found with the following URIs:\n"
-		                   . var_export( $uris, true ) );
-
-		// Get the labels.
-		$labels = $this->get_labels( $entity );
-
-		if ( empty( $post ) ) {
-			$entity_description = array_key_exists( 'description', $entity ) ? $entity['description'] : '';
-			// Create the entity if it doesn't exist.
-			$post_id = Entity_Store::get_instance()->create( array(
-				'labels'      => $labels,
-				'description' => $entity_description,
-				'same_as'     => $uris,
-			), $post_status );
-
-			// Return the WP_Error if we got one.
-			if ( is_wp_error( $post_id ) ) {
-				return $post_id;
-			}
-
-			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_set_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-			}
-
-			if ( isset( $entity['properties'] ) && isset( $entity['properties']['latitude'] ) && isset( $entity['properties']['longitude'] ) ) {
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude'] );
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude'] );
-			}
-		} else {
-			// Update the entity otherwise.
-			$post_id = Entity_Store::get_instance()->update( array(
-				'ID'      => $post->ID,
-				'labels'  => $labels,
-				'same_as' => $uris,
-			) );
-
-			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_add_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-			}
-
-			// see https://github.com/insideout10/wordlift-plugin/issues/1304
-			// Set the post status, we need to set that in order to support entities
-			// created using rest endpoint on block editor, so that they get published
-			// when the post is published.
-			// Once the entity is published dont update the post status.
-			if ( $post->post_status !== 'publish' ) {
-				wp_update_post( array(
-					'ID'          => $post->ID,
-					'post_status' => $post_status
-				) );
-			}
-		}
-
-		return $post_id;
-	}
-
-	/**
-	 * Get the first matching entity for the provided URI array.
-	 *
-	 * Entities IDs and sameAs are searched.
-	 *
-	 * @param array $uris An array of URIs.
-	 *
-	 * @return \WP_Post|null The entity WP_Post if found or null if not found.
-	 */
-	private function get_first_matching_entity_by_uri( $uris ) {
-
-		foreach ( $uris as $uri ) {
-
-			$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
-
-			if ( ! $content ) {
-				continue;
-			}
-
-			$existing_entity = $content->get_bag();
-
-			if ( is_a( $existing_entity, 'WP_Post' ) ) {
-				return $existing_entity;
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * @param $entity
-	 *
-	 * @return array
-	 */
-	private function filter_valid_entity_ids( $entity ) {
-		$id = $entity['id'];
-
-		return array_filter( (array) $id, function ( $id ) {
-			return preg_match( '|^https?://|', $id );
-		} );
-	}
-
-	/**
-	 * @param array $entity
-	 *
-	 * @return array
-	 */
-	private function get_entity_uris( $entity ) {
-		$ids     = $this->filter_valid_entity_ids( $entity );
-		$same_as = array_key_exists( 'sameAs', $entity ) ? $entity['sameAs'] : array();
-
-		return array_merge(
-			(array) $ids,
-			(array) $same_as
-		);
-	}
-
-	private function entity_id_valid( $entity_id ) {
-		return preg_match( '#^https?://#i', $entity_id ) === 1;
-	}
+    /**
+     * A {@link Wordlift_Log_Service} logging instance.
+     *
+     * @access private
+     * @var \Wordlift_Log_Service A {@link Wordlift_Log_Service} logging instance.
+     */
+    private $log;
+
+    public function __construct() {
+
+        // Bail out if block editor's functions aren't available.
+        if ( ! function_exists( 'register_block_type' ) || ! function_exists( 'parse_blocks' ) ) {
+            return;
+        }
+
+        $this->log = \Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'init', array( $this, 'init' ) );
+        add_filter( 'wp_insert_post_data', array( $this, 'wp_insert_post_data' ), 10, 2 );
+
+    }
+
+    /**
+     * Initialize by registering our block type `wordlift/classification`, required for {@link parse_blocks) to work
+     * correctly.
+     */
+    public function init() {
+
+        register_block_type( 'wordlift/classification', array(
+            'editor_script' => 'wl-block-editor',
+            'attributes'    => array(
+                'entities' => array( 'type' => 'array' ),
+            ),
+        ) );
+
+    }
+
+    /**
+     * A sample structure:
+     *
+     * {
+     *   "entities": [
+     *     {
+     *       "annotations": {
+     *         "urn:enhancement-7e8e66fc": {
+     *           "start": 3480,
+     *           "end": 3486,
+     *           "text": "libero"
+     *         }
+     *       },
+     *       "description": "Le libero ou libéro est un poste défensif du volley-ball. Des règles particulières le concernant ont été introduites à la fin des années 1990. De par sa spécificité, le libéro a un statut à part au sein d’une équipe de volley-ball. Pour être identifié, il doit porter un uniforme qui contraste avec ceux des autres membres de son équipe, titulaires ou remplaçants.",
+     *       "id": "http://fr.dbpedia.org/resource/Libero_(volley-ball)",
+     *       "label": "Libero (volley-ball)",
+     *       "mainType": "other",
+     *       "occurrences": ["urn:enhancement-7e8e66fc"],
+     *       "sameAs": null,
+     *       "synonyms": [],
+     *       "types": ["other"]
+     *     }
+     *   ]
+     * }
+     *
+     * @param array $data An array of slashed post data.
+     * @param array $postarr An array of sanitized, but otherwise unmodified post data.
+     *
+     * @return array The data array.
+     */
+    public function wp_insert_post_data( $data, $postarr ) {
+
+        $post_status = $data['post_status'];
+        if ( 'auto-draft' === $post_status || 'inherit' === $post_status ) {
+            return $data;
+        }
+
+        $this->log->trace( "The following data has been received by `wp_insert_post_data`:\n"
+                            . var_export( $data, true ) );
+
+
+        try {
+            $entities = $this->parse_content( wp_unslash( $data['post_content'] ) );
+
+            foreach ( $entities as $entity ) {
+
+                $entity_id = array_key_exists( 'id', $entity ) ? $entity['id'] : '';
+
+                if ( ! $this->entity_id_valid( $entity_id ) ) {
+                    continue;
+                }
+
+                $entity_uris = $this->get_entity_uris( $entity );
+
+                if ( $this->get_first_matching_entity_by_uri( $entity_uris ) === null &&
+                     Post_Entities_Validator::is_local_entity_uri_exist( Wordlift_Entity_Uri_Service::get_instance(), $entity_uris ) ) {
+                    // Skip the entity
+                    continue;
+                }
+
+                // If 'entity auto publish' is false, we set the status to `draft` by default.
+                $post_status = apply_filters( 'wl_feature__enable__entity-auto-publish', true )
+                    ? $data['post_status'] : 'draft';
+                $this->create_or_update_entity( $entity, $post_status );
+
+            }
+
+        } catch ( \Exception $e ) {
+            $this->log->error( $e->getMessage() );
+        }
+
+
+        return $data;
+    }
+
+    /**
+     * Parse the post content to find the `wordlift/classification` block and return the entities' data.
+     *
+     * @param string $post_content The post content.
+     *
+     * @return array An array of entities' structures.
+     * @throws \Exception
+     */
+    private function parse_content( $post_content ) {
+
+        $all_blocks = parse_blocks( $post_content );
+        $this->log->trace( "The following blocks have been parsed while in `wp_insert_post`:\n"
+                            . var_export( $all_blocks, true ) );
+
+        $blocks = array_filter( $all_blocks, function ( $item ) {
+            return ! empty( $item['blockName'] ) && 'wordlift/classification' === $item['blockName'];
+        } );
+
+        // Bail out if the blocks' array is empty.
+        if ( empty( $blocks ) ) {
+            return array();
+        }
+
+        $block = current( $blocks );
+        $this->log->trace( "The following block has been found while in `wp_insert_post`:\n"
+                            . var_export( $block, true ) );
+
+        // Bail out if the entities array is empty.
+        if ( empty( $block['attrs'] ) && empty( $block['attrs']['entities'] ) ) {
+            return array();
+        }
+
+        return $block['attrs']['entities'];
+    }
+
+    /**
+     * Collect entity labels from the entity array.
+     *
+     * This function expects an array with the following keys:
+     *
+     * array(
+     *   'label'       => ...,
+     *   'synonyms'    => array( ... ),
+     *   'annotations' => array(
+     *     ...id...      => array( text => ... ),
+     *   ),
+     *   'occurrences' => array( ... ),
+     * )
+     *
+     * and it is going to output an array with all the labels, keeping the `label` at first position:
+     *
+     * array(
+     *   ...label...,
+     *   ...synonyms...,
+     *   ...texts...,
+     * )
+     *
+     * This function is going to collect the label from the `label` property, from the `synonyms` property and from
+     * `annotations` property. Since the `annotations` property contains all the annotations including those that
+     * haven't been selected, this function is going to only get the `text` for the annotations property listed in
+     * `occurrences`.
+     *
+     * @param array $entity {
+     *  The entity data.
+     *
+     * @type string $label The entity label.
+     * @type array $synonyms The entity synonyms.
+     * @type array $occurrences The selected occurrences.
+     * @type array $annotations The annotations.
+     * }
+     *
+     * @return array An array of labels.
+     */
+    public function get_labels( $entity ) {
+
+        $args = wp_parse_args( $entity, array(
+            'label'       => array(),
+            'synonyms'    => array(),
+            'annotations' => array(),
+            'occurrences' => array(),
+        ) );
+
+        // We gather all the labels, occurrences texts and synonyms into one array.
+        $initial = array_merge(
+            (array) $args['label'],
+            (array) $args['synonyms']
+        );
+
+        $annotations = $args['annotations'];
+
+        return array_reduce( $args['occurrences'], function ( $carry, $item ) use ( $annotations ) {
+
+            // Bail out if occurrences->$item->text isn't set or its contents are already
+            // in `$carry`.
+            if ( ! isset( $annotations[ $item ]['text'] )
+                 || in_array( $annotations[ $item ]['text'], $carry ) ) {
+                return $carry;
+            }
+
+            // Push the label.
+            $carry[] = $annotations[ $item ]['text'];
+
+            return $carry;
+        }, $initial );
+    }
+
+    /**
+     * Create or update the entity.
+     *
+     * An entity lookup is performed on the local vocabulary using the `id` and `sameAs` URIs. If an entity is found
+     * the {@link Entity_Store} update function is called to update the `labels` and the `sameAs` values.
+     *
+     * If an entity is not found the {@link Entity_Store} create function is called to create a new entity.
+     *
+     * @param array $entity {
+     * The entity parameters.
+     *
+     * @type string The entity item id URI.
+     * @type string|array The entity sameAs URI(s).
+     * @type string $description The entity description.
+     * }
+     *
+     * @param       $string $post_status The post status, default 'draft'.
+     *
+     * @return int|\WP_Error
+     * @throws \Exception
+     */
+    private function create_or_update_entity( $entity, $post_status = 'draft' ) {
+
+        // Get only valid IDs.
+        $uris = $this->get_entity_uris( $entity );
+
+        $post = $this->get_first_matching_entity_by_uri( $uris );
+
+        $this->log->trace( 'Entity' . ( empty( $post ) ? ' not' : '' ) . " found with the following URIs:\n"
+                            . var_export( $uris, true ) );
+
+        // Get the labels.
+        $labels = $this->get_labels( $entity );
+
+        if ( empty( $post ) ) {
+            $entity_description = array_key_exists( 'description', $entity ) ? $entity['description'] : '';
+            // Create the entity if it doesn't exist.
+            $post_id = Entity_Store::get_instance()->create( array(
+                'labels'      => $labels,
+                'description' => $entity_description,
+                'same_as'     => $uris,
+            ), $post_status );
+
+            // Return the WP_Error if we got one.
+            if ( is_wp_error( $post_id ) ) {
+                return $post_id;
+            }
+
+            // Add the entity type.
+            if ( isset( $entity['mainType'] ) ) {
+                wp_set_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+            }
+
+            if ( isset( $entity['properties'] ) && isset( $entity['properties']['latitude'] ) && isset( $entity['properties']['longitude'] ) ) {
+                add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude'] );
+                add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude'] );
+            }
+        } else {
+            // Update the entity otherwise.
+            $post_id = Entity_Store::get_instance()->update( array(
+                'ID'      => $post->ID,
+                'labels'  => $labels,
+                'same_as' => $uris,
+            ) );
+
+            // Add the entity type.
+            if ( isset( $entity['mainType'] ) ) {
+                wp_add_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+            }
+
+            // see https://github.com/insideout10/wordlift-plugin/issues/1304
+            // Set the post status, we need to set that in order to support entities
+            // created using rest endpoint on block editor, so that they get published
+            // when the post is published.
+            // Once the entity is published dont update the post status.
+            if ( $post->post_status !== 'publish' ) {
+                wp_update_post( array(
+                    'ID'          => $post->ID,
+                    'post_status' => $post_status
+                ) );
+            }
+        }
+
+        return $post_id;
+    }
+
+    /**
+     * Get the first matching entity for the provided URI array.
+     *
+     * Entities IDs and sameAs are searched.
+     *
+     * @param array $uris An array of URIs.
+     *
+     * @return \WP_Post|null The entity WP_Post if found or null if not found.
+     */
+    private function get_first_matching_entity_by_uri( $uris ) {
+
+        foreach ( $uris as $uri ) {
+
+            $content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+
+            if ( ! $content ) {
+                continue;
+            }
+
+            $existing_entity = $content->get_bag();
+
+            if ( is_a( $existing_entity, 'WP_Post' ) ) {
+                return $existing_entity;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @param $entity
+     *
+     * @return array
+     */
+    private function filter_valid_entity_ids( $entity ) {
+        $id = $entity['id'];
+
+        return array_filter( (array) $id, function ( $id ) {
+            return preg_match( '|^https?://|', $id );
+        } );
+    }
+
+    /**
+     * @param array $entity
+     *
+     * @return array
+     */
+    private function get_entity_uris( $entity ) {
+        $ids     = $this->filter_valid_entity_ids( $entity );
+        $same_as = array_key_exists( 'sameAs', $entity ) ? $entity['sameAs'] : array();
+
+        return array_merge(
+            (array) $ids,
+            (array) $same_as
+        );
+    }
+
+    private function entity_id_valid( $entity_id ) {
+        return preg_match( '#^https?://#i', $entity_id ) === 1;
+    }
 
 }

Spacing +77 added lines, -77 removed lines

@@ -31,14 +31,14 @@ 
 	public function __construct() {
 
 		// Bail out if block editor's functions aren't available.
-		if ( ! function_exists( 'register_block_type' ) || ! function_exists( 'parse_blocks' ) ) {
+		if ( ! function_exists('register_block_type') || ! function_exists('parse_blocks')) {
 			return;
 		}
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = \Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'init', array( $this, 'init' ) );
-		add_filter( 'wp_insert_post_data', array( $this, 'wp_insert_post_data' ), 10, 2 );
+		add_action('init', array($this, 'init'));
+		add_filter('wp_insert_post_data', array($this, 'wp_insert_post_data'), 10, 2);
 
 	}
 
@@ -48,12 +48,12 @@ 
 	 */
 	public function init() {
 
-		register_block_type( 'wordlift/classification', array(
+		register_block_type('wordlift/classification', array(
 			'editor_script' => 'wl-block-editor',
 			'attributes'    => array(
-				'entities' => array( 'type' => 'array' ),
+				'entities' => array('type' => 'array'),
 			),
-		) );
+		));
 
 	}
 
@@ -87,45 +87,45 @@ 
 	 *
 	 * @return array The data array.
 	 */
-	public function wp_insert_post_data( $data, $postarr ) {
+	public function wp_insert_post_data($data, $postarr) {
 
 		$post_status = $data['post_status'];
-		if ( 'auto-draft' === $post_status || 'inherit' === $post_status ) {
+		if ('auto-draft' === $post_status || 'inherit' === $post_status) {
 			return $data;
 		}
 
-		$this->log->trace( "The following data has been received by `wp_insert_post_data`:\n"
-		                   . var_export( $data, true ) );
+		$this->log->trace("The following data has been received by `wp_insert_post_data`:\n"
+		                   . var_export($data, true));
 
 
 		try {
-			$entities = $this->parse_content( wp_unslash( $data['post_content'] ) );
+			$entities = $this->parse_content(wp_unslash($data['post_content']));
 
-			foreach ( $entities as $entity ) {
+			foreach ($entities as $entity) {
 
-				$entity_id = array_key_exists( 'id', $entity ) ? $entity['id'] : '';
+				$entity_id = array_key_exists('id', $entity) ? $entity['id'] : '';
 
-				if ( ! $this->entity_id_valid( $entity_id ) ) {
+				if ( ! $this->entity_id_valid($entity_id)) {
 					continue;
 				}
 
-				$entity_uris = $this->get_entity_uris( $entity );
+				$entity_uris = $this->get_entity_uris($entity);
 
-				if ( $this->get_first_matching_entity_by_uri( $entity_uris ) === null &&
-				     Post_Entities_Validator::is_local_entity_uri_exist( Wordlift_Entity_Uri_Service::get_instance(), $entity_uris ) ) {
+				if ($this->get_first_matching_entity_by_uri($entity_uris) === null &&
+				     Post_Entities_Validator::is_local_entity_uri_exist(Wordlift_Entity_Uri_Service::get_instance(), $entity_uris)) {
 					// Skip the entity
 					continue;
 				}
 
 				// If 'entity auto publish' is false, we set the status to `draft` by default.
-				$post_status = apply_filters( 'wl_feature__enable__entity-auto-publish', true )
+				$post_status = apply_filters('wl_feature__enable__entity-auto-publish', true)
 					? $data['post_status'] : 'draft';
-				$this->create_or_update_entity( $entity, $post_status );
+				$this->create_or_update_entity($entity, $post_status);
 
 			}
 
-		} catch ( \Exception $e ) {
-			$this->log->error( $e->getMessage() );
+		} catch (\Exception $e) {
+			$this->log->error($e->getMessage());
 		}
 
 
@@ -140,27 +140,27 @@ 
 	 * @return array An array of entities' structures.
 	 * @throws \Exception
 	 */
-	private function parse_content( $post_content ) {
+	private function parse_content($post_content) {
 
-		$all_blocks = parse_blocks( $post_content );
-		$this->log->trace( "The following blocks have been parsed while in `wp_insert_post`:\n"
-		                   . var_export( $all_blocks, true ) );
+		$all_blocks = parse_blocks($post_content);
+		$this->log->trace("The following blocks have been parsed while in `wp_insert_post`:\n"
+		                   . var_export($all_blocks, true));
 
-		$blocks = array_filter( $all_blocks, function ( $item ) {
-			return ! empty( $item['blockName'] ) && 'wordlift/classification' === $item['blockName'];
+		$blocks = array_filter($all_blocks, function($item) {
+			return ! empty($item['blockName']) && 'wordlift/classification' === $item['blockName'];
 		} );
 
 		// Bail out if the blocks' array is empty.
-		if ( empty( $blocks ) ) {
+		if (empty($blocks)) {
 			return array();
 		}
 
-		$block = current( $blocks );
-		$this->log->trace( "The following block has been found while in `wp_insert_post`:\n"
-		                   . var_export( $block, true ) );
+		$block = current($blocks);
+		$this->log->trace("The following block has been found while in `wp_insert_post`:\n"
+		                   . var_export($block, true));
 
 		// Bail out if the entities array is empty.
-		if ( empty( $block['attrs'] ) && empty( $block['attrs']['entities'] ) ) {
+		if (empty($block['attrs']) && empty($block['attrs']['entities'])) {
 			return array();
 		}
 
@@ -205,14 +205,14 @@ 
 	 *
 	 * @return array An array of labels.
 	 */
-	public function get_labels( $entity ) {
+	public function get_labels($entity) {
 
-		$args = wp_parse_args( $entity, array(
+		$args = wp_parse_args($entity, array(
 			'label'       => array(),
 			'synonyms'    => array(),
 			'annotations' => array(),
 			'occurrences' => array(),
-		) );
+		));
 
 		// We gather all the labels, occurrences texts and synonyms into one array.
 		$initial = array_merge(
@@ -222,20 +222,20 @@ 
 
 		$annotations = $args['annotations'];
 
-		return array_reduce( $args['occurrences'], function ( $carry, $item ) use ( $annotations ) {
+		return array_reduce($args['occurrences'], function($carry, $item) use ($annotations) {
 
 			// Bail out if occurrences->$item->text isn't set or its contents are already
 			// in `$carry`.
-			if ( ! isset( $annotations[ $item ]['text'] )
-			     || in_array( $annotations[ $item ]['text'], $carry ) ) {
+			if ( ! isset($annotations[$item]['text'])
+			     || in_array($annotations[$item]['text'], $carry)) {
 				return $carry;
 			}
 
 			// Push the label.
-			$carry[] = $annotations[ $item ]['text'];
+			$carry[] = $annotations[$item]['text'];
 
 			return $carry;
-		}, $initial );
+		}, $initial);
 	}
 
 	/**
@@ -259,53 +259,53 @@ 
 	 * @return int|\WP_Error
 	 * @throws \Exception
 	 */
-	private function create_or_update_entity( $entity, $post_status = 'draft' ) {
+	private function create_or_update_entity($entity, $post_status = 'draft') {
 
 		// Get only valid IDs.
-		$uris = $this->get_entity_uris( $entity );
+		$uris = $this->get_entity_uris($entity);
 
-		$post = $this->get_first_matching_entity_by_uri( $uris );
+		$post = $this->get_first_matching_entity_by_uri($uris);
 
-		$this->log->trace( 'Entity' . ( empty( $post ) ? ' not' : '' ) . " found with the following URIs:\n"
-		                   . var_export( $uris, true ) );
+		$this->log->trace('Entity'.(empty($post) ? ' not' : '')." found with the following URIs:\n"
+		                   . var_export($uris, true));
 
 		// Get the labels.
-		$labels = $this->get_labels( $entity );
+		$labels = $this->get_labels($entity);
 
-		if ( empty( $post ) ) {
-			$entity_description = array_key_exists( 'description', $entity ) ? $entity['description'] : '';
+		if (empty($post)) {
+			$entity_description = array_key_exists('description', $entity) ? $entity['description'] : '';
 			// Create the entity if it doesn't exist.
-			$post_id = Entity_Store::get_instance()->create( array(
+			$post_id = Entity_Store::get_instance()->create(array(
 				'labels'      => $labels,
 				'description' => $entity_description,
 				'same_as'     => $uris,
-			), $post_status );
+			), $post_status);
 
 			// Return the WP_Error if we got one.
-			if ( is_wp_error( $post_id ) ) {
+			if (is_wp_error($post_id)) {
 				return $post_id;
 			}
 
 			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_set_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+			if (isset($entity['mainType'])) {
+				wp_set_object_terms($post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 			}
 
-			if ( isset( $entity['properties'] ) && isset( $entity['properties']['latitude'] ) && isset( $entity['properties']['longitude'] ) ) {
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude'] );
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude'] );
+			if (isset($entity['properties']) && isset($entity['properties']['latitude']) && isset($entity['properties']['longitude'])) {
+				add_post_meta($post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude']);
+				add_post_meta($post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude']);
 			}
 		} else {
 			// Update the entity otherwise.
-			$post_id = Entity_Store::get_instance()->update( array(
+			$post_id = Entity_Store::get_instance()->update(array(
 				'ID'      => $post->ID,
 				'labels'  => $labels,
 				'same_as' => $uris,
-			) );
+			));
 
 			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_add_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+			if (isset($entity['mainType'])) {
+				wp_add_object_terms($post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 			}
 
 			// see https://github.com/insideout10/wordlift-plugin/issues/1304
@@ -313,11 +313,11 @@ 
 			// created using rest endpoint on block editor, so that they get published
 			// when the post is published.
 			// Once the entity is published dont update the post status.
-			if ( $post->post_status !== 'publish' ) {
-				wp_update_post( array(
+			if ($post->post_status !== 'publish') {
+				wp_update_post(array(
 					'ID'          => $post->ID,
 					'post_status' => $post_status
-				) );
+				));
 			}
 		}
 
@@ -333,19 +333,19 @@ 
 	 *
 	 * @return \WP_Post|null The entity WP_Post if found or null if not found.
 	 */
-	private function get_first_matching_entity_by_uri( $uris ) {
+	private function get_first_matching_entity_by_uri($uris) {
 
-		foreach ( $uris as $uri ) {
+		foreach ($uris as $uri) {
 
-			$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+			$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as($uri);
 
-			if ( ! $content ) {
+			if ( ! $content) {
 				continue;
 			}
 
 			$existing_entity = $content->get_bag();
 
-			if ( is_a( $existing_entity, 'WP_Post' ) ) {
+			if (is_a($existing_entity, 'WP_Post')) {
 				return $existing_entity;
 			}
 		}
@@ -358,11 +358,11 @@ 
 	 *
 	 * @return array
 	 */
-	private function filter_valid_entity_ids( $entity ) {
+	private function filter_valid_entity_ids($entity) {
 		$id = $entity['id'];
 
-		return array_filter( (array) $id, function ( $id ) {
-			return preg_match( '|^https?://|', $id );
+		return array_filter((array) $id, function($id) {
+			return preg_match('|^https?://|', $id);
 		} );
 	}
 
@@ -371,9 +371,9 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_entity_uris( $entity ) {
-		$ids     = $this->filter_valid_entity_ids( $entity );
-		$same_as = array_key_exists( 'sameAs', $entity ) ? $entity['sameAs'] : array();
+	private function get_entity_uris($entity) {
+		$ids     = $this->filter_valid_entity_ids($entity);
+		$same_as = array_key_exists('sameAs', $entity) ? $entity['sameAs'] : array();
 
 		return array_merge(
 			(array) $ids,
@@ -381,8 +381,8 @@ 
 		);
 	}
 
-	private function entity_id_valid( $entity_id ) {
-		return preg_match( '#^https?://#i', $entity_id ) === 1;
+	private function entity_id_valid($entity_id) {
+		return preg_match('#^https?://#i', $entity_id) === 1;
 	}
 
 }

src/wordlift/vocabulary/class-analysis-service.php

Indentation +142 added lines, -142 removed lines

@@ -13,184 +13,184 @@
  */
 class Analysis_Service {
 
-	/**
-	 * @var Default_Api_Service
-	 */
-	private $api_service;
-	/**
-	 * @var Cache
-	 */
-	private $cache_service;
-	/**
-	 * @var \Wordlift_Log_Service
-	 */
-	private $log;
+    /**
+     * @var Default_Api_Service
+     */
+    private $api_service;
+    /**
+     * @var Cache
+     */
+    private $cache_service;
+    /**
+     * @var \Wordlift_Log_Service
+     */
+    private $log;
 
 
-	/**
-	 * Tag_Rest_Endpoint constructor.
-	 *
-	 * @param Default_Api_Service $api_service
-	 * @param Cache $cache_service
-	 */
-	public function __construct( $api_service, $cache_service ) {
+    /**
+     * Tag_Rest_Endpoint constructor.
+     *
+     * @param Default_Api_Service $api_service
+     * @param Cache $cache_service
+     */
+    public function __construct( $api_service, $cache_service ) {
 
-		$this->api_service = $api_service;
+        $this->api_service = $api_service;
 
-		$this->cache_service = $cache_service;
+        $this->cache_service = $cache_service;
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+        $this->log = \Wordlift_Log_Service::get_logger( get_class() );
 
-	}
+    }
 
 
-	/**
-	 * Check if entities are in cache, if not return the results from
-	 * cache service.
-	 *
-	 * @param $tag \WP_Term
-	 */
-	public function get_entities( $tag ) {
+    /**
+     * Check if entities are in cache, if not return the results from
+     * cache service.
+     *
+     * @param $tag \WP_Term
+     */
+    public function get_entities( $tag ) {
 
-		$cache_key    = $tag->term_id;
-		$cache_result = $this->cache_service->get( $cache_key );
-		if ( $cache_result !== false ) {
-			return $cache_result;
-		}
+        $cache_key    = $tag->term_id;
+        $cache_result = $this->cache_service->get( $cache_key );
+        if ( $cache_result !== false ) {
+            return $cache_result;
+        }
 
-		// send the request.
-		$tag_name = $tag->name;
+        // send the request.
+        $tag_name = $tag->name;
 
-		$entities = $this->get_entities_by_search_query( $tag_name );
+        $entities = $this->get_entities_by_search_query( $tag_name );
 
-		if ( ! $entities ) {
-			return false;
-		}
-
-		$this->cache_service->put( $cache_key, $entities );
-
-		return $entities;
-
-	}
-
-
-	/**
-	 * @param $entity_url string
-	 * Formats the entity url from https://foo.com/some/path to
-	 * https/foo.com/some/path
-	 *
-	 * @return bool|string
-	 */
-	public static function format_entity_url( $entity_url ) {
-		$result = parse_url( $entity_url );
-		if ( ! $result ) {
-			return false;
-		}
-		if ( ! array_key_exists( 'scheme', $result )
-		     || ! array_key_exists( 'host', $result )
-		     || ! array_key_exists( 'path', $result ) ) {
-			return false;
-		}
+        if ( ! $entities ) {
+            return false;
+        }
+
+        $this->cache_service->put( $cache_key, $entities );
+
+        return $entities;
+
+    }
+
+
+    /**
+     * @param $entity_url string
+     * Formats the entity url from https://foo.com/some/path to
+     * https/foo.com/some/path
+     *
+     * @return bool|string
+     */
+    public static function format_entity_url( $entity_url ) {
+        $result = parse_url( $entity_url );
+        if ( ! $result ) {
+            return false;
+        }
+        if ( ! array_key_exists( 'scheme', $result )
+             || ! array_key_exists( 'host', $result )
+             || ! array_key_exists( 'path', $result ) ) {
+            return false;
+        }
 
-		return $result['scheme'] . "/" . $result['host'] . $result['path'];
-	}
+        return $result['scheme'] . "/" . $result['host'] . $result['path'];
+    }
 
-	private function get_meta( $entity_url ) {
+    private function get_meta( $entity_url ) {
 
 
-		$cache_results = $this->cache_service->get( $entity_url );
+        $cache_results = $this->cache_service->get( $entity_url );
 
-		if ( $cache_results !== false ) {
-			return $cache_results;
-		}
+        if ( $cache_results !== false ) {
+            return $cache_results;
+        }
 
-		$formatted_url = self::format_entity_url( $entity_url );
+        $formatted_url = self::format_entity_url( $entity_url );
 
-		if ( ! $formatted_url ) {
-			return array();
-		}
+        if ( ! $formatted_url ) {
+            return array();
+        }
 
-		$meta_url = 'https://api.wordlift.io/id/' . $formatted_url;
+        $meta_url = 'https://api.wordlift.io/id/' . $formatted_url;
 
-		$response = wp_remote_get( $meta_url );
+        $response = wp_remote_get( $meta_url );
 
-		if ( is_wp_error( $response )
-		     || ! isset( $response['response']['code'] )
-		     || 2 !== (int) $response['response']['code'] / 100 ) {
-			return false;
-		}
+        if ( is_wp_error( $response )
+             || ! isset( $response['response']['code'] )
+             || 2 !== (int) $response['response']['code'] / 100 ) {
+            return false;
+        }
 
-		$this->log->debug( "Requesting entity data for url :" . $meta_url );
-		$this->log->debug( "Got entity meta data as : " );
-		$this->log->debug( var_export( $response, true ) );
-		if ( ! is_wp_error( $response ) ) {
-			$meta = json_decode( wp_remote_retrieve_body( $response ), true );
-			$this->log->debug( "Saved entity data to meta :" );
-			$this->log->debug( var_export( $meta, true ) );
-			$this->cache_service->put( $entity_url, $meta );
+        $this->log->debug( "Requesting entity data for url :" . $meta_url );
+        $this->log->debug( "Got entity meta data as : " );
+        $this->log->debug( var_export( $response, true ) );
+        if ( ! is_wp_error( $response ) ) {
+            $meta = json_decode( wp_remote_retrieve_body( $response ), true );
+            $this->log->debug( "Saved entity data to meta :" );
+            $this->log->debug( var_export( $meta, true ) );
+            $this->cache_service->put( $entity_url, $meta );
 
-			return $meta;
-		}
+            return $meta;
+        }
 
 
-		return array();
+        return array();
 
-	}
+    }
 
-	private function get_meta_for_entities( $entities ) {
+    private function get_meta_for_entities( $entities ) {
 
-		$filtered_entities = array();
-		foreach ( $entities as $entity ) {
-			$entity['meta'] = array();
-			$meta           = $this->get_meta( $entity['entityId'] );
-			if ( $meta ) {
-				$meta                = Default_Entity_List::compact_jsonld( $meta );
-				$entity['meta']      = $meta;
-				$filtered_entities[] = $entity;
-			}
-		}
-		$this->log->debug( "Returning filtered entities as" );
-		$this->log->debug( var_export( $filtered_entities, true ) );
+        $filtered_entities = array();
+        foreach ( $entities as $entity ) {
+            $entity['meta'] = array();
+            $meta           = $this->get_meta( $entity['entityId'] );
+            if ( $meta ) {
+                $meta                = Default_Entity_List::compact_jsonld( $meta );
+                $entity['meta']      = $meta;
+                $filtered_entities[] = $entity;
+            }
+        }
+        $this->log->debug( "Returning filtered entities as" );
+        $this->log->debug( var_export( $filtered_entities, true ) );
 
-		return $filtered_entities;
+        return $filtered_entities;
 
-	}
+    }
 
-	/**
-	 * @param $tag_name
-	 *
-	 * @return array
-	 */
-	public function get_entities_by_search_query( $tag_name ) {
-		$response = $this->api_service->request(
-			'POST',
-			"/analysis/single",
-			array( 'Content-Type' => 'application/json' ),
-			wp_json_encode( array(
-				"content"         => $tag_name,
-				"contentType"     => "text/plain",
-				"version"         => "1.0.0",
-				"contentLanguage" => "en",
-				"scope"           => "all",
-			) )
-		);
-
-
-		if ( ! $response->is_success() ) {
-			return false;
-		}
-
-		$response = json_decode( $response->get_body(), true );
+    /**
+     * @param $tag_name
+     *
+     * @return array
+     */
+    public function get_entities_by_search_query( $tag_name ) {
+        $response = $this->api_service->request(
+            'POST',
+            "/analysis/single",
+            array( 'Content-Type' => 'application/json' ),
+            wp_json_encode( array(
+                "content"         => $tag_name,
+                "contentType"     => "text/plain",
+                "version"         => "1.0.0",
+                "contentLanguage" => "en",
+                "scope"           => "all",
+            ) )
+        );
+
+
+        if ( ! $response->is_success() ) {
+            return false;
+        }
+
+        $response = json_decode( $response->get_body(), true );
 
-		if ( ! array_key_exists( 'entities', $response ) ) {
-			return false;
-		}
+        if ( ! array_key_exists( 'entities', $response ) ) {
+            return false;
+        }
 
 
-		$entities = $this->get_meta_for_entities( $response['entities'] );
+        $entities = $this->get_meta_for_entities( $response['entities'] );
 
-		return $entities;
-	}
+        return $entities;
+    }
 
 
 }

Spacing +48 added lines, -48 removed lines

@@ -33,13 +33,13 @@ 
 	 * @param Default_Api_Service $api_service
 	 * @param Cache $cache_service
 	 */
-	public function __construct( $api_service, $cache_service ) {
+	public function __construct($api_service, $cache_service) {
 
 		$this->api_service = $api_service;
 
 		$this->cache_service = $cache_service;
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = \Wordlift_Log_Service::get_logger(get_class());
 
 	}
 
@@ -50,24 +50,24 @@ 
 	 *
 	 * @param $tag \WP_Term
 	 */
-	public function get_entities( $tag ) {
+	public function get_entities($tag) {
 
 		$cache_key    = $tag->term_id;
-		$cache_result = $this->cache_service->get( $cache_key );
-		if ( $cache_result !== false ) {
+		$cache_result = $this->cache_service->get($cache_key);
+		if ($cache_result !== false) {
 			return $cache_result;
 		}
 
 		// send the request.
 		$tag_name = $tag->name;
 
-		$entities = $this->get_entities_by_search_query( $tag_name );
+		$entities = $this->get_entities_by_search_query($tag_name);
 
-		if ( ! $entities ) {
+		if ( ! $entities) {
 			return false;
 		}
 
-		$this->cache_service->put( $cache_key, $entities );
+		$this->cache_service->put($cache_key, $entities);
 
 		return $entities;
 
@@ -81,53 +81,53 @@ 
 	 *
 	 * @return bool|string
 	 */
-	public static function format_entity_url( $entity_url ) {
-		$result = parse_url( $entity_url );
-		if ( ! $result ) {
+	public static function format_entity_url($entity_url) {
+		$result = parse_url($entity_url);
+		if ( ! $result) {
 			return false;
 		}
-		if ( ! array_key_exists( 'scheme', $result )
-		     || ! array_key_exists( 'host', $result )
-		     || ! array_key_exists( 'path', $result ) ) {
+		if ( ! array_key_exists('scheme', $result)
+		     || ! array_key_exists('host', $result)
+		     || ! array_key_exists('path', $result)) {
 			return false;
 		}
 
-		return $result['scheme'] . "/" . $result['host'] . $result['path'];
+		return $result['scheme']."/".$result['host'].$result['path'];
 	}
 
-	private function get_meta( $entity_url ) {
+	private function get_meta($entity_url) {
 
 
-		$cache_results = $this->cache_service->get( $entity_url );
+		$cache_results = $this->cache_service->get($entity_url);
 
-		if ( $cache_results !== false ) {
+		if ($cache_results !== false) {
 			return $cache_results;
 		}
 
-		$formatted_url = self::format_entity_url( $entity_url );
+		$formatted_url = self::format_entity_url($entity_url);
 
-		if ( ! $formatted_url ) {
+		if ( ! $formatted_url) {
 			return array();
 		}
 
-		$meta_url = 'https://api.wordlift.io/id/' . $formatted_url;
+		$meta_url = 'https://api.wordlift.io/id/'.$formatted_url;
 
-		$response = wp_remote_get( $meta_url );
+		$response = wp_remote_get($meta_url);
 
-		if ( is_wp_error( $response )
-		     || ! isset( $response['response']['code'] )
-		     || 2 !== (int) $response['response']['code'] / 100 ) {
+		if (is_wp_error($response)
+		     || ! isset($response['response']['code'])
+		     || 2 !== (int) $response['response']['code'] / 100) {
 			return false;
 		}
 
-		$this->log->debug( "Requesting entity data for url :" . $meta_url );
-		$this->log->debug( "Got entity meta data as : " );
-		$this->log->debug( var_export( $response, true ) );
-		if ( ! is_wp_error( $response ) ) {
-			$meta = json_decode( wp_remote_retrieve_body( $response ), true );
-			$this->log->debug( "Saved entity data to meta :" );
-			$this->log->debug( var_export( $meta, true ) );
-			$this->cache_service->put( $entity_url, $meta );
+		$this->log->debug("Requesting entity data for url :".$meta_url);
+		$this->log->debug("Got entity meta data as : ");
+		$this->log->debug(var_export($response, true));
+		if ( ! is_wp_error($response)) {
+			$meta = json_decode(wp_remote_retrieve_body($response), true);
+			$this->log->debug("Saved entity data to meta :");
+			$this->log->debug(var_export($meta, true));
+			$this->cache_service->put($entity_url, $meta);
 
 			return $meta;
 		}
@@ -137,20 +137,20 @@ 
 
 	}
 
-	private function get_meta_for_entities( $entities ) {
+	private function get_meta_for_entities($entities) {
 
 		$filtered_entities = array();
-		foreach ( $entities as $entity ) {
+		foreach ($entities as $entity) {
 			$entity['meta'] = array();
-			$meta           = $this->get_meta( $entity['entityId'] );
-			if ( $meta ) {
-				$meta                = Default_Entity_List::compact_jsonld( $meta );
+			$meta           = $this->get_meta($entity['entityId']);
+			if ($meta) {
+				$meta                = Default_Entity_List::compact_jsonld($meta);
 				$entity['meta']      = $meta;
 				$filtered_entities[] = $entity;
 			}
 		}
-		$this->log->debug( "Returning filtered entities as" );
-		$this->log->debug( var_export( $filtered_entities, true ) );
+		$this->log->debug("Returning filtered entities as");
+		$this->log->debug(var_export($filtered_entities, true));
 
 		return $filtered_entities;
 
@@ -161,33 +161,33 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_entities_by_search_query( $tag_name ) {
+	public function get_entities_by_search_query($tag_name) {
 		$response = $this->api_service->request(
 			'POST',
 			"/analysis/single",
-			array( 'Content-Type' => 'application/json' ),
-			wp_json_encode( array(
+			array('Content-Type' => 'application/json'),
+			wp_json_encode(array(
 				"content"         => $tag_name,
 				"contentType"     => "text/plain",
 				"version"         => "1.0.0",
 				"contentLanguage" => "en",
 				"scope"           => "all",
-			) )
+			))
 		);
 
 
-		if ( ! $response->is_success() ) {
+		if ( ! $response->is_success()) {
 			return false;
 		}
 
-		$response = json_decode( $response->get_body(), true );
+		$response = json_decode($response->get_body(), true);
 
-		if ( ! array_key_exists( 'entities', $response ) ) {
+		if ( ! array_key_exists('entities', $response)) {
 			return false;
 		}
 
 
-		$entities = $this->get_meta_for_entities( $response['entities'] );
+		$entities = $this->get_meta_for_entities($response['entities']);
 
 		return $entities;
 	}

src/admin/class-wordlift-admin-settings-page.php

Indentation +388 added lines, -388 removed lines

@@ -18,393 +18,393 @@
  */
 class Wordlift_Admin_Settings_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Input_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
-	 */
-	private $input_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 *
-	 * @since  3.13.0
-	 * @access protected
-	 * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 */
-	private $radio_input_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 */
-	private $language_select_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 *
-	 * @since  3.18.0
-	 * @access private
-	 * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 */
-	private $country_select_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 */
-	private $publisher_element;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Settings_Page} instance.
-	 *
-	 * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Admin_Input_Element $input_element A {@link Wordlift_Admin_Input_Element} element renderer.
-	 * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 * @param \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 * @param \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 *
-	 * @since 3.11.0
-	 *
-	 */
-	public function __construct( $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
-
-		$this->entity_service = $entity_service;
-
-		// Set a reference to the UI elements.
-		$this->input_element           = $input_element;
-		$this->radio_input_element     = $radio_input_element;
-		$this->language_select_element = $language_select_element;
-		$this->country_select_element  = $country_select_element;
-		$this->publisher_element       = $publisher_element;
-
-	}
-
-	private static $instance;
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
-	 * @since 3.14.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			$publisher_element = new Wordlift_Admin_Publisher_Element(
-				Wordlift_Publisher_Service::get_instance(),
-				new Wordlift_Admin_Tabs_Element(),
-				new Wordlift_Admin_Select2_Element() );
-
-			self::$instance = new self(
-				Wordlift_Entity_Service::get_instance(),
-				new Wordlift_Admin_Input_Element(),
-				new Wordlift_Admin_Language_Select_Element(),
-				new Wordlift_Admin_Country_Select_Element(),
-				$publisher_element,
-				new Wordlift_Admin_Radio_Input_Element() );
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_page_title() {
-
-		return 'WordLift Settings';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_menu_title() {
-
-		return 'Settings';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_menu_slug() {
-
-		return 'wl_configuration_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_partial_name() {
-
-		return 'wordlift-admin-settings-page.php';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function enqueue_scripts() {
-
-		// Enqueue the media scripts to be used for the publisher's logo selection.
-		wp_enqueue_media();
-
-		// JavaScript required for the settings page.
-		// @todo: try to move to the `wordlift-admin.bundle.js`.
-		wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.js', array( 'wp-util' ) );
-		wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.css' );
-
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.11.0
-	 */
-	function admin_init() {
-		// Register WordLift's general settings, providing our own sanitize callback
-		// which will also check whether the user filled the WL Publisher form.
-		register_setting(
-			'wl_general_settings',
-			'wl_general_settings',
-			array( $this, 'sanitize_callback' )
-		);
-
-		// Add the general settings section.
-		add_settings_section(
-			'wl_general_settings_section', // ID used to identify this section and with which to register options.
-			'',                            // Section header.
-			'',                            // Callback used to render the description of the section.
-			'wl_general_settings'          // Page on which to add this section of options.
-		);
-
-		$key_args = array(
-			'id'          => 'wl-key',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
-			'value'       => Wordlift_Configuration_Service::get_instance()->get_key(),
-			'description' => __( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' )
-			                 . ' [' . get_option( 'home' ) . ']',
-		);
-
-		// Before we were used to validate the key beforehand, but this means
-		// an http call whenever a page is opened in the admin area. Therefore
-		// we now leave the input `untouched`, leaving to the client to update
-		// the `css_class`.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/669.
-		$key_args['css_class'] = 'untouched';
-
-		// Add the `key` field.
-		add_settings_field(
-			'wl-key',                                       // Element id used to identify the field throughout the theme.
-			__( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
-			// The name of the function responsible for rendering the option interface.
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',                          // The page on which this option will be displayed.
-			'wl_general_settings_section',                  // The name of the section to which this field belongs.
-			$key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
-		);
-
-		// Entity Base Path input.
-		$entity_base_path_args = array(
-			// The array of arguments to pass to the callback. In this case, just a description.
-			'id'          => 'wl-entity-base-path',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
-			'value'       => Wordlift_Configuration_Service::get_instance()->get_entity_base_path(),
-			/* translators: Placeholders: %s - a link to FAQ's page. */
-			'description' => sprintf( __( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
-		);
-
-		// The following call is very heavy on large web sites and is always run
-		// also when not needed:
-		// $entity_base_path_args['readonly'] = 0 < $this->entity_service->count();
-		//
-		// It is now replaced by a filter to add the `readonly` flag to the
-		// input element when this is actually rendered.
-		add_filter( 'wl_admin_input_element_params', array(
-			$this,
-			'entity_path_input_element_params',
-		) );
-
-		// Add the `wl_entity_base_path` field.
-		add_settings_field(
-			'wl-entity-base-path',                                // ID used to identify the field throughout the theme
-			__( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
-			// The name of the function responsible for rendering the option interface
-			array( $this->input_element, 'render', ),
-			'wl_general_settings',                                // The page on which this option will be displayed
-			'wl_general_settings_section',                        // The name of the section to which this field belongs
-			$entity_base_path_args
-		);
-
-
-		$language_name = Wordlift_Languages::get_language_name(
-			Wordlift_Configuration_Service::get_instance()->get_language_code()
-		);
-
-		// Add the `language_name` field.
-		add_settings_field(
-			'wl-site-language',
-			__( 'Site Language', 'wordlift' ),
-			function () use ( $language_name ) {
-				echo sprintf( '<p><label>%s</label></p>', esc_html( $language_name ) );
-				echo sprintf( __( '<br/><p>WordLift uses the site language, You can change the language from <a href="%s">settings.</a></p>', 'wordlift' ),
-					admin_url( 'options-general.php#WPLANG' )
-				);
-			},
-			'wl_general_settings',
-			'wl_general_settings_section'
-		);
-
-		// Add the `country_code` field.
-		add_settings_field(
-			'wl-country-code',
-			_x( 'Country', 'wordlift' ),
-			array( $this->country_select_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-country-code',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::COUNTRY_CODE . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_country_code(),
-				'description' => __( 'Please select a country.', 'wordlift' ),
-				'notice'      => __( 'The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift' ),
-			)
-		);
-
-		// Add the `publisher` field.
-		add_settings_field(
-			'wl-publisher-id',
-			__( 'Publisher', 'wordlift' ),
-			array( $this->publisher_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'   => 'wl-publisher-id',
-				'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
-			)
-		);
-
-		// Add the `link by default` field.
-		add_settings_field(
-			'wl-link-by-default',
-			__( 'Link by Default', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-link-by-default',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->is_link_by_default() ? 'yes' : 'no',
-				'description' => __( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
-			)
-		);
-
-		// Add the `diagnostic data` field.
-		add_settings_field(
-			'wl-send-diagnostic',
-			__( 'Send Diagnostic Data', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-send-diagnostic',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::SEND_DIAGNOSTIC . ']',
-				'value'       => 'yes' === Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences() ? 'yes' : 'no',
-				'description' => __( 'Whether to send diagnostic data or not.', 'wordlift' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Filter the {@link Wordlift_Admin_Input_Element} in order to add the
-	 * `readonly` flag to the `wl-entity-base-path` input.
-	 *
-	 * @param array $args An array of {@link Wordlift_Admin_Input_Element} parameters.
-	 *
-	 * @return array The updated array.
-	 * @since 3.17.0
-	 *
-	 */
-	public function entity_path_input_element_params( $args ) {
-
-		// Bail out if it's not the `wl-entity-base-path`).
-		if ( 'wl-entity-base-path' !== $args['id'] ) {
-			return $args;
-		}
-
-		// Set the readonly flag according to the entities count.
-		$args['readonly'] = 0 < $this->entity_service->count();
-
-		// Return the updated args.
-		return $args;
-	}
-
-	/**
-	 * Sanitize the configuration settings to be stored.
-	 *
-	 * If a new entity is being created for the publisher, create it and set The
-	 * publisher setting.
-	 *
-	 * @param array $input The configuration settings array.
-	 *
-	 * @return array The sanitized input array.
-	 * @since 3.11.0
-	 *
-	 */
-	function sanitize_callback( $input ) {
-
-		// Check whether a publisher name has been set.
-		if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { // WPCS: CSRF, input var, sanitization ok.
-			$name         = isset( $_POST['wl_publisher']['name'] ) ? (string) $_POST['wl_publisher']['name'] : '';
-			$type         = isset( $_POST['wl_publisher']['type'] ) ? (string) $_POST['wl_publisher']['type'] : '';
-			$thumbnail_id = isset( $_POST['wl_publisher']['thumbnail_id'] ) ? $_POST['wl_publisher']['thumbnail_id'] : null; // WPCS: CSRF, input var, sanitization ok.
-
-			// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-			$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
-
-			// Create an entity for the publisher and assign it to the input
-			// parameter which WordPress automatically saves into the settings.
-			$input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
-		}
-
-		return $input;
-	}
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Admin_Input_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
+     */
+    private $input_element;
+
+    /**
+     * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     *
+     * @since  3.13.0
+     * @access protected
+     * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     */
+    private $radio_input_element;
+
+    /**
+     * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     */
+    private $language_select_element;
+
+    /**
+     * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     *
+     * @since  3.18.0
+     * @access private
+     * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     */
+    private $country_select_element;
+
+    /**
+     * A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     */
+    private $publisher_element;
+
+    /**
+     * Create a {@link Wordlift_Admin_Settings_Page} instance.
+     *
+     * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Admin_Input_Element $input_element A {@link Wordlift_Admin_Input_Element} element renderer.
+     * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     * @param \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     * @param \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     *
+     * @since 3.11.0
+     *
+     */
+    public function __construct( $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
+
+        $this->entity_service = $entity_service;
+
+        // Set a reference to the UI elements.
+        $this->input_element           = $input_element;
+        $this->radio_input_element     = $radio_input_element;
+        $this->language_select_element = $language_select_element;
+        $this->country_select_element  = $country_select_element;
+        $this->publisher_element       = $publisher_element;
+
+    }
+
+    private static $instance;
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+     * @since 3.14.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            $publisher_element = new Wordlift_Admin_Publisher_Element(
+                Wordlift_Publisher_Service::get_instance(),
+                new Wordlift_Admin_Tabs_Element(),
+                new Wordlift_Admin_Select2_Element() );
+
+            self::$instance = new self(
+                Wordlift_Entity_Service::get_instance(),
+                new Wordlift_Admin_Input_Element(),
+                new Wordlift_Admin_Language_Select_Element(),
+                new Wordlift_Admin_Country_Select_Element(),
+                $publisher_element,
+                new Wordlift_Admin_Radio_Input_Element() );
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_page_title() {
+
+        return 'WordLift Settings';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_menu_title() {
+
+        return 'Settings';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_menu_slug() {
+
+        return 'wl_configuration_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_partial_name() {
+
+        return 'wordlift-admin-settings-page.php';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function enqueue_scripts() {
+
+        // Enqueue the media scripts to be used for the publisher's logo selection.
+        wp_enqueue_media();
+
+        // JavaScript required for the settings page.
+        // @todo: try to move to the `wordlift-admin.bundle.js`.
+        wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.js', array( 'wp-util' ) );
+        wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.css' );
+
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.11.0
+     */
+    function admin_init() {
+        // Register WordLift's general settings, providing our own sanitize callback
+        // which will also check whether the user filled the WL Publisher form.
+        register_setting(
+            'wl_general_settings',
+            'wl_general_settings',
+            array( $this, 'sanitize_callback' )
+        );
+
+        // Add the general settings section.
+        add_settings_section(
+            'wl_general_settings_section', // ID used to identify this section and with which to register options.
+            '',                            // Section header.
+            '',                            // Callback used to render the description of the section.
+            'wl_general_settings'          // Page on which to add this section of options.
+        );
+
+        $key_args = array(
+            'id'          => 'wl-key',
+            'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
+            'value'       => Wordlift_Configuration_Service::get_instance()->get_key(),
+            'description' => __( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' )
+                                . ' [' . get_option( 'home' ) . ']',
+        );
+
+        // Before we were used to validate the key beforehand, but this means
+        // an http call whenever a page is opened in the admin area. Therefore
+        // we now leave the input `untouched`, leaving to the client to update
+        // the `css_class`.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/669.
+        $key_args['css_class'] = 'untouched';
+
+        // Add the `key` field.
+        add_settings_field(
+            'wl-key',                                       // Element id used to identify the field throughout the theme.
+            __( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
+            // The name of the function responsible for rendering the option interface.
+            array( $this->input_element, 'render' ),
+            'wl_general_settings',                          // The page on which this option will be displayed.
+            'wl_general_settings_section',                  // The name of the section to which this field belongs.
+            $key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
+        );
+
+        // Entity Base Path input.
+        $entity_base_path_args = array(
+            // The array of arguments to pass to the callback. In this case, just a description.
+            'id'          => 'wl-entity-base-path',
+            'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
+            'value'       => Wordlift_Configuration_Service::get_instance()->get_entity_base_path(),
+            /* translators: Placeholders: %s - a link to FAQ's page. */
+            'description' => sprintf( __( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
+        );
+
+        // The following call is very heavy on large web sites and is always run
+        // also when not needed:
+        // $entity_base_path_args['readonly'] = 0 < $this->entity_service->count();
+        //
+        // It is now replaced by a filter to add the `readonly` flag to the
+        // input element when this is actually rendered.
+        add_filter( 'wl_admin_input_element_params', array(
+            $this,
+            'entity_path_input_element_params',
+        ) );
+
+        // Add the `wl_entity_base_path` field.
+        add_settings_field(
+            'wl-entity-base-path',                                // ID used to identify the field throughout the theme
+            __( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
+            // The name of the function responsible for rendering the option interface
+            array( $this->input_element, 'render', ),
+            'wl_general_settings',                                // The page on which this option will be displayed
+            'wl_general_settings_section',                        // The name of the section to which this field belongs
+            $entity_base_path_args
+        );
+
+
+        $language_name = Wordlift_Languages::get_language_name(
+            Wordlift_Configuration_Service::get_instance()->get_language_code()
+        );
+
+        // Add the `language_name` field.
+        add_settings_field(
+            'wl-site-language',
+            __( 'Site Language', 'wordlift' ),
+            function () use ( $language_name ) {
+                echo sprintf( '<p><label>%s</label></p>', esc_html( $language_name ) );
+                echo sprintf( __( '<br/><p>WordLift uses the site language, You can change the language from <a href="%s">settings.</a></p>', 'wordlift' ),
+                    admin_url( 'options-general.php#WPLANG' )
+                );
+            },
+            'wl_general_settings',
+            'wl_general_settings_section'
+        );
+
+        // Add the `country_code` field.
+        add_settings_field(
+            'wl-country-code',
+            _x( 'Country', 'wordlift' ),
+            array( $this->country_select_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-country-code',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::COUNTRY_CODE . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_country_code(),
+                'description' => __( 'Please select a country.', 'wordlift' ),
+                'notice'      => __( 'The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift' ),
+            )
+        );
+
+        // Add the `publisher` field.
+        add_settings_field(
+            'wl-publisher-id',
+            __( 'Publisher', 'wordlift' ),
+            array( $this->publisher_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'   => 'wl-publisher-id',
+                'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
+            )
+        );
+
+        // Add the `link by default` field.
+        add_settings_field(
+            'wl-link-by-default',
+            __( 'Link by Default', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-link-by-default',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->is_link_by_default() ? 'yes' : 'no',
+                'description' => __( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
+            )
+        );
+
+        // Add the `diagnostic data` field.
+        add_settings_field(
+            'wl-send-diagnostic',
+            __( 'Send Diagnostic Data', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-send-diagnostic',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::SEND_DIAGNOSTIC . ']',
+                'value'       => 'yes' === Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences() ? 'yes' : 'no',
+                'description' => __( 'Whether to send diagnostic data or not.', 'wordlift' ),
+            )
+        );
+
+    }
+
+    /**
+     * Filter the {@link Wordlift_Admin_Input_Element} in order to add the
+     * `readonly` flag to the `wl-entity-base-path` input.
+     *
+     * @param array $args An array of {@link Wordlift_Admin_Input_Element} parameters.
+     *
+     * @return array The updated array.
+     * @since 3.17.0
+     *
+     */
+    public function entity_path_input_element_params( $args ) {
+
+        // Bail out if it's not the `wl-entity-base-path`).
+        if ( 'wl-entity-base-path' !== $args['id'] ) {
+            return $args;
+        }
+
+        // Set the readonly flag according to the entities count.
+        $args['readonly'] = 0 < $this->entity_service->count();
+
+        // Return the updated args.
+        return $args;
+    }
+
+    /**
+     * Sanitize the configuration settings to be stored.
+     *
+     * If a new entity is being created for the publisher, create it and set The
+     * publisher setting.
+     *
+     * @param array $input The configuration settings array.
+     *
+     * @return array The sanitized input array.
+     * @since 3.11.0
+     *
+     */
+    function sanitize_callback( $input ) {
+
+        // Check whether a publisher name has been set.
+        if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { // WPCS: CSRF, input var, sanitization ok.
+            $name         = isset( $_POST['wl_publisher']['name'] ) ? (string) $_POST['wl_publisher']['name'] : '';
+            $type         = isset( $_POST['wl_publisher']['type'] ) ? (string) $_POST['wl_publisher']['type'] : '';
+            $thumbnail_id = isset( $_POST['wl_publisher']['thumbnail_id'] ) ? $_POST['wl_publisher']['thumbnail_id'] : null; // WPCS: CSRF, input var, sanitization ok.
+
+            // Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
+            $type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
+
+            // Create an entity for the publisher and assign it to the input
+            // parameter which WordPress automatically saves into the settings.
+            $input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
+        }
+
+        return $input;
+    }
 
 }

Spacing +54 added lines, -54 removed lines

@@ -85,7 +85,7 @@ 
 	 * @since 3.11.0
 	 *
 	 */
-	public function __construct( $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
+	public function __construct($entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element) {
 
 		$this->entity_service = $entity_service;
 
@@ -108,7 +108,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			$publisher_element = new Wordlift_Admin_Publisher_Element(
 				Wordlift_Publisher_Service::get_instance(),
 				new Wordlift_Admin_Tabs_Element(),
@@ -184,8 +184,8 @@ 
 
 		// JavaScript required for the settings page.
 		// @todo: try to move to the `wordlift-admin.bundle.js`.
-		wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.js', array( 'wp-util' ) );
-		wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.css' );
+		wp_enqueue_script('wordlift-admin-settings-page', plugin_dir_url(dirname(__FILE__)).'admin/js/1/settings.js', array('wp-util'));
+		wp_enqueue_style('wordlift-admin-settings-page', plugin_dir_url(dirname(__FILE__)).'admin/js/1/settings.css');
 
 	}
 
@@ -202,23 +202,23 @@ 
 		register_setting(
 			'wl_general_settings',
 			'wl_general_settings',
-			array( $this, 'sanitize_callback' )
+			array($this, 'sanitize_callback')
 		);
 
 		// Add the general settings section.
 		add_settings_section(
 			'wl_general_settings_section', // ID used to identify this section and with which to register options.
-			'',                            // Section header.
-			'',                            // Callback used to render the description of the section.
+			'', // Section header.
+			'', // Callback used to render the description of the section.
 			'wl_general_settings'          // Page on which to add this section of options.
 		);
 
 		$key_args = array(
 			'id'          => 'wl-key',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
+			'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::KEY.']',
 			'value'       => Wordlift_Configuration_Service::get_instance()->get_key(),
-			'description' => __( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' )
-			                 . ' [' . get_option( 'home' ) . ']',
+			'description' => __('Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift')
+			                 . ' ['.get_option('home').']',
 		);
 
 		// Before we were used to validate the key beforehand, but this means
@@ -231,12 +231,12 @@ 
 
 		// Add the `key` field.
 		add_settings_field(
-			'wl-key',                                       // Element id used to identify the field throughout the theme.
-			__( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
+			'wl-key', // Element id used to identify the field throughout the theme.
+			__('WordLift Key', 'wordlift'), // The label to the left of the option interface element.
 			// The name of the function responsible for rendering the option interface.
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',                          // The page on which this option will be displayed.
-			'wl_general_settings_section',                  // The name of the section to which this field belongs.
+			array($this->input_element, 'render'),
+			'wl_general_settings', // The page on which this option will be displayed.
+			'wl_general_settings_section', // The name of the section to which this field belongs.
 			$key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
 		);
 
@@ -244,10 +244,10 @@ 
 		$entity_base_path_args = array(
 			// The array of arguments to pass to the callback. In this case, just a description.
 			'id'          => 'wl-entity-base-path',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
+			'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY.']',
 			'value'       => Wordlift_Configuration_Service::get_instance()->get_entity_base_path(),
 			/* translators: Placeholders: %s - a link to FAQ's page. */
-			'description' => sprintf( __( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
+			'description' => sprintf(__('All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift'), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary'),
 		);
 
 		// The following call is very heavy on large web sites and is always run
@@ -256,19 +256,19 @@ 
 		//
 		// It is now replaced by a filter to add the `readonly` flag to the
 		// input element when this is actually rendered.
-		add_filter( 'wl_admin_input_element_params', array(
+		add_filter('wl_admin_input_element_params', array(
 			$this,
 			'entity_path_input_element_params',
-		) );
+		));
 
 		// Add the `wl_entity_base_path` field.
 		add_settings_field(
-			'wl-entity-base-path',                                // ID used to identify the field throughout the theme
-			__( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
+			'wl-entity-base-path', // ID used to identify the field throughout the theme
+			__('Entity Base Path', 'wordlift'), // The label to the left of the option interface element
 			// The name of the function responsible for rendering the option interface
-			array( $this->input_element, 'render', ),
-			'wl_general_settings',                                // The page on which this option will be displayed
-			'wl_general_settings_section',                        // The name of the section to which this field belongs
+			array($this->input_element, 'render',),
+			'wl_general_settings', // The page on which this option will be displayed
+			'wl_general_settings_section', // The name of the section to which this field belongs
 			$entity_base_path_args
 		);
 
@@ -280,11 +280,11 @@ 
 		// Add the `language_name` field.
 		add_settings_field(
 			'wl-site-language',
-			__( 'Site Language', 'wordlift' ),
-			function () use ( $language_name ) {
-				echo sprintf( '<p><label>%s</label></p>', esc_html( $language_name ) );
-				echo sprintf( __( '<br/><p>WordLift uses the site language, You can change the language from <a href="%s">settings.</a></p>', 'wordlift' ),
-					admin_url( 'options-general.php#WPLANG' )
+			__('Site Language', 'wordlift'),
+			function() use ($language_name) {
+				echo sprintf('<p><label>%s</label></p>', esc_html($language_name));
+				echo sprintf(__('<br/><p>WordLift uses the site language, You can change the language from <a href="%s">settings.</a></p>', 'wordlift'),
+					admin_url('options-general.php#WPLANG')
 				);
 			},
 			'wl_general_settings',
@@ -294,59 +294,59 @@ 
 		// Add the `country_code` field.
 		add_settings_field(
 			'wl-country-code',
-			_x( 'Country', 'wordlift' ),
-			array( $this->country_select_element, 'render' ),
+			_x('Country', 'wordlift'),
+			array($this->country_select_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'          => 'wl-country-code',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::COUNTRY_CODE . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::COUNTRY_CODE.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_country_code(),
-				'description' => __( 'Please select a country.', 'wordlift' ),
-				'notice'      => __( 'The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift' ),
+				'description' => __('Please select a country.', 'wordlift'),
+				'notice'      => __('The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift'),
 			)
 		);
 
 		// Add the `publisher` field.
 		add_settings_field(
 			'wl-publisher-id',
-			__( 'Publisher', 'wordlift' ),
-			array( $this->publisher_element, 'render' ),
+			__('Publisher', 'wordlift'),
+			array($this->publisher_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'   => 'wl-publisher-id',
-				'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
+				'name' => 'wl_general_settings['.Wordlift_Configuration_Service::PUBLISHER_ID.']',
 			)
 		);
 
 		// Add the `link by default` field.
 		add_settings_field(
 			'wl-link-by-default',
-			__( 'Link by Default', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Link by Default', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'          => 'wl-link-by-default',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::LINK_BY_DEFAULT.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->is_link_by_default() ? 'yes' : 'no',
-				'description' => __( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
+				'description' => __('Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift'),
 			)
 		);
 
 		// Add the `diagnostic data` field.
 		add_settings_field(
 			'wl-send-diagnostic',
-			__( 'Send Diagnostic Data', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Send Diagnostic Data', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'          => 'wl-send-diagnostic',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::SEND_DIAGNOSTIC . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::SEND_DIAGNOSTIC.']',
 				'value'       => 'yes' === Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences() ? 'yes' : 'no',
-				'description' => __( 'Whether to send diagnostic data or not.', 'wordlift' ),
+				'description' => __('Whether to send diagnostic data or not.', 'wordlift'),
 			)
 		);
 
@@ -362,10 +362,10 @@ 
 	 * @since 3.17.0
 	 *
 	 */
-	public function entity_path_input_element_params( $args ) {
+	public function entity_path_input_element_params($args) {
 
 		// Bail out if it's not the `wl-entity-base-path`).
-		if ( 'wl-entity-base-path' !== $args['id'] ) {
+		if ('wl-entity-base-path' !== $args['id']) {
 			return $args;
 		}
 
@@ -388,20 +388,20 @@ 
 	 * @since 3.11.0
 	 *
 	 */
-	function sanitize_callback( $input ) {
+	function sanitize_callback($input) {
 
 		// Check whether a publisher name has been set.
-		if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { // WPCS: CSRF, input var, sanitization ok.
-			$name         = isset( $_POST['wl_publisher']['name'] ) ? (string) $_POST['wl_publisher']['name'] : '';
-			$type         = isset( $_POST['wl_publisher']['type'] ) ? (string) $_POST['wl_publisher']['type'] : '';
-			$thumbnail_id = isset( $_POST['wl_publisher']['thumbnail_id'] ) ? $_POST['wl_publisher']['thumbnail_id'] : null; // WPCS: CSRF, input var, sanitization ok.
+		if (isset($_POST['wl_publisher']) && ! empty($_POST['wl_publisher']['name'])) { // WPCS: CSRF, input var, sanitization ok.
+			$name         = isset($_POST['wl_publisher']['name']) ? (string) $_POST['wl_publisher']['name'] : '';
+			$type         = isset($_POST['wl_publisher']['type']) ? (string) $_POST['wl_publisher']['type'] : '';
+			$thumbnail_id = isset($_POST['wl_publisher']['thumbnail_id']) ? $_POST['wl_publisher']['thumbnail_id'] : null; // WPCS: CSRF, input var, sanitization ok.
 
 			// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-			$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
+			$type_uri = sprintf('http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person');
 
 			// Create an entity for the publisher and assign it to the input
 			// parameter which WordPress automatically saves into the settings.
-			$input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
+			$input['publisher_id'] = $this->entity_service->create($name, $type_uri, $thumbnail_id, 'publish');
 		}
 
 		return $input;