insideout10 / wordlift-plugin

src/modules/linked_data/wordlift_linked_data.php

Indentation +339 added lines, -339 removed lines

@@ -14,19 +14,19 @@ 
  */
 function wl_linked_data_save_post( $post_id ) {
 
-	// If it's not numeric exit from here.
-	if ( ! is_numeric( $post_id ) || is_numeric( wp_is_post_revision( $post_id ) ) ) {
-		return;
-	}
+    // If it's not numeric exit from here.
+    if ( ! is_numeric( $post_id ) || is_numeric( wp_is_post_revision( $post_id ) ) ) {
+        return;
+    }
 
-	// unhook this function so it doesn't loop infinitely
-	remove_action( 'save_post', 'wl_linked_data_save_post' );
+    // unhook this function so it doesn't loop infinitely
+    remove_action( 'save_post', 'wl_linked_data_save_post' );
 
-	// raise the *wl_linked_data_save_post* event.
-	do_action( 'wl_linked_data_save_post', $post_id );
+    // raise the *wl_linked_data_save_post* event.
+    do_action( 'wl_linked_data_save_post', $post_id );
 
-	// re-hook this function
-	add_action( 'save_post', 'wl_linked_data_save_post' );
+    // re-hook this function
+    add_action( 'save_post', 'wl_linked_data_save_post' );
 }
 
 add_action( 'save_post', 'wl_linked_data_save_post' );
@@ -40,143 +40,143 @@ 
  */
 function wl_linked_data_save_post_and_related_entities( $post_id ) {
 
-	// Ignore auto-saves
-	if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
-		return;
-	}
+    // Ignore auto-saves
+    if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
+        return;
+    }
 
-	// get the current post.
-	$post = get_post( $post_id );
+    // get the current post.
+    $post = get_post( $post_id );
 
-	remove_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
+    remove_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
 
-	// wl_write_log( "[ post id :: $post_id ][ autosave :: false ][ post type :: $post->post_type ]" );
+    // wl_write_log( "[ post id :: $post_id ][ autosave :: false ][ post type :: $post->post_type ]" );
 
-	// Store mapping between tmp new entities uris and real new entities uri
-	$entities_uri_mapping = array();
+    // Store mapping between tmp new entities uris and real new entities uri
+    $entities_uri_mapping = array();
 
-	// Save the entities coming with POST data.
-	if ( isset( $_POST['wl_entities'] ) && isset( $_POST['wl_boxes'] ) ) {
+    // Save the entities coming with POST data.
+    if ( isset( $_POST['wl_entities'] ) && isset( $_POST['wl_boxes'] ) ) {
 
-		wl_write_log( "[ post id :: $post_id ][ POST(wl_entities) :: " );
-		wl_write_log( json_encode( $_POST['wl_entities'] ) );
-		wl_write_log( "]" );
-		wl_write_log( "[ post id :: $post_id ][ POST(wl_boxes) :: " );
-		wl_write_log( json_encode( $_POST['wl_boxes'], true ) );
-		wl_write_log( "]" );
+        wl_write_log( "[ post id :: $post_id ][ POST(wl_entities) :: " );
+        wl_write_log( json_encode( $_POST['wl_entities'] ) );
+        wl_write_log( "]" );
+        wl_write_log( "[ post id :: $post_id ][ POST(wl_boxes) :: " );
+        wl_write_log( json_encode( $_POST['wl_boxes'], true ) );
+        wl_write_log( "]" );
 
-		$entities_via_post = $_POST['wl_entities'];
-		$boxes_via_post    = $_POST['wl_boxes'];
+        $entities_via_post = $_POST['wl_entities'];
+        $boxes_via_post    = $_POST['wl_boxes'];
 
-		foreach ( $entities_via_post as $entity_uri => $entity ) {
+        foreach ( $entities_via_post as $entity_uri => $entity ) {
 
-			// Only if the current entity is created from scratch let's avoid to
-			// create more than one entity with same label & entity type.
-			$entity_type = ( preg_match( '/^local-entity-.+/', $entity_uri ) > 0 ) ?
-				$entity['main_type'] : null;
-
-			// Look if current entity uri matches an internal existing entity, meaning:
-			// 1. when $entity_uri is an internal uri
-			// 2. when $entity_uri is an external uri used as sameAs of an internal entity
-			$ie = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $entity_uri );
+            // Only if the current entity is created from scratch let's avoid to
+            // create more than one entity with same label & entity type.
+            $entity_type = ( preg_match( '/^local-entity-.+/', $entity_uri ) > 0 ) ?
+                $entity['main_type'] : null;
+
+            // Look if current entity uri matches an internal existing entity, meaning:
+            // 1. when $entity_uri is an internal uri
+            // 2. when $entity_uri is an external uri used as sameAs of an internal entity
+            $ie = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $entity_uri );
 
-			// Detect the uri depending if is an existing or a new entity
-			$uri = ( null === $ie ) ?
-				Wordlift_Uri_Service::get_instance()->build_uri(
-					$entity['label'],
-					Wordlift_Entity_Service::TYPE_NAME,
-					$entity_type
-				) : wl_get_entity_uri( $ie->ID );
+            // Detect the uri depending if is an existing or a new entity
+            $uri = ( null === $ie ) ?
+                Wordlift_Uri_Service::get_instance()->build_uri(
+                    $entity['label'],
+                    Wordlift_Entity_Service::TYPE_NAME,
+                    $entity_type
+                ) : wl_get_entity_uri( $ie->ID );
 
-			wl_write_log( "Map $entity_uri on $uri" );
-			$entities_uri_mapping[ $entity_uri ] = $uri;
+            wl_write_log( "Map $entity_uri on $uri" );
+            $entities_uri_mapping[ $entity_uri ] = $uri;
 
-			// Local entities have a tmp uri with 'local-entity-' prefix
-			// These uris need to be rewritten here and replaced in the content
-			if ( preg_match( '/^local-entity-.+/', $entity_uri ) > 0 ) {
-				// Override the entity obj
-				$entity['uri'] = $uri;
-			}
+            // Local entities have a tmp uri with 'local-entity-' prefix
+            // These uris need to be rewritten here and replaced in the content
+            if ( preg_match( '/^local-entity-.+/', $entity_uri ) > 0 ) {
+                // Override the entity obj
+                $entity['uri'] = $uri;
+            }
 
-			// Update entity data with related post
-			$entity['related_post_id'] = $post_id;
+            // Update entity data with related post
+            $entity['related_post_id'] = $post_id;
 
-			// Save the entity if is a new entity
-			if ( null === $ie ) {
-				wl_save_entity( $entity );
-			}
+            // Save the entity if is a new entity
+            if ( null === $ie ) {
+                wl_save_entity( $entity );
+            }
 
-		}
+        }
 
-	}
+    }
 
-	// Replace tmp uris in content post if needed
-	$updated_post_content = $post->post_content;
-	// Save each entity and store the post id.
-	foreach ( $entities_uri_mapping as $tmp_uri => $uri ) {
-		$updated_post_content = str_replace( $tmp_uri, $uri, $updated_post_content );
-	}
+    // Replace tmp uris in content post if needed
+    $updated_post_content = $post->post_content;
+    // Save each entity and store the post id.
+    foreach ( $entities_uri_mapping as $tmp_uri => $uri ) {
+        $updated_post_content = str_replace( $tmp_uri, $uri, $updated_post_content );
+    }
 
-	// Update the post content
-	wp_update_post( array(
-		'ID'           => $post->ID,
-		'post_content' => $updated_post_content,
-	) );
+    // Update the post content
+    wp_update_post( array(
+        'ID'           => $post->ID,
+        'post_content' => $updated_post_content,
+    ) );
 
-	// Extract related/referenced entities from text.
-	$disambiguated_entities = wl_linked_data_content_get_embedded_entities( $updated_post_content );
+    // Extract related/referenced entities from text.
+    $disambiguated_entities = wl_linked_data_content_get_embedded_entities( $updated_post_content );
 
-	// Reset previously saved instances
-	wl_core_delete_relation_instances( $post_id );
+    // Reset previously saved instances
+    wl_core_delete_relation_instances( $post_id );
 
-	// Save relation instances
-	foreach ( array_unique( $disambiguated_entities ) as $referenced_entity_id ) {
+    // Save relation instances
+    foreach ( array_unique( $disambiguated_entities ) as $referenced_entity_id ) {
 
-		wl_core_add_relation_instance(
-			$post_id,
-			Wordlift_Entity_Service::get_instance()->get_classification_scope_for( $referenced_entity_id ),
-			$referenced_entity_id
-		);
+        wl_core_add_relation_instance(
+            $post_id,
+            Wordlift_Entity_Service::get_instance()->get_classification_scope_for( $referenced_entity_id ),
+            $referenced_entity_id
+        );
 
-	}
+    }
 
-	if ( isset( $_POST['wl_entities'] ) ) {
-		// Save post metadata if available
-		$metadata_via_post = ( isset( $_POST['wl_metadata'] ) ) ?
-			$_POST['wl_metadata'] : array();
+    if ( isset( $_POST['wl_entities'] ) ) {
+        // Save post metadata if available
+        $metadata_via_post = ( isset( $_POST['wl_metadata'] ) ) ?
+            $_POST['wl_metadata'] : array();
 
-		$fields = array(
-			Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
-			Wordlift_Schema_Service::FIELD_TOPIC,
-		);
-
-		// Unlink topic taxonomy terms
-		Wordlift_Topic_Taxonomy_Service::get_instance()->unlink_topic_for( $post->ID );
-
-		foreach ( $fields as $field ) {
-
-			// Delete current values
-			delete_post_meta( $post->ID, $field );
-			// Retrieve the entity uri
-			$uri = ( isset( $metadata_via_post[ $field ] ) ) ?
-				stripslashes( $metadata_via_post[ $field ] ) : '';
-
-			$entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri );
-
-			if ( $entity ) {
-				add_post_meta( $post->ID, $field, $entity->ID, true );
-				// Set also the topic taxonomy
-				if ( $field === Wordlift_Schema_Service::FIELD_TOPIC ) {
-					Wordlift_Topic_Taxonomy_Service::get_instance()->set_topic_for( $post->ID, $entity );
-				}
-			}
-		}
-	}
-
-	// Push the post to Redlink.
-	wl_linked_data_push_to_redlink( $post->ID );
-
-	add_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
+        $fields = array(
+            Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
+            Wordlift_Schema_Service::FIELD_TOPIC,
+        );
+
+        // Unlink topic taxonomy terms
+        Wordlift_Topic_Taxonomy_Service::get_instance()->unlink_topic_for( $post->ID );
+
+        foreach ( $fields as $field ) {
+
+            // Delete current values
+            delete_post_meta( $post->ID, $field );
+            // Retrieve the entity uri
+            $uri = ( isset( $metadata_via_post[ $field ] ) ) ?
+                stripslashes( $metadata_via_post[ $field ] ) : '';
+
+            $entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri );
+
+            if ( $entity ) {
+                add_post_meta( $post->ID, $field, $entity->ID, true );
+                // Set also the topic taxonomy
+                if ( $field === Wordlift_Schema_Service::FIELD_TOPIC ) {
+                    Wordlift_Topic_Taxonomy_Service::get_instance()->set_topic_for( $post->ID, $entity );
+                }
+            }
+        }
+    }
+
+    // Push the post to Redlink.
+    wl_linked_data_push_to_redlink( $post->ID );
+
+    add_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
 }
 
 add_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
