insideout10 / wordlift-plugin

src/admin/wordlift_admin_edit_post.php

Indentation +18 added lines, -18 removed lines

@@ -16,29 +16,29 @@
  */
 function wl_admin_permalink_html( $html, $post_id, $new_title, $new_slug ) {
 
-	// Get the entity service instance.
-	$entity_service = Wordlift_Entity_Service::get_instance();
+    // Get the entity service instance.
+    $entity_service = Wordlift_Entity_Service::get_instance();
 
-	// Show the View Linked Data button only for entities.
-	//
-	// See https://github.com/insideout10/wordlift-plugin/issues/668.
-	if ( 'publish' === get_post_status( $post_id )
-		 && $uri = $entity_service->get_uri( $post_id ) ) {
+    // Show the View Linked Data button only for entities.
+    //
+    // See https://github.com/insideout10/wordlift-plugin/issues/668.
+    if ( 'publish' === get_post_status( $post_id )
+         && $uri = $entity_service->get_uri( $post_id ) ) {
 
-		$lod_view_href = 'http://lodview.it/lodview/?IRI=' . urlencode( $uri );
-		$html          .= "<span id='view-post-btn'><a href='$lod_view_href' class='button button-small wl-button' target='_blank'>" .
-						  esc_html__( 'View Linked Data', 'wordlift' ) .
-						  "</a></span>\n";
+        $lod_view_href = 'http://lodview.it/lodview/?IRI=' . urlencode( $uri );
+        $html          .= "<span id='view-post-btn'><a href='$lod_view_href' class='button button-small wl-button' target='_blank'>" .
+                            esc_html__( 'View Linked Data', 'wordlift' ) .
+                            "</a></span>\n";
 
-	}
+    }
 
-	$html .= "<span id='view-post-btn'><a href='" . WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL .
-			 urlencode( get_permalink( $post_id ) ) .
-			 "' class='button button-small wl-button' target='_blank'>" .
-			 esc_html__( 'Test Google Rich Snippets', 'wordlift' ) .
-			 "</a></span>\n";
+    $html .= "<span id='view-post-btn'><a href='" . WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL .
+                urlencode( get_permalink( $post_id ) ) .
+                "' class='button button-small wl-button' target='_blank'>" .
+                esc_html__( 'Test Google Rich Snippets', 'wordlift' ) .
+                "</a></span>\n";
 
-	return $html;
+    return $html;
 }
 
 add_filter( 'get_sample_permalink_html', 'wl_admin_permalink_html', PHP_INT_MAX, 4 );

Spacing +11 added lines, -11 removed lines

@@ -14,7 +14,7 @@ 
  *
  * @return string The enhanced html.
  */
-function wl_admin_permalink_html( $html, $post_id, $new_title, $new_slug ) {
+function wl_admin_permalink_html($html, $post_id, $new_title, $new_slug) {
 
 	// Get the entity service instance.
 	$entity_service = Wordlift_Entity_Service::get_instance();
@@ -22,23 +22,23 @@ 
 	// Show the View Linked Data button only for entities.
 	//
 	// See https://github.com/insideout10/wordlift-plugin/issues/668.
-	if ( 'publish' === get_post_status( $post_id )
-		 && $uri = $entity_service->get_uri( $post_id ) ) {
+	if ('publish' === get_post_status($post_id)
+		 && $uri = $entity_service->get_uri($post_id)) {
 
-		$lod_view_href = 'http://lodview.it/lodview/?IRI=' . urlencode( $uri );
-		$html          .= "<span id='view-post-btn'><a href='$lod_view_href' class='button button-small wl-button' target='_blank'>" .
-						  esc_html__( 'View Linked Data', 'wordlift' ) .
+		$lod_view_href = 'http://lodview.it/lodview/?IRI='.urlencode($uri);
+		$html .= "<span id='view-post-btn'><a href='$lod_view_href' class='button button-small wl-button' target='_blank'>".
+						  esc_html__('View Linked Data', 'wordlift').
 						  "</a></span>\n";
 
 	}
 
-	$html .= "<span id='view-post-btn'><a href='" . WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL .
-			 urlencode( get_permalink( $post_id ) ) .
-			 "' class='button button-small wl-button' target='_blank'>" .
-			 esc_html__( 'Test Google Rich Snippets', 'wordlift' ) .
+	$html .= "<span id='view-post-btn'><a href='".WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL.
+			 urlencode(get_permalink($post_id)).
+			 "' class='button button-small wl-button' target='_blank'>".
+			 esc_html__('Test Google Rich Snippets', 'wordlift').
 			 "</a></span>\n";
 
 	return $html;
 }
 
-add_filter( 'get_sample_permalink_html', 'wl_admin_permalink_html', PHP_INT_MAX, 4 );
+add_filter('get_sample_permalink_html', 'wl_admin_permalink_html', PHP_INT_MAX, 4);

src/admin/wordlift_admin.php

Indentation +39 added lines, -39 removed lines

@@ -17,28 +17,28 @@ 
  */
 function wl_serialize_entity( $entity ) {
 
-	$entity = ( is_numeric( $entity ) ) ? get_post( $entity ) : $entity;
+    $entity = ( is_numeric( $entity ) ) ? get_post( $entity ) : $entity;
 
-	// Bail if the entity doesn't exists.
-	// In some cases we have `wl_topic` meta
-	// pointing to an entity that has been deleted.
-	if ( empty( $entity ) ) {
-		return;
-	}
+    // Bail if the entity doesn't exists.
+    // In some cases we have `wl_topic` meta
+    // pointing to an entity that has been deleted.
+    if ( empty( $entity ) ) {
+        return;
+    }
 
-	$type   = Wordlift_Entity_Type_Service::get_instance()->get( $entity->ID );
-	$images = wl_get_image_urls( $entity->ID );
+    $type   = Wordlift_Entity_Type_Service::get_instance()->get( $entity->ID );
+    $images = wl_get_image_urls( $entity->ID );
 
-	return array(
-		'id'          => wl_get_entity_uri( $entity->ID ),
-		'label'       => $entity->post_title,
-		'description' => $entity->post_content,
-		'sameAs'      => wl_schema_get_value( $entity->ID, 'sameAs' ),
-		'mainType'    => str_replace( 'wl-', '', $type['css_class'] ),
-		'types'       => wl_get_entity_rdf_types( $entity->ID ),
-		'images'      => $images,
+    return array(
+        'id'          => wl_get_entity_uri( $entity->ID ),
+        'label'       => $entity->post_title,
+        'description' => $entity->post_content,
+        'sameAs'      => wl_schema_get_value( $entity->ID, 'sameAs' ),
+        'mainType'    => str_replace( 'wl-', '', $type['css_class'] ),
+        'types'       => wl_get_entity_rdf_types( $entity->ID ),
+        'images'      => $images,
 
-	);
+    );
 }
 
 /**
@@ -52,27 +52,27 @@ 
  */
 function wl_remove_text_annotations( $data ) {
 
-	// Remove blank elements that can interfere with annotations removing
-	// See https://github.com/insideout10/wordlift-plugin/issues/234
-	// Just blank attributes without any attributes are cleaned up.
-	$pattern = '/<(\w+)><\/\1>/im';
-	// Remove the pattern while it is found (match nested annotations).
-	while ( 1 === preg_match( $pattern, $data['post_content'] ) ) {
-		$data['post_content'] = preg_replace( $pattern, '$2', $data['post_content'], -1, $count );
-	}
-	// Remove text annotations
-	// <span class="textannotation" id="urn:enhancement-777cbed4-b131-00fb-54a4-ed9b26ae57ea">.
+    // Remove blank elements that can interfere with annotations removing
+    // See https://github.com/insideout10/wordlift-plugin/issues/234
+    // Just blank attributes without any attributes are cleaned up.
+    $pattern = '/<(\w+)><\/\1>/im';
+    // Remove the pattern while it is found (match nested annotations).
+    while ( 1 === preg_match( $pattern, $data['post_content'] ) ) {
+        $data['post_content'] = preg_replace( $pattern, '$2', $data['post_content'], -1, $count );
+    }
+    // Remove text annotations
+    // <span class="textannotation" id="urn:enhancement-777cbed4-b131-00fb-54a4-ed9b26ae57ea">.
 
-	// @see https://github.com/insideout10/wordlift-plugin/issues/771
-	// Changing this:
-	//	$pattern = '/<(\w+)[^>]*\sclass=\\\"textannotation(?![^\\"]*\sdisambiguated)[^\\"]*\\\"[^>]*>([^<]+)<\/\1>/im';
-	// to:
-	$pattern = '/<(\w+)[^>]*\sclass=\\\"textannotation(?![^\\"]*\sdisambiguated)[^\\"]*\\\"[^>]*>(.*?)<\/\1>/im';
-	// Remove the pattern while it is found (match nested annotations).
-	while ( 1 === preg_match( $pattern, $data['post_content'] ) ) {
-		$data['post_content'] = preg_replace( $pattern, '$2', $data['post_content'], -1, $count );
-	}
-	return $data;
+    // @see https://github.com/insideout10/wordlift-plugin/issues/771
+    // Changing this:
+    //	$pattern = '/<(\w+)[^>]*\sclass=\\\"textannotation(?![^\\"]*\sdisambiguated)[^\\"]*\\\"[^>]*>([^<]+)<\/\1>/im';
+    // to:
+    $pattern = '/<(\w+)[^>]*\sclass=\\\"textannotation(?![^\\"]*\sdisambiguated)[^\\"]*\\\"[^>]*>(.*?)<\/\1>/im';
+    // Remove the pattern while it is found (match nested annotations).
+    while ( 1 === preg_match( $pattern, $data['post_content'] ) ) {
+        $data['post_content'] = preg_replace( $pattern, '$2', $data['post_content'], -1, $count );
+    }
+    return $data;
 }
 
 add_filter( 'wp_insert_post_data', 'wl_remove_text_annotations', '98', 1 );
@@ -88,5 +88,5 @@ 
  */
 function wl_admin_metaboxes_add_css_class( $classes = array() ) {
 
-	return array_merge( $classes, array( 'wl-metabox' ) );
+    return array_merge( $classes, array( 'wl-metabox' ) );
 }

Spacing +18 added lines, -18 removed lines

@@ -6,7 +6,7 @@ 
  */
 
 // Add the Admin menu.
-require_once( 'wordlift_admin_menu.php' );
+require_once('wordlift_admin_menu.php');
 
 /**
  * Serialize an entity post.
@@ -15,27 +15,27 @@ 
  *
  * @return array mixed The entity data array.
  */
-function wl_serialize_entity( $entity ) {
+function wl_serialize_entity($entity) {
 
-	$entity = ( is_numeric( $entity ) ) ? get_post( $entity ) : $entity;
+	$entity = (is_numeric($entity)) ? get_post($entity) : $entity;
 
 	// Bail if the entity doesn't exists.
 	// In some cases we have `wl_topic` meta
 	// pointing to an entity that has been deleted.
-	if ( empty( $entity ) ) {
+	if (empty($entity)) {
 		return;
 	}
 
-	$type   = Wordlift_Entity_Type_Service::get_instance()->get( $entity->ID );
-	$images = wl_get_image_urls( $entity->ID );
+	$type   = Wordlift_Entity_Type_Service::get_instance()->get($entity->ID);
+	$images = wl_get_image_urls($entity->ID);
 
 	return array(
-		'id'          => wl_get_entity_uri( $entity->ID ),
+		'id'          => wl_get_entity_uri($entity->ID),
 		'label'       => $entity->post_title,
 		'description' => $entity->post_content,
-		'sameAs'      => wl_schema_get_value( $entity->ID, 'sameAs' ),
-		'mainType'    => str_replace( 'wl-', '', $type['css_class'] ),
-		'types'       => wl_get_entity_rdf_types( $entity->ID ),
+		'sameAs'      => wl_schema_get_value($entity->ID, 'sameAs'),
+		'mainType'    => str_replace('wl-', '', $type['css_class']),
+		'types'       => wl_get_entity_rdf_types($entity->ID),
 		'images'      => $images,
 
 	);
@@ -50,15 +50,15 @@ 
  *
  * @return array mixed The post data array.
  */
-function wl_remove_text_annotations( $data ) {
+function wl_remove_text_annotations($data) {
 
 	// Remove blank elements that can interfere with annotations removing
 	// See https://github.com/insideout10/wordlift-plugin/issues/234
 	// Just blank attributes without any attributes are cleaned up.
 	$pattern = '/<(\w+)><\/\1>/im';
 	// Remove the pattern while it is found (match nested annotations).
-	while ( 1 === preg_match( $pattern, $data['post_content'] ) ) {
-		$data['post_content'] = preg_replace( $pattern, '$2', $data['post_content'], -1, $count );
+	while (1 === preg_match($pattern, $data['post_content'])) {
+		$data['post_content'] = preg_replace($pattern, '$2', $data['post_content'], -1, $count);
 	}
 	// Remove text annotations
 	// <span class="textannotation" id="urn:enhancement-777cbed4-b131-00fb-54a4-ed9b26ae57ea">.
@@ -69,13 +69,13 @@ 
 	// to:
 	$pattern = '/<(\w+)[^>]*\sclass=\\\"textannotation(?![^\\"]*\sdisambiguated)[^\\"]*\\\"[^>]*>(.*?)<\/\1>/im';
 	// Remove the pattern while it is found (match nested annotations).
-	while ( 1 === preg_match( $pattern, $data['post_content'] ) ) {
-		$data['post_content'] = preg_replace( $pattern, '$2', $data['post_content'], -1, $count );
+	while (1 === preg_match($pattern, $data['post_content'])) {
+		$data['post_content'] = preg_replace($pattern, '$2', $data['post_content'], -1, $count);
 	}
 	return $data;
 }
 
-add_filter( 'wp_insert_post_data', 'wl_remove_text_annotations', '98', 1 );
+add_filter('wp_insert_post_data', 'wl_remove_text_annotations', '98', 1);
 
 /**
  * Adds wl-metabox CSS class to a metabox.
@@ -86,7 +86,7 @@ 
  *
  * @return array The updated list of CSS classes.
  */
-function wl_admin_metaboxes_add_css_class( $classes = array() ) {
+function wl_admin_metaboxes_add_css_class($classes = array()) {
 
-	return array_merge( $classes, array( 'wl-metabox' ) );
+	return array_merge($classes, array('wl-metabox'));
 }

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

Indentation +315 added lines, -315 removed lines

@@ -18,320 +18,320 @@
  */
 class Wordlift_Cached_Post_Converter implements Wordlift_Post_Converter {
 
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Post_Converter $converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var Wordlift_Log_Service \$log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * @var Wordlift_Cache_Service
-	 */
-	private $cache_service;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * A list of meta keys that do not cause the cache to update.
-	 *
-	 * @since 3.17.3
-	 * @var array An array of ignored meta keys.
-	 */
-	private static $ignored_meta_keys = array(
-		'_edit_lock',
-		'_edit_last',
-		'_wp_page_template',
-		'_wp_attachment_is_custom_background',
-		'_wp_attachment_backup_sizes',
-		'_wp_attachment_is_custom_header',
-	);
-
-	/**
-	 * Wordlift_Cached_Post_Converter constructor.
-	 *
-	 * @param \Wordlift_Post_Converter        $converter             The {@link Wordlift_Post_Converter} implementation.
-	 * @param \Wordlift_Cache_Service         $cache_service         The {@link Wordlift_Cache_Service} implementation.
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	public function __construct( $converter, $cache_service, $configuration_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->converter             = $converter;
-		$this->cache_service         = $cache_service;
-		$this->configuration_service = $configuration_service;
-
-		$this->init_hooks();
-
-	}
-
-	/**
-	 * Hooks to catch post/post meta changes in order to invalidate the cache.
-	 *
-	 * @since 3.16.0
-	 */
-	private function init_hooks() {
-
-		// Hook on post save to flush relevant cache.
-		add_action( 'save_post', array( $this, 'save_post' ) );
-
-		add_action( 'added_post_meta', array(
-			$this,
-			'changed_post_meta',
-		), 10, 3 );
-		add_action( 'updated_post_meta', array(
-			$this,
-			'changed_post_meta',
-		), 10, 3 );
-		add_action( 'deleted_post_meta', array(
-			$this,
-			'changed_post_meta',
-		), 10, 3 );
-
-		// Flush cache when wordlift settings were updated.
-		add_action( 'update_option_wl_general_settings', array(
-			$this,
-			'update_option_wl_general_settings',
-		) );
-
-		// Flushes the cache when permalink structure is changed.
-		add_action( 'update_option_permalink_structure', array(
-			$this,
-			'permalinks_structure_changed',
-		) );
-
-		// Invalid cache on relationship change.
-		add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
-		add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
-
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function convert( $post_id, &$references = array(), &$cache = false ) {
-
-		$this->log->trace( "Converting post $post_id..." );
-
-		// Try to get a cached result.
-		$contents = $this->get_cache( $post_id, $references );
-
-		// Return the cached contents if any.
-		if ( false !== $contents ) {
-			$this->log->debug( "Cached contents found for post $post_id." );
-
-			// Inform the caller that this is cached result.
-			$cache = true;
-			$this->add_http_header( $post_id, true );
-
-			// Return the contents.
-			return $contents;
-		}
-
-		// Set cached to false.
-		$cache = false;
-		$this->add_http_header( $post_id, false );
-
-		// Convert the the post.
-		$jsonld = $this->converter->convert( $post_id, $references );
-
-		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld );
-
-		// Finally return the JSON-LD.
-		return $jsonld;
-	}
-
-	/**
-	 * Try to get the cached contents.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int   $post_id    The {@link WP_Post} id.
-	 * @param array $references The referenced posts.
-	 *
-	 * @return mixed|bool The cached contents or false if the cached isn't found.
-	 */
-	private function get_cache( $post_id, &$references = array() ) {
-
-		$this->log->trace( "Getting cached contents for post $post_id..." );
-
-		// Get the cache.
-		$contents = $this->cache_service->get_cache( $post_id );
-
-		// Bail out if we don't have cached contents or the cached contents are
-		// invalid.
-		if ( false === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
-
-			return false;
-		}
-
-		// Remap the cache.
-		$references = $contents['references'];
-
-		return $contents['jsonld'];
-	}
-
-	/**
-	 * Set the cache with the provided results.
-	 *
-	 * The function will prepare the provided results and will ask the {@link Wordlift_Cache_Service}
-	 * to cache them.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int   $post_id    The {@link WP_Post} id.
-	 * @param array $references An array of references.
-	 * @param array $jsonld     A JSON-LD structure.
-	 */
-	private function set_cache( $post_id, $references, $jsonld ) {
-
-		$this->log->trace( "Caching result for post $post_id..." );
-
-		$this->cache_service->set_cache( $post_id, array(
-			'references' => $references,
-			'jsonld'     => $jsonld,
-		) );
-
-	}
-
-	/**
-	 * Hook to 'save_post', will invalidate the cache for that post.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 */
-	public function save_post( $post_id ) {
-
-		$this->log->trace( "Post $post_id saved, invalidating cache..." );
-
-		$this->cache_service->delete_cache( $post_id );
-
-		$this->flush_cache_if_publisher( $post_id );
-
-	}
-
-	/**
-	 * Hook to meta changed for a {@link WP_Post}, will cause the cause to
-	 * invalidate.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int    $id       The {@link WP_Post} meta id.
-	 * @param int    $post_id  The {@link WP_Post} id.
-	 * @param string $meta_key The meta key.
-	 */
-	public function changed_post_meta( $id, $post_id, $meta_key ) {
-
-		if ( in_array( $meta_key, self::$ignored_meta_keys ) ) {
-			$this->log->trace( "Post $post_id meta $meta_key ignored." );
-
-			return;
-		}
-
-		$this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
-
-		// Delete the single cache file.
-		$this->cache_service->delete_cache( $post_id );
-
-		// Flush the cache if it's the publisher.
-		$this->flush_cache_if_publisher( $post_id );
-
-	}
-
-	/**
-	 * Hook to WordLift's options changes, will flush the cache.
-	 *
-	 * @since 3.16.0
-	 */
-	public function update_option_wl_general_settings() {
-		$this->log->trace( "WordLift options changed, flushing cache..." );
-
-		$this->cache_service->flush();
-	}
-
-	/**
-	 * Hook when permalinks are changed, will flush the cache.
-	 *
-	 * @since 3.17.0
-	 */
-	public function permalinks_structure_changed() {
-		$this->log->trace( "Permalinks structure changed, flushing cache..." );
-
-		$this->cache_service->flush();
-	}
-
-	/**
-	 * Hook to WordLift's post/entity relation changes, will invalidate the cache.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 */
-	public function relation_changed( $post_id ) {
-		$this->log->trace( "Post $post_id relations changed, invalidating cache..." );
-
-		$this->cache_service->delete_cache( $post_id );
-	}
-
-	/**
-	 * When in Ajax, prints an http header with the information whether the
-	 * response is cached or not.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int  $post_id The {@link WP_Post} id.
-	 * @param bool $cache   Whether the response fragment is cached.
-	 */
-	private function add_http_header( $post_id, $cache ) {
-
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
-			return;
-		}
-
-		header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
-
-	}
-
-	/**
-	 * Call the `flush` operation on the {@link Wordlift_Cache_Service} if
-	 * the publisher has changed.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int $post_id The changed {@link WP_Post}'s id.
-	 */
-	private function flush_cache_if_publisher( $post_id ) {
-
-		// Bail out if it's not the publisher.
-		if ( $post_id !== $this->configuration_service->get_publisher_id() ) {
-			return;
-		}
-
-		// Flush the cache, since the publisher has changed.
-		$this->cache_service->flush();
-
-	}
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Post_Converter $converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var Wordlift_Log_Service \$log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * @var Wordlift_Cache_Service
+     */
+    private $cache_service;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.16.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * A list of meta keys that do not cause the cache to update.
+     *
+     * @since 3.17.3
+     * @var array An array of ignored meta keys.
+     */
+    private static $ignored_meta_keys = array(
+        '_edit_lock',
+        '_edit_last',
+        '_wp_page_template',
+        '_wp_attachment_is_custom_background',
+        '_wp_attachment_backup_sizes',
+        '_wp_attachment_is_custom_header',
+    );
+
+    /**
+     * Wordlift_Cached_Post_Converter constructor.
+     *
+     * @param \Wordlift_Post_Converter        $converter             The {@link Wordlift_Post_Converter} implementation.
+     * @param \Wordlift_Cache_Service         $cache_service         The {@link Wordlift_Cache_Service} implementation.
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    public function __construct( $converter, $cache_service, $configuration_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->converter             = $converter;
+        $this->cache_service         = $cache_service;
+        $this->configuration_service = $configuration_service;
+
+        $this->init_hooks();
+
+    }
+
+    /**
+     * Hooks to catch post/post meta changes in order to invalidate the cache.
+     *
+     * @since 3.16.0
+     */
+    private function init_hooks() {
+
+        // Hook on post save to flush relevant cache.
+        add_action( 'save_post', array( $this, 'save_post' ) );
+
+        add_action( 'added_post_meta', array(
+            $this,
+            'changed_post_meta',
+        ), 10, 3 );
+        add_action( 'updated_post_meta', array(
+            $this,
+            'changed_post_meta',
+        ), 10, 3 );
+        add_action( 'deleted_post_meta', array(
+            $this,
+            'changed_post_meta',
+        ), 10, 3 );
+
+        // Flush cache when wordlift settings were updated.
+        add_action( 'update_option_wl_general_settings', array(
+            $this,
+            'update_option_wl_general_settings',
+        ) );
+
+        // Flushes the cache when permalink structure is changed.
+        add_action( 'update_option_permalink_structure', array(
+            $this,
+            'permalinks_structure_changed',
+        ) );
+
+        // Invalid cache on relationship change.
+        add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
+        add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
+
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function convert( $post_id, &$references = array(), &$cache = false ) {
+
+        $this->log->trace( "Converting post $post_id..." );
+
+        // Try to get a cached result.
+        $contents = $this->get_cache( $post_id, $references );
+
+        // Return the cached contents if any.
+        if ( false !== $contents ) {
+            $this->log->debug( "Cached contents found for post $post_id." );
+
+            // Inform the caller that this is cached result.
+            $cache = true;
+            $this->add_http_header( $post_id, true );
+
+            // Return the contents.
+            return $contents;
+        }
+
+        // Set cached to false.
+        $cache = false;
+        $this->add_http_header( $post_id, false );
+
+        // Convert the the post.
+        $jsonld = $this->converter->convert( $post_id, $references );
+
+        // Cache the results.
+        $this->set_cache( $post_id, $references, $jsonld );
+
+        // Finally return the JSON-LD.
+        return $jsonld;
+    }
+
+    /**
+     * Try to get the cached contents.
+     *
+     * @since 3.16.0
+     *
+     * @param int   $post_id    The {@link WP_Post} id.
+     * @param array $references The referenced posts.
+     *
+     * @return mixed|bool The cached contents or false if the cached isn't found.
+     */
+    private function get_cache( $post_id, &$references = array() ) {
+
+        $this->log->trace( "Getting cached contents for post $post_id..." );
+
+        // Get the cache.
+        $contents = $this->cache_service->get_cache( $post_id );
+
+        // Bail out if we don't have cached contents or the cached contents are
+        // invalid.
+        if ( false === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
+            $this->log->debug( "Cached contents for post $post_id not found." );
+
+            return false;
+        }
+
+        // Remap the cache.
+        $references = $contents['references'];
+
+        return $contents['jsonld'];
+    }
+
+    /**
+     * Set the cache with the provided results.
+     *
+     * The function will prepare the provided results and will ask the {@link Wordlift_Cache_Service}
+     * to cache them.
+     *
+     * @since 3.16.0
+     *
+     * @param int   $post_id    The {@link WP_Post} id.
+     * @param array $references An array of references.
+     * @param array $jsonld     A JSON-LD structure.
+     */
+    private function set_cache( $post_id, $references, $jsonld ) {
+
+        $this->log->trace( "Caching result for post $post_id..." );
+
+        $this->cache_service->set_cache( $post_id, array(
+            'references' => $references,
+            'jsonld'     => $jsonld,
+        ) );
+
+    }
+
+    /**
+     * Hook to 'save_post', will invalidate the cache for that post.
+     *
+     * @since 3.16.0
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     */
+    public function save_post( $post_id ) {
+
+        $this->log->trace( "Post $post_id saved, invalidating cache..." );
+
+        $this->cache_service->delete_cache( $post_id );
+
+        $this->flush_cache_if_publisher( $post_id );
+
+    }
+
+    /**
+     * Hook to meta changed for a {@link WP_Post}, will cause the cause to
+     * invalidate.
+     *
+     * @since 3.16.0
+     *
+     * @param int    $id       The {@link WP_Post} meta id.
+     * @param int    $post_id  The {@link WP_Post} id.
+     * @param string $meta_key The meta key.
+     */
+    public function changed_post_meta( $id, $post_id, $meta_key ) {
+
+        if ( in_array( $meta_key, self::$ignored_meta_keys ) ) {
+            $this->log->trace( "Post $post_id meta $meta_key ignored." );
+
+            return;
+        }
+
+        $this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
+
+        // Delete the single cache file.
+        $this->cache_service->delete_cache( $post_id );
+
+        // Flush the cache if it's the publisher.
+        $this->flush_cache_if_publisher( $post_id );
+
+    }
+
+    /**
+     * Hook to WordLift's options changes, will flush the cache.
+     *
+     * @since 3.16.0
+     */
+    public function update_option_wl_general_settings() {
+        $this->log->trace( "WordLift options changed, flushing cache..." );
+
+        $this->cache_service->flush();
+    }
+
+    /**
+     * Hook when permalinks are changed, will flush the cache.
+     *
+     * @since 3.17.0
+     */
+    public function permalinks_structure_changed() {
+        $this->log->trace( "Permalinks structure changed, flushing cache..." );
+
+        $this->cache_service->flush();
+    }
+
+    /**
+     * Hook to WordLift's post/entity relation changes, will invalidate the cache.
+     *
+     * @since 3.16.0
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     */
+    public function relation_changed( $post_id ) {
+        $this->log->trace( "Post $post_id relations changed, invalidating cache..." );
+
+        $this->cache_service->delete_cache( $post_id );
+    }
+
+    /**
+     * When in Ajax, prints an http header with the information whether the
+     * response is cached or not.
+     *
+     * @since 3.16.0
+     *
+     * @param int  $post_id The {@link WP_Post} id.
+     * @param bool $cache   Whether the response fragment is cached.
+     */
+    private function add_http_header( $post_id, $cache ) {
+
+        if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
+            return;
+        }
+
+        header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
+
+    }
+
+    /**
+     * Call the `flush` operation on the {@link Wordlift_Cache_Service} if
+     * the publisher has changed.
+     *
+     * @since 3.16.0
+     *
+     * @param int $post_id The changed {@link WP_Post}'s id.
+     */
+    private function flush_cache_if_publisher( $post_id ) {
+
+        // Bail out if it's not the publisher.
+        if ( $post_id !== $this->configuration_service->get_publisher_id() ) {
+            return;
+        }
+
+        // Flush the cache, since the publisher has changed.
+        $this->cache_service->flush();
+
+    }
 
 }

Spacing +53 added lines, -53 removed lines

@@ -72,9 +72,9 @@ 
 	 * @param \Wordlift_Cache_Service         $cache_service         The {@link Wordlift_Cache_Service} implementation.
 	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
 	 */
-	public function __construct( $converter, $cache_service, $configuration_service ) {
+	public function __construct($converter, $cache_service, $configuration_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->converter             = $converter;
 		$this->cache_service         = $cache_service;
@@ -92,56 +92,56 @@ 
 	private function init_hooks() {
 
 		// Hook on post save to flush relevant cache.
-		add_action( 'save_post', array( $this, 'save_post' ) );
+		add_action('save_post', array($this, 'save_post'));
 
-		add_action( 'added_post_meta', array(
+		add_action('added_post_meta', array(
 			$this,
 			'changed_post_meta',
-		), 10, 3 );
-		add_action( 'updated_post_meta', array(
+		), 10, 3);
+		add_action('updated_post_meta', array(
 			$this,
 			'changed_post_meta',
-		), 10, 3 );
-		add_action( 'deleted_post_meta', array(
+		), 10, 3);
+		add_action('deleted_post_meta', array(
 			$this,
 			'changed_post_meta',
-		), 10, 3 );
+		), 10, 3);
 
 		// Flush cache when wordlift settings were updated.
-		add_action( 'update_option_wl_general_settings', array(
+		add_action('update_option_wl_general_settings', array(
 			$this,
 			'update_option_wl_general_settings',
-		) );
+		));
 
 		// Flushes the cache when permalink structure is changed.
-		add_action( 'update_option_permalink_structure', array(
+		add_action('update_option_permalink_structure', array(
 			$this,
 			'permalinks_structure_changed',
-		) );
+		));
 
 		// Invalid cache on relationship change.
-		add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
-		add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
+		add_action('wl_relation_added', array($this, 'relation_changed'));
+		add_action('wl_relation_deleted', array($this, 'relation_changed'));
 
 	}
 
 	/**
 	 * @inheritdoc
 	 */
-	public function convert( $post_id, &$references = array(), &$cache = false ) {
+	public function convert($post_id, &$references = array(), &$cache = false) {
 
-		$this->log->trace( "Converting post $post_id..." );
+		$this->log->trace("Converting post $post_id...");
 
 		// Try to get a cached result.
-		$contents = $this->get_cache( $post_id, $references );
+		$contents = $this->get_cache($post_id, $references);
 
 		// Return the cached contents if any.
-		if ( false !== $contents ) {
-			$this->log->debug( "Cached contents found for post $post_id." );
+		if (false !== $contents) {
+			$this->log->debug("Cached contents found for post $post_id.");
 
 			// Inform the caller that this is cached result.
 			$cache = true;
-			$this->add_http_header( $post_id, true );
+			$this->add_http_header($post_id, true);
 
 			// Return the contents.
 			return $contents;
@@ -149,13 +149,13 @@ 
 
 		// Set cached to false.
 		$cache = false;
-		$this->add_http_header( $post_id, false );
+		$this->add_http_header($post_id, false);
 
 		// Convert the the post.
-		$jsonld = $this->converter->convert( $post_id, $references );
+		$jsonld = $this->converter->convert($post_id, $references);
 
 		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld );
+		$this->set_cache($post_id, $references, $jsonld);
 
 		// Finally return the JSON-LD.
 		return $jsonld;
@@ -171,17 +171,17 @@ 
 	 *
 	 * @return mixed|bool The cached contents or false if the cached isn't found.
 	 */
-	private function get_cache( $post_id, &$references = array() ) {
+	private function get_cache($post_id, &$references = array()) {
 
-		$this->log->trace( "Getting cached contents for post $post_id..." );
+		$this->log->trace("Getting cached contents for post $post_id...");
 
 		// Get the cache.
-		$contents = $this->cache_service->get_cache( $post_id );
+		$contents = $this->cache_service->get_cache($post_id);
 
 		// Bail out if we don't have cached contents or the cached contents are
 		// invalid.
-		if ( false === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
+		if (false === $contents || ! isset($contents['jsonld']) || ! isset($contents['references'])) {
+			$this->log->debug("Cached contents for post $post_id not found.");
 
 			return false;
 		}
@@ -204,14 +204,14 @@ 
 	 * @param array $references An array of references.
 	 * @param array $jsonld     A JSON-LD structure.
 	 */
-	private function set_cache( $post_id, $references, $jsonld ) {
+	private function set_cache($post_id, $references, $jsonld) {
 
-		$this->log->trace( "Caching result for post $post_id..." );
+		$this->log->trace("Caching result for post $post_id...");
 
-		$this->cache_service->set_cache( $post_id, array(
+		$this->cache_service->set_cache($post_id, array(
 			'references' => $references,
 			'jsonld'     => $jsonld,
-		) );
+		));
 
 	}
 
@@ -222,13 +222,13 @@ 
 	 *
 	 * @param int $post_id The {@link WP_Post} id.
 	 */
-	public function save_post( $post_id ) {
+	public function save_post($post_id) {
 
-		$this->log->trace( "Post $post_id saved, invalidating cache..." );
+		$this->log->trace("Post $post_id saved, invalidating cache...");
 
-		$this->cache_service->delete_cache( $post_id );
+		$this->cache_service->delete_cache($post_id);
 
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -242,21 +242,21 @@ 
 	 * @param int    $post_id  The {@link WP_Post} id.
 	 * @param string $meta_key The meta key.
 	 */
-	public function changed_post_meta( $id, $post_id, $meta_key ) {
+	public function changed_post_meta($id, $post_id, $meta_key) {
 
-		if ( in_array( $meta_key, self::$ignored_meta_keys ) ) {
-			$this->log->trace( "Post $post_id meta $meta_key ignored." );
+		if (in_array($meta_key, self::$ignored_meta_keys)) {
+			$this->log->trace("Post $post_id meta $meta_key ignored.");
 
 			return;
 		}
 
-		$this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
+		$this->log->trace("Post $post_id meta $meta_key changed, invalidating cache...");
 
 		// Delete the single cache file.
-		$this->cache_service->delete_cache( $post_id );
+		$this->cache_service->delete_cache($post_id);
 
 		// Flush the cache if it's the publisher.
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -266,7 +266,7 @@ 
 	 * @since 3.16.0
 	 */
 	public function update_option_wl_general_settings() {
-		$this->log->trace( "WordLift options changed, flushing cache..." );
+		$this->log->trace("WordLift options changed, flushing cache...");
 
 		$this->cache_service->flush();
 	}
@@ -277,7 +277,7 @@ 
 	 * @since 3.17.0
 	 */
 	public function permalinks_structure_changed() {
-		$this->log->trace( "Permalinks structure changed, flushing cache..." );
+		$this->log->trace("Permalinks structure changed, flushing cache...");
 
 		$this->cache_service->flush();
 	}
@@ -289,10 +289,10 @@ 
 	 *
 	 * @param int $post_id The {@link WP_Post} id.
 	 */
-	public function relation_changed( $post_id ) {
-		$this->log->trace( "Post $post_id relations changed, invalidating cache..." );
+	public function relation_changed($post_id) {
+		$this->log->trace("Post $post_id relations changed, invalidating cache...");
 
-		$this->cache_service->delete_cache( $post_id );
+		$this->cache_service->delete_cache($post_id);
 	}
 
 	/**
@@ -304,13 +304,13 @@ 
 	 * @param int  $post_id The {@link WP_Post} id.
 	 * @param bool $cache   Whether the response fragment is cached.
 	 */
-	private function add_http_header( $post_id, $cache ) {
+	private function add_http_header($post_id, $cache) {
 
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || headers_sent()) {
 			return;
 		}
 
-		header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
+		header("X-WordLift-JsonLd-Cache-$post_id: ".($cache ? 'HIT' : 'MISS'));
 
 	}
 
@@ -322,10 +322,10 @@ 
 	 *
 	 * @param int $post_id The changed {@link WP_Post}'s id.
 	 */
-	private function flush_cache_if_publisher( $post_id ) {
+	private function flush_cache_if_publisher($post_id) {
 
 		// Bail out if it's not the publisher.
-		if ( $post_id !== $this->configuration_service->get_publisher_id() ) {
+		if ($post_id !== $this->configuration_service->get_publisher_id()) {
 			return;
 		}
 

src/includes/class-wordlift-linked-data-service.php

Indentation +316 added lines, -316 removed lines

@@ -18,321 +18,321 @@
  */
 class Wordlift_Linked_Data_Service {
 
-	//<editor-fold desc="## FIELDS">
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * The {@link Wordlift_Schema_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
-	 */
-	private $schema_service;
-
-	/**
-	 * The {@link Wordlift_Sparql_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
-	 */
-	private $sparql_service;
-
-	/**
-	 * The {@link Wordlift_Linked_Data_Service} singleton instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Linked_Data_Service $instance The {@link Wordlift_Linked_Data_Service} singleton instance.
-	 */
-	private static $instance;
-	//</editor-fold>
-
-	/**
-	 * Create a {@link Wordlift_Linked_Data_Service} instance.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param \Wordlift_Entity_Service      $entity_service      The {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_Schema_Service      $schema_service      The {@link Wordlift_Schema_Service} instance.
-	 * @param \Wordlift_Sparql_Service      $sparql_service      The {@link Wordlift_Sparql_Service} instance.
-	 */
-	public function __construct( $entity_service, $entity_type_service, $schema_service, $sparql_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Linked_Data_Service' );
-
-		$this->entity_service      = $entity_service;
-		$this->entity_type_service = $entity_type_service;
-		$this->schema_service      = $schema_service;
-		$this->sparql_service      = $sparql_service;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of {@link Wordlift_Linked_Data_Service}.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @return Wordlift_Linked_Data_Service The singleton instance of <a href='psi_element://Wordlift_Linked_Data_Service'>Wordlift_Linked_Data_Service</a>.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	//<editor-fold desc="## FUNCTIONS">
-
-	/**
-	 * Push a {@link WP_Post} to the Linked Data store.
-	 *
-	 * If the {@link WP_Post} is an entity and it's not of the `Article` type,
-	 * then it is pushed to the remote Linked Data store.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 */
-	public function push( $post_id ) {
-
-		$this->log->debug( "Pushing post $post_id..." );
-
-		// @since 3.18.0 we don't check anymore if the post is an entity, i.e.
-		// we removed the following:
-		//		if ( ! $this->entity_service->is_entity( $post_id ) ) {
-		//			$this->log->debug( "Post $post_id is not an entity." );
-		//
-		//			return;
-		//		}
-
-		// Get the post and push it to the Linked Data store.
-		$this->do_push( $post_id );
-
-		// Reindex the triple store if buffering is turned off.
-		if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
-			wordlift_reindex_triple_store();
-		}
-
-	}
-
-	/**
-	 * Push an entity to the Linked Data store.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 */
-	private function do_push( $post_id ) {
-		$this->log->debug( "Doing post $post_id push..." );
-
-		// Get the post.
-		$post = get_post( $post_id );
-
-		// Bail out if the post isn't found.
-		if ( null === $post ) {
-			$this->log->warn( "Post $post_id not found." );
-
-			return;
-		}
-
-		// Bail out if the post isn't published.
-		if ( 'publish' !== $post->post_status ) {
-			$this->log->info( "Post $post_id not published." );
-
-			return;
-		}
-
-		// Bail out if the URI isn't valid.
-		if ( ! $this->has_valid_uri( $post_id ) ) {
-			$this->log->warn( "Post $post_id URI invalid." );
-
-			return;
-		}
-
-		// First remove the post data.
-		$this->remove( $post_id );
-
-		// Then execute the insert query.
-		$this->insert( $post_id );
-	}
-
-	/**
-	 * Check if an entity's {@link WP_Post} has a valid URI.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int $post_id The entity's {@link WP_Post}'s id.
-	 *
-	 * @return bool True if the URI is valid otherwise false.
-	 */
-	private function has_valid_uri( $post_id ) {
-
-		// Get the entity's URI.
-		$uri = $this->entity_service->get_uri( $post_id );
-
-		// If the URI isn't found, return false.
-		if ( null === $uri ) {
-			return false;
-		}
-
-		// If the URI ends with a trailing slash, return false.
-		if ( '/' === substr( $uri, - 1 ) ) {
-			return false;
-		}
-
-		// URI is valid.
-		return true;
-	}
-
-	/**
-	 * Remove the specified {@link WP_Post} from the Linked Data.
-	 *
-	 * @since 3.18.0
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 */
-	public function remove( $post_id ) {
-		$delete_query = '';
-
-		// Get the delete statements.
-		$triples = $this->get_delete_triples( $post_id );
-
-		// Loop through all triples and add the statement to delete query.
-		foreach ( $triples as $item ) {
-			$delete_query .= "DELETE { $item } WHERE { $item }; \n";
-		}
-
-		$this->log->trace( "Delete Query generated [ $delete_query ]." );
-
-		$this->sparql_service->execute( $delete_query );
-	}
-
-	/**
-	 * Insert the specific {@link WP_Post} to Linked Data store.
-	 *
-	 * @since 3.18.0
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 */
-	private function insert( $post_id ) {
-		// Get the insert statements.
-		$insert_triples = $this->get_insert_triples( $post_id );
-
-		// Convert all statements to single string.
-		$insert_query_body = implode( "\n", $insert_triples );
-
-		// Build the insert query.
-		$insert_query = "INSERT DATA { $insert_query_body };";
-
-		$this->log->trace( "Insert Query generated [ $insert_query ]." );
-
-		$this->sparql_service->execute( $insert_query );
-	}
-
-	/**
-	 * Get the delete statements.
-	 *
-	 * @since 3.18.0
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return array An array of delete statements.
-	 */
-	private function get_delete_triples( $post_id ) {
-		$delete_triples = array();
-
-		// Loop through all renditions and get the triples.
-		foreach ( $this->schema_service->get_renditions() as $rendition ) {
-			// Push the rendition delete triple to $delete_triples.
-			$delete_triples = array_merge(
-				$delete_triples,
-				(array) $rendition->get_delete_triples( $post_id )
-			);
-		}
-
-		/**
-		 * Filter: 'wl_delete_triples' - Allow third parties to hook and add additional delete triples.
-		 *
-		 * @since 3.18.0
-		 *
-		 * @param array $delete_triples Delete triples.
-		 * @param int   $post_id        The current post ID.
-		 */
-		return apply_filters( 'wl_delete_triples', array_unique( $delete_triples ), $post_id );
-	}
-
-	/**
-	 * Get the SPARQL insert triples ( ?s ?p ?o ) for the specified {@link WP_Post}.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return array An array of insert triples.
-	 */
-	private function get_insert_triples( $post_id ) {
-
-		// Get the entity type.
-		$type = $this->entity_type_service->get( $post_id );
-
-		// Get the `linked_data` parameter.
-		$properties = $type['linked_data'];
-
-		// Accumulate the triples.
-		$triples = array();
-
-		/** @var Wordlift_Default_Sparql_Tuple_Rendition $property A {@link Wordlift_Sparql_Tuple_Rendition} instance. */
-		foreach ( $properties as $property ) {
-			foreach ( $property->get_insert_triples( $post_id ) as $triple ) {
-				$triples[] = $triple;
-			}
-		}
-
-		$this->log->trace( count( $properties ) . ' properties and ' . count( $triples ) . " triples found for post $post_id." );
-
-		/**
-		 * Get the INSERT triples properties.
-		 *
-		 * The `wl_insert_triples` filter allows 3rd parties to extend
-		 * the list of triples for SPARQL INSERT statements.
-		 *
-		 * @since 3.17.0
-		 * @since 3.18.0 The hook has been renamed from `wl_insert_tuples_properties` to `wl_insert_triples`.
-		 *
-		 * @param array                         $linked_data         A {@link Wordlift_Sparql_Tuple_Rendition} instances.
-		 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-		 * @param int                           $post_id             The {@link WP_Post}'s id.
-		 */
-		return apply_filters( 'wl_insert_triples', $triples, $this->entity_service, $post_id );
-	}
-	//</editor-fold>
+    //<editor-fold desc="## FIELDS">
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * The {@link Wordlift_Schema_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
+     */
+    private $schema_service;
+
+    /**
+     * The {@link Wordlift_Sparql_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
+     */
+    private $sparql_service;
+
+    /**
+     * The {@link Wordlift_Linked_Data_Service} singleton instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Linked_Data_Service $instance The {@link Wordlift_Linked_Data_Service} singleton instance.
+     */
+    private static $instance;
+    //</editor-fold>
+
+    /**
+     * Create a {@link Wordlift_Linked_Data_Service} instance.
+     *
+     * @since 3.15.0
+     *
+     * @param \Wordlift_Entity_Service      $entity_service      The {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_Schema_Service      $schema_service      The {@link Wordlift_Schema_Service} instance.
+     * @param \Wordlift_Sparql_Service      $sparql_service      The {@link Wordlift_Sparql_Service} instance.
+     */
+    public function __construct( $entity_service, $entity_type_service, $schema_service, $sparql_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Linked_Data_Service' );
+
+        $this->entity_service      = $entity_service;
+        $this->entity_type_service = $entity_type_service;
+        $this->schema_service      = $schema_service;
+        $this->sparql_service      = $sparql_service;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of {@link Wordlift_Linked_Data_Service}.
+     *
+     * @since 3.15.0
+     *
+     * @return Wordlift_Linked_Data_Service The singleton instance of <a href='psi_element://Wordlift_Linked_Data_Service'>Wordlift_Linked_Data_Service</a>.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    //<editor-fold desc="## FUNCTIONS">
+
+    /**
+     * Push a {@link WP_Post} to the Linked Data store.
+     *
+     * If the {@link WP_Post} is an entity and it's not of the `Article` type,
+     * then it is pushed to the remote Linked Data store.
+     *
+     * @since 3.15.0
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     */
+    public function push( $post_id ) {
+
+        $this->log->debug( "Pushing post $post_id..." );
+
+        // @since 3.18.0 we don't check anymore if the post is an entity, i.e.
+        // we removed the following:
+        //		if ( ! $this->entity_service->is_entity( $post_id ) ) {
+        //			$this->log->debug( "Post $post_id is not an entity." );
+        //
+        //			return;
+        //		}
+
+        // Get the post and push it to the Linked Data store.
+        $this->do_push( $post_id );
+
+        // Reindex the triple store if buffering is turned off.
+        if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
+            wordlift_reindex_triple_store();
+        }
+
+    }
+
+    /**
+     * Push an entity to the Linked Data store.
+     *
+     * @since 3.15.0
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     */
+    private function do_push( $post_id ) {
+        $this->log->debug( "Doing post $post_id push..." );
+
+        // Get the post.
+        $post = get_post( $post_id );
+
+        // Bail out if the post isn't found.
+        if ( null === $post ) {
+            $this->log->warn( "Post $post_id not found." );
+
+            return;
+        }
+
+        // Bail out if the post isn't published.
+        if ( 'publish' !== $post->post_status ) {
+            $this->log->info( "Post $post_id not published." );
+
+            return;
+        }
+
+        // Bail out if the URI isn't valid.
+        if ( ! $this->has_valid_uri( $post_id ) ) {
+            $this->log->warn( "Post $post_id URI invalid." );
+
+            return;
+        }
+
+        // First remove the post data.
+        $this->remove( $post_id );
+
+        // Then execute the insert query.
+        $this->insert( $post_id );
+    }
+
+    /**
+     * Check if an entity's {@link WP_Post} has a valid URI.
+     *
+     * @since 3.15.0
+     *
+     * @param int $post_id The entity's {@link WP_Post}'s id.
+     *
+     * @return bool True if the URI is valid otherwise false.
+     */
+    private function has_valid_uri( $post_id ) {
+
+        // Get the entity's URI.
+        $uri = $this->entity_service->get_uri( $post_id );
+
+        // If the URI isn't found, return false.
+        if ( null === $uri ) {
+            return false;
+        }
+
+        // If the URI ends with a trailing slash, return false.
+        if ( '/' === substr( $uri, - 1 ) ) {
+            return false;
+        }
+
+        // URI is valid.
+        return true;
+    }
+
+    /**
+     * Remove the specified {@link WP_Post} from the Linked Data.
+     *
+     * @since 3.18.0
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     */
+    public function remove( $post_id ) {
+        $delete_query = '';
+
+        // Get the delete statements.
+        $triples = $this->get_delete_triples( $post_id );
+
+        // Loop through all triples and add the statement to delete query.
+        foreach ( $triples as $item ) {
+            $delete_query .= "DELETE { $item } WHERE { $item }; \n";
+        }
+
+        $this->log->trace( "Delete Query generated [ $delete_query ]." );
+
+        $this->sparql_service->execute( $delete_query );
+    }
+
+    /**
+     * Insert the specific {@link WP_Post} to Linked Data store.
+     *
+     * @since 3.18.0
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     */
+    private function insert( $post_id ) {
+        // Get the insert statements.
+        $insert_triples = $this->get_insert_triples( $post_id );
+
+        // Convert all statements to single string.
+        $insert_query_body = implode( "\n", $insert_triples );
+
+        // Build the insert query.
+        $insert_query = "INSERT DATA { $insert_query_body };";
+
+        $this->log->trace( "Insert Query generated [ $insert_query ]." );
+
+        $this->sparql_service->execute( $insert_query );
+    }
+
+    /**
+     * Get the delete statements.
+     *
+     * @since 3.18.0
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return array An array of delete statements.
+     */
+    private function get_delete_triples( $post_id ) {
+        $delete_triples = array();
+
+        // Loop through all renditions and get the triples.
+        foreach ( $this->schema_service->get_renditions() as $rendition ) {
+            // Push the rendition delete triple to $delete_triples.
+            $delete_triples = array_merge(
+                $delete_triples,
+                (array) $rendition->get_delete_triples( $post_id )
+            );
+        }
+
+        /**
+         * Filter: 'wl_delete_triples' - Allow third parties to hook and add additional delete triples.
+         *
+         * @since 3.18.0
+         *
+         * @param array $delete_triples Delete triples.
+         * @param int   $post_id        The current post ID.
+         */
+        return apply_filters( 'wl_delete_triples', array_unique( $delete_triples ), $post_id );
+    }
+
+    /**
+     * Get the SPARQL insert triples ( ?s ?p ?o ) for the specified {@link WP_Post}.
+     *
+     * @since 3.15.0
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return array An array of insert triples.
+     */
+    private function get_insert_triples( $post_id ) {
+
+        // Get the entity type.
+        $type = $this->entity_type_service->get( $post_id );
+
+        // Get the `linked_data` parameter.
+        $properties = $type['linked_data'];
+
+        // Accumulate the triples.
+        $triples = array();
+
+        /** @var Wordlift_Default_Sparql_Tuple_Rendition $property A {@link Wordlift_Sparql_Tuple_Rendition} instance. */
+        foreach ( $properties as $property ) {
+            foreach ( $property->get_insert_triples( $post_id ) as $triple ) {
+                $triples[] = $triple;
+            }
+        }
+
+        $this->log->trace( count( $properties ) . ' properties and ' . count( $triples ) . " triples found for post $post_id." );
+
+        /**
+         * Get the INSERT triples properties.
+         *
+         * The `wl_insert_triples` filter allows 3rd parties to extend
+         * the list of triples for SPARQL INSERT statements.
+         *
+         * @since 3.17.0
+         * @since 3.18.0 The hook has been renamed from `wl_insert_tuples_properties` to `wl_insert_triples`.
+         *
+         * @param array                         $linked_data         A {@link Wordlift_Sparql_Tuple_Rendition} instances.
+         * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+         * @param int                           $post_id             The {@link WP_Post}'s id.
+         */
+        return apply_filters( 'wl_insert_triples', $triples, $this->entity_service, $post_id );
+    }
+    //</editor-fold>
 
 }

Spacing +41 added lines, -41 removed lines

@@ -84,9 +84,9 @@ 
 	 * @param \Wordlift_Schema_Service      $schema_service      The {@link Wordlift_Schema_Service} instance.
 	 * @param \Wordlift_Sparql_Service      $sparql_service      The {@link Wordlift_Sparql_Service} instance.
 	 */
-	public function __construct( $entity_service, $entity_type_service, $schema_service, $sparql_service ) {
+	public function __construct($entity_service, $entity_type_service, $schema_service, $sparql_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Linked_Data_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Linked_Data_Service');
 
 		$this->entity_service      = $entity_service;
 		$this->entity_type_service = $entity_type_service;
@@ -121,9 +121,9 @@ 
 	 *
 	 * @param int $post_id The {@link WP_Post}'s id.
 	 */
-	public function push( $post_id ) {
+	public function push($post_id) {
 
-		$this->log->debug( "Pushing post $post_id..." );
+		$this->log->debug("Pushing post $post_id...");
 
 		// @since 3.18.0 we don't check anymore if the post is an entity, i.e.
 		// we removed the following:
@@ -134,10 +134,10 @@ 
 		//		}
 
 		// Get the post and push it to the Linked Data store.
-		$this->do_push( $post_id );
+		$this->do_push($post_id);
 
 		// 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();
 		}
 
@@ -150,38 +150,38 @@ 
 	 *
 	 * @param int $post_id The {@link WP_Post}'s id.
 	 */
-	private function do_push( $post_id ) {
-		$this->log->debug( "Doing post $post_id push..." );
+	private function do_push($post_id) {
+		$this->log->debug("Doing post $post_id push...");
 
 		// Get the post.
-		$post = get_post( $post_id );
+		$post = get_post($post_id);
 
 		// Bail out if the post isn't found.
-		if ( null === $post ) {
-			$this->log->warn( "Post $post_id not found." );
+		if (null === $post) {
+			$this->log->warn("Post $post_id not found.");
 
 			return;
 		}
 
 		// Bail out if the post isn't published.
-		if ( 'publish' !== $post->post_status ) {
-			$this->log->info( "Post $post_id not published." );
+		if ('publish' !== $post->post_status) {
+			$this->log->info("Post $post_id not published.");
 
 			return;
 		}
 
 		// Bail out if the URI isn't valid.
-		if ( ! $this->has_valid_uri( $post_id ) ) {
-			$this->log->warn( "Post $post_id URI invalid." );
+		if ( ! $this->has_valid_uri($post_id)) {
+			$this->log->warn("Post $post_id URI invalid.");
 
 			return;
 		}
 
 		// First remove the post data.
-		$this->remove( $post_id );
+		$this->remove($post_id);
 
 		// Then execute the insert query.
-		$this->insert( $post_id );
+		$this->insert($post_id);
 	}
 
 	/**
@@ -193,18 +193,18 @@ 
 	 *
 	 * @return bool True if the URI is valid otherwise false.
 	 */
-	private function has_valid_uri( $post_id ) {
+	private function has_valid_uri($post_id) {
 
 		// Get the entity's URI.
-		$uri = $this->entity_service->get_uri( $post_id );
+		$uri = $this->entity_service->get_uri($post_id);
 
 		// If the URI isn't found, return false.
-		if ( null === $uri ) {
+		if (null === $uri) {
 			return false;
 		}
 
 		// If the URI ends with a trailing slash, return false.
-		if ( '/' === substr( $uri, - 1 ) ) {
+		if ('/' === substr($uri, - 1)) {
 			return false;
 		}
 
@@ -219,20 +219,20 @@ 
 	 *
 	 * @param int $post_id The {@link WP_Post}'s id.
 	 */
-	public function remove( $post_id ) {
+	public function remove($post_id) {
 		$delete_query = '';
 
 		// Get the delete statements.
-		$triples = $this->get_delete_triples( $post_id );
+		$triples = $this->get_delete_triples($post_id);
 
 		// Loop through all triples and add the statement to delete query.
-		foreach ( $triples as $item ) {
+		foreach ($triples as $item) {
 			$delete_query .= "DELETE { $item } WHERE { $item }; \n";
 		}
 
-		$this->log->trace( "Delete Query generated [ $delete_query ]." );
+		$this->log->trace("Delete Query generated [ $delete_query ].");
 
-		$this->sparql_service->execute( $delete_query );
+		$this->sparql_service->execute($delete_query);
 	}
 
 	/**
@@ -242,19 +242,19 @@ 
 	 *
 	 * @param int $post_id The {@link WP_Post}'s id.
 	 */
-	private function insert( $post_id ) {
+	private function insert($post_id) {
 		// Get the insert statements.
-		$insert_triples = $this->get_insert_triples( $post_id );
+		$insert_triples = $this->get_insert_triples($post_id);
 
 		// Convert all statements to single string.
-		$insert_query_body = implode( "\n", $insert_triples );
+		$insert_query_body = implode("\n", $insert_triples);
 
 		// Build the insert query.
 		$insert_query = "INSERT DATA { $insert_query_body };";
 
-		$this->log->trace( "Insert Query generated [ $insert_query ]." );
+		$this->log->trace("Insert Query generated [ $insert_query ].");
 
-		$this->sparql_service->execute( $insert_query );
+		$this->sparql_service->execute($insert_query);
 	}
 
 	/**
@@ -266,15 +266,15 @@ 
 	 *
 	 * @return array An array of delete statements.
 	 */
-	private function get_delete_triples( $post_id ) {
+	private function get_delete_triples($post_id) {
 		$delete_triples = array();
 
 		// Loop through all renditions and get the triples.
-		foreach ( $this->schema_service->get_renditions() as $rendition ) {
+		foreach ($this->schema_service->get_renditions() as $rendition) {
 			// Push the rendition delete triple to $delete_triples.
 			$delete_triples = array_merge(
 				$delete_triples,
-				(array) $rendition->get_delete_triples( $post_id )
+				(array) $rendition->get_delete_triples($post_id)
 			);
 		}
 
@@ -286,7 +286,7 @@ 
 		 * @param array $delete_triples Delete triples.
 		 * @param int   $post_id        The current post ID.
 		 */
-		return apply_filters( 'wl_delete_triples', array_unique( $delete_triples ), $post_id );
+		return apply_filters('wl_delete_triples', array_unique($delete_triples), $post_id);
 	}
 
 	/**
@@ -298,10 +298,10 @@ 
 	 *
 	 * @return array An array of insert triples.
 	 */
-	private function get_insert_triples( $post_id ) {
+	private function get_insert_triples($post_id) {
 
 		// Get the entity type.
-		$type = $this->entity_type_service->get( $post_id );
+		$type = $this->entity_type_service->get($post_id);
 
 		// Get the `linked_data` parameter.
 		$properties = $type['linked_data'];
@@ -310,13 +310,13 @@ 
 		$triples = array();
 
 		/** @var Wordlift_Default_Sparql_Tuple_Rendition $property A {@link Wordlift_Sparql_Tuple_Rendition} instance. */
-		foreach ( $properties as $property ) {
-			foreach ( $property->get_insert_triples( $post_id ) as $triple ) {
+		foreach ($properties as $property) {
+			foreach ($property->get_insert_triples($post_id) as $triple) {
 				$triples[] = $triple;
 			}
 		}
 
-		$this->log->trace( count( $properties ) . ' properties and ' . count( $triples ) . " triples found for post $post_id." );
+		$this->log->trace(count($properties).' properties and '.count($triples)." triples found for post $post_id.");
 
 		/**
 		 * Get the INSERT triples properties.
@@ -331,7 +331,7 @@ 
 		 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
 		 * @param int                           $post_id             The {@link WP_Post}'s id.
 		 */
-		return apply_filters( 'wl_insert_triples', $triples, $this->entity_service, $post_id );
+		return apply_filters('wl_insert_triples', $triples, $this->entity_service, $post_id);
 	}
 	//</editor-fold>
 

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

Indentation +214 added lines, -214 removed lines

@@ -18,222 +18,222 @@
  */
 class Wordlift_Publisher_Service {
 
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.19.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * The {@link Wordlift_Publisher_Service} instance.
-	 *
-	 * @since 3.19.0
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	public function __construct( $configuration_service ) {
-		$this->configuration_service = $configuration_service;
-	}
-
-	/**
-	 * Counts the number of potential publishers.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return int The number of potential publishers.
-	 */
-	public function count() {
-
-		// Search for entities which are either a Person
-		// or Organization.
-
-		// Get only the ids as all we need is the count.
-		$entities = get_posts( array(
-			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
-			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
-			'tax_query'      => array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => array( 'organization', 'person' ),
-				),
-			),
-			'fields'         => 'ids',
-		) );
-
-		// Finally return the count.
-		return count( $entities );
-	}
-
-	/**
-	 * Search SQL filter for matching against post title only.
-	 *
-	 * @link    http://wordpress.stackexchange.com/a/11826/1685
-	 *
-	 * @since   3.15.0
-	 *
-	 * @param   string   $search   The search string.
-	 * @param   WP_Query $wp_query The {@link WP_Query} instance.
-	 *
-	 * @return array|string An array of results.
-	 */
-	public function limit_search_to_title( $search, $wp_query ) {
-
-		// Bail out if the search or the `search_terms` haven't been set.
-		if ( empty( $search ) || empty( $wp_query->query_vars['search_terms'] ) ) {
-			return $search;
-		}
-
-		global $wpdb;
-
-		$query_vars = $wp_query->query_vars;
-		$percent    = ! empty( $query_vars['exact'] ) ? '' : '%';
-		$search     = array();
-
-		foreach ( (array) $query_vars['search_terms'] as $term ) {
-			$search[] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $percent . $wpdb->esc_like( $term ) . $percent );
-		}
-
-		if ( ! is_user_logged_in() ) {
-			$search[] = "$wpdb->posts.post_password = ''";
-		}
-
-		$search = ' AND ' . implode( ' AND ', $search );
-
-		return $search;
-	}
-
-	/**
-	 * Query WP for potential publishers, i.e. {@link WP_Post}s which are associated`
-	 * with `wl_entity_type` (taxonomy) terms of `Organization` or `Person`.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param string $filter The title filter.
-	 *
-	 * @return array An array of results in a select2 friendly format.
-	 */
-	public function query( $filter = '' ) {
-
-		// Search for the filter in the titles only.
-		add_filter( 'posts_search', array(
-			$this,
-			'limit_search_to_title',
-		), 10, 2 );
-
-		/*
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.19.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * The {@link Wordlift_Publisher_Service} instance.
+     *
+     * @since 3.19.0
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    public function __construct( $configuration_service ) {
+        $this->configuration_service = $configuration_service;
+    }
+
+    /**
+     * Counts the number of potential publishers.
+     *
+     * @since 3.11.0
+     *
+     * @return int The number of potential publishers.
+     */
+    public function count() {
+
+        // Search for entities which are either a Person
+        // or Organization.
+
+        // Get only the ids as all we need is the count.
+        $entities = get_posts( array(
+            'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
+            'post_status'    => 'publish',
+            'posts_per_page' => - 1,
+            'tax_query'      => array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => array( 'organization', 'person' ),
+                ),
+            ),
+            'fields'         => 'ids',
+        ) );
+
+        // Finally return the count.
+        return count( $entities );
+    }
+
+    /**
+     * Search SQL filter for matching against post title only.
+     *
+     * @link    http://wordpress.stackexchange.com/a/11826/1685
+     *
+     * @since   3.15.0
+     *
+     * @param   string   $search   The search string.
+     * @param   WP_Query $wp_query The {@link WP_Query} instance.
+     *
+     * @return array|string An array of results.
+     */
+    public function limit_search_to_title( $search, $wp_query ) {
+
+        // Bail out if the search or the `search_terms` haven't been set.
+        if ( empty( $search ) || empty( $wp_query->query_vars['search_terms'] ) ) {
+            return $search;
+        }
+
+        global $wpdb;
+
+        $query_vars = $wp_query->query_vars;
+        $percent    = ! empty( $query_vars['exact'] ) ? '' : '%';
+        $search     = array();
+
+        foreach ( (array) $query_vars['search_terms'] as $term ) {
+            $search[] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $percent . $wpdb->esc_like( $term ) . $percent );
+        }
+
+        if ( ! is_user_logged_in() ) {
+            $search[] = "$wpdb->posts.post_password = ''";
+        }
+
+        $search = ' AND ' . implode( ' AND ', $search );
+
+        return $search;
+    }
+
+    /**
+     * Query WP for potential publishers, i.e. {@link WP_Post}s which are associated`
+     * with `wl_entity_type` (taxonomy) terms of `Organization` or `Person`.
+     *
+     * @since 3.11.0
+     *
+     * @param string $filter The title filter.
+     *
+     * @return array An array of results in a select2 friendly format.
+     */
+    public function query( $filter = '' ) {
+
+        // Search for the filter in the titles only.
+        add_filter( 'posts_search', array(
+            $this,
+            'limit_search_to_title',
+        ), 10, 2 );
+
+        /*
 		 * Search for entities which are either a Person
 		 * or Organization. Sort the results by title in ascending order.
 		 */
-		$entities = get_posts( array(
-			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
-			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
-			'tax_query'      => array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => array( 'organization', 'person' ),
-				),
-			),
-			's'              => $filter,
-			'orderby'        => 'title',
-			'order'          => 'ASC',
-		) );
-
-		// Remove the search filter added before the query.
-		remove_filter( 'posts_search', array(
-			$this,
-			'limit_search_to_title',
-		), 10, 2 );
-
-		// Set a reference to ourselves to pass to the closure.
-		$publisher_service = $this;
-
-		// Map the results in a `Select2` compatible array.
-		return array_map( function ( $entity ) use ( $publisher_service ) {
-			$type     = wp_get_post_terms( $entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-			$thumb_id = get_post_thumbnail_id( $entity->ID );
-
-			return array(
-				'id'            => $entity->ID,
-				'text'          => $entity->post_title,
-				'type'          => $type[0]->name,
-				'thumbnail_url' => $publisher_service->get_attachment_image_url( $thumb_id ),
-			);
-		}, $entities );
-	}
-
-	/**
-	 * Get the thumbnail's URL.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param int    $attachment_id The attachment id.
-	 * @param string $size          The attachment size (default = 'thumbnail').
-	 *
-	 * @return string|bool The image URL or false if not found.
-	 */
-	public function get_attachment_image_url( $attachment_id, $size = 'thumbnail' ) {
-
-		$image = wp_get_attachment_image_src( $attachment_id, $size );
-
-		return isset( $image['0'] ) ? $image['0'] : false;
-	}
-
-	/**
-	 * Add additional instructions to featured image metabox
-	 * when the entity type is the publisher.
-	 *
-	 * @since  3.19.0
-	 *
-	 * @param  string $content Current metabox content.
-	 *
-	 * @return string $content metabox content with additional instructions.
-	 */
-	public function add_featured_image_instruction( $content ) {
-		// Get the current post ID.
-		$post_id = get_the_ID();
-
-		// Get the publisher id.
-		$publisher_id = $this->configuration_service->get_publisher_id();
-
-
-		// Bail if for some reason the post id is not set.
-		if (
-			empty( $post_id ) ||
-			$post_id !== (int) $publisher_id
-		) {
-			return $content;
-		}
-
-		$terms = wp_get_post_terms(
-			$post_id, // The post id.
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, // The taxonomy slug.
-			array(
-				'fields' => 'slugs',
-				// We don't need all fields, but only slugs.
-			)
-		);
-
-		// Check that the entity type is "Organization".
-		if ( in_array( 'organization', $terms, true ) ) {
-			// Add the featured image description when the type is "Organization".
-
-			$link = sprintf( '<a target="_blank" href="%s">%s</a>',
-				esc_attr__( 'https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift' ),
-				esc_html__( 'AMP logo guidelines', 'wordlift' ) );
-			$content .= sprintf( '<p>'
-								 . esc_html_x( 'According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift' )
-								 . '</p>', $link );
-		}
-
-		// Finally return the content.
-		return $content;
-	}
+        $entities = get_posts( array(
+            'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
+            'post_status'    => 'publish',
+            'posts_per_page' => - 1,
+            'tax_query'      => array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => array( 'organization', 'person' ),
+                ),
+            ),
+            's'              => $filter,
+            'orderby'        => 'title',
+            'order'          => 'ASC',
+        ) );
+
+        // Remove the search filter added before the query.
+        remove_filter( 'posts_search', array(
+            $this,
+            'limit_search_to_title',
+        ), 10, 2 );
+
+        // Set a reference to ourselves to pass to the closure.
+        $publisher_service = $this;
+
+        // Map the results in a `Select2` compatible array.
+        return array_map( function ( $entity ) use ( $publisher_service ) {
+            $type     = wp_get_post_terms( $entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+            $thumb_id = get_post_thumbnail_id( $entity->ID );
+
+            return array(
+                'id'            => $entity->ID,
+                'text'          => $entity->post_title,
+                'type'          => $type[0]->name,
+                'thumbnail_url' => $publisher_service->get_attachment_image_url( $thumb_id ),
+            );
+        }, $entities );
+    }
+
+    /**
+     * Get the thumbnail's URL.
+     *
+     * @since 3.11.0
+     *
+     * @param int    $attachment_id The attachment id.
+     * @param string $size          The attachment size (default = 'thumbnail').
+     *
+     * @return string|bool The image URL or false if not found.
+     */
+    public function get_attachment_image_url( $attachment_id, $size = 'thumbnail' ) {
+
+        $image = wp_get_attachment_image_src( $attachment_id, $size );
+
+        return isset( $image['0'] ) ? $image['0'] : false;
+    }
+
+    /**
+     * Add additional instructions to featured image metabox
+     * when the entity type is the publisher.
+     *
+     * @since  3.19.0
+     *
+     * @param  string $content Current metabox content.
+     *
+     * @return string $content metabox content with additional instructions.
+     */
+    public function add_featured_image_instruction( $content ) {
+        // Get the current post ID.
+        $post_id = get_the_ID();
+
+        // Get the publisher id.
+        $publisher_id = $this->configuration_service->get_publisher_id();
+
+
+        // Bail if for some reason the post id is not set.
+        if (
+            empty( $post_id ) ||
+            $post_id !== (int) $publisher_id
+        ) {
+            return $content;
+        }
+
+        $terms = wp_get_post_terms(
+            $post_id, // The post id.
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, // The taxonomy slug.
+            array(
+                'fields' => 'slugs',
+                // We don't need all fields, but only slugs.
+            )
+        );
+
+        // Check that the entity type is "Organization".
+        if ( in_array( 'organization', $terms, true ) ) {
+            // Add the featured image description when the type is "Organization".
+
+            $link = sprintf( '<a target="_blank" href="%s">%s</a>',
+                esc_attr__( 'https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift' ),
+                esc_html__( 'AMP logo guidelines', 'wordlift' ) );
+            $content .= sprintf( '<p>'
+                                    . esc_html_x( 'According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift' )
+                                    . '</p>', $link );
+        }
+
+        // Finally return the content.
+        return $content;
+    }
 
 }

Spacing +39 added lines, -39 removed lines

@@ -34,7 +34,7 @@ 
 	 *
 	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
 	 */
-	public function __construct( $configuration_service ) {
+	public function __construct($configuration_service) {
 		$this->configuration_service = $configuration_service;
 	}
 
@@ -51,22 +51,22 @@ 
 		// or Organization.
 
 		// Get only the ids as all we need is the count.
-		$entities = get_posts( array(
+		$entities = get_posts(array(
 			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
 			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
+			'posts_per_page' => -1,
 			'tax_query'      => array(
 				array(
 					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
 					'field'    => 'slug',
-					'terms'    => array( 'organization', 'person' ),
+					'terms'    => array('organization', 'person'),
 				),
 			),
 			'fields'         => 'ids',
-		) );
+		));
 
 		// Finally return the count.
-		return count( $entities );
+		return count($entities);
 	}
 
 	/**
@@ -81,28 +81,28 @@ 
 	 *
 	 * @return array|string An array of results.
 	 */
-	public function limit_search_to_title( $search, $wp_query ) {
+	public function limit_search_to_title($search, $wp_query) {
 
 		// Bail out if the search or the `search_terms` haven't been set.
-		if ( empty( $search ) || empty( $wp_query->query_vars['search_terms'] ) ) {
+		if (empty($search) || empty($wp_query->query_vars['search_terms'])) {
 			return $search;
 		}
 
 		global $wpdb;
 
 		$query_vars = $wp_query->query_vars;
-		$percent    = ! empty( $query_vars['exact'] ) ? '' : '%';
+		$percent    = ! empty($query_vars['exact']) ? '' : '%';
 		$search     = array();
 
-		foreach ( (array) $query_vars['search_terms'] as $term ) {
-			$search[] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $percent . $wpdb->esc_like( $term ) . $percent );
+		foreach ((array) $query_vars['search_terms'] as $term) {
+			$search[] = $wpdb->prepare("$wpdb->posts.post_title LIKE %s", $percent.$wpdb->esc_like($term).$percent);
 		}
 
-		if ( ! is_user_logged_in() ) {
+		if ( ! is_user_logged_in()) {
 			$search[] = "$wpdb->posts.post_password = ''";
 		}
 
-		$search = ' AND ' . implode( ' AND ', $search );
+		$search = ' AND '.implode(' AND ', $search);
 
 		return $search;
 	}
@@ -117,55 +117,55 @@ 
 	 *
 	 * @return array An array of results in a select2 friendly format.
 	 */
-	public function query( $filter = '' ) {
+	public function query($filter = '') {
 
 		// Search for the filter in the titles only.
-		add_filter( 'posts_search', array(
+		add_filter('posts_search', array(
 			$this,
 			'limit_search_to_title',
-		), 10, 2 );
+		), 10, 2);
 
 		/*
 		 * Search for entities which are either a Person
 		 * or Organization. Sort the results by title in ascending order.
 		 */
-		$entities = get_posts( array(
+		$entities = get_posts(array(
 			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
 			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
+			'posts_per_page' => -1,
 			'tax_query'      => array(
 				array(
 					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
 					'field'    => 'slug',
-					'terms'    => array( 'organization', 'person' ),
+					'terms'    => array('organization', 'person'),
 				),
 			),
 			's'              => $filter,
 			'orderby'        => 'title',
 			'order'          => 'ASC',
-		) );
+		));
 
 		// Remove the search filter added before the query.
-		remove_filter( 'posts_search', array(
+		remove_filter('posts_search', array(
 			$this,
 			'limit_search_to_title',
-		), 10, 2 );
+		), 10, 2);
 
 		// Set a reference to ourselves to pass to the closure.
 		$publisher_service = $this;
 
 		// Map the results in a `Select2` compatible array.
-		return array_map( function ( $entity ) use ( $publisher_service ) {
-			$type     = wp_get_post_terms( $entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-			$thumb_id = get_post_thumbnail_id( $entity->ID );
+		return array_map(function($entity) use ($publisher_service) {
+			$type     = wp_get_post_terms($entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
+			$thumb_id = get_post_thumbnail_id($entity->ID);
 
 			return array(
 				'id'            => $entity->ID,
 				'text'          => $entity->post_title,
 				'type'          => $type[0]->name,
-				'thumbnail_url' => $publisher_service->get_attachment_image_url( $thumb_id ),
+				'thumbnail_url' => $publisher_service->get_attachment_image_url($thumb_id),
 			);
-		}, $entities );
+		}, $entities);
 	}
 
 	/**
@@ -178,11 +178,11 @@ 
 	 *
 	 * @return string|bool The image URL or false if not found.
 	 */
-	public function get_attachment_image_url( $attachment_id, $size = 'thumbnail' ) {
+	public function get_attachment_image_url($attachment_id, $size = 'thumbnail') {
 
-		$image = wp_get_attachment_image_src( $attachment_id, $size );
+		$image = wp_get_attachment_image_src($attachment_id, $size);
 
-		return isset( $image['0'] ) ? $image['0'] : false;
+		return isset($image['0']) ? $image['0'] : false;
 	}
 
 	/**
@@ -195,7 +195,7 @@ 
 	 *
 	 * @return string $content metabox content with additional instructions.
 	 */
-	public function add_featured_image_instruction( $content ) {
+	public function add_featured_image_instruction($content) {
 		// Get the current post ID.
 		$post_id = get_the_ID();
 
@@ -205,7 +205,7 @@ 
 
 		// Bail if for some reason the post id is not set.
 		if (
-			empty( $post_id ) ||
+			empty($post_id) ||
 			$post_id !== (int) $publisher_id
 		) {
 			return $content;
@@ -221,15 +221,15 @@ 
 		);
 
 		// Check that the entity type is "Organization".
-		if ( in_array( 'organization', $terms, true ) ) {
+		if (in_array('organization', $terms, true)) {
 			// Add the featured image description when the type is "Organization".
 
-			$link = sprintf( '<a target="_blank" href="%s">%s</a>',
-				esc_attr__( 'https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift' ),
-				esc_html__( 'AMP logo guidelines', 'wordlift' ) );
-			$content .= sprintf( '<p>'
-								 . esc_html_x( 'According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift' )
-								 . '</p>', $link );
+			$link = sprintf('<a target="_blank" href="%s">%s</a>',
+				esc_attr__('https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift'),
+				esc_html__('AMP logo guidelines', 'wordlift'));
+			$content .= sprintf('<p>'
+								 . esc_html_x('According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift')
+								 . '</p>', $link);
 		}
 
 		// Finally return the content.

src/admin/wordlift_admin_shortcodes.php

Indentation +7 added lines, -7 removed lines

@@ -9,11 +9,11 @@ 
  * Loads the buttons in TinyMCE.
  */
 function wl_admin_shortcode_buttons() {
-	// Only add hooks when the current user has permissions AND is in Rich Text editor mode
-	if ( ( current_user_can( 'edit_posts' ) || current_user_can( 'edit_pages' ) ) && get_user_option( 'rich_editing' ) ) {
-		// add_filter( 'mce_external_plugins', 'wl_admin_shortcode_buttons_register_tinymce_javascript' );
-		add_filter( 'mce_buttons', 'wl_admin_shortcode_register_buttons' );
-	}
+    // Only add hooks when the current user has permissions AND is in Rich Text editor mode
+    if ( ( current_user_can( 'edit_posts' ) || current_user_can( 'edit_pages' ) ) && get_user_option( 'rich_editing' ) ) {
+        // add_filter( 'mce_external_plugins', 'wl_admin_shortcode_buttons_register_tinymce_javascript' );
+        add_filter( 'mce_buttons', 'wl_admin_shortcode_register_buttons' );
+    }
 }
 
 /**
@@ -24,9 +24,9 @@ 
  * @return array The buttons array including the *wl_shortcodes_menu*.
  */
 function wl_admin_shortcode_register_buttons( $buttons ) {
-	array_push( $buttons, 'wl_shortcodes_menu' );
+    array_push( $buttons, 'wl_shortcodes_menu' );
 
-	return $buttons;
+    return $buttons;
 }
 
 // init process for button control

Spacing +5 added lines, -5 removed lines

@@ -10,9 +10,9 @@ 
  */
 function wl_admin_shortcode_buttons() {
 	// Only add hooks when the current user has permissions AND is in Rich Text editor mode
-	if ( ( current_user_can( 'edit_posts' ) || current_user_can( 'edit_pages' ) ) && get_user_option( 'rich_editing' ) ) {
+	if ((current_user_can('edit_posts') || current_user_can('edit_pages')) && get_user_option('rich_editing')) {
 		// add_filter( 'mce_external_plugins', 'wl_admin_shortcode_buttons_register_tinymce_javascript' );
-		add_filter( 'mce_buttons', 'wl_admin_shortcode_register_buttons' );
+		add_filter('mce_buttons', 'wl_admin_shortcode_register_buttons');
 	}
 }
 
@@ -23,11 +23,11 @@ 
  *
  * @return array The buttons array including the *wl_shortcodes_menu*.
  */
-function wl_admin_shortcode_register_buttons( $buttons ) {
-	array_push( $buttons, 'wl_shortcodes_menu' );
+function wl_admin_shortcode_register_buttons($buttons) {
+	array_push($buttons, 'wl_shortcodes_menu');
 
 	return $buttons;
 }
 
 // init process for button control
-add_action( 'admin_init', 'wl_admin_shortcode_buttons' );
+add_action('admin_init', 'wl_admin_shortcode_buttons');

src/install/class-wordlift-install-3-18-3.php

Indentation +49 added lines, -49 removed lines

@@ -15,47 +15,47 @@ 
  * @subpackage Wordlift/install
  */
 class Wordlift_Install_3_18_3 extends Wordlift_Install {
-	/**
-	 * @inheritdoc
-	 */
-	protected static $version = '3.18.3';
+    /**
+     * @inheritdoc
+     */
+    protected static $version = '3.18.3';
 
-	/**
-	 * @inheritdoc
-	 */
-	public function install() {
-		$this->set_article_term_to_posts();
-	}
+    /**
+     * @inheritdoc
+     */
+    public function install() {
+        $this->set_article_term_to_posts();
+    }
 
-	/**
-	 * Set default article term to posts
-	 * that exists in `wl_relation_instances` table.
-	 *
-	 * @since 3.18.3
-	 *
-	 * @return mixed False if the `article` doesn't exists.
-	 */
-	public function set_article_term_to_posts() {
-		// Load the global $wpdb;
-		global $wpdb;
+    /**
+     * Set default article term to posts
+     * that exists in `wl_relation_instances` table.
+     *
+     * @since 3.18.3
+     *
+     * @return mixed False if the `article` doesn't exists.
+     */
+    public function set_article_term_to_posts() {
+        // Load the global $wpdb;
+        global $wpdb;
 
-		// Get the article term.
-		$term = get_term_by(
-			'slug',
-			'article',
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME
-		);
+        // Get the article term.
+        $term = get_term_by(
+            'slug',
+            'article',
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME
+        );
 
-		// Bail if term doesn't exist.
-		if ( empty( $term ) ) {
-			return false;
-		}
+        // Bail if term doesn't exist.
+        if ( empty( $term ) ) {
+            return false;
+        }
 
-		// Set `article` term to all posts that exists in
-		// `wl_relation_instances` table and don't have `article` term set.
-		$post_ids = $wpdb->get_results(
-			$wpdb->prepare(
-				"
+        // Set `article` term to all posts that exists in
+        // `wl_relation_instances` table and don't have `article` term set.
+        $post_ids = $wpdb->get_results(
+            $wpdb->prepare(
+                "
 				SELECT DISTINCT p.ID
 				FROM $wpdb->posts AS p
 				INNER JOIN {$wpdb->prefix}wl_relation_instances AS ri
@@ -70,19 +70,19 @@ 
 					)
 				)
 				",
-				'post',
-				$term->term_id
-			)
-		);
+                'post',
+                $term->term_id
+            )
+        );
 
-		// Loop through all posts and set `article` term for each one.
-		foreach ($post_ids as $p) {
-			wp_set_object_terms(
-				(int) $p->ID,
-				$term->term_id,
-				Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME
-			);
-		}
-	}
+        // Loop through all posts and set `article` term for each one.
+        foreach ($post_ids as $p) {
+            wp_set_object_terms(
+                (int) $p->ID,
+                $term->term_id,
+                Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME
+            );
+        }
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 		);
 
 		// Bail if term doesn't exist.
-		if ( empty( $term ) ) {
+		if (empty($term)) {
 			return false;
 		}
 

src/includes/class-wordlift-jsonld-website-converter.php

Indentation +55 added lines, -55 removed lines

@@ -15,68 +15,68 @@
  */
 class Wordlift_Website_Jsonld_Converter extends Wordlift_Post_To_Jsonld_Converter {
 
-	/**
-	 * Convert the home/blog page to a JSON-LD array.
-	 *
-	 * @since 3.14.0
-	 *
-	 * @return array A JSON-LD array.
-	 */
-	public function create_schema() {
+    /**
+     * Convert the home/blog page to a JSON-LD array.
+     *
+     * @since 3.14.0
+     *
+     * @return array A JSON-LD array.
+     */
+    public function create_schema() {
 
-		// Create new jsonld.
-		$home_url = home_url( '/' );
+        // Create new jsonld.
+        $home_url = home_url( '/' );
 
-		$jsonld = array(
-			'@context'      => 'http://schema.org',
-			'@type'         => 'WebSite',
-			'@id'           => "$home_url#website",
-			'name'          => html_entity_decode( get_bloginfo( 'name' ), ENT_QUOTES ),
-			'alternateName' => html_entity_decode( get_bloginfo( 'description' ), ENT_QUOTES ),
-			'url'           => $home_url,
-		);
+        $jsonld = array(
+            '@context'      => 'http://schema.org',
+            '@type'         => 'WebSite',
+            '@id'           => "$home_url#website",
+            'name'          => html_entity_decode( get_bloginfo( 'name' ), ENT_QUOTES ),
+            'alternateName' => html_entity_decode( get_bloginfo( 'description' ), ENT_QUOTES ),
+            'url'           => $home_url,
+        );
 
-		// Add publisher information.
-		$this->set_publisher( $jsonld );
+        // Add publisher information.
+        $this->set_publisher( $jsonld );
 
-		// Add search action.
-		$this->set_search_action( $jsonld );
+        // Add search action.
+        $this->set_search_action( $jsonld );
 
-		/**
-		 * Call the `wl_website_jsonld` filter.
-		 *
-		 * @api
-		 *
-		 * @since 3.14.0
-		 *
-		 * @param array $jsonld The JSON-LD structure.
-		 */
-		return apply_filters( 'wl_website_jsonld', $jsonld );
-	}
+        /**
+         * Call the `wl_website_jsonld` filter.
+         *
+         * @api
+         *
+         * @since 3.14.0
+         *
+         * @param array $jsonld The JSON-LD structure.
+         */
+        return apply_filters( 'wl_website_jsonld', $jsonld );
+    }
 
-	/**
-	 * Add SearchAction part to the schema
-	 *
-	 * @since 3.14.0
-	 *
-	 * @param array $params The parameters array.
-	 */
-	private function set_search_action( &$params ) {
-		/**
-		 * Filter: 'wl_jsonld_search_url' - Allows filtering of the search URL.
-		 *
-		 * @since  3.14.0
-		 * @api    string $search_url The search URL for this site with a `{search_term_string}` variable.
-		 */
-		$search_url = apply_filters( 'wl_jsonld_search_url', home_url( '/' ) . '?s={search_term_string}' );
+    /**
+     * Add SearchAction part to the schema
+     *
+     * @since 3.14.0
+     *
+     * @param array $params The parameters array.
+     */
+    private function set_search_action( &$params ) {
+        /**
+         * Filter: 'wl_jsonld_search_url' - Allows filtering of the search URL.
+         *
+         * @since  3.14.0
+         * @api    string $search_url The search URL for this site with a `{search_term_string}` variable.
+         */
+        $search_url = apply_filters( 'wl_jsonld_search_url', home_url( '/' ) . '?s={search_term_string}' );
 
-		// Add search action
-		$params['potentialAction'] = array(
-			'@type'       => 'SearchAction',
-			'target'      => $search_url,
-			'query-input' => 'required name=search_term_string',
-		);
+        // Add search action
+        $params['potentialAction'] = array(
+            '@type'       => 'SearchAction',
+            'target'      => $search_url,
+            'query-input' => 'required name=search_term_string',
+        );
 
-	}
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -25,22 +25,22 @@ 
 	public function create_schema() {
 
 		// Create new jsonld.
-		$home_url = home_url( '/' );
+		$home_url = home_url('/');
 
 		$jsonld = array(
 			'@context'      => 'http://schema.org',
 			'@type'         => 'WebSite',
 			'@id'           => "$home_url#website",
-			'name'          => html_entity_decode( get_bloginfo( 'name' ), ENT_QUOTES ),
-			'alternateName' => html_entity_decode( get_bloginfo( 'description' ), ENT_QUOTES ),
+			'name'          => html_entity_decode(get_bloginfo('name'), ENT_QUOTES),
+			'alternateName' => html_entity_decode(get_bloginfo('description'), ENT_QUOTES),
 			'url'           => $home_url,
 		);
 
 		// Add publisher information.
-		$this->set_publisher( $jsonld );
+		$this->set_publisher($jsonld);
 
 		// Add search action.
-		$this->set_search_action( $jsonld );
+		$this->set_search_action($jsonld);
 
 		/**
 		 * Call the `wl_website_jsonld` filter.
@@ -51,7 +51,7 @@ 
 		 *
 		 * @param array $jsonld The JSON-LD structure.
 		 */
-		return apply_filters( 'wl_website_jsonld', $jsonld );
+		return apply_filters('wl_website_jsonld', $jsonld);
 	}
 
 	/**
@@ -61,14 +61,14 @@ 
 	 *
 	 * @param array $params The parameters array.
 	 */
-	private function set_search_action( &$params ) {
+	private function set_search_action(&$params) {
 		/**
 		 * Filter: 'wl_jsonld_search_url' - Allows filtering of the search URL.
 		 *
 		 * @since  3.14.0
 		 * @api    string $search_url The search URL for this site with a `{search_term_string}` variable.
 		 */
-		$search_url = apply_filters( 'wl_jsonld_search_url', home_url( '/' ) . '?s={search_term_string}' );
+		$search_url = apply_filters('wl_jsonld_search_url', home_url('/').'?s={search_term_string}');
 
 		// Add search action
 		$params['potentialAction'] = array(

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

Indentation +163 added lines, -163 removed lines

@@ -16,168 +16,168 @@
  */
 class Wordlift_Entity_Post_Type_Service {
 
-	/**
-	 * The entity post type.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var string $post_type The entity post type.
-	 */
-	private $post_type;
-
-	/**
-	 * The entity type slug.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var string $slug The entity type slug.
-	 */
-	private $slug;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * A singleton instance of the entity type service.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var Wordlift_Entity_Post_Type_Service
-	 */
-	private static $instance;
-
-	/**
-	 * Create an entity type service instance.
-	 *
-	 * @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->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->post_type = $post_type;
-
-		// We cannot assign an empty slug to the register_post_type function, therefore if the slug is empty we default
-		// to the type name.
-		$this->slug = $slug ?: $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() {
-
-		$this->log->debug( "Registering post type $this->post_type..." );
-
-		$labels = array(
-			'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
-			'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
-			'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
-			'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
-			'edit_item'          => __( 'Edit Entity', 'wordlift' ),
-			'new_item'           => __( 'New Entity', 'wordlift' ),
-			'all_items'          => __( 'All Entities', 'wordlift' ),
-			'view_item'          => __( 'View Entity', 'wordlift' ),
-			'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
-			'not_found'          => __( 'No entities found', 'wordlift' ),
-			'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
-			'parent_item_colon'  => '',
-			'menu_name'          => __( 'Vocabulary', 'wordlift' ),
-		);
-
-		$args = array(
-			'labels'          => $labels,
-			'description'     => 'Holds our vocabulary (set of entities) and entity specific data',
-			'public'          => true,
-			'menu_position'   => 20,
-			// after the pages menu.
-			// Add support for 'authors' and 'revisions':
-			// * see https://github.com/insideout10/wordlift-plugin/issues/395
-			// * see https://github.com/insideout10/wordlift-plugin/issues/376
-			'supports'        => array(
-				'title',
-				'editor',
-				'thumbnail',
-				'excerpt',
-				'comments',
-				'author',
-				'revisions',
-			),
-			'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 ),
-			'capability_type' => array(
-				'wordlift_entity',
-				'wordlift_entities',
-			),
-			'capabilities' => array(
-				'delete_posts' => 'delete_wordlift_entities',
-			)
-		);
-
-		register_post_type( $this->post_type, $args );
-
-		// Enable WP's standard `category` taxonomy for entities.
-		//
-		// While this enables editors to bind entities to the WP posts' category
-		// taxonomy, in Wordlift_Category_Taxonomy_Service we also need to alter
-		// WP's main category query to include the `entity` post type.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/442
-		register_taxonomy_for_object_type( 'category', $this->post_type );
-
-	}
+    /**
+     * The entity post type.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var string $post_type The entity post type.
+     */
+    private $post_type;
+
+    /**
+     * The entity type slug.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var string $slug The entity type slug.
+     */
+    private $slug;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * A singleton instance of the entity type service.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var Wordlift_Entity_Post_Type_Service
+     */
+    private static $instance;
+
+    /**
+     * Create an entity type service instance.
+     *
+     * @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->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->post_type = $post_type;
+
+        // We cannot assign an empty slug to the register_post_type function, therefore if the slug is empty we default
+        // to the type name.
+        $this->slug = $slug ?: $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() {
+
+        $this->log->debug( "Registering post type $this->post_type..." );
+
+        $labels = array(
+            'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
+            'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
+            'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
+            'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
+            'edit_item'          => __( 'Edit Entity', 'wordlift' ),
+            'new_item'           => __( 'New Entity', 'wordlift' ),
+            'all_items'          => __( 'All Entities', 'wordlift' ),
+            'view_item'          => __( 'View Entity', 'wordlift' ),
+            'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
+            'not_found'          => __( 'No entities found', 'wordlift' ),
+            'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
+            'parent_item_colon'  => '',
+            'menu_name'          => __( 'Vocabulary', 'wordlift' ),
+        );
+
+        $args = array(
+            'labels'          => $labels,
+            'description'     => 'Holds our vocabulary (set of entities) and entity specific data',
+            'public'          => true,
+            'menu_position'   => 20,
+            // after the pages menu.
+            // Add support for 'authors' and 'revisions':
+            // * see https://github.com/insideout10/wordlift-plugin/issues/395
+            // * see https://github.com/insideout10/wordlift-plugin/issues/376
+            'supports'        => array(
+                'title',
+                'editor',
+                'thumbnail',
+                'excerpt',
+                'comments',
+                'author',
+                'revisions',
+            ),
+            '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 ),
+            'capability_type' => array(
+                'wordlift_entity',
+                'wordlift_entities',
+            ),
+            'capabilities' => array(
+                'delete_posts' => 'delete_wordlift_entities',
+            )
+        );
+
+        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 +19 added lines, -19 removed lines

@@ -60,9 +60,9 @@ 
 	 * @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->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->post_type = $post_type;
 
@@ -118,22 +118,22 @@ 
 	 */
 	public function register() {
 
-		$this->log->debug( "Registering post type $this->post_type..." );
+		$this->log->debug("Registering post type $this->post_type...");
 
 		$labels = array(
-			'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
-			'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
-			'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
-			'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
-			'edit_item'          => __( 'Edit Entity', 'wordlift' ),
-			'new_item'           => __( 'New Entity', 'wordlift' ),
-			'all_items'          => __( 'All Entities', 'wordlift' ),
-			'view_item'          => __( 'View Entity', 'wordlift' ),
-			'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
-			'not_found'          => __( 'No entities found', 'wordlift' ),
-			'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
+			'name'               => _x('Vocabulary', 'post type general name', 'wordlift'),
+			'singular_name'      => _x('Entity', 'post type singular name', 'wordlift'),
+			'add_new'            => _x('Add New Entity', 'entity', 'wordlift'),
+			'add_new_item'       => __('Add New Entity', 'wordlift'),
+			'edit_item'          => __('Edit Entity', 'wordlift'),
+			'new_item'           => __('New Entity', 'wordlift'),
+			'all_items'          => __('All Entities', 'wordlift'),
+			'view_item'          => __('View Entity', 'wordlift'),
+			'search_items'       => __('Search in Vocabulary', 'wordlift'),
+			'not_found'          => __('No entities found', 'wordlift'),
+			'not_found_in_trash' => __('No entities found in the Trash', 'wordlift'),
 			'parent_item_colon'  => '',
-			'menu_name'          => __( 'Vocabulary', 'wordlift' ),
+			'menu_name'          => __('Vocabulary', 'wordlift'),
 		);
 
 		$args = array(
@@ -155,9 +155,9 @@ 
 				'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),
 			'capability_type' => array(
 				'wordlift_entity',
 				'wordlift_entities',
@@ -167,7 +167,7 @@ 
 			)
 		);
 
-		register_post_type( $this->post_type, $args );
+		register_post_type($this->post_type, $args);
 
 		// Enable WP's standard `category` taxonomy for entities.
 		//
@@ -176,7 +176,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);
 
 	}