@@ -186,20 +186,20 @@ 
  */
 function wordlift_save_post_add_default_schema_type( $entity_id ) {
 
-	$entity = get_post( $entity_id );
+    $entity = get_post( $entity_id );
 
-	// Avoid doing anything if post is autosave or a revision.
+    // Avoid doing anything if post is autosave or a revision.
 
-	if ( wp_is_post_autosave( $entity ) || wp_is_post_revision( $entity ) ) {
-		return;
-	}
+    if ( wp_is_post_autosave( $entity ) || wp_is_post_revision( $entity ) ) {
+        return;
+    }
 
-	$entity_type = wl_schema_get_types( $entity_id );
+    $entity_type = wl_schema_get_types( $entity_id );
 
-	// Assign type 'Thing' if we are dealing with an entity without type
-	if ( $entity->post_type == Wordlift_Entity_Service::TYPE_NAME && is_null( $entity_type ) ) {
-		wl_schema_set_types( $entity_id, 'Thing' );
-	}
+    // Assign type 'Thing' if we are dealing with an entity without type
+    if ( $entity->post_type == Wordlift_Entity_Service::TYPE_NAME && is_null( $entity_type ) ) {
+        wl_schema_set_types( $entity_id, 'Thing' );
+    }
 
 }
 
@@ -225,178 +225,178 @@ 
  */
 function wl_save_entity( $entity_data ) {
 
-	$uri              = $entity_data['uri'];
-	$label            = $entity_data['label'];
-	$type_uri         = $entity_data['main_type'];
-	$entity_types     = isset( $entity_data['type'] ) ? $entity_data['type'] : array();
-	$description      = $entity_data['description'];
-	$images           = isset( $entity_data['image'] ) ? wl_force_to_array( $entity_data['image'] ) : array();
-	$same_as          = isset( $entity_data['sameas'] ) ? wl_force_to_array( $entity_data['sameas'] ) : array();
-	$related_post_id  = isset( $entity_data['related_post_id'] ) ? $entity_data['related_post_id'] : null;
-	$other_properties = isset( $entity_data['properties'] ) ? $entity_data['properties'] : array();
-
-	// Check whether an entity already exists with the provided URI.
-	if ( null !== $post = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri ) ) {
-		return $post;
-	}
-
-	// Prepare properties of the new entity.
-	$params = array(
-		'post_status'  => ( is_numeric( $related_post_id ) ? get_post_status( $related_post_id ) : 'draft' ),
-		'post_type'    => Wordlift_Entity_Service::TYPE_NAME,
-		'post_title'   => $label,
-		'post_content' => $description,
-		'post_excerpt' => '',
-		// Ensure we're using a valid slug. We're not overwriting an existing
-		// entity with a post_name already set, since this call is made only for
-		// new entities.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/282
-		'post_name'    => sanitize_title( $label ),
-	);
-
-	// If Yoast is installed and active, we temporary remove the save_postdata hook which causes Yoast to "pass over"
-	// the local SEO form values to the created entity (https://github.com/insideout10/wordlift-plugin/issues/156)
-	// Same thing applies to SEO Ultimate (https://github.com/insideout10/wordlift-plugin/issues/148)
-	// This does NOT affect saving an entity from the entity admin page since this function is called when an entity
-	// is created when saving a post.
-	global $wpseo_metabox, $seo_ultimate;
-	if ( isset( $wpseo_metabox ) ) {
-		remove_action( 'wp_insert_post', array(
-			$wpseo_metabox,
-			'save_postdata',
-		) );
-	}
-
-	if ( isset( $seo_ultimate ) ) {
-		remove_action( 'save_post', array(
-			$seo_ultimate,
-			'save_postmeta_box',
-		) );
-	}
-
-	// The fact that we're calling here wp_insert_post is causing issues with plugins (and ourselves too) that hook to
-	// save_post in order to save additional inputs from the edit page. In order to avoid issues, we pop all the hooks
-	// to the save_post and restore them after we saved the entity.
-	// see https://github.com/insideout10/wordlift-plugin/issues/203
-	// see https://github.com/insideout10/wordlift-plugin/issues/156
-	// see https://github.com/insideout10/wordlift-plugin/issues/148
-	global $wp_filter;
-	$save_post_filters = is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] : $wp_filter['save_post']->callbacks;
-	is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] = array() : $wp_filter['save_post']->remove_all_filters();
-
-	// create or update the post.
-	$post_id = wp_insert_post( $params, true );
-
-	// Restore all the existing filters.
-	is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] = $save_post_filters : $wp_filter['save_post']->callbacks = $save_post_filters;
-
-	// If Yoast is installed and active, we restore the Yoast save_postdata hook (https://github.com/insideout10/wordlift-plugin/issues/156)
-	if ( isset( $wpseo_metabox ) ) {
-		add_action( 'wp_insert_post', array(
-			$wpseo_metabox,
-			'save_postdata',
-		) );
-	}
-
-	// If SEO Ultimate is installed, add back the hook we removed a few lines above.
-	if ( isset( $seo_ultimate ) ) {
-		add_action( 'save_post', array(
-			$seo_ultimate,
-			'save_postmeta_box',
-		), 10, 2 );
-	}
-
-	// TODO: handle errors.
-	if ( is_wp_error( $post_id ) ) {
-		wl_write_log( ': error occurred' );
-
-		// inform an error occurred.
-		return null;
-	}
-
-	wl_set_entity_main_type( $post_id, $type_uri );
-
-	// Save the entity types.
-	wl_set_entity_rdf_types( $post_id, $entity_types );
-
-	// Get a dataset URI for the entity.
-	$wl_uri = wl_build_entity_uri( $post_id );
-
-	// Save the entity URI.
-	wl_set_entity_uri( $post_id, $wl_uri );
-
-	// Add the uri to the sameAs data if it's not a local URI.
-	if ( $wl_uri !== $uri ) {
-		array_push( $same_as, $uri );
-	}
-
-	$new_uri = wl_get_entity_uri( $post_id );
-
-	// Save the sameAs data for the entity.
-	wl_schema_set_value( $post_id, 'sameAs', $same_as );
-
-	// Save the other properties (latitude, langitude, startDate, endDate, etc.)
-	foreach ( $other_properties as $property_name => $property_value ) {
-		wl_schema_set_value( $post_id, $property_name, $property_value );
-	}
-
-	// Call hooks.
-	do_action( 'wl_save_entity', $post_id );
-
-	foreach ( $images as $image_remote_url ) {
-
-		// Check if image is already present in local DB
-		if ( strpos( $image_remote_url, site_url() ) !== false ) {
-			// Do nothing.
-			continue;
-		}
-
-		// Check if there is an existing attachment for this post ID and source URL.
-		$existing_image = wl_get_attachment_for_source_url( $post_id, $image_remote_url );
-
-		// Skip if an existing image is found.
-		if ( null !== $existing_image ) {
-			continue;
-		}
-
-		// Save the image and get the local path.
-		$image = wl_save_image( $image_remote_url );
-
-		// Get the local URL.
-		$filename     = $image['path'];
-		$url          = $image['url'];
-		$content_type = $image['content_type'];
-
-		$attachment = array(
-			'guid'           => $url,
-			// post_title, post_content (the value for this key should be the empty string), post_status and post_mime_type
-			'post_title'     => $label,
-			// Set the title to the post title.
-			'post_content'   => '',
-			'post_status'    => 'inherit',
-			'post_mime_type' => $content_type,
-		);
-
-		// Create the attachment in WordPress and generate the related metadata.
-		$attachment_id = wp_insert_attachment( $attachment, $filename, $post_id );
-
-		// Set the source URL for the image.
-		wl_set_source_url( $attachment_id, $image_remote_url );
+    $uri              = $entity_data['uri'];
+    $label            = $entity_data['label'];
+    $type_uri         = $entity_data['main_type'];
+    $entity_types     = isset( $entity_data['type'] ) ? $entity_data['type'] : array();
+    $description      = $entity_data['description'];
+    $images           = isset( $entity_data['image'] ) ? wl_force_to_array( $entity_data['image'] ) : array();
+    $same_as          = isset( $entity_data['sameas'] ) ? wl_force_to_array( $entity_data['sameas'] ) : array();
+    $related_post_id  = isset( $entity_data['related_post_id'] ) ? $entity_data['related_post_id'] : null;
+    $other_properties = isset( $entity_data['properties'] ) ? $entity_data['properties'] : array();
+
+    // Check whether an entity already exists with the provided URI.
+    if ( null !== $post = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri ) ) {
+        return $post;
+    }
+
+    // Prepare properties of the new entity.
+    $params = array(
+        'post_status'  => ( is_numeric( $related_post_id ) ? get_post_status( $related_post_id ) : 'draft' ),
+        'post_type'    => Wordlift_Entity_Service::TYPE_NAME,
+        'post_title'   => $label,
+        'post_content' => $description,
+        'post_excerpt' => '',
+        // Ensure we're using a valid slug. We're not overwriting an existing
+        // entity with a post_name already set, since this call is made only for
+        // new entities.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/282
+        'post_name'    => sanitize_title( $label ),
+    );
+
+    // If Yoast is installed and active, we temporary remove the save_postdata hook which causes Yoast to "pass over"
+    // the local SEO form values to the created entity (https://github.com/insideout10/wordlift-plugin/issues/156)
+    // Same thing applies to SEO Ultimate (https://github.com/insideout10/wordlift-plugin/issues/148)
+    // This does NOT affect saving an entity from the entity admin page since this function is called when an entity
+    // is created when saving a post.
+    global $wpseo_metabox, $seo_ultimate;
+    if ( isset( $wpseo_metabox ) ) {
+        remove_action( 'wp_insert_post', array(
+            $wpseo_metabox,
+            'save_postdata',
+        ) );
+    }
+
+    if ( isset( $seo_ultimate ) ) {
+        remove_action( 'save_post', array(
+            $seo_ultimate,
+            'save_postmeta_box',
+        ) );
+    }
+
+    // The fact that we're calling here wp_insert_post is causing issues with plugins (and ourselves too) that hook to
+    // save_post in order to save additional inputs from the edit page. In order to avoid issues, we pop all the hooks
+    // to the save_post and restore them after we saved the entity.
+    // see https://github.com/insideout10/wordlift-plugin/issues/203
+    // see https://github.com/insideout10/wordlift-plugin/issues/156
+    // see https://github.com/insideout10/wordlift-plugin/issues/148
+    global $wp_filter;
+    $save_post_filters = is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] : $wp_filter['save_post']->callbacks;
+    is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] = array() : $wp_filter['save_post']->remove_all_filters();
+
+    // create or update the post.
+    $post_id = wp_insert_post( $params, true );
+
+    // Restore all the existing filters.
+    is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] = $save_post_filters : $wp_filter['save_post']->callbacks = $save_post_filters;
+
+    // If Yoast is installed and active, we restore the Yoast save_postdata hook (https://github.com/insideout10/wordlift-plugin/issues/156)
+    if ( isset( $wpseo_metabox ) ) {
+        add_action( 'wp_insert_post', array(
+            $wpseo_metabox,
+            'save_postdata',
+        ) );
+    }
+
+    // If SEO Ultimate is installed, add back the hook we removed a few lines above.
+    if ( isset( $seo_ultimate ) ) {
+        add_action( 'save_post', array(
+            $seo_ultimate,
+            'save_postmeta_box',
+        ), 10, 2 );
+    }
+
+    // TODO: handle errors.
+    if ( is_wp_error( $post_id ) ) {
+        wl_write_log( ': error occurred' );
+
+        // inform an error occurred.
+        return null;
+    }
+
+    wl_set_entity_main_type( $post_id, $type_uri );
+
+    // Save the entity types.
+    wl_set_entity_rdf_types( $post_id, $entity_types );
+
+    // Get a dataset URI for the entity.
+    $wl_uri = wl_build_entity_uri( $post_id );
+
+    // Save the entity URI.
+    wl_set_entity_uri( $post_id, $wl_uri );
+
+    // Add the uri to the sameAs data if it's not a local URI.
+    if ( $wl_uri !== $uri ) {
+        array_push( $same_as, $uri );
+    }
+
+    $new_uri = wl_get_entity_uri( $post_id );
+
+    // Save the sameAs data for the entity.
+    wl_schema_set_value( $post_id, 'sameAs', $same_as );
+
+    // Save the other properties (latitude, langitude, startDate, endDate, etc.)
+    foreach ( $other_properties as $property_name => $property_value ) {
+        wl_schema_set_value( $post_id, $property_name, $property_value );
+    }
+
+    // Call hooks.
+    do_action( 'wl_save_entity', $post_id );
+
+    foreach ( $images as $image_remote_url ) {
+
+        // Check if image is already present in local DB
+        if ( strpos( $image_remote_url, site_url() ) !== false ) {
+            // Do nothing.
+            continue;
+        }
+
+        // Check if there is an existing attachment for this post ID and source URL.
+        $existing_image = wl_get_attachment_for_source_url( $post_id, $image_remote_url );
+
+        // Skip if an existing image is found.
+        if ( null !== $existing_image ) {
+            continue;
+        }
+
+        // Save the image and get the local path.
+        $image = wl_save_image( $image_remote_url );
+
+        // Get the local URL.
+        $filename     = $image['path'];
+        $url          = $image['url'];
+        $content_type = $image['content_type'];
+
+        $attachment = array(
+            'guid'           => $url,
+            // post_title, post_content (the value for this key should be the empty string), post_status and post_mime_type
+            'post_title'     => $label,
+            // Set the title to the post title.
+            'post_content'   => '',
+            'post_status'    => 'inherit',
+            'post_mime_type' => $content_type,
+        );
+
+        // Create the attachment in WordPress and generate the related metadata.
+        $attachment_id = wp_insert_attachment( $attachment, $filename, $post_id );
+
+        // Set the source URL for the image.
+        wl_set_source_url( $attachment_id, $image_remote_url );
 
-		$attachment_data = wp_generate_attachment_metadata( $attachment_id, $filename );
-		wp_update_attachment_metadata( $attachment_id, $attachment_data );
+        $attachment_data = wp_generate_attachment_metadata( $attachment_id, $filename );
+        wp_update_attachment_metadata( $attachment_id, $attachment_data );
 
-		// Set it as the featured image.
-		set_post_thumbnail( $post_id, $attachment_id );
-	}
+        // Set it as the featured image.
+        set_post_thumbnail( $post_id, $attachment_id );
+    }
 
-	// The entity is pushed to Redlink on save by the function hooked to save_post.
-	// save the entity in the triple store.
-	wl_linked_data_push_to_redlink( $post_id );
+    // The entity is pushed to Redlink on save by the function hooked to save_post.
+    // save the entity in the triple store.
+    wl_linked_data_push_to_redlink( $post_id );
 
-	// finally return the entity post.
-	return get_post( $post_id );
+    // finally return the entity post.
+    return get_post( $post_id );
 }
 
 /**
@@ -410,42 +410,42 @@ 
  */
 function wl_linked_data_content_get_embedded_entities( $content ) {
 
-	// Remove quote escapes.
-	$content = str_replace( '\\"', '"', $content );
+    // Remove quote escapes.
+    $content = str_replace( '\\"', '"', $content );
 
-	// Match all itemid attributes.
-	$pattern = '/<\w+[^>]*\sitemid="([^"]+)"[^>]*>/im';
+    // Match all itemid attributes.
+    $pattern = '/<\w+[^>]*\sitemid="([^"]+)"[^>]*>/im';
 
-	//	wl_write_log( "Getting entities embedded into content [ pattern :: $pattern ]" );
+    //	wl_write_log( "Getting entities embedded into content [ pattern :: $pattern ]" );
 
-	// Remove the pattern while it is found (match nested annotations).
-	$matches = array();
+    // Remove the pattern while it is found (match nested annotations).
+    $matches = array();
 
-	// In case of errors, return an empty array.
-	if ( false === preg_match_all( $pattern, $content, $matches ) ) {
-		wl_write_log( "Found no entities embedded in content" );
+    // In case of errors, return an empty array.
+    if ( false === preg_match_all( $pattern, $content, $matches ) ) {
+        wl_write_log( "Found no entities embedded in content" );
 
-		return array();
-	}
+        return array();
+    }
 
 //    wl_write_log("wl_update_related_entities [ content :: $content ][ data :: " . var_export($data, true). " ][ matches :: " . var_export($matches, true) . " ]");
 
-	// Collect the entities.
-	$entities = array();
-	foreach ( $matches[1] as $uri ) {
-		$uri_d = html_entity_decode( $uri );
+    // Collect the entities.
+    $entities = array();
+    foreach ( $matches[1] as $uri ) {
+        $uri_d = html_entity_decode( $uri );
 
-		$entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri_d );
+        $entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri_d );
 
-		if ( null !== $entity ) {
-			array_push( $entities, $entity->ID );
-		}
-	}
+        if ( null !== $entity ) {
+            array_push( $entities, $entity->ID );
+        }
+    }
 
-	// $count = sizeof( $entities );
-	// wl_write_log( "Found $count entities embedded in content" );
+    // $count = sizeof( $entities );
+    // wl_write_log( "Found $count entities embedded in content" );
 
-	return $entities;
+    return $entities;
 }
 
 /**
@@ -457,22 +457,22 @@ 
  */
 function wl_linked_data_push_to_redlink( $post_id ) {
 
-	// Get the post.
-	$post = get_post( $post_id );
+    // Get the post.
+    $post = get_post( $post_id );
 
-	// wl_write_log( "wl_linked_data_push_to_redlink [ post id :: $post_id ][ post type :: $post->post_type ]" );
+    // wl_write_log( "wl_linked_data_push_to_redlink [ post id :: $post_id ][ post type :: $post->post_type ]" );
 
-	// Call the method on behalf of the post type.
-	switch ( $post->post_type ) {
-		case 'entity':
-			wl_push_entity_post_to_redlink( $post );
-			break;
-		default:
-			wl_push_post_to_redlink( $post );
-	}
+    // Call the method on behalf of the post type.
+    switch ( $post->post_type ) {
+        case 'entity':
+            wl_push_entity_post_to_redlink( $post );
+            break;
+        default:
+            wl_push_post_to_redlink( $post );
+    }
 
-	// Reindex the triple store if buffering is turned off.
-	if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
-		wordlift_reindex_triple_store();
-	}
+    // Reindex the triple store if buffering is turned off.
+    if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
+        wordlift_reindex_triple_store();
+    }
 }

Spacing +123 added lines, -123 removed lines

@@ -3,7 +3,7 @@ 
  * The Linked Data module provides synchronization of local WordPress data with the remote Linked Data store.
  */
 
-require_once( 'wordlift_linked_data_images.php' );
+require_once('wordlift_linked_data_images.php');
 
 /**
  * Receive events from post saves, and split them according to the post type.
@@ -12,24 +12,24 @@ 
  *
  * @param int $post_id The post id.
  */
-function wl_linked_data_save_post( $post_id ) {
+function wl_linked_data_save_post($post_id) {
 
 	// If it's not numeric exit from here.
-	if ( ! is_numeric( $post_id ) || is_numeric( wp_is_post_revision( $post_id ) ) ) {
+	if ( ! is_numeric($post_id) || is_numeric(wp_is_post_revision($post_id))) {
 		return;
 	}
 
 	// unhook this function so it doesn't loop infinitely
-	remove_action( 'save_post', 'wl_linked_data_save_post' );
+	remove_action('save_post', 'wl_linked_data_save_post');
 
 	// raise the *wl_linked_data_save_post* event.
-	do_action( 'wl_linked_data_save_post', $post_id );
+	do_action('wl_linked_data_save_post', $post_id);
 
 	// re-hook this function
-	add_action( 'save_post', 'wl_linked_data_save_post' );
+	add_action('save_post', 'wl_linked_data_save_post');
 }
 
-add_action( 'save_post', 'wl_linked_data_save_post' );
+add_action('save_post', 'wl_linked_data_save_post');
 
 /**
  * Save the post to the triple store. Also saves the entities locally and on the triple store.
@@ -38,17 +38,17 @@ 
  *
  * @param int $post_id The post id being saved.
  */
-function wl_linked_data_save_post_and_related_entities( $post_id ) {
+function wl_linked_data_save_post_and_related_entities($post_id) {
 
 	// Ignore auto-saves
-	if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
+	if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
 		return;
 	}
 
 	// get the current post.
-	$post = get_post( $post_id );
+	$post = get_post($post_id);
 
-	remove_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
+	remove_action('wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities');
 
 	// wl_write_log( "[ post id :: $post_id ][ autosave :: false ][ post type :: $post->post_type ]" );
 
@@ -56,44 +56,44 @@ 
 	$entities_uri_mapping = array();
 
 	// Save the entities coming with POST data.
-	if ( isset( $_POST['wl_entities'] ) && isset( $_POST['wl_boxes'] ) ) {
+	if (isset($_POST['wl_entities']) && isset($_POST['wl_boxes'])) {
 
-		wl_write_log( "[ post id :: $post_id ][ POST(wl_entities) :: " );
-		wl_write_log( json_encode( $_POST['wl_entities'] ) );
-		wl_write_log( "]" );
-		wl_write_log( "[ post id :: $post_id ][ POST(wl_boxes) :: " );
-		wl_write_log( json_encode( $_POST['wl_boxes'], true ) );
-		wl_write_log( "]" );
+		wl_write_log("[ post id :: $post_id ][ POST(wl_entities) :: ");
+		wl_write_log(json_encode($_POST['wl_entities']));
+		wl_write_log("]");
+		wl_write_log("[ post id :: $post_id ][ POST(wl_boxes) :: ");
+		wl_write_log(json_encode($_POST['wl_boxes'], true));
+		wl_write_log("]");
 
 		$entities_via_post = $_POST['wl_entities'];
 		$boxes_via_post    = $_POST['wl_boxes'];
 
-		foreach ( $entities_via_post as $entity_uri => $entity ) {
+		foreach ($entities_via_post as $entity_uri => $entity) {
 
 			// Only if the current entity is created from scratch let's avoid to
 			// create more than one entity with same label & entity type.
-			$entity_type = ( preg_match( '/^local-entity-.+/', $entity_uri ) > 0 ) ?
+			$entity_type = (preg_match('/^local-entity-.+/', $entity_uri) > 0) ?
 				$entity['main_type'] : null;
 
 			// Look if current entity uri matches an internal existing entity, meaning:
 			// 1. when $entity_uri is an internal uri
 			// 2. when $entity_uri is an external uri used as sameAs of an internal entity
-			$ie = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $entity_uri );
+			$ie = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri($entity_uri);
 
 			// Detect the uri depending if is an existing or a new entity
-			$uri = ( null === $ie ) ?
+			$uri = (null === $ie) ?
 				Wordlift_Uri_Service::get_instance()->build_uri(
 					$entity['label'],
 					Wordlift_Entity_Service::TYPE_NAME,
 					$entity_type
-				) : wl_get_entity_uri( $ie->ID );
+				) : wl_get_entity_uri($ie->ID);
 
-			wl_write_log( "Map $entity_uri on $uri" );
-			$entities_uri_mapping[ $entity_uri ] = $uri;
+			wl_write_log("Map $entity_uri on $uri");
+			$entities_uri_mapping[$entity_uri] = $uri;
 
 			// Local entities have a tmp uri with 'local-entity-' prefix
 			// These uris need to be rewritten here and replaced in the content
-			if ( preg_match( '/^local-entity-.+/', $entity_uri ) > 0 ) {
+			if (preg_match('/^local-entity-.+/', $entity_uri) > 0) {
 				// Override the entity obj
 				$entity['uri'] = $uri;
 			}
@@ -102,8 +102,8 @@ 
 			$entity['related_post_id'] = $post_id;
 
 			// Save the entity if is a new entity
-			if ( null === $ie ) {
-				wl_save_entity( $entity );
+			if (null === $ie) {
+				wl_save_entity($entity);
 			}
 
 		}
@@ -113,36 +113,36 @@ 
 	// Replace tmp uris in content post if needed
 	$updated_post_content = $post->post_content;
 	// Save each entity and store the post id.
-	foreach ( $entities_uri_mapping as $tmp_uri => $uri ) {
-		$updated_post_content = str_replace( $tmp_uri, $uri, $updated_post_content );
+	foreach ($entities_uri_mapping as $tmp_uri => $uri) {
+		$updated_post_content = str_replace($tmp_uri, $uri, $updated_post_content);
 	}
 
 	// Update the post content
-	wp_update_post( array(
+	wp_update_post(array(
 		'ID'           => $post->ID,
 		'post_content' => $updated_post_content,
-	) );
+	));
 
 	// Extract related/referenced entities from text.
-	$disambiguated_entities = wl_linked_data_content_get_embedded_entities( $updated_post_content );
+	$disambiguated_entities = wl_linked_data_content_get_embedded_entities($updated_post_content);
 
 	// Reset previously saved instances
-	wl_core_delete_relation_instances( $post_id );
+	wl_core_delete_relation_instances($post_id);
 
 	// Save relation instances
-	foreach ( array_unique( $disambiguated_entities ) as $referenced_entity_id ) {
+	foreach (array_unique($disambiguated_entities) as $referenced_entity_id) {
 
 		wl_core_add_relation_instance(
 			$post_id,
-			Wordlift_Entity_Service::get_instance()->get_classification_scope_for( $referenced_entity_id ),
+			Wordlift_Entity_Service::get_instance()->get_classification_scope_for($referenced_entity_id),
 			$referenced_entity_id
 		);
 
 	}
 
-	if ( isset( $_POST['wl_entities'] ) ) {
+	if (isset($_POST['wl_entities'])) {
 		// Save post metadata if available
-		$metadata_via_post = ( isset( $_POST['wl_metadata'] ) ) ?
+		$metadata_via_post = (isset($_POST['wl_metadata'])) ?
 			$_POST['wl_metadata'] : array();
 
 		$fields = array(
@@ -151,61 +151,61 @@ 
 		);
 
 		// Unlink topic taxonomy terms
-		Wordlift_Topic_Taxonomy_Service::get_instance()->unlink_topic_for( $post->ID );
+		Wordlift_Topic_Taxonomy_Service::get_instance()->unlink_topic_for($post->ID);
 
-		foreach ( $fields as $field ) {
+		foreach ($fields as $field) {
 
 			// Delete current values
-			delete_post_meta( $post->ID, $field );
+			delete_post_meta($post->ID, $field);
 			// Retrieve the entity uri
-			$uri = ( isset( $metadata_via_post[ $field ] ) ) ?
-				stripslashes( $metadata_via_post[ $field ] ) : '';
+			$uri = (isset($metadata_via_post[$field])) ?
+				stripslashes($metadata_via_post[$field]) : '';
 
-			$entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri );
+			$entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri($uri);
 
-			if ( $entity ) {
-				add_post_meta( $post->ID, $field, $entity->ID, true );
+			if ($entity) {
+				add_post_meta($post->ID, $field, $entity->ID, true);
 				// Set also the topic taxonomy
-				if ( $field === Wordlift_Schema_Service::FIELD_TOPIC ) {
-					Wordlift_Topic_Taxonomy_Service::get_instance()->set_topic_for( $post->ID, $entity );
+				if ($field === Wordlift_Schema_Service::FIELD_TOPIC) {
+					Wordlift_Topic_Taxonomy_Service::get_instance()->set_topic_for($post->ID, $entity);
 				}
 			}
 		}
 	}
 
 	// Push the post to Redlink.
-	wl_linked_data_push_to_redlink( $post->ID );
+	wl_linked_data_push_to_redlink($post->ID);
 
-	add_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
+	add_action('wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities');
 }
 
-add_action( 'wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities' );
+add_action('wl_linked_data_save_post', 'wl_linked_data_save_post_and_related_entities');
 
 /**
  * Adds default schema type "Thing" as soon as an entity is created.
  */
-function wordlift_save_post_add_default_schema_type( $entity_id ) {
+function wordlift_save_post_add_default_schema_type($entity_id) {
 
-	$entity = get_post( $entity_id );
+	$entity = get_post($entity_id);
 
 	// Avoid doing anything if post is autosave or a revision.
 
-	if ( wp_is_post_autosave( $entity ) || wp_is_post_revision( $entity ) ) {
+	if (wp_is_post_autosave($entity) || wp_is_post_revision($entity)) {
 		return;
 	}
 
-	$entity_type = wl_schema_get_types( $entity_id );
+	$entity_type = wl_schema_get_types($entity_id);
 
 	// Assign type 'Thing' if we are dealing with an entity without type
-	if ( $entity->post_type == Wordlift_Entity_Service::TYPE_NAME && is_null( $entity_type ) ) {
-		wl_schema_set_types( $entity_id, 'Thing' );
+	if ($entity->post_type == Wordlift_Entity_Service::TYPE_NAME && is_null($entity_type)) {
+		wl_schema_set_types($entity_id, 'Thing');
 	}
 
 }
 
 // Priority 1 (default is 10) because we want the default type to be set as soon as possible
 // Attatched to save_post because *wl_linked_data_save_post* does not always fire
-add_action( 'save_post', 'wordlift_save_post_add_default_schema_type', 1 );
+add_action('save_post', 'wordlift_save_post_add_default_schema_type', 1);
 
 /**
  * Save the specified data as an entity in WordPress. This method only create new entities. When an existing entity is
@@ -223,26 +223,26 @@ 
  *
  * @return null|WP_Post A post instance or null in case of failure.
  */
-function wl_save_entity( $entity_data ) {
+function wl_save_entity($entity_data) {
 
 	$uri              = $entity_data['uri'];
 	$label            = $entity_data['label'];
 	$type_uri         = $entity_data['main_type'];
-	$entity_types     = isset( $entity_data['type'] ) ? $entity_data['type'] : array();
+	$entity_types     = isset($entity_data['type']) ? $entity_data['type'] : array();
 	$description      = $entity_data['description'];
-	$images           = isset( $entity_data['image'] ) ? wl_force_to_array( $entity_data['image'] ) : array();
-	$same_as          = isset( $entity_data['sameas'] ) ? wl_force_to_array( $entity_data['sameas'] ) : array();
-	$related_post_id  = isset( $entity_data['related_post_id'] ) ? $entity_data['related_post_id'] : null;
-	$other_properties = isset( $entity_data['properties'] ) ? $entity_data['properties'] : array();
+	$images           = isset($entity_data['image']) ? wl_force_to_array($entity_data['image']) : array();
+	$same_as          = isset($entity_data['sameas']) ? wl_force_to_array($entity_data['sameas']) : array();
+	$related_post_id  = isset($entity_data['related_post_id']) ? $entity_data['related_post_id'] : null;
+	$other_properties = isset($entity_data['properties']) ? $entity_data['properties'] : array();
 
 	// Check whether an entity already exists with the provided URI.
-	if ( null !== $post = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri ) ) {
+	if (null !== $post = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri($uri)) {
 		return $post;
 	}
 
 	// Prepare properties of the new entity.
 	$params = array(
-		'post_status'  => ( is_numeric( $related_post_id ) ? get_post_status( $related_post_id ) : 'draft' ),
+		'post_status'  => (is_numeric($related_post_id) ? get_post_status($related_post_id) : 'draft'),
 		'post_type'    => Wordlift_Entity_Service::TYPE_NAME,
 		'post_title'   => $label,
 		'post_content' => $description,
@@ -252,7 +252,7 @@ 
 		// new entities.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/282
-		'post_name'    => sanitize_title( $label ),
+		'post_name'    => sanitize_title($label),
 	);
 
 	// If Yoast is installed and active, we temporary remove the save_postdata hook which causes Yoast to "pass over"
@@ -261,18 +261,18 @@ 
 	// This does NOT affect saving an entity from the entity admin page since this function is called when an entity
 	// is created when saving a post.
 	global $wpseo_metabox, $seo_ultimate;
-	if ( isset( $wpseo_metabox ) ) {
-		remove_action( 'wp_insert_post', array(
+	if (isset($wpseo_metabox)) {
+		remove_action('wp_insert_post', array(
 			$wpseo_metabox,
 			'save_postdata',
-		) );
+		));
 	}
 
-	if ( isset( $seo_ultimate ) ) {
-		remove_action( 'save_post', array(
+	if (isset($seo_ultimate)) {
+		remove_action('save_post', array(
 			$seo_ultimate,
 			'save_postmeta_box',
-		) );
+		));
 	}
 
 	// The fact that we're calling here wp_insert_post is causing issues with plugins (and ourselves too) that hook to
@@ -282,86 +282,86 @@ 
 	// see https://github.com/insideout10/wordlift-plugin/issues/156
 	// see https://github.com/insideout10/wordlift-plugin/issues/148
 	global $wp_filter;
-	$save_post_filters = is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] : $wp_filter['save_post']->callbacks;
-	is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] = array() : $wp_filter['save_post']->remove_all_filters();
+	$save_post_filters = is_array($wp_filter['save_post']) ? $wp_filter['save_post'] : $wp_filter['save_post']->callbacks;
+	is_array($wp_filter['save_post']) ? $wp_filter['save_post'] = array() : $wp_filter['save_post']->remove_all_filters();
 
 	// create or update the post.
-	$post_id = wp_insert_post( $params, true );
+	$post_id = wp_insert_post($params, true);
 
 	// Restore all the existing filters.
-	is_array( $wp_filter['save_post'] ) ? $wp_filter['save_post'] = $save_post_filters : $wp_filter['save_post']->callbacks = $save_post_filters;
+	is_array($wp_filter['save_post']) ? $wp_filter['save_post'] = $save_post_filters : $wp_filter['save_post']->callbacks = $save_post_filters;
 
 	// If Yoast is installed and active, we restore the Yoast save_postdata hook (https://github.com/insideout10/wordlift-plugin/issues/156)
-	if ( isset( $wpseo_metabox ) ) {
-		add_action( 'wp_insert_post', array(
+	if (isset($wpseo_metabox)) {
+		add_action('wp_insert_post', array(
 			$wpseo_metabox,
 			'save_postdata',
-		) );
+		));
 	}
 
 	// If SEO Ultimate is installed, add back the hook we removed a few lines above.
-	if ( isset( $seo_ultimate ) ) {
-		add_action( 'save_post', array(
+	if (isset($seo_ultimate)) {
+		add_action('save_post', array(
 			$seo_ultimate,
 			'save_postmeta_box',
-		), 10, 2 );
+		), 10, 2);
 	}
 
 	// TODO: handle errors.
-	if ( is_wp_error( $post_id ) ) {
-		wl_write_log( ': error occurred' );
+	if (is_wp_error($post_id)) {
+		wl_write_log(': error occurred');
 
 		// inform an error occurred.
 		return null;
 	}
 
-	wl_set_entity_main_type( $post_id, $type_uri );
+	wl_set_entity_main_type($post_id, $type_uri);
 
 	// Save the entity types.
-	wl_set_entity_rdf_types( $post_id, $entity_types );
+	wl_set_entity_rdf_types($post_id, $entity_types);
 
 	// Get a dataset URI for the entity.
-	$wl_uri = wl_build_entity_uri( $post_id );
+	$wl_uri = wl_build_entity_uri($post_id);
 
 	// Save the entity URI.
-	wl_set_entity_uri( $post_id, $wl_uri );
+	wl_set_entity_uri($post_id, $wl_uri);
 
 	// Add the uri to the sameAs data if it's not a local URI.
-	if ( $wl_uri !== $uri ) {
-		array_push( $same_as, $uri );
+	if ($wl_uri !== $uri) {
+		array_push($same_as, $uri);
 	}
 
-	$new_uri = wl_get_entity_uri( $post_id );
+	$new_uri = wl_get_entity_uri($post_id);
 
 	// Save the sameAs data for the entity.
-	wl_schema_set_value( $post_id, 'sameAs', $same_as );
+	wl_schema_set_value($post_id, 'sameAs', $same_as);
 
 	// Save the other properties (latitude, langitude, startDate, endDate, etc.)
-	foreach ( $other_properties as $property_name => $property_value ) {
-		wl_schema_set_value( $post_id, $property_name, $property_value );
+	foreach ($other_properties as $property_name => $property_value) {
+		wl_schema_set_value($post_id, $property_name, $property_value);
 	}
 
 	// Call hooks.
-	do_action( 'wl_save_entity', $post_id );
+	do_action('wl_save_entity', $post_id);
 
-	foreach ( $images as $image_remote_url ) {
+	foreach ($images as $image_remote_url) {
 
 		// Check if image is already present in local DB
-		if ( strpos( $image_remote_url, site_url() ) !== false ) {
+		if (strpos($image_remote_url, site_url()) !== false) {
 			// Do nothing.
 			continue;
 		}
 
 		// Check if there is an existing attachment for this post ID and source URL.
-		$existing_image = wl_get_attachment_for_source_url( $post_id, $image_remote_url );
+		$existing_image = wl_get_attachment_for_source_url($post_id, $image_remote_url);
 
 		// Skip if an existing image is found.
-		if ( null !== $existing_image ) {
+		if (null !== $existing_image) {
 			continue;
 		}
 
 		// Save the image and get the local path.
-		$image = wl_save_image( $image_remote_url );
+		$image = wl_save_image($image_remote_url);
 
 		// Get the local URL.
 		$filename     = $image['path'];
@@ -379,24 +379,24 @@ 
 		);
 
 		// Create the attachment in WordPress and generate the related metadata.
-		$attachment_id = wp_insert_attachment( $attachment, $filename, $post_id );
+		$attachment_id = wp_insert_attachment($attachment, $filename, $post_id);
 
 		// Set the source URL for the image.
-		wl_set_source_url( $attachment_id, $image_remote_url );
+		wl_set_source_url($attachment_id, $image_remote_url);
 
-		$attachment_data = wp_generate_attachment_metadata( $attachment_id, $filename );
-		wp_update_attachment_metadata( $attachment_id, $attachment_data );
+		$attachment_data = wp_generate_attachment_metadata($attachment_id, $filename);
+		wp_update_attachment_metadata($attachment_id, $attachment_data);
 
 		// Set it as the featured image.
-		set_post_thumbnail( $post_id, $attachment_id );
+		set_post_thumbnail($post_id, $attachment_id);
 	}
 
 	// The entity is pushed to Redlink on save by the function hooked to save_post.
 	// save the entity in the triple store.
-	wl_linked_data_push_to_redlink( $post_id );
+	wl_linked_data_push_to_redlink($post_id);
 
 	// finally return the entity post.
-	return get_post( $post_id );
+	return get_post($post_id);
 }
 
 /**
@@ -408,10 +408,10 @@ 
  *
  * @return array An array of entity posts.
  */
-function wl_linked_data_content_get_embedded_entities( $content ) {
+function wl_linked_data_content_get_embedded_entities($content) {
 
 	// Remove quote escapes.
-	$content = str_replace( '\\"', '"', $content );
+	$content = str_replace('\\"', '"', $content);
 
 	// Match all itemid attributes.
 	$pattern = '/<\w+[^>]*\sitemid="([^"]+)"[^>]*>/im';
@@ -422,8 +422,8 @@ 
 	$matches = array();
 
 	// In case of errors, return an empty array.
-	if ( false === preg_match_all( $pattern, $content, $matches ) ) {
-		wl_write_log( "Found no entities embedded in content" );
+	if (false === preg_match_all($pattern, $content, $matches)) {
+		wl_write_log("Found no entities embedded in content");
 
 		return array();
 	}
@@ -432,13 +432,13 @@ 
 
 	// Collect the entities.
 	$entities = array();
-	foreach ( $matches[1] as $uri ) {
-		$uri_d = html_entity_decode( $uri );
+	foreach ($matches[1] as $uri) {
+		$uri_d = html_entity_decode($uri);
 
-		$entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri( $uri_d );
+		$entity = Wordlift_Entity_Service::get_instance()->get_entity_post_by_uri($uri_d);
 
-		if ( null !== $entity ) {
-			array_push( $entities, $entity->ID );
+		if (null !== $entity) {
+			array_push($entities, $entity->ID);
 		}
 	}
 
@@ -455,24 +455,24 @@ 
  *
  * @param int $post_id The post ID.
  */
-function wl_linked_data_push_to_redlink( $post_id ) {
+function wl_linked_data_push_to_redlink($post_id) {
 
 	// Get the post.
-	$post = get_post( $post_id );
+	$post = get_post($post_id);
 
 	// wl_write_log( "wl_linked_data_push_to_redlink [ post id :: $post_id ][ post type :: $post->post_type ]" );
 
 	// Call the method on behalf of the post type.
-	switch ( $post->post_type ) {
+	switch ($post->post_type) {
 		case 'entity':
-			wl_push_entity_post_to_redlink( $post );
+			wl_push_entity_post_to_redlink($post);
 			break;
 		default:
-			wl_push_post_to_redlink( $post );
+			wl_push_post_to_redlink($post);
 	}
 
 	// Reindex the triple store if buffering is turned off.
-	if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
+	if (false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING) {
 		wordlift_reindex_triple_store();
 	}
 }

src/includes/class-wordlift-entity-service.php

Indentation +462 added lines, -462 removed lines

@@ -7,472 +7,472 @@
  */
 class Wordlift_Entity_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * The UI service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_UI_Service $ui_service The UI service.
-	 */
-	private $ui_service;
-
-	/**
-	 * The entity post type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const TYPE_NAME = 'entity';
-
-	/**
-	 * The alternative label meta key.
-	 *
-	 * @since 3.2.0
-	 */
-	const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
-
-	/**
-	 * The alternative label input template.
-	 *
-	 * @since 3.2.0
-	 */
-	// TODO: this should be moved to a class that deals with HTML code.
-	const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
+    /**
+     * The Log service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Log_Service $log The Log service.
+     */
+    private $log;
+
+    /**
+     * The UI service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_UI_Service $ui_service The UI service.
+     */
+    private $ui_service;
+
+    /**
+     * The entity post type name.
+     *
+     * @since 3.1.0
+     */
+    const TYPE_NAME = 'entity';
+
+    /**
+     * The alternative label meta key.
+     *
+     * @since 3.2.0
+     */
+    const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
+
+    /**
+     * The alternative label input template.
+     *
+     * @since 3.2.0
+     */
+    // TODO: this should be moved to a class that deals with HTML code.
+    const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
                 <label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label>
                 <input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text">
                 <button class="button wl-delete-button">%s</button>
                 </div>';
 
-	/**
-	 * A singleton instance of the Entity service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Entity_Service instance.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param \Wordlift_UI_Service $ui_service The UI service.
-	 */
-	public function __construct( $ui_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		// Set the UI service.
-		$this->ui_service = $ui_service;
-
-		// Set the singleton instance.
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Entity service.
-	 *
-	 * @since 3.2.0
-	 * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Determines whether a post is an entity or not.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param int $post_id A post id.
-	 *
-	 * @return bool Return true if the post is an entity otherwise false.
-	 */
-	public function is_entity( $post_id ) {
-
-		return ( self::TYPE_NAME === get_post_type( $post_id ) );
-	}
-
-	/**
-	 * Get the proper classification scope for a given entity post
-	 *
-	 * @since 3.5.0
-	 *
-	 * @param integer $post_id An entity post id.
-	 *
-	 * @return string Returns an uri.
-	 */
-	public function get_classification_scope_for( $post_id ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return null;
-		}
-		// Retrieve the entity type
-		$entity_type_arr = wl_entity_type_taxonomy_get_type( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
-		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
-				return $cb['id'];
-			}
-		}
-
-		// or null
-		return null;
-
-	}
-
-
-	public function is_used( $post_id ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return null;
-		}
-		// Retrieve the post
-		$entity = get_post( $post_id );
-
-		global $wpdb;
-		// Retrieve Wordlift relation instances table name
-		$table_name = wl_core_get_relation_instances_table_name();
-
-		// Check is it's referenced / related to another post / entity
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
-			$entity->ID
-		);
-
-		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
-		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
-			return true;
-		}
-
-		// Check if the entity uri is used as meta_value
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
-			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
-		);
-		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
-
-		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
-			return true;
-		}
-
-		// If we are here, it means the current entity is not used at the moment
-		return false;
-	}
-
-	/**
-	 * Determines whether a given uri is an internal uri or not.
-	 *
-	 * @since 3.3.2
-	 *
-	 * @param int $uri An uri.
-	 *
-	 * @return true if the uri internal to the current dataset otherwise false.
-	 */
-	public function is_internal_uri( $uri ) {
-
-		return ( 0 === strrpos( $uri, wl_configuration_get_redlink_dataset_uri() ) );
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 */
-	public function get_entity_post_by_uri( $uri ) {
-
-		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
-			return null;
-		}
-
-		$query_args = array(
-			'posts_per_page' => 1,
-			'post_status'    => 'any',
-			'post_type'      => self::TYPE_NAME,
-			'meta_query'     => array(
-				array(
-					'key'     => WL_ENTITY_URL_META_NAME,
-					'value'   => $uri,
-					'compare' => '=',
-				),
-			),
-		);
-
-		// Only if the current uri is not an internal uri, entity search is
-		// performed also looking at sameAs values.
-		//
-		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal_uri( $uri ) ) {
-
-			$query_args['meta_query']['relation'] = 'OR';
-			$query_args['meta_query'][]           = array(
-				'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
-				'value'   => $uri,
-				'compare' => '=',
-			);
-		}
-
-		$query = new WP_Query( $query_args );
-
-		// Get the matching entity posts.
-		$posts = $query->get_posts();
-
-		// Return null if no post is found.
-		if ( 0 === count( $posts ) ) {
-			return null;
-		}
-
-		// Return the found post.
-		return $posts[0];
-	}
-
-	/**
-	 * Fires once a post has been saved. This function uses the $_REQUEST, therefore
-	 * we check that the post we're saving is the current post.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/363
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int     $post_id Post ID.
-	 * @param WP_Post $post    Post object.
-	 * @param bool    $update  Whether this is an existing post being updated or not.
-	 */
-	public function save_post( $post_id, $post, $update ) {
-
-		// Avoid doing anything if post is autosave or a revision.
-
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
-			return;
-		}
-
-		// We're setting the alternative label that have been provided via the UI
-		// (in fact we're using $_REQUEST), while save_post may be also called
-		// programmatically by some other function: we need to check therefore if
-		// the $post_id in the save_post call matches the post id set in the request.
-		//
-		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-
-		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
-
-		// Set the alternative labels.
-		$this->set_alternative_labels( $post_id, $alt_labels );
-
-	}
-
-	/**
-	 * Set the alternative labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int   $post_id    The post id.
-	 * @param array $alt_labels An array of labels.
-	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
-
-		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
-		}
-
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
-
-		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-
-		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
-			}
-		}
-
-	}
-
-	/**
-	 * Retrieve the alternate labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int $post_id Post id.
-	 *
-	 * @return mixed An array  of alternative labels.
-	 */
-	public function get_alternative_labels( $post_id ) {
-
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-	}
-
-	/**
-	 * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param WP_Post $post Post object.
-	 */
-	public function edit_form_before_permalink( $post ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
-			return;
-		}
-
-		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
-
-		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
-
-			echo $this->get_alternative_label_input( $alt_label );
-
-		};
-
-		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
-
-	}
-
-	/**
-	 * Get the URI for the entity with the specified post id.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
-	 */
-	public function get_uri( $post_id ) {
-
-		// If a null is given, nothing to do
-		if ( null == $post_id ) {
-			return null;
-		}
-
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
-
-		// If the dataset uri is not properly configured, null is returned
-		if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
-			return null;
-		}
-
-		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
-		}
-
-		return $uri;
-	}
-
-
-	/**
-	 * Get the alternative label input HTML code.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $value The input value.
-	 *
-	 * @return string The input HTML code.
-	 */
-	private function get_alternative_label_input( $value = '' ) {
-
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
-	}
-
-	/**
-	 * Get the number of entity posts published in this blog.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return int The number of published entity posts.
-	 */
-	public function count() {
-
-		$count = wp_count_posts( self::TYPE_NAME );
-
-		return $count->publish;
-	}
-
-	/**
-	 * Create a new entity.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param string $name     The entity name.
-	 * @param string $type_uri The entity's type URI.
-	 * @param null   $logo     The entity logo id (or NULL if none).
-	 * @param string $status   The post status, by default 'publish'.
-	 *
-	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
-	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
-
-		// Create an entity for the publisher.
-		$post_id = wp_insert_post( array(
-			'post_type'    => self::TYPE_NAME,
-			'post_title'   => $name,
-			'post_status'  => $status,
-			'post_content' => '',
-		) );
-
-		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
-			return $post_id;
-		}
-
-		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
-		}
-
-		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
-
-		return $post_id;
-	}
-
-	/**
-	 * Get the entities related to the one with the specified id. By default only
-	 * published entities will be returned.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @param int    $id          The post id.
-	 * @param string $post_status The target post status (default = publish).
-	 *
-	 * @return array An array of post ids.
-	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
-
-		return wl_core_inner_get_related_entities( 'post_ids', $id, null, $post_status );
-	}
+    /**
+     * A singleton instance of the Entity service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Entity_Service instance.
+     *
+     * @since 3.2.0
+     *
+     * @param \Wordlift_UI_Service $ui_service The UI service.
+     */
+    public function __construct( $ui_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        // Set the UI service.
+        $this->ui_service = $ui_service;
+
+        // Set the singleton instance.
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Entity service.
+     *
+     * @since 3.2.0
+     * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Determines whether a post is an entity or not.
+     *
+     * @since 3.1.0
+     *
+     * @param int $post_id A post id.
+     *
+     * @return bool Return true if the post is an entity otherwise false.
+     */
+    public function is_entity( $post_id ) {
+
+        return ( self::TYPE_NAME === get_post_type( $post_id ) );
+    }
+
+    /**
+     * Get the proper classification scope for a given entity post
+     *
+     * @since 3.5.0
+     *
+     * @param integer $post_id An entity post id.
+     *
+     * @return string Returns an uri.
+     */
+    public function get_classification_scope_for( $post_id ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return null;
+        }
+        // Retrieve the entity type
+        $entity_type_arr = wl_entity_type_taxonomy_get_type( $post_id );
+        $entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+        // Retrieve classification boxes configuration
+        $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+        foreach ( $classification_boxes as $cb ) {
+            if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+                return $cb['id'];
+            }
+        }
+
+        // or null
+        return null;
+
+    }
+
+
+    public function is_used( $post_id ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return null;
+        }
+        // Retrieve the post
+        $entity = get_post( $post_id );
+
+        global $wpdb;
+        // Retrieve Wordlift relation instances table name
+        $table_name = wl_core_get_relation_instances_table_name();
+
+        // Check is it's referenced / related to another post / entity
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
+            $entity->ID
+        );
+
+        // Perform the query
+        $relation_instances = (int) $wpdb->get_var( $stmt );
+        // If there is at least one relation instance for the current entity, then it's used
+        if ( 0 < $relation_instances ) {
+            return true;
+        }
+
+        // Check if the entity uri is used as meta_value
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
+            $entity->ID,
+            wl_get_entity_uri( $entity->ID )
+        );
+        // Perform the query
+        $meta_instances = (int) $wpdb->get_var( $stmt );
+
+        // If there is at least one meta that refers the current entity uri, then current entity is used
+        if ( 0 < $meta_instances ) {
+            return true;
+        }
+
+        // If we are here, it means the current entity is not used at the moment
+        return false;
+    }
+
+    /**
+     * Determines whether a given uri is an internal uri or not.
+     *
+     * @since 3.3.2
+     *
+     * @param int $uri An uri.
+     *
+     * @return true if the uri internal to the current dataset otherwise false.
+     */
+    public function is_internal_uri( $uri ) {
+
+        return ( 0 === strrpos( $uri, wl_configuration_get_redlink_dataset_uri() ) );
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @since 3.2.0
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     */
+    public function get_entity_post_by_uri( $uri ) {
+
+        // Check if we've been provided with a value otherwise return null.
+        if ( empty( $uri ) ) {
+            return null;
+        }
+
+        $query_args = array(
+            'posts_per_page' => 1,
+            'post_status'    => 'any',
+            'post_type'      => self::TYPE_NAME,
+            'meta_query'     => array(
+                array(
+                    'key'     => WL_ENTITY_URL_META_NAME,
+                    'value'   => $uri,
+                    'compare' => '=',
+                ),
+            ),
+        );
+
+        // Only if the current uri is not an internal uri, entity search is
+        // performed also looking at sameAs values.
+        //
+        // This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
+        if ( ! $this->is_internal_uri( $uri ) ) {
+
+            $query_args['meta_query']['relation'] = 'OR';
+            $query_args['meta_query'][]           = array(
+                'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
+                'value'   => $uri,
+                'compare' => '=',
+            );
+        }
+
+        $query = new WP_Query( $query_args );
+
+        // Get the matching entity posts.
+        $posts = $query->get_posts();
+
+        // Return null if no post is found.
+        if ( 0 === count( $posts ) ) {
+            return null;
+        }
+
+        // Return the found post.
+        return $posts[0];
+    }
+
+    /**
+     * Fires once a post has been saved. This function uses the $_REQUEST, therefore
+     * we check that the post we're saving is the current post.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/363
+     *
+     * @since 3.2.0
+     *
+     * @param int     $post_id Post ID.
+     * @param WP_Post $post    Post object.
+     * @param bool    $update  Whether this is an existing post being updated or not.
+     */
+    public function save_post( $post_id, $post, $update ) {
+
+        // Avoid doing anything if post is autosave or a revision.
+
+        if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+            return;
+        }
+
+        // We're setting the alternative label that have been provided via the UI
+        // (in fact we're using $_REQUEST), while save_post may be also called
+        // programmatically by some other function: we need to check therefore if
+        // the $post_id in the save_post call matches the post id set in the request.
+        //
+        // If this is not the current post being saved or if it's not an entity, return.
+        if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+
+        // Get the alt labels from the request (or empty array).
+        $alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+
+        // Set the alternative labels.
+        $this->set_alternative_labels( $post_id, $alt_labels );
+
+    }
+
+    /**
+     * Set the alternative labels.
+     *
+     * @since 3.2.0
+     *
+     * @param int   $post_id    The post id.
+     * @param array $alt_labels An array of labels.
+     */
+    public function set_alternative_labels( $post_id, $alt_labels ) {
+
+        // Force $alt_labels to be an array
+        if ( ! is_array( $alt_labels ) ) {
+            $alt_labels = array( $alt_labels );
+        }
+
+        $this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+
+        // Delete all the existing alternate labels.
+        delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+
+        // Set the alternative labels.
+        foreach ( $alt_labels as $alt_label ) {
+            if ( ! empty( $alt_label ) ) {
+                add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+            }
+        }
+
+    }
+
+    /**
+     * Retrieve the alternate labels.
+     *
+     * @since 3.2.0
+     *
+     * @param int $post_id Post id.
+     *
+     * @return mixed An array  of alternative labels.
+     */
+    public function get_alternative_labels( $post_id ) {
+
+        return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+    }
+
+    /**
+     * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
+     *
+     * @since 3.2.0
+     *
+     * @param WP_Post $post Post object.
+     */
+    public function edit_form_before_permalink( $post ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post->ID ) ) {
+            return;
+        }
+
+        // Print the input template.
+        $this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+
+        // Print all the currently set alternative labels.
+        foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+
+            echo $this->get_alternative_label_input( $alt_label );
+
+        };
+
+        // Print the button.
+        $this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+
+    }
+
+    /**
+     * Get the URI for the entity with the specified post id.
+     *
+     * @since 3.6.0
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
+     */
+    public function get_uri( $post_id ) {
+
+        // If a null is given, nothing to do
+        if ( null == $post_id ) {
+            return null;
+        }
+
+        $uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+
+        // If the dataset uri is not properly configured, null is returned
+        if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
+            return null;
+        }
+
+        // Set the URI if it isn't set yet.
+        $post_status = get_post_status( $post_id );
+        if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
+            $uri = wl_build_entity_uri( $post_id );
+            wl_set_entity_uri( $post_id, $uri );
+        }
+
+        return $uri;
+    }
+
+
+    /**
+     * Get the alternative label input HTML code.
+     *
+     * @since 3.2.0
+     *
+     * @param string $value The input value.
+     *
+     * @return string The input HTML code.
+     */
+    private function get_alternative_label_input( $value = '' ) {
+
+        return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+    }
+
+    /**
+     * Get the number of entity posts published in this blog.
+     *
+     * @since 3.6.0
+     *
+     * @return int The number of published entity posts.
+     */
+    public function count() {
+
+        $count = wp_count_posts( self::TYPE_NAME );
+
+        return $count->publish;
+    }
+
+    /**
+     * Create a new entity.
+     *
+     * @since 3.9.0
+     *
+     * @param string $name     The entity name.
+     * @param string $type_uri The entity's type URI.
+     * @param null   $logo     The entity logo id (or NULL if none).
+     * @param string $status   The post status, by default 'publish'.
+     *
+     * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
+     */
+    public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+
+        // Create an entity for the publisher.
+        $post_id = wp_insert_post( array(
+            'post_type'    => self::TYPE_NAME,
+            'post_title'   => $name,
+            'post_status'  => $status,
+            'post_content' => '',
+        ) );
+
+        // Return the error if any.
+        if ( is_wp_error( $post_id ) ) {
+            return $post_id;
+        }
+
+        // Set the entity logo.
+        if ( $logo && is_numeric( $logo ) ) {
+            set_post_thumbnail( $post_id, $logo );
+        }
+
+        // Set the entity type.
+        Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+
+        return $post_id;
+    }
+
+    /**
+     * Get the entities related to the one with the specified id. By default only
+     * published entities will be returned.
+     *
+     * @since 3.10.0
+     *
+     * @param int    $id          The post id.
+     * @param string $post_status The target post status (default = publish).
+     *
+     * @return array An array of post ids.
+     */
+    public function get_related_entities( $id, $post_status = 'publish' ) {
+
+        return wl_core_inner_get_related_entities( 'post_ids', $id, null, $post_status );
+    }
 
 }

Spacing +67 added lines, -67 removed lines

@@ -67,9 +67,9 @@ 
 	 *
 	 * @param \Wordlift_UI_Service $ui_service The UI service.
 	 */
-	public function __construct( $ui_service ) {
+	public function __construct($ui_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		// Set the UI service.
 		$this->ui_service = $ui_service;
@@ -99,9 +99,9 @@ 
 	 *
 	 * @return bool Return true if the post is an entity otherwise false.
 	 */
-	public function is_entity( $post_id ) {
+	public function is_entity($post_id) {
 
-		return ( self::TYPE_NAME === get_post_type( $post_id ) );
+		return (self::TYPE_NAME === get_post_type($post_id));
 	}
 
 	/**
@@ -113,18 +113,18 @@ 
 	 *
 	 * @return string Returns an uri.
 	 */
-	public function get_classification_scope_for( $post_id ) {
+	public function get_classification_scope_for($post_id) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return null;
 		}
 		// Retrieve the entity type
-		$entity_type_arr = wl_entity_type_taxonomy_get_type( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+		$entity_type_arr = wl_entity_type_taxonomy_get_type($post_id);
+		$entity_type     = str_replace('wl-', '', $entity_type_arr['css_class']);
 		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+		$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
+		foreach ($classification_boxes as $cb) {
+			if (in_array($entity_type, $cb['registeredTypes'])) {
 				return $cb['id'];
 			}
 		}
@@ -135,13 +135,13 @@ 
 	}
 
 
-	public function is_used( $post_id ) {
+	public function is_used($post_id) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return null;
 		}
 		// Retrieve the post
-		$entity = get_post( $post_id );
+		$entity = get_post($post_id);
 
 		global $wpdb;
 		// Retrieve Wordlift relation instances table name
@@ -154,9 +154,9 @@ 
 		);
 
 		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
+		$relation_instances = (int) $wpdb->get_var($stmt);
 		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
+		if (0 < $relation_instances) {
 			return true;
 		}
 
@@ -164,13 +164,13 @@ 
 		$stmt = $wpdb->prepare(
 			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
 			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
+			wl_get_entity_uri($entity->ID)
 		);
 		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
+		$meta_instances = (int) $wpdb->get_var($stmt);
 
 		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
+		if (0 < $meta_instances) {
 			return true;
 		}
 
@@ -187,9 +187,9 @@ 
 	 *
 	 * @return true if the uri internal to the current dataset otherwise false.
 	 */
-	public function is_internal_uri( $uri ) {
+	public function is_internal_uri($uri) {
 
-		return ( 0 === strrpos( $uri, wl_configuration_get_redlink_dataset_uri() ) );
+		return (0 === strrpos($uri, wl_configuration_get_redlink_dataset_uri()));
 	}
 
 	/**
@@ -201,10 +201,10 @@ 
 	 *
 	 * @return WP_Post|null A WP_Post instance or null if not found.
 	 */
-	public function get_entity_post_by_uri( $uri ) {
+	public function get_entity_post_by_uri($uri) {
 
 		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
+		if (empty($uri)) {
 			return null;
 		}
 
@@ -225,7 +225,7 @@ 
 		// performed also looking at sameAs values.
 		//
 		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal_uri( $uri ) ) {
+		if ( ! $this->is_internal_uri($uri)) {
 
 			$query_args['meta_query']['relation'] = 'OR';
 			$query_args['meta_query'][]           = array(
@@ -235,13 +235,13 @@ 
 			);
 		}
 
-		$query = new WP_Query( $query_args );
+		$query = new WP_Query($query_args);
 
 		// Get the matching entity posts.
 		$posts = $query->get_posts();
 
 		// Return null if no post is found.
-		if ( 0 === count( $posts ) ) {
+		if (0 === count($posts)) {
 			return null;
 		}
 
@@ -261,11 +261,11 @@ 
 	 * @param WP_Post $post    Post object.
 	 * @param bool    $update  Whether this is an existing post being updated or not.
 	 */
-	public function save_post( $post_id, $post, $update ) {
+	public function save_post($post_id, $post, $update) {
 
 		// Avoid doing anything if post is autosave or a revision.
 
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+		if (wp_is_post_autosave($post) || wp_is_post_revision($post)) {
 			return;
 		}
 
@@ -275,15 +275,15 @@ 
 		// the $post_id in the save_post call matches the post id set in the request.
 		//
 		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+		if ( ! isset($_REQUEST['post_ID']) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity($post_id)) {
 			return;
 		}
 
 		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+		$alt_labels = isset($_REQUEST['wl_alternative_label']) ? $_REQUEST['wl_alternative_label'] : array();
 
 		// Set the alternative labels.
-		$this->set_alternative_labels( $post_id, $alt_labels );
+		$this->set_alternative_labels($post_id, $alt_labels);
 
 	}
 
@@ -295,22 +295,22 @@ 
 	 * @param int   $post_id    The post id.
 	 * @param array $alt_labels An array of labels.
 	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
+	public function set_alternative_labels($post_id, $alt_labels) {
 
 		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
+		if ( ! is_array($alt_labels)) {
+			$alt_labels = array($alt_labels);
 		}
 
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+		$this->log->debug("Setting alternative labels [ post id :: $post_id ][ alt labels :: ".implode(',', $alt_labels)." ]");
 
 		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		delete_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 
 		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+		foreach ($alt_labels as $alt_label) {
+			if ( ! empty($alt_label)) {
+				add_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label);
 			}
 		}
 
@@ -325,9 +325,9 @@ 
 	 *
 	 * @return mixed An array  of alternative labels.
 	 */
-	public function get_alternative_labels( $post_id ) {
+	public function get_alternative_labels($post_id) {
 
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		return get_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 	}
 
 	/**
@@ -337,25 +337,25 @@ 
 	 *
 	 * @param WP_Post $post Post object.
 	 */
-	public function edit_form_before_permalink( $post ) {
+	public function edit_form_before_permalink($post) {
 
 		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
+		if ( ! $this->is_entity($post->ID)) {
 			return;
 		}
 
 		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+		$this->ui_service->print_template('wl-tmpl-alternative-label-input', $this->get_alternative_label_input());
 
 		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+		foreach ($this->get_alternative_labels($post->ID) as $alt_label) {
 
-			echo $this->get_alternative_label_input( $alt_label );
+			echo $this->get_alternative_label_input($alt_label);
 
 		};
 
 		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+		$this->ui_service->print_button('wl-add-alternative-labels-button', __('Add more titles', 'wordlift'));
 
 	}
 
@@ -368,25 +368,25 @@ 
 	 *
 	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
 	 */
-	public function get_uri( $post_id ) {
+	public function get_uri($post_id) {
 
 		// If a null is given, nothing to do
-		if ( null == $post_id ) {
+		if (null == $post_id) {
 			return null;
 		}
 
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+		$uri = get_post_meta($post_id, WL_ENTITY_URL_META_NAME, true);
 
 		// If the dataset uri is not properly configured, null is returned
-		if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
+		if ('' === wl_configuration_get_redlink_dataset_uri()) {
 			return null;
 		}
 
 		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
+		$post_status = get_post_status($post_id);
+		if (empty($uri) && 'auto-draft' !== $post_status && 'revision' !== $post_status) {
+			$uri = wl_build_entity_uri($post_id);
+			wl_set_entity_uri($post_id, $uri);
 		}
 
 		return $uri;
@@ -402,9 +402,9 @@ 
 	 *
 	 * @return string The input HTML code.
 	 */
-	private function get_alternative_label_input( $value = '' ) {
+	private function get_alternative_label_input($value = '') {
 
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+		return sprintf(self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr($value), __('Delete', 'wordlift'));
 	}
 
 	/**
@@ -416,7 +416,7 @@ 
 	 */
 	public function count() {
 
-		$count = wp_count_posts( self::TYPE_NAME );
+		$count = wp_count_posts(self::TYPE_NAME);
 
 		return $count->publish;
 	}
@@ -433,28 +433,28 @@ 
 	 *
 	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
 	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+	public function create($name, $type_uri, $logo = null, $status = 'publish') {
 
 		// Create an entity for the publisher.
-		$post_id = wp_insert_post( array(
+		$post_id = wp_insert_post(array(
 			'post_type'    => self::TYPE_NAME,
 			'post_title'   => $name,
 			'post_status'  => $status,
 			'post_content' => '',
-		) );
+		));
 
 		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
+		if (is_wp_error($post_id)) {
 			return $post_id;
 		}
 
 		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
+		if ($logo && is_numeric($logo)) {
+			set_post_thumbnail($post_id, $logo);
 		}
 
 		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+		Wordlift_Entity_Type_Service::get_instance()->set($post_id, $type_uri);
 
 		return $post_id;
 	}
@@ -470,9 +470,9 @@ 
 	 *
 	 * @return array An array of post ids.
 	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
+	public function get_related_entities($id, $post_status = 'publish') {
 
-		return wl_core_inner_get_related_entities( 'post_ids', $id, null, $post_status );
+		return wl_core_inner_get_related_entities('post_ids', $id, null, $post_status);
 	}
 
 }

src/includes/class-wordlift-entity-post-type-service.php

Indentation +143 added lines, -143 removed lines

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

Spacing +17 added lines, -17 removed lines

@@ -51,7 +51,7 @@ 
 	 * @param string $post_type The post type, e.g. entity.
 	 * @param string $slug      The entity type slug, if the slug is empty, the default slug will be used.
 	 */
-	public function __construct( $post_type, $slug ) {
+	public function __construct($post_type, $slug) {
 
 		$this->post_type = $post_type;
 
@@ -108,19 +108,19 @@ 
 	public function register() {
 
 		$labels = array(
-			'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
-			'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
-			'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
-			'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
-			'edit_item'          => __( 'Edit Entity', 'wordlift' ),
-			'new_item'           => __( 'New Entity', 'wordlift' ),
-			'all_items'          => __( 'All Entities', 'wordlift' ),
-			'view_item'          => __( 'View Entity', 'wordlift' ),
-			'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
-			'not_found'          => __( 'No entities found', 'wordlift' ),
-			'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
+			'name'               => _x('Vocabulary', 'post type general name', 'wordlift'),
+			'singular_name'      => _x('Entity', 'post type singular name', 'wordlift'),
+			'add_new'            => _x('Add New Entity', 'entity', 'wordlift'),
+			'add_new_item'       => __('Add New Entity', 'wordlift'),
+			'edit_item'          => __('Edit Entity', 'wordlift'),
+			'new_item'           => __('New Entity', 'wordlift'),
+			'all_items'          => __('All Entities', 'wordlift'),
+			'view_item'          => __('View Entity', 'wordlift'),
+			'search_items'       => __('Search in Vocabulary', 'wordlift'),
+			'not_found'          => __('No entities found', 'wordlift'),
+			'not_found_in_trash' => __('No entities found in the Trash', 'wordlift'),
 			'parent_item_colon'  => '',
-			'menu_name'          => __( 'Vocabulary', 'wordlift' ),
+			'menu_name'          => __('Vocabulary', 'wordlift'),
 		);
 
 		$args = array(
@@ -142,12 +142,12 @@ 
 				'revisions',
 			),
 			'has_archive'   => true,
-			'menu_icon'     => WP_CONTENT_URL . '/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
+			'menu_icon'     => WP_CONTENT_URL.'/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
 			// Although we define our slug here, we further manage linking to entities using the Wordlift_Entity_Link_Service.
-			'rewrite'       => array( 'slug' => $this->slug ),
+			'rewrite'       => array('slug' => $this->slug),
 		);
 
-		register_post_type( $this->post_type, $args );
+		register_post_type($this->post_type, $args);
 
 		// Enable WP's standard `category` taxonomy for entities.
 		//
@@ -156,7 +156,7 @@ 
 		// WP's main category query to include the `entity` post type.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/442
-		register_taxonomy_for_object_type( 'category', $this->post_type );
+		register_taxonomy_for_object_type('category', $this->post_type);
 
 	